Skip to content
Snippets Groups Projects
Select Git revision
  • ll-workflow
  • master default protected
  • b24
  • FJ_LL_Tbl_Contrat
  • ll-rgpd
  • alc-scindage-donnees-pj
  • b23
  • alc-filtre-type-intervenant
  • ll-sans-mdb5
  • formules-ancienne-infra
  • ll-apiplatform
  • php84
  • ll-formules
  • alc-intervenant-dmep
  • ll-suppr-v_vol-s
  • b20
  • ll-postgresql
  • b23.0.1
  • b22
  • Dev_UM
  • 24.3
  • 24.2
  • 24.1
  • 24.0
  • 23.15
  • 24.0-beta19
  • 24.0-beta18
  • 24.0-beta17
  • 24.0-beta16
  • 24.0-beta15
  • 24.0-beta14
  • 24.0-beta13
  • 23.14
  • 24.0-beta12
  • 24.0-beta11
  • 24.0-beta10
  • 24.0-beta9
  • 24.0-beta8
  • 24.0-beta7
  • 24.0-beta6
40 results

OSE

  • Clone with SSH
  • Clone with HTTPS
  • 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

    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

    0.4.2

    • Provide new SQL option custom_query_file

    0.4.1

    • Cease management of custom logging modules logtofile and logtosyslog 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 adding freeradius::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