README.md 10.1 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
       * [`freeradius::attr`](#freeradiusattr)
12
       * [`freeradius::cert`](#freeradiuscert)
13
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)
       * [`freeradius::statusclient`](#freeradiusstatusclient)
21
22
23
4. [Limitations - OS compatibility, etc.](#limitations)
5. [Development - Guide for contributing to the module](#development)
6. [Release Notes](#release-notes)
24
25
26

## Overview

27
28
29
30
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.
31
32
33

## Module Description

34
35
36
37
38
39
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.
40

41
42
43
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.
44
45


46
## Usage
47

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

50
### Classes
51

52
#### `freeradius`
53

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

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

##### `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`

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

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

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

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

102
### Resources
103

104
#### `freeradius::attr`
105

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

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

114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
#### `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`.

129
130
131
132
#### `freeradius::client`

Define RADIUS clients as seen in `clients.conf`

133
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
134
135
freeradius::client { "wlan-controller01":
  ip        => '192.168.0.1',
136
  secret    => 'testing123',
Jonathan Gazeley's avatar
Jonathan Gazeley committed
137
  shortname => 'wlc01',
138
  nastype   => 'other',
Jonathan Gazeley's avatar
Jonathan Gazeley committed
139
140
141
  port      => '1645-1646',
  firewall  => true,
}
142
143
```

144
##### `ip`
145
The IP address of the client.  For IPv6, use `ipv6addr`. `ip` and `ip6` are mutually exclusive but one must be supplied. Default: `undef`.
146
147

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

##### `shortname`
151
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.
152
153

##### `secret`
154
The RADIUS shared secret used for communication between the client/NAS and the RADIUS server. Required.
155
156

##### `virtual_server`
157
The virtual server that traffic from this client should be sent to. Default: `undef`.
158
159

##### `nastype`
160
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`.
161
162

##### `netmask`
163
The netmask of the client, specified as an integer, e.g. `24`. Default: `undef`.
164
165

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

168
169
##### `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`.
170
171
172
173
174

#### `freeradius::config`

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

175
```puppet
176
177
178
179
180
freeradius::config { 'realm-checks.conf':
  source => 'puppet:///modules/site_freeradius/realm-checks.conf',
}
```

181
182
183
184
185
186
187
188
189
190
#### `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',
}
```

191
192
#### `freeradius::instantiate`

Jonathan Gazeley's avatar
Jonathan Gazeley committed
193
194
Instantiate a module that is not automatically instantiated.

195
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
196
197
freeradius::instantiate { 'mymodule': }
```
198
199

#### `freeradius::module`
200

201
Install a module from a flat file.
202

203
```puppet
204
205
206
207
208
209
210
211
212
freeradius::module { 'buffered-sql':
  source => 'puppet:///modules/site_freeradius/buffered-sql',
}
```

#### `freeradius::policy`

Install a policy from a flat file.

213
```puppet
214
215
216
217
218
219
220
221
222
223
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.

224
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
225
226
227
228
229
freeradius::site { 'myperlscript.pl':
  source => 'puppet:///modules/site_freeradius/myperlscript.pl',
}
```

230
231
#### `freeradius::site`

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

235
```puppet
236
237
238
239
240
241
242
243
244
245
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.

246
247
248
249
250
251
252
253
254
255
256
257
258
259
##### `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.
260
261
262
263


## Limitations

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

268
269
270
271
272
273
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.
274
275
276

## Development

277
278
279
280
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.
281

282
## Release Notes
283

284
285
286
287
### 0.1.4

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

Jonathan Gazeley's avatar
Jonathan Gazeley committed
288
289
290
291
292
293
294
### 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
295
296
297
298
299
300
301
### 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
302
303
304
305
306
### 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
307