README.md 9.34 KB
Newer Older
Jonathan Gazeley's avatar
Jonathan Gazeley committed
1
# freeradius
Jonathan's avatar
Jonathan committed
2

3
4
5
6
#### Table of Contents

1. [Overview](#overview)
2. [Module Description - What the module does and why it is useful](#module-description)
7
3. [Usage - Configuration options and additional functionality](#usage)
8
9
10
    * [Classes](#classes)
       * [`freeradius`](#freeradius)
    * [Resources](#resources)
11
12
13
14
15
16
17
18
19
       * [`freeradius::attr`](#freeradiusattr)
       * [`freeradius::client`](#freeradiusclient)
       * [`freeradius::config`](#freeradiusconfig)
       * [`freeradius::dictionary`](#freeradiusdictionary)
       * [`freeradius::instantiate`](#freeradiusinstantiate)
       * [`freeradius::module`](#freeradiusmodule)
       * [`freeradius::policy`](#freeradiuspolicy)
       * [`freeradius::site`](#freeradiussite)
       * [`freeradius::statusclient`](#freeradiusstatusclient)
20
21
22
4. [Limitations - OS compatibility, etc.](#limitations)
5. [Development - Guide for contributing to the module](#development)
6. [Release Notes](#release-notes)
23
24
25

## Overview

26
27
28
29
This module installs and configures [FreeRADIUS](http://freeradius.org/) server
on Linux. This module was written for use with FreeRADIUS 2.x and has not been
tested with FreeRADIUS 3.x. It was designed with CentOS in mind but should
work on other distributions.
30
31
32

## Module Description

33
34
35
36
37
38
This module installs FreeRADIUS from a distro-provided package and installs a
number of customised config files to enable flexibility. It then provides some
helpers to allow you to easily configure virtual servers (sites), modules, clients
and other config items. Most of these items accept a flat config file which you
supply either as a static file or a template - similar to the `source` and `content`
parameters in Puppet's `file` resource.
39

40
41
42
This module is designed to make it more straightforward for RADIUS administrators to
deploy RADIUS servers using Puppet. This module does not serve as a wizard and does
not avoid having to have an understanding of FreeRADIUS.
43
44


45
## Usage
46

47
This module provides several classes and defined types which take parameters.
48

49
### Classes
50

51
#### `freeradius`
52

53
54
The `freeradius` class installs the base server. In the early releases, this class does not
have many parameters as most values are hard-coded. I am working on parameterising more
55
56
of the global settings to increase flexibility. Patches are welcome.

57
##### `control_socket`
58
Enable the `control-socket` virtual server. See also the `radmin` program. Default: `false`
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

##### `max_requests`
The maximum number of requests which the server keeps track of. This should be 256 multiplied by the number of clients. Default: `4096`

##### `max_servers`
Limit on the total number of servers running. Default: `4096`

##### `mysql_support`
Install support for MySQL. Default: `false`

##### `perl_support`
Install support for Perl. Default: `false`

##### `utils_support`
Install FreeRADIUS utils. Default: `false`

##### `ldap_support`
Install support for LDAP. Default: `false`

78
##### `wpa_supplicant`
79
80
Install wpa_supplicant utility. Default: `false`

81
##### `winbind_support`
82
Add the radius user to the winbind privileged group. You must install winbind separately. Default: `false`.
83

84
85
##### `syslog`
Add a syslog rule (using the `jgazeley/syslog` module). Default: `false`.
86

Jonathan Gazeley's avatar
Jonathan Gazeley committed
87
88
```puppet
class { 'freeradius':
89
90
91
92
93
94
95
96
  control_socket  => true,
  max_requests    => 4096,
  max_servers     => 4096,
  mysql_support   => true,
  perl_support    => true,
  utils_support   => true,
  wpa_supplicant  => true,
  winbind_support => true,
97
  syslog          => true,
Jonathan Gazeley's avatar
Jonathan Gazeley committed
98
99
100
}
```

101
### Resources
102

103
#### `freeradius::attr`
104

Jonathan Gazeley's avatar
Jonathan Gazeley committed
105
Install arbitrary attribute filters from a flat file. These are installed in `/etc/raddb/attr.d`
Jonathan Gazeley's avatar
Jonathan Gazeley committed
106

107
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
108
109
110
111
freeradius::attr { 'eduroamlocal':
  source => 'puppet:///modules/site_freeradius/eduroamlocal',
}
```
112
113
114
115
116

#### `freeradius::client`

Define RADIUS clients as seen in `clients.conf`

117
```puppet
118
119
120
121
122
123
124
125
freeradius::client { "localhost-${::hostname}-lo":
  ip        => '127.0.0.1',
  secret    => 'testing123',
  shortname => 'localhost',
  nastype   => 'other',
  }
```

126
##### `ip`
127
The IP address of the client.  For IPv6, use `ipv6addr`. `ip` and `ip6` are mutually exclusive but one must be supplied. Default: `undef`.
128
129

##### `ip6`
130
The IPv6 address of the client. `ip` and `ip6` are mutually exclusive but one must be supplied. Default: `undef`.
131
132

##### `net`
133
The netmask of the client, specified as an integer, e.g. `24`. Default: `undef`.
134
135

##### `shortname`
136
A short alias that is used in place of the IP address or fully qualified hostname provided in the first line of the section. Required.
137
138

##### `secret`
139
The RADIUS shared secret used for communication between the client/NAS and the RADIUS server. Required.
140
141

##### `virtual_server`
142
The virtual server that traffic from this client should be sent to. Default: `undef`.
143
144

##### `nastype`
145
The `nastype` attribute is used to tell the `checkrad.pl` script which NAS-specific method it should use when checking simultaneous use. See [`man clients.conf`](http://freeradius.org/radiusd/man/clients.conf.txt) for a list of all options. Default: `undef`.
146
147

##### `netmask`
148
The netmask of the client, specified as an integer, e.g. `24`. Default: `undef`.
149
150

##### `port`
Jonathan Gazeley's avatar
Jonathan Gazeley committed
151
The UDP port that this virtual server should listen on. Leave blank if this client is not tied to a virtual server. Currently the port number is only used to create firewall exceptions and you only need to specify it if you set `firewall => true`. Use port range syntax as in [`puppetlabs-firewall`](https://forge.puppetlabs.com/puppetlabs/firewall). Default: `undef`.
152

153
154
##### `firewall`
Create a firewall exception for this virtual server. If this is set to `true`, you must also supply `port` and either `ip` or `ip6`. Default: `false`.
155
156
157
158
159

#### `freeradius::config`

Install arbitrary config snippets from a flat file. These are installed in `/etc/raddb/conf.d`

160
```puppet
161
162
163
164
165
freeradius::config { 'realm-checks.conf':
  source => 'puppet:///modules/site_freeradius/realm-checks.conf',
}
```

166
167
168
169
170
171
172
173
174
175
#### `freeradius::dictionary`

Install custom dictionaries without breaking the default FreeRADIUS dictionary. Custom dictionaries are installed in `/etc/raddb/dictionary.d` and automatically included in the global dictionary.

```puppet
freeradius::dictionary { 'mydict':
  source => 'puppet:///modules/site_freeradius/dictionary.mydict',
}
```

176
177
#### `freeradius::instantiate`

Jonathan Gazeley's avatar
Jonathan Gazeley committed
178
179
Instantiate a module that is not automatically instantiated.

180
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
181
182
freeradius::instantiate { 'mymodule': }
```
183
184

#### `freeradius::module`
185

186
Install a module from a flat file.
187

188
```puppet
189
190
191
192
193
194
195
196
197
freeradius::module { 'buffered-sql':
  source => 'puppet:///modules/site_freeradius/buffered-sql',
}
```

#### `freeradius::policy`

Install a policy from a flat file.

198
```puppet
199
200
201
202
203
204
205
206
207
208
freeradius::policy { 'my-policies':
  source => 'puppet:///modules/site_freeradius/my-policies',
}
```

#### `freeradius::script`

Install a helper script, e.g. which might be called upon by a virtual server. These are
placed in `/etc/raddb/scripts` and are not automatically included by the server.

209
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
210
211
212
213
214
freeradius::site { 'myperlscript.pl':
  source => 'puppet:///modules/site_freeradius/myperlscript.pl',
}
```

215
216
#### `freeradius::site`

Jonathan Gazeley's avatar
Jonathan Gazeley committed
217
Install a virtual server (a.k.a. site) from a flat file. Sites are installed directly
218
219
into `/etc/raddb/sites-enabled`

220
```puppet
221
222
223
224
225
226
227
228
229
230
freeradius::site { 'inner-tunnel':
  source => 'puppet:///modules/site_freeradius/inner-tunnel',
}
```

#### `freeradius::statusclient`

Define RADIUS clients, specifically to connect to the status server for monitoring.
Very similar usage to `freeradius::client` but with fewer options.

231
232
233
234
235
236
237
238
239
240
241
242
243
244
##### `ip`
Default: `undef`. The IP address of the client.  For IPv6, use `ipv6addr`. `ip` and `ip6` are mutually exclusive but one must be supplied.

##### `ip6`
Default: `undef`. The IPv6 address of the client. `ip` and `ip6` are mutually exclusive but one must be supplied.

##### `secret`
required. The RADIUS shared secret used for communication between the client/NAS and the RADIUS server.

##### `port`
Default: `undef`. The UDP port that this virtual server should listen on. Leave blank if this client is not tied to a virtual server.

##### `shortname`
required. A short alias that is used in place of the IP address or fully qualified hostname provided in the first line of the section.
245
246
247
248


## Limitations

249
This module is targeted at FreeRADIUS 2.x running on CentOS 6. It has not been tested
250
251
on other distributions, but might work. Likely sticking points with other distros are
the names of packages, services and file paths.
252

253
254
255
256
257
258
This module has not been tested on FreeRADIUS 3.x and almost certainly won't work
without modification. FreeRADIUS 3.x support in this module will come onto the roadmap
at the same time that my employer decides to start looking FreeRADIUS 3.x.

This module was written for use with Puppet 3.6 and 3.7, but should be quite agnostic
to new versions of Puppet.
259
260
261

## Development

262
263
264
265
This module was written primarily for internal use - features we haven't needed to
use probably haven't been written. Please send pull requests with new features and
bug fixes. You are also welcome to file issues but I make no guarantees of
development effort if the features aren't useful to my employer.
266

267
## Release Notes
268

Jonathan Gazeley's avatar
Jonathan Gazeley committed
269
270
271
272
273
274
275
### 0.1.2

 * Improved modular installs with optional components
 * Improved support for Debian
 * Clarify dependencies on other modules
 * Lots of bugfixes

Jonathan Gazeley's avatar
Jonathan Gazeley committed
276
277
278
279
280
### 0.1.0

 * Initial release with support for installing FreeRADIUS and configuring servers, modules, clients and other objects using flat files.
 * Probably works only with FreeRADIUS 2.x
 * Only tested with CentOS 6
Jonathan Gazeley's avatar
Jonathan Gazeley committed
281