README.md 8.17 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
8
9
10
3. [Usage - Configuration options and additional functionality](#usage)
4. [Limitations - OS compatibility, etc.](#limitations)
5. [Development - Guide for contributing to the module](#development)
6. [Release Notes](#release-notes)
11
12
13

## Overview

14
15
16
17
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.
18
19
20

## Module Description

21
22
23
24
25
26
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.
27

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


33
## Usage
34

35
This module provides several classes and defined types which take parameters.
36

37
### Classes
38

39
#### `freeradius`
40

41
42
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
43
44
45
46
47
of the global settings to increase flexibility. Patches are welcome.

 * `control_socket` Enable the control-socket virtual server. See also the "radmin" program. Default: `false`
 * `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`
48
49
50
51
52
 * `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`
 * `wpa_supplicant`. Install wpa_supplicant utility. Default: `false`
53
 * `winbind_support`. Add the radius user to the winbind privileged group. You must install winbind separately. Default: `false`.
54

Jonathan Gazeley's avatar
Jonathan Gazeley committed
55
56
```puppet
class { 'freeradius':
57
58
59
60
61
62
63
64
  control_socket  => true,
  max_requests    => 4096,
  max_servers     => 4096,
  mysql_support   => true,
  perl_support    => true,
  utils_support   => true,
  wpa_supplicant  => true,
  winbind_support => true,
Jonathan Gazeley's avatar
Jonathan Gazeley committed
65
66
67
}
```

68
### Resources
69

70
#### `freeradius::attr`
71

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

74
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
75
76
77
78
freeradius::attr { 'eduroamlocal':
  source => 'puppet:///modules/site_freeradius/eduroamlocal',
}
```
79
80
81
82
83

#### `freeradius::client`

Define RADIUS clients as seen in `clients.conf`

84
```puppet
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
freeradius::client { "localhost-${::hostname}-lo":
  ip        => '127.0.0.1',
  secret    => 'testing123',
  shortname => 'localhost',
  nastype   => 'other',
  }
```

 * `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.
 * `net` Default: `undef`. The netmask of the client, specified as an integer, e.g. `24`
 * `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.
 * `secret` required. The RADIUS shared secret used for communication between the client/NAS and the RADIUS server.
 * `server` Default: `undef`
 * `virtual_server` Default: `undef`. The virtual server that traffic from this client should be sent to.
 * `nastype` Default: `undef`. The nastype attribute is used to tell the checkrad.pl script which NAS-specific method it should use when checking simultaneous use.
 * `netmask` Default: `undef`. The netmask of the client, specified as an integer, e.g. `24`
 * `redirect` Default: `undef`
 * `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.
 * `srcip` Default: `undef`

#### `freeradius::config`

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

110
```puppet
111
112
113
114
115
freeradius::config { 'realm-checks.conf':
  source => 'puppet:///modules/site_freeradius/realm-checks.conf',
}
```

116
117
118
119
120
121
122
123
124
125
#### `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',
}
```

126
127
#### `freeradius::instantiate`

Jonathan Gazeley's avatar
Jonathan Gazeley committed
128
129
Instantiate a module that is not automatically instantiated.

130
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
131
132
freeradius::instantiate { 'mymodule': }
```
133
134

#### `freeradius::module`
135

136
Install a module from a flat file.
137

138
```puppet
139
140
141
142
143
144
145
146
147
freeradius::module { 'buffered-sql':
  source => 'puppet:///modules/site_freeradius/buffered-sql',
}
```

#### `freeradius::policy`

Install a policy from a flat file.

148
```puppet
149
150
151
152
153
154
155
156
157
158
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.

159
```puppet
Jonathan Gazeley's avatar
Jonathan Gazeley committed
160
161
162
163
164
freeradius::site { 'myperlscript.pl':
  source => 'puppet:///modules/site_freeradius/myperlscript.pl',
}
```

165
166
#### `freeradius::site`

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

170
```puppet
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
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.

 * `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.
186
187
188
189


## Limitations

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

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

## Development

203
204
205
206
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.
207

208
## Release Notes
209

Jonathan Gazeley's avatar
Jonathan Gazeley committed
210
211
212
213
214
215
216
### 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
217
218
219
220
221
### 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
222