README.md 13 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
    * [Classes](#classes)
       * [`freeradius`](#freeradius)
Jonathan Gazeley's avatar
Jonathan Gazeley committed
10
       * [`freeradius::status_server`](#freeradiusstatus_server)
11
    * [Resources](#resources)
12
       * [`freeradius::attr`](#freeradiusattr)
13
       * [`freeradius::cert`](#freeradiuscert)
14
15
16
17
18
19
20
       * [`freeradius::client`](#freeradiusclient)
       * [`freeradius::config`](#freeradiusconfig)
       * [`freeradius::dictionary`](#freeradiusdictionary)
       * [`freeradius::instantiate`](#freeradiusinstantiate)
       * [`freeradius::module`](#freeradiusmodule)
       * [`freeradius::policy`](#freeradiuspolicy)
       * [`freeradius::site`](#freeradiussite)
Jonathan Gazeley's avatar
Jonathan Gazeley committed
21
       * [`freeradius::sql`](#freeradiussql)
22
       * [`freeradius::statusclient`](#freeradiusstatusclient)
23
24
25
4. [Limitations - OS compatibility, etc.](#limitations)
5. [Development - Guide for contributing to the module](#development)
6. [Release Notes](#release-notes)
26
27
28

## Overview

29
30
31
32
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.
33
34
35

## Module Description

36
37
38
39
40
41
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.
42

43
44
45
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.
46
47


48
## Usage
49

50
This module provides several classes and defined types which take parameters.
51

52
### Classes
53

54
#### `freeradius`
55

56
57
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
58
59
of the global settings to increase flexibility. Patches are welcome.

60
##### `control_socket`
61
Enable the `control-socket` virtual server. See also the `radmin` program. Default: `false`
62
63
64
65
66
67
68
69

##### `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`
70
Install support for MySQL. Note this only installs the package. Use `freeradius::sql` to configure SQL support. Default: `false`
71
72
73
74
75
76
77
78
79
80

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

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

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

81
##### `wpa_supplicant`
82
83
Install wpa_supplicant utility. Default: `false`

84
##### `winbind_support`
85
Add the radius user to the winbind privileged group. You must install winbind separately. Default: `false`.
86

87
88
##### `syslog`
Add a syslog rule (using the `jgazeley/syslog` module). Default: `false`.
89

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

104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
#### `freeradius::status_server`

The `freeradius::status_server` class installs support for the [status server](http://wiki.freeradius.org/config/Status).

##### `secret`
The shared secret for the status server. Required.

##### `port`
The port to listen for status requests on. Default: `18121`

##### `listen`
The address to listen on. Defaults to listen on all addresses but you could set this to `$::ipaddress` or `127.0.0.1`.  Default: `*`

##### `enable`
Whether to enable the status server. Default: `true`

```puppet
  # Enable status server
  class { 'freeradius::status_server':
    port   => '18120',
    secret => 't0pSecret!',
  }
```

128
### Resources
129

130
#### `freeradius::attr`
131

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

134
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
135
136
137
138
freeradius::attr { 'eduroamlocal':
  source => 'puppet:///modules/site_freeradius/eduroamlocal',
}
```
139

140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
#### `freeradius::cert`

Install certificates as provided. These are installed in `/etc/raddb/certs`

```puppet
freeradius::cert { 'mycert.pem':
  source => 'puppet:///modules/site_freeradius/mycert.pem',
  type   => 'key',
}
```

##### `type`

Set file permissions on the installed certificate differently depending on whether this is a private key or a public certificate. Note that the default is to treat the file as a private key and remove world-readable privileges. Allowable values: `cert`, `key`. Default: `key`.

155
156
157
158
#### `freeradius::client`

Define RADIUS clients as seen in `clients.conf`

159
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
160
161
freeradius::client { "wlan-controller01":
  ip        => '192.168.0.1',
162
  secret    => 'testing123',
Jonathan Gazeley's avatar
Jonathan Gazeley committed
163
  shortname => 'wlc01',
164
  nastype   => 'other',
Jonathan Gazeley's avatar
Jonathan Gazeley committed
165
166
167
  port      => '1645-1646',
  firewall  => true,
}
168
169
```

170
##### `ip`
171
The IP address of the client.  For IPv6, use `ipv6addr`. `ip` and `ip6` are mutually exclusive but one must be supplied. Default: `undef`.
172
173

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

##### `shortname`
177
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.
178
179

##### `secret`
180
The RADIUS shared secret used for communication between the client/NAS and the RADIUS server. Required.
181
182

##### `virtual_server`
183
The virtual server that traffic from this client should be sent to. Default: `undef`.
184
185

##### `nastype`
186
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`.
187
188

##### `netmask`
189
The netmask of the client, specified as an integer, e.g. `24`. Default: `undef`.
190
191

##### `port`
Jonathan Gazeley's avatar
Jonathan Gazeley committed
192
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`.
193

194
195
##### `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`.
196
197
198
199
200

#### `freeradius::config`

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

201
```puppet
202
203
204
205
206
freeradius::config { 'realm-checks.conf':
  source => 'puppet:///modules/site_freeradius/realm-checks.conf',
}
```

207
208
209
210
211
212
213
214
215
216
#### `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',
}
```

217
218
#### `freeradius::instantiate`

Jonathan Gazeley's avatar
Jonathan Gazeley committed
219
220
Instantiate a module that is not automatically instantiated.

221
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
222
223
freeradius::instantiate { 'mymodule': }
```
224
225

#### `freeradius::module`
226

227
Install a module from a flat file.
228

229
```puppet
230
231
232
233
234
235
236
237
238
freeradius::module { 'buffered-sql':
  source => 'puppet:///modules/site_freeradius/buffered-sql',
}
```

#### `freeradius::policy`

Install a policy from a flat file.

239
```puppet
240
241
242
243
244
245
246
247
248
249
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.

250
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
251
252
253
254
255
freeradius::site { 'myperlscript.pl':
  source => 'puppet:///modules/site_freeradius/myperlscript.pl',
}
```

256
257
#### `freeradius::site`

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

261
```puppet
262
263
264
265
266
freeradius::site { 'inner-tunnel':
  source => 'puppet:///modules/site_freeradius/inner-tunnel',
}
```

267
268
269
270
271
272
#### `freeradius::sql`

Configure SQL connections. You can define multiple database connections by
invoking this resource multiple times. If you are using MySQL, don't forget to
also set `mysql_support => true` in the base `freeradius` class.

273
274
275
276
277
278
279
280
281
282
```puppet
freeradius::sql { 'mydatabase':
  database  => 'mysql',
  server    => '192.168.0.1',
  login     => 'radius',
  password  => 'topsecret',
  radius_db => 'radius',
}
```

283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
##### `database`

Default: `undef`. Required. Specify which FreeRADIUS database driver to use. Choose one of `mysql`, `mssql`, `oracle`, `postgresql`

##### `server`

Default: `localhost`. Specify hostname of IP address of the database server.

##### `login`

Default: `radius`. Username to connect to the databae.

##### `password`

Default: `undef`. Required. Password to connect to the database.

##### `radius_db`

Default: `radius`. Name of the database. Normally you should leave this alone. If you are using Oracle then use this instead:
`(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SID=your_sid)))`.

304
305
306
307
308
309
310
311
##### `num_sql_socks`

Default: same as `max_servers`. Number of sql connections to make to the database server. 
Setting this to LESS than the number of threads means that some threads may starve, and
you will see errors like "No connections available and at max connection limit". Setting
this to MORE than the number of threads means that there are more connections than necessary.
Leave blank to set it to the same value as the number of threads.

312
313
314
315
316
317
318
319
320
321
##### `query_file`

Default: `sql/${database}/dialup.conf`. Relative path to the file which contains your SQL queries. By
default, points to the `dialup.conf` specific to your database engine, so leave this blank if you are
using stock queries.

If you need to use custom queries, it is recommended that you deploy your query file using
`freeradius::script` to install the file into `/etc/raddb/scripts/custom_dialup.conf` and then
set `query_file` to `scripts/custom_dialup.conf`.

322

323
324
325
326
327
#### `freeradius::statusclient`

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

328
329
330
331
332
333
334
335
336
337
338
339
340
341
##### `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.
342
343
344
345


## Limitations

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

350
351
352
353
354
355
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.
356
357
358

## Development

359
360
361
362
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.
363

364
## Release Notes
365

Jonathan Gazeley's avatar
Jonathan Gazeley committed
366
367
368
369
### 0.3.0

 * Add `ensure` parameter to all defined types

Jonathan Gazeley's avatar
Jonathan Gazeley committed
370
371
372
373
### 0.2.0

 * Add support for customising `sql.conf` natively by adding `freeradius::sql`

374
375
376
377
### 0.1.4

 * Fix ambiguity about net/netmask in freeradius::client

Jonathan Gazeley's avatar
Jonathan Gazeley committed
378
379
380
381
382
383
384
### 0.1.3

 * Add support for managing firewall rules automatically
 * Add support for installation certificates & keys
 * Make syslog support an optional component
 * Various bugfixes

Jonathan Gazeley's avatar
Jonathan Gazeley committed
385
386
387
388
389
390
391
### 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
392
393
394
395
396
### 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
397