eniuz/puppet-freeradius

Puppet module to install and configure FreeRADIUS

freeradius

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module
6. 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 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

class { 'freeradius':
  control_socket => true,
  max_requests   => 4096,
  max_servers    => 4096,
}

Resources

freeradius::attr

Install arbitrary attribute filters from a flat flit. These are installed in /etc/raddb/attr.d

freeradius::attr { 'eduroamlocal':
  source => 'puppet:///modules/site_freeradius/eduroamlocal',
}

freeradius::client

Define RADIUS clients as seen in clients.conf

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

freeradius::config { 'realm-checks.conf':
  source => 'puppet:///modules/site_freeradius/realm-checks.conf',
}

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::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::site { '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

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.

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.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