Puppet module to install and configure FreeRADIUS
Ruby HTML Puppet Pascal
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

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

Overview

This module installs and configures FreeRADIUS server on Linux. It supports FreeRADIUS 3.x only. It was designed with CentOS in mind but should work on other distributions.

This module requires Puppet 4.0.0 or greater. Puppet 3.x was discontinued at the end of 2016.

jgazeley/freeradius FreeRADIUS
3.x 3.x
2.x 3.x
1.x 2.x and 3.x
0.x 2.x

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.

correct_escapes

Use correct backslash escaping in unlang. Default: true

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

preserve_mods

Leave recommended stock modules enabled. Default: true

utils_support

Install FreeRADIUS utils. Default: false

ldap_support

Install support for LDAP. Default: false

dhcp_support

Install support for DHCP. Default: false

krb5_support

Install support for Kerberos. 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.

log_destination

Configure destination of log messages. Valid values are files, syslog, stdout and stderr. Default: files.

syslog

Add a syslog rule (using the saz/rsyslog module). Default: false.

log_auth

Log authentication requests (yes/no). Default: no.

package_ensure

Choose whether the package is just installed and left (installed), or updated every Puppet run (latest). Default: installed

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,
  log_auth        => 'yes',
}

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 an appropriate module config directory. The contents of the attr_filter module are automatically updated to reference the filters.

key

Specify a RADIUS attribute to be the key for this attribute filter. Enter only the string part of the name.

prefix

Specify the prefix for the attribute filter name before the dot, e.g. filter.post_proxy. This is usually set to filter on FR2 and attr_filter on FR3. Default: filter.

freeradius::attr { 'eduroamlocal':
  key    => 'User-Name',
  prefix => 'attr_filter',
  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 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

# Single host example
freeradius::client { "wlan-controller01":
  ip        => '192.168.0.1',
  secret    => 'testing123',
  shortname => 'wlc01',
  nastype   => 'other',
  port      => '1645-1646',
  firewall  => true,
}
# Range example
freeradius::client { "wlan-controllers":
  ip        => '192.168.0.0/24',
  secret    => 'testing123',
  shortname => 'wlc01',
  nastype   => 'other',
  port      => '1645-1646',
  firewall  => true,
}
# Huntgroup Example
freeradius::client { "asa01":
  ip         => '192.168.0.1',
  secret     => 'testing123',
  huntgroups => [
    { name       => 'firewall',
      conditions => [ 'NAS-IP-Address == 192.168.0.1' ] },
  ]
}
ip

The IP address of the client or range in CIDR format. For IPv6, use ipv6addr. ip and ip6 are mutually exclusive but one must be supplied. Default: undef.

ip6

The IPv6 address of the client or range in CIDR format. 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. Defaults to resource name.

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.

proto

Transport protocol used by the client. If unspecified, defaults to "udp", which is the traditional RADIUS transport. Valid values are udp, tcp or * for both of them. Default: undef.

require_message_authenticator

Old-style clients do not send a Message-Authenticator in an Access-Request. RFC 5080 suggests that all clients SHOULD include it in an Access-Request. Valid values are yes and no. Default: no.

login

Login used by checkrad.pl when querying the NAS for simultaneous use. Default: undef.

password

Password used by checkrad.pl when querying the NAS for simultaneous use. Default: undef.

coa_server

A pointer to the home_server_pool OR a home_server section that contains the CoA configuration for this client. Default: undef.

response_window

Response window for proxied packets. Default: undef.

max_connections

Limit the number of simultaneous TCP connections from a client. It is ignored for clients sending UDP traffic. Default: undef.

lifetime

The lifetime, in seconds, of a TCP connection. It is ignored for clients sending UDP traffic. Default: undef.

idle_timeout

The idle timeout, in seconds, of a TCP connection. It is ignored for clients sending UDP traffic. 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.

attributes

Array of attributes to assign to this client. Default: empty.

huntgroups

Array of hashes, each hash defines one freeradius::huntgroup. Hash keys are all passed to a new instance of freeradius::huntgroup.

freeradius::config

Install arbitrary config snippets from a flat file. These are installed in mods-config

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 dictionary.d and automatically included in the global dictionary.

freeradius::dictionary { 'mydict':
  source => 'puppet:///modules/site_freeradius/dictionary.mydict',
}

freeradius::home_server

This section defines a "Home Server" which is another RADIUS server that gets sent proxied requests.

secret

The shared secret use to "encrypt" and "sign" packets between FreeRADIUS and the home server.

type

Home servers can be sent Access-Request packets or Accounting-Request packets. Allowed values are:

  • auth Handles Access-Request packets
  • acct Handles Accounting-Request packets
  • auth+acct Handles Access-Request packets at "port" and Accounting-Request packets at "port + 1"
  • coa Handles CoA-Request and Disconnect-Request packets.

Default: auth

ipaddr

IPv4 address or hostname of the home server. Specify one of ipaddr, ipv6addr or virtual_server

ipv6addr

IPv6 address or hostname of the home server. Specify one of ipaddr, ipv6addr or virtual_server

virtual_server

If you specify a virtual_server here, then requests will be proxied internally to that virtual server. These requests CANNOT be proxied again, however. The intent is to have the local server handle packets when all home servers are dead. Specify one of ipaddr, ipv6addr or virtual_server

port

The port to which packets are sent. Usually 1812 for type "auth", and 1813 for type "acct". Older servers may use 1645 and 1646. Use 3799 for type "coa" Default: 1812

proto

The transport protocol. If unspecified, defaults to "udp", which is the traditional RADIUS transport. It may also be "tcp", in which case TCP will be used to talk to this home server. Default: udp

status_check

Type of check to see if the home_server is dead or alive. Valid values are none, status-server and request. Default: undef.

freeradius::home_server_pool

home_server

An array of one or more home servers. The names of the home servers are NOT the hostnames, but the names of the sections. (e.g. home_server foo {...} has name "foo".

Note that ALL home servers listed here have to be of the same type. i.e. they all have to be "auth", or they all have to be "acct", or they all have to be "auth+acct".

type

The type of this pool controls how home servers are chosen.

  • fail-over the request is sent to the first live home server in the list. i.e. If the first home server is marked "dead", the second one is chosen, etc.
  • load-balance the least busy home server is chosen For non-EAP auth methods, and for acct packets, we recommend using "load-balance". It will ensure the highest availability for your network.
  • client-balance the home server is chosen by hashing the source IP address of the packet. This configuration is most useful to do simple load balancing for EAP sessions
  • client-port-balance the home server is chosen by hashing the source IP address and source port of the packet.
  • keyed-balance the home server is chosen by hashing (FNV) the contents of the Load-Balance-Key attribute from the control items.

The default type is fail-over.

virtual_server

A virtual_server may be specified here. If so, the "pre-proxy" and "post-proxy" sections are called when the request is proxied, and when a response is received.

fallback

If ALL home servers are dead, then this "fallback" home server is used. If set, it takes precedence over any realm-based fallback, such as the DEFAULT realm.

For reasons of stability, this home server SHOULD be a virtual server. Otherwise, the fallback may itself be dead!

freeradius::huntgroup

Define a huntgroup given a name and the conditions under which a huntgroup matches a client.

freeradius::huntgroup { 'switchaccess':
  huntgroup  => 'switchaccess',
  conditions => [
    'NAS-IP-Address == 192.168.0.1'
  ]
}
huntgroup

Name of the huntgroup to assign, if conditions are all met. Default to the resource title.

conditons

Array of conditions which are used to match the client, each element should contain a condition in the form of 'Key == Value'.

type
home_server

freeradius::instantiate

Instantiate a module that is not automatically instantiated.

freeradius::instantiate { 'mymodule': }

freeradius::ldap

Deprecated. Use freeradius::module::ldap instead.

freeradius::module::ldap

Configure LDAP support for FreeRADIUS

ensure

Whether the site should be present or not.

identity

LDAP account for searching the directory. Required.

password

Password for the identity account. Required.

sasl

SASL parameters to use for admin binds to the ldap server. This is a hash with 3 possible keys:

  • mech: The SASL mechanism used.
  • proxy: SASL authorizatino identity to proxy.
  • realm: SASL realm (used for kerberos)

Default: {}

basedn

Unless overridden in another section, the dn from which all searches will start from. Required.

server

Array of hostnames or IP addresses of the LDAP server(s). Note that this needs to match the name(s) in the LDAP server certificate, if you're using ldaps. Default: [localhost]

port

Port to connect to the LDAP server on. Default: 389

valuepair_attribute

Generic valuepair attribute. If set, this attribute will be retrieved in addition to any mapped attributes. Default: undef.

update

Array with mapping of LDAP directory attributes to RADIUS dictionary attributes. Default: []

edir

Se to yes if you have eDirectory and want to use the universal password mechanisms. Possible values are yes and no. Default: undef.

edir_autz

Set to yesif you want to bind as the user after retrieving the Cleartest-Password. Possible values are yes and no. Default: undef.

user_base_dn

Where to start searching for users in the LDAP tree. Default: ${..base_dn}.

user_filter

Filter for user objects. Default: uid=%{%{Stripped-User-Name}-%{User-Name}})

user_sasl

SASL parameters to use for user binds to the ldap server. This is a hash with 3 possible keys:

  • mech: The SASL mechanism used.
  • proxy: SASL authorizatino identity to proxy.
  • realm: SASL realm (used for kerberos)

Default: {}

user_scope

Search scope for users. Valid values are base, one, sub and children. Default: undef (sub is applied).

user_sort_by

Server side result sorting. A list of space delimited attributes to order the result set by. Default: undef.

user_access_attribute

If this undefined, anyone is authorized. If it is defined, the contents of this attribute determine whether or not the user is authorised. Default: undef.

user_access_positive

Control whether the presence of access_attribute allows access or denys access. Default: undef.

group_base_dn

Where to start searching for groups in the LDAP tree. Default: ${..base_dn}.

group_filter

Filter for group objects. Default: '(objectClass=posixGroup)'.

group_scope

Search scope for groups. Valid values are base, one, sub and children. Default: undef (sub is applied).

group_name_attribute

Attribute that uniquely identifies a group. Default: undef ('cn' is applied).

group_membership_filter

Filter to find group objects a user is member of. That is, group objects with attributes that identify members (the inverse of group_membership_attribute). Default: undef.

group_membership_attribute

The attribute in user objects which contain the namos or DNs of groups a user is a member of. Default: 'memberOf'.

group_cacheable_name

If group_cacheable_name or group_cacheable_dn are enabled, all group information for the user will be retrieved from the directory and written to LDAP-Group attributes appropiaate for the instance of rlm_ldap. Default: undef.

group_cacheable_dn

If group_cacheable_name or group_cacheable_dn are enabled, all group information for the user will be retrieved from the directory and written to LDAP-Group attributes appropiaate for the instance of rlm_ldap. Default: undef.

group_cache_attribute

Override the normal cache attribute (<inst>-LDAP-Group or LDAP-Group if using the default instance) and create a custom attribute. Default: undef.

group_attribute

Override the normal group comparison attribute name (<inst>-LDAP-Group or LDAP-Group if using the default instance). Default: undef.

profile_filter

Filter for RADIUS profile objects. Default: undef.

profile_default

The default profile. This may be a DN or an attribute reference. Default: undef.

profile_attribute

The LDAP attribute containing profile DNs to apply in addition to the default profile above. Default: undef.

client_base_dn

Where to start searching for clients in the LDAP tree. Default: '${..base_dn}'.

client_filter

Filter to match client objects. Default: '(objectClass=radiusClient)'.

client_scope

Search scope for clients. Valid values are base, one, sub and children. Default: undef (sub is applied).

read_clients

Load clients on startup. Default: undef ('no' is applied).

dereference

Control under which situations LDAP aliases are followed. May be one of never, searching, finding or always. Default: undef (always is applied).

chase_referrals

With rebind control whether the server follows references returned by LDAP directory. Mostly used for AD compatibility. Default: yes.

rebind

With chase_referrals control whether the server follows references returned by LDAP directory. Mostly used for AD compatibility. Default: yes.

use_referral_credentials

On rebind, use the credentials from the rebind url instead of admin credentials. Default: no.

session_tracking

If yes, then include draft-wahl-ldap-session tracking controls. Default: undef.

uses

How many times the connection can be used before being re-established. This is useful for things like load balancers, which may exhibit sticky behaviour without it. 0 is unlimited. Default: 0

retry_delay

The number of seconds to wait after the server tries to open a connection, and fails. Default: `30'.

lifetime

The lifetime (in seconds) of the connection. Default: 0 (forever).

idle_timeout

Idle timeout (in seconds). A connection which is unused for this length of time will be closed. Default: 60.

connect_timeout

Connection timeout (in seconds). The maximum amount of time to wait for a new connection to be established. Default: 3.0.

idle

Sets the idle time before keepalive probes are sent. Default 60

This option may not be supported by your LDAP library. If this configuration entry appears in the output of radiusd -X then it is supported. Otherwise, it is unsupported and changing it will do nothing.

probes

Sets the maximum number of keepalive probes TCP should send before dropping the connection. Default: 3

This option may not be supported by your LDAP library. If this configuration entry appears in the output of radiusd -X then it is supported. Otherwise, it is unsupported and changing it will do nothing.

interval

Setss the interval in seconds between individual keepalive probes. Default: 3

This option may not be supported by your LDAP library. If this configuration entry appears in the output of radiusd -X then it is supported. Otherwise, it is unsupported and changing it will do nothing.

timeout

Number of seconds to wait for LDAP query to finish. Default: 10

timelimit

Seconds LDAP server has to process the query (server-side time limit). Default: 20.

ldap_debug

Debug flag for LDAP SDK. Default: 0x0028.

start

Connections to create during module instantiation. If the server cannot create specified number of connections during instantiation it will exit. Set to 0 to allow the server to start without the directory being available. Default: ${thread[pool].start_servers}

min

Minimum number of connections to keep open. Default: ${thread[pool].min_spare_servers}

max

Maximum number of connections. Default: ${thread[pool].max_servers}

spare

Spare connections to be left idle. Default: ${thread[pool].max_spare_servers}

starttls

Set this to 'yes' to use TLS encrypted connections to the LDAP database by using the StartTLS extended operation. The StartTLS operation is supposed to be used with normal ldap connections instead of using ldaps (port 636) connections

Default: no

cafile

Path to CA cert file for TLS

certfile

Path to cert file for TLS

keyfile

Path to key file for TLS

random_file

Random file used for TLS operations. Default: undef ('/dev/urandom' is used).

requirecert

Certificate Verification requirements. Choose from: 'never' (do not even bother trying) 'allow' (try, but don't fail if the certificate cannot be verified) 'demand' (fail if the certificate does not verify) 'hard' (similar to 'demand' but fails if TLS cannot negotiate)

Default: allow

freeradius::krb5

Configure Kerberos support for FreeRADIUS

keytab

Full path to the Kerberos keytab file

principal

Name of the service principal

start

Connections to create during module instantiation. If the server cannot create specified number of connections during instantiation it will exit. Set to 0 to allow the server to start without the directory being available. Default: ${thread[pool].start_servers}

min

Minimum number of connections to keep open. Default: ${thread[pool].min_spare_servers}

max

Maximum number of connections. Default: ${thread[pool].max_servers}

spare

Spare connections to be left idle. Default: ${thread[pool].max_spare_servers}

freeradius::module

Install a module from a flat file, or enable a stock module that came with your distribution of FreeRADIUS. Modules are installed into mods-available and automatically symlinked into mods-enabled, to ensure compatibility with package managers. Any files in this directory that are not managed by Puppet will be removed.

# Enable a stock module
freeradius::module { 'pap':
  preserve => true,
}
# Install a custom module from a flat file
freeradius::module { 'buffered-sql':
  source => 'puppet:///modules/site_freeradius/buffered-sql',
}
# Install a custom module from a template
freeradius::module { 'buffered-sql':
  content => template('some_template.erb)',
}

freeradius::module::ippool

Install a ippool module

ensure

If the module should present or absent. Default: present.

range_start

The first IP address of the pool.

range_stop

The last IP address of the pool.

netmask

The network mask used for the pool

cache_size

The gdbm cache size for the db files. Default: number of IP address in the range.

filename

The main db file used to allocate address. Default: ${db_dir}/db.${name}

ip_index

Helper db index file. Default: ${db_dir}/db.${name}.index

override

If set, the Framed-IP-Address already in the reply (if any) will be discarded. Default: no.

maximum_timeout

Maximum time in seconds that an entry may be active. Default: 0 (no timeout).

key

The key to use for the session database. Default: undef.

freeradius::module::linelog

Install and configure linelog module to log text to files.

ensure

If the module should present or absent. Default: present.

filename

The file where the logs will go. Default: ${logdir}/linelog.

escape_filenames

If UTF-8 characters should be escaped from filename. Default: no.

permissions

Unix-style permissions for the log file. Default: 0600.

group

The Unix group which owns the log file. Default: undef.

syslog_facility

Syslog facility (if logging via syslog). Default: undef (daemon).

syslog_severity

Syslog severity (if logging via syslog). Default: undef (info).

format

The default format string. Default: This is a log message for %{User-Name}.

reference

If it is defined, the line string logged is dynamically expanded and the result is used to find another configuration entry here, with the given name. That name is then used as the format string. Default: messages.%{%reply:Packet-Type}:-default}.

messages

Array of messages. The messages defined here are taken from the reference expansion. Default: [].

accounting_request

Array of messages. Similar to messages but for accounting logs.

freeradius::module::detail

Install a detail module to write detailed log of accounting records.

ensure

If the module should present or absent. Default: present.

filename

The file where the detailed logs will go. Default: ${radacctdir}/%{%{Packet-Src-IP-Address}:-%{Packet-Src-IPv6-Address}}/detail-%Y%m%d.

escape_filenames

If UTF-8 characters should be escaped from filename. Default: no.

permissions

Unix-style permissions for the log file. Default: 0600.

group

The Unix group which owns the log file. Default: undef.

header

Header to use in every entry in the detail file. Default: undef (%t).

locking

Enable if a detail file reader will be reading this file. Default: undef.

log_packet_header

Log the package src/dst IP/port. Default: undef.

suppress

Array of (sensitive) attributes that should be removed from the log. Default: [].

freeradius::module::files

Install a file module with users in freeradius.

ensure

If the module should present or absent. Default: present.

moddir

Directory where the users file is located. Default: ${modconfdir}/${.:instance}.

key

The default key attribute to use for matches. Default: undef.

filename

The (old) users style filename. Default: ${moddir}/authorize.

usersfile

Accepted for backups compatibility. Default: undef.

acctusersfile

Accepted for backups compatibility. Default: undef.

preproxy_usersfile

Accepted for backups compatibility. Default: undef.

users

Array of hashes with users entries (see "man users"). If entry in the hash is an array which valid keys are:

  • login: The login of the user.
  • check_items: An array with check components for the user entry.
  • reply_items: An array with reply components for the user entry.

For example:

freeradius::module::files {'myuserfile':
  users => [
    {
      login => 'DEFAULT',
      check_items => [
        'Realm == NULL'
      ],
      reply_items => [
        'Fall-Through = No
      ],
    },
  ],
}

will produce a user file like:

DEFAULT Realm == NULL
  Fall-Through = No

You should use just one of users, source or content parameters.

source

Provide source to a file with the users file. Default: undef.

You should use just one of users, source or content parameters.

content

Provide the content for the users file. Default: undef.

You should use just one of users, source or content parameters.

freeradius::module::eap

Install a module for EAP configuration

ensure

If the module should present or absent. Default: present.

default_eap_type

Default EAP type. Default: md5.

timer_expire

How much time an entry is maintained in the list to correlate EAP-Response packets with EAP-Request packets. Default: 60.

ignore_unknown_eap_types

By setting this options to yes, you can tell the server to keep processing requests with an EAP type it does not support. Default: no.

cisco_accounting_username_bug

Enables a work around to handle Cisco AP1230B firmware bug. Default: no.

max_sessions

Maximum number of EAP sessions the server tracked. Default: ${max_requests}.

Parameters to configure EAP-pwd authentication.
eap_pwd

If set to true configures EAP-pwd authentication. Default: false.

pwd_group

group used in pwd configuration. Default: undef.

pwd_server_id

server_id option in pwd configuration. Default: undef.

pwd_fragment_size

fragment_size option in pwd configuration. Default: undef.

pwd_virtual_server

The virtual server which determines the "known good" password for the user in pwd authentication. Default: undef.

Parameters to configure Generic Tocken Card
gtc_challenge

The default challenge. Default: undef

gtc_auth_type

auth_type use in GTC. Default: PAP.

Parameters for TLS configuration
tls_config_name

Name for the tls-config. It normally should not be used. Default: tls-common.

tls_private_key_password

Private key password. Default: undef.

tls_private_key_file

File with the private key of the server. Default: ${certdir}/server.pem.

tls_certificate_file

File with the certificate of the server. Default: ${certdir}/server.pem.

tls_ca_file

File with the trusted root CA list. Default: ${certdir}/ca.pem.

tls_auth_chain

When setting to no, the server certificate file MUST include the full certificate chain. Default: undef.

tls_psk_identity

PSK identity (if OpenSSL supports TLS-PSK). Default: undef.

tls_psk_hexphrase

PSK (hex) password (if OpenSSL supports TLS-PSK). Default: undef.

tls_dh_file

DH file. Default: ${certdir}/dh.

tls_random_file

Random file. Default: undef (/dev/urandom).

tls_fragment_size

Fragment size for TLS packets. Default: undef.

tls_include_length

If set to no, total length of the message is included only in the first packet of a fragment series. Default: undef.

tls_check_crl

Check the certificate revocation list. Default: undef.

tls_check_all_crl

Check if intermediate CAs have been revoked. Default: undef.

tls_allow_expired_crl

Allow use of an expired CRL. Default: undef.

tls_ca_path

Path to the CA file. Default: ${cadir}.

tls_check_cert_issuer

If set, the value will be checked against the DN of the issuer in the client certificate. Default: undef.

tls_check_cert_cn

If it is set, the value will be xlat'ed and checked against the CN in the client certificate. Default: undef

tls_cipher_list

Set this option to specify the allowed TLS cipher suites. Default: DEFAULT.

tls_disable_tlsv1_2

Disable TLS v1.2. Default: undef.

tls_ecdh_curve

Elliptical cryptography configuration. Default: prime256v1.

tls_cache_enable

Enable TLS cache. Default: yes.

tls_cache_lifetime

Lifetime of the cached entries, in hours. Default: 24.

tls_cache_max_entries

The maximum number of entries in the cache. Default: 255.

tls_cache_name

Internal name of the session cache. Default: undef.

tls_cache_persist_dir

Simple directory-based storage of sessions. Default: undef.

tls_verify_skip_if_ocsp_ok

If the OCSP checks suceed, the verify section is run to allow additional checks. Default: undef.

tls_verify_tmpdir

Temporary directory where the client certificates are stored. Default: undef.

tls_verify_client

The command used to verify the client certificate. Default: undef.

tls_ocsp_enable

Enable OCSP certificate verification. Default: no.

tls_ocsp_override_cert_url

If set to yes the OCSP Responder URL is overrided. Default: yes.

tls_ocsp_url

The URL used to verify the certificate when tls_ocsp_override_cert_url is set to yes. Default: http://127.0.0.1/ocsp/.

tls_ocsp_use_nonce

If the OCSP Responder can not cope with nonce in the request, then it can be set to no. Default: undef.

tls_ocsp_timeout

Number of seconds before giving up waiting for OCSP response. Default: undef.

tls_ocsp_softfail

To treat OCSP errors as soft. Default: undef.

tls_virtual_server

Virtual server for EAP-TLS requests. Default: undef.

Parameters for TTLS configuration
ttls_default_eap_type

Default EAP type use inside the TTLS tunnel. Default: md5.

ttls_copy_request_to_tunnel

If set to yes, any attribute in the ouside of the tunnel but not in the tunneled request is copied to the tunneled request. Default: no.

ttls_use_tunneled_reply

If set to yes, reply attributes get from the tunneled request are sent as part of the outside reply. Default: no.

ttls_virtual_server

The virtual server that will handle tunneled requests. Default: inner-tunnel.

ttls_include_length

If set to no, total length of the message is included only in the first packet of a fragment series. Default: undef.

ttls_require_client_cert

Set to yes to require a client certificate. Default: undef.

Parameters for PEAP configuration
peap_default_eap_type

Default EAP type used in tunneled EAP session. Default: mschapv2.

peap_copy_request_to_tunnel

If set to yes, any attribute in the ouside of the tunnel but not in the tunneled request is copied to the tunneled request. Default: no.

peap_use_tunneled_reply

If set to yes, reply attributes get from the tunneled request are sent as part of the outside reply. Default: no.

peap_proxy_tunneled_request_as_eap

Set the parameter to no to proxy the tunneled EAP-MSCHAP-V2 as normal MSCHAPv2. Default: undef.

peap_virtual_server

The virtual server that will handle tunneled requests. Default: inner-tunnel.

peap_soh

Enables support for MS-SoH. Default: undef.

peap_soh_virtual_server

The virtual server that will handle tunneled requests. Default: undef.

peap_require_client_cert

Set to yes to require a client certificate. Default: undef.

Parameters for MS-CHAPv2 configuration
mschapv2_send_error

If set to yes, then the error message will be sent back to the client. Default: undef.

mschapv2_identity

Server indentifier to send back in the challenge. Default: undef.

freeradius::module::preprocess

Install a preprocess module to process huntgroups and hints files.

ensure

If the module should present or absent. Default: present.

moddir

Directory where the preprocess' files are located. Default: ${modconfdir}/${.:instance}.

huntgroups

Path for the huntgroups file. Defaut: ${moddir}/huntgroups.

hints

Path for the hints file. Default ${moddir}/hints.

with_ascend_hack

This hack changes Ascend's weird port numbering to standar 0-??? port numbers. Default: no.

ascend_channels_per_line

Default: 23.

with_ntdomain_hack

Windows NT machines often authenticate themselves as NT_DOMAIN\username. If this parameter is set to yes, then the NT_DOMAIN portion of the user-name is silently discarded. Default: no.

with_specialix_jetstream_hack

Set to yes if you are using a Specialix Jetstream 8500 access server. Default: no.

with_cicso_vsa_hack

Set to yes if you are using a Cisco or Quintum NAS. Default: no.

freeradius::module::huntgroup

Creates a huntgroup entry in a huntgroup file (see freeradius::module::preprocess)

conditions

Array of rules to match in this huntgroup.

order

Order of this huntgroup in the huntgroup files. This is the order parameter for the underlying concat::fragment. Default: `50' .

huntgroup

The path of the huntgroup file. Default: huntgroup.

freeradius::policy

Install a policy from a flat file.

freeradius::policy { 'my-policies':
  source => 'puppet:///modules/site_freeradius/my-policies',
}

freeradius::realm

Define a realm in proxy.conf. Realms point to pools of home servers.

virtual_server

Set this to "proxy" requests internally to a virtual server. The pre-proxy and post-proxy sections are run just as with any other kind of home server. The virtual server then receives the request, and replies, just as with any other packet. Once proxied internally like this, the request CANNOT be proxied internally or externally.

auth_pool

For authentication, the auth_pool configuration item should point to a home_server_pool that was previously defined. All of the home servers in the auth_pool must be of type auth.

acct_pool

For accounting, the acct_pool configuration item should point to a home_server_pool that was previously defined. All of the home servers in the acct_pool must be of type acct.

pool

If you have a home_server_pool where all of the home servers are of type auth+acct, you can just use the pool configuration item, instead of specifying both auth_pool and acct_pool.

nostrip

Normally, when an incoming User-Name is matched against the realm, the realm name is "stripped" off, and the "stripped" user name is used to perform matches.If you do not want this to happen, set this to true. Default: false.

freeradius::script

Install a helper script, e.g. which might be called upon by a virtual server. These are placed in 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 into sites-available and automatically symlinked into sites-enabled, to ensure compatibility with package managers. 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',
}
ensure

Whether the site should be present or not.

source

Provide source to a file with the configuration of the site. Default: undef.

content

Provide content for the configuartion of the site. Default: undef.

authorize

Array of options (as String) for the authorize section of the site. This parameter is ignored if source or contentare used. Default: [].

authenticate

Array of options (as String) for the authenticate section of the site. This parameter is ignored if source or contentare used. Default: [].

preacct

Array of options (as String) for the preacct section of the site. This parameter is ignored if source or contentare used. Default: [].

accounting

Array of options (as String) for the accounting section of the site. This parameter is ignored if source or contentare used. Default: [].

session

Array of options (as String) for the session section of the site. This parameter is ignored if source or contentare used. Default: [].

post_auth

Array of options (as String) for the post-auth section of the site. This parameter is ignored if source or contentare used. Default: [].

pre_proxy

Array of options (as String) for the pre-proxy section of the site. This parameter is ignored if source or contentare used. Default: [].

post_proxy

Array of options (as String) for the post-proxy section of the site. This parameter is ignored if source or contentare used. Default: [].

listen

Array of listen definitions for the site. This parameter is ignored if source or contentare used. Default: [].

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 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}/sqllog.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.

pool_start

Connections to create during module instantiation. Default: 1.

pool_min

Minimum number of connnections to keep open. Default: 1.

pool_spare

Spare connections to be left idle. Default: 1.

pool_idle_timeout

Idle timeout (in seconds). A connection which is unused for this length of time will be closed. Default: 60.

pool_connect_timeout

Connection timeout (in seconds). The maximum amount of time to wait for a new connection to be established. Default: '3.0'.

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 in CIDR format. For IPv6, use ipv6addr. ip and ip6 are mutually exclusive but one must be supplied.

ip6

Default: undef. The IPv6 address of the client in CIDR format. 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.

freeradius::template

Define template items that can be referred to in other config items

source

Provide source to a file with the template item. Specify only one of source or content.

content

Provide content of template item. Specify only one of source or content.

freeradius::virtual_module

Define a virtual module which consists of one or more other modules, for failover or load-balancing purposes.

submodules

Provide an array of submodules which will be loaded into this virtual module. Required.

type

Select the type of virtual module from redundant, load-balance, redundant-load-balance or group. See virtual modules and load-balancing for more details.

# Load virtual module myldap
freeradius::virtual_module { 'myldap':
  submodules => ['ldap1', 'ldap2'],
  type       => 'redundant-load-balance',
}

Limitations

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

This module requires Puppet 4 or greater.

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.