Version information
This version is compatible with:
- ,
Start using this module
Add this module to your Puppetfile:
mod 'jgazeley-freeradius', '0.4.4'
Learn more about managing modules with a PuppetfileDocumentation
freeradius
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Release Notes
Overview
This module installs and configures FreeRADIUS 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.
Module Description
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.
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.
Usage
This module provides several classes and defined types which take parameters.
Classes
freeradius
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
of the global settings to increase flexibility. Patches are welcome.
control_socket
Use of the control_socket parameter in the freeradius class is deprecated. Use the freeradius::control_socket
class instead.
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. Note this only installs the package. Use freeradius::sql
to configure SQL support. 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
winbind_support
Add the radius user to the winbind privileged group. You must install winbind separately. Default: false
.
syslog
Add a syslog rule (using the jgazeley/syslog
module). Default: false
.
class { 'freeradius':
max_requests => 4096,
max_servers => 4096,
mysql_support => true,
perl_support => true,
utils_support => true,
wpa_supplicant => true,
winbind_support => true,
syslog => true,
}
freeradius::status_server
The freeradius::status_server
class enabled the status server.
To remove the status server, do not include this class and the server will be removed.
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 status server
class { 'freeradius::status_server':
port => '18120',
secret => 't0pSecret!',
}
freeradius::control_socket
The freeradius::control_socket
class enables the control socket which can be used with RADMIN.
To remove the control socket, do not include this class and the socket will be removed.
mode
Whether the control socket should be read-only or read-write. Choose from ro
, rw
. Default: ro
.
# Enable control socket
class { 'freeradius::control_socket':
mode => 'ro',
}
Resources
freeradius::attr
Install arbitrary attribute filters from a flat file. These are installed in /etc/raddb/attr.d
freeradius::attr { 'eduroamlocal':
source => 'puppet:///modules/site_freeradius/eduroamlocal',
}
freeradius::blank
Selectively blank certain stock config files that aren't required. This is preferable to deleting them because the package manager will replace certain files next time the package is upgraded, potentially causing unexpected behaviour.
The resource title should be the relative path from the FreeRADIUS config directory to the file(s) you want to blank. You can pass multiple files in an array.
freeradius::blank { 'sites-enabled/default': }
freeradius::blank { [
'sites-enabled/default',
'eap.conf',
]: }
freeradius::cert
Install certificates as provided. These are installed in /etc/raddb/certs
. Beware that any certificates not deployed by Puppet will be purged from this directory.
freeradius::cert { 'mycert.pem':
source => 'puppet:///modules/site_freeradius/mycert.pem',
type => 'key',
}
freeradius::cert { 'mycert.pem':
content => '<your key/cert content here>',
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
.
freeradius::client
Define RADIUS clients as seen in clients.conf
freeradius::client { "wlan-controller01":
ip => '192.168.0.1',
secret => 'testing123',
shortname => 'wlc01',
nastype => 'other',
port => '1645-1646',
firewall => true,
}
ip
The IP address of the client. For IPv6, use ipv6addr
. ip
and ip6
are mutually exclusive but one must be supplied. Default: undef
.
ip6
The IPv6 address of the client. ip
and ip6
are mutually exclusive but one must be supplied. Default: undef
.
shortname
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.
secret
The RADIUS shared secret used for communication between the client/NAS and the RADIUS server. Required.
virtual_server
The virtual server that traffic from this client should be sent to. Default: undef
.
nastype
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
for a list of all options. Default: undef
.
netmask
The netmask of the client, specified as an integer, e.g. 24
. Default: undef
.
port
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
. Default: undef
.
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
.
freeradius::config
Install arbitrary config snippets from a flat file. These are installed in /etc/raddb/conf.d
freeradius::config { 'realm-checks.conf':
source => 'puppet:///modules/site_freeradius/realm-checks.conf',
}
freeradius::config { 'realm-checks.conf':
content => template('your_template),
}
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.
freeradius::dictionary { 'mydict':
source => 'puppet:///modules/site_freeradius/dictionary.mydict',
}
freeradius::instantiate
Instantiate a module that is not automatically instantiated.
freeradius::instantiate { 'mymodule': }
freeradius::module
Install a module from a flat file.
freeradius::module { 'buffered-sql':
source => 'puppet:///modules/site_freeradius/buffered-sql',
}
freeradius::module { 'buffered-sql':
content => template('some_template.erb)',
}
freeradius::policy
Install a policy from a flat file.
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.
freeradius::script{ 'myperlscript.pl':
source => 'puppet:///modules/site_freeradius/myperlscript.pl',
}
freeradius::site
Install a virtual server (a.k.a. site) from a flat file. Sites are installed directly
into /etc/raddb/sites-enabled
. Any files in this directory that are not managed by
Puppet will be removed.
freeradius::site { 'inner-tunnel':
source => 'puppet:///modules/site_freeradius/inner-tunnel',
}
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.
freeradius::sql { 'mydatabase':
database => 'mysql',
server => '192.168.0.1',
login => 'radius',
password => 'topsecret',
radius_db => 'radius',
}
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.
port
TCP port to connect to the database. Default: 3306
.
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)))
.
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.
lifetime
Default: 0
. Lifetime of an SQL socket. If you are having network issues such as TCP sessions expiring, you may need to set the socket
lifetime. If set to non-zero, any open connections will be closed $lifetime
seconds after they were first opened.
max_queries
Default: 0
. Maximum number of queries used by an SQL socket. If you are having issues with SQL sockets lasting "too long", you can
limit the number of queries performed over one socket. After $max_qeuries
, the socket will be closed. Use 0 for "no limit".
query_file
query_file
has been deprecated - use custom_query_file
instead
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
.
custom_query_file
Default: null
. Puppet fileserver path to a file which contains your SQL queries, i.e. dialup.conf
. This
option is intended to be a replacment for query_file
, which requires separate deployment of the file. This
option allows you to specify a Puppet-managed custom dialup.conf
which is installed and loaded automatically.
query_file
must be left blank if you use custom_query_file
.
acct_table1
If you want both stop and start records logged to the same SQL table, leave this as is. If you want them in
different tables, put the start table in $acct_table1
and stop table in $acct_table2
. Default : radacct
acct_table2
If you want both stop and start records logged to the same SQL table, leave this as is. If you want them in
different tables, put the start table in $acct_table1
and stop table in $acct_table2
. Default : radacct
postauth_table
Table for storing data after authentication
authcheck_table
Default: radcheck
authreply_table
Default: radreply
groupcheck_table
Default: radgroupcheck
groupreply_table
Default: radgroupreply
usergroup_table
Table to keep group info. Default: radusergroup
read_groups
If set to yes
(default) we read the group tables. If set to no
the user MUST have Fall-Through = Yes
in the radreply table. Default: yes
.
deletestalesessions
Remove stale session if checkrad does not see a double login. Default: yes
.
sqltrace
Print all SQL statements when in debug mode (-x). Default: no
.
sqltracefile
Location for SQL statements to be stored if $sqltrace = yes
. Default:
${logdir}/sqltrace.sql
connect_failure_retry_delay
Number of seconds to dely retrying on a failed database connection (per socket). Default: 60
.
nas_table
Table to keep radius client info. Default: nas
.
readclients
Set to yes
to read radius clients from the database ($nas_table
) Clients will ONLY be read on server startup. For performance
and security reasons, finding clients via SQL queries CANNOT be done "live" while the server is running. Default: no
.
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.
Limitations
This module is targeted at FreeRADIUS 2.x running on CentOS 6. It has not been tested on other distributions, but might work. Likely sticking points with other distros are the names of packages, services and file paths.
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.
Development
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.
Release Notes
0.4.4
- Fix bug displaying deprecation notice and update documentation to reflect this
0.4.3
- Manage log rotation with rodjek/logrotate instead of deploying flat files
0.4.2
- Provide new SQL option custom_query_file
0.4.1
- Cease management of custom logging modules
logtofile
andlogtosyslog
since it does not make sense to manage these globally - Purge instantiation of unused modules
0.4.0
- Move control_socket into its own class and add parameters
- Improve the way the status_server is added or removed
- Delete all unmanaged sites from sites-available
0.3.8
- Purge all non-managed sites
0.3.7
- Minor linting of code to improve score
- Minor linting of metadata to improve score
0.3.6
- Bugfixes and feature improvements in
freeradius::sql
0.3.5
- Add ability to customise SQL socket lifetimes
- Purge all non-managed clients
- Add defined type to blank out unneeded config files without deleting them
0.3.4
- Correctly pass template content to control-socket
0.3.3
- The default behaviour is now to purge anything in ${confdir}/certs that is not managed by Puppet
0.3.2
- Various improvements to support Debian family
- Optional content parameters in various resources
0.3.1
- Fix a bug which prevents the module from working properly on Debian/Ubuntu (thanks @diranged)
0.3.0
- Add
ensure
parameter to all defined types
0.2.0
- Add support for customising
sql.conf
natively by addingfreeradius::sql
0.1.4
- Fix ambiguity about net/netmask in freeradius::client
0.1.3
- Add support for managing firewall rules automatically
- Add support for installation certificates & keys
- Make syslog support an optional component
- Various bugfixes
0.1.2
- Improved modular installs with optional components
- Improved support for Debian
- Clarify dependencies on other modules
- Lots of bugfixes
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
Dependencies
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.