Datastore Modules

Datastore modules store data. In most cases, they are databases. We use the term "datastore" to mean that some of the storage methods are not traditional databases, but they do still store data.

For example, the files module implements the widely-used RADIUS users file format. It is not a database, but it can store thousands or millions of user credentials.

The available Datastore modules are:

Datastore Modules

Module Description

Module	Description
cache	Stores attributes and/or lists and adds them back to a subsequent request or to the current request on a later execution of the module.
cache_eap	This cache stores replies for user sessions that are used by eap for authentication purposes.
cache_tls	Cache TLS Session saves all eap session attributes in backend cache to provide users with robust and fast session reconnections.
client	Reads client definitions from flat files.
csv	Maps values in a CSV file to FreeRADIUS attributes and adds them to the request.
etc_group	Allow users to be assigned to one or more groups to permit different levels of access.
files	Implements a traditional Livingston-style users file.
file format	A users file example.
ldap	Allows LDAP directory entries to be retrieved, modified, inserted and deleted.
opendirectory	Integrates with an Apple OpenDirectory service on the same host as FreeRADIUS to allow OpenDirectory users to authenticate.
passwd	Reads and caches line-oriented files that are in a format similar to `/etc/passwd`.
mac2ip	Enables the mapping of a MAC address to an ip address.
mac2vlan	Enables the mapping of a MAC address to an vlan id.
smbpasswd	Performs SMB authentication using a flat password file.
redis	Provides connectivity to single and clustered instances of Redis. This module exposes a string expansion that may be used to execute queries against Redis.
redis_ippool	Implements a fast and scalable IP allocation system using Redis. Supports both IPv4 and IPv6 address and prefix allocation, and implements pre-allocation for use with DHCPv4.
rediswho	Records which users are currently logged into the service. The file is used mainly for Simultaneous-Use checking to see who has current sessions.
rest	Sends HTTP requests to remote servers and decodes the responses.
sql	Provides an abstraction over multiple SQL backends, via database specific drivers.
sqlippool	SQL based IP allocation module used to create ip pools.
sqlcounter	Records statistics for users such as data transfer and session time, and prevent further logins when limits are reached.
redundant_sql	Configure a redundant sql server for redundancy or load-balancing purposes.
unix	Retrieves a user’s encrypted password from the local system and places it into the `control.Password.Crypt` attribute. The password is retrieved via the `getpwent()` and `getspwent()` system calls.

cache

Stores attributes and/or lists and adds them back to a subsequent request or to the current request on a later execution of the module.

cache_eap

This cache stores replies for user sessions that are used by eap for authentication purposes.

cache_tls

Cache TLS Session saves all eap session attributes in backend cache to provide users with robust and fast session reconnections.

client

Reads client definitions from flat files.

csv

Maps values in a CSV file to FreeRADIUS attributes and adds them to the request.

etc_group

Allow users to be assigned to one or more groups to permit different levels of access.

files

Implements a traditional Livingston-style users file.

file format

A users file example.

ldap

Allows LDAP directory entries to be retrieved, modified, inserted and deleted.

opendirectory

Integrates with an Apple OpenDirectory service on the same host as FreeRADIUS to allow OpenDirectory users to authenticate.

passwd

Reads and caches line-oriented files that are in a format similar to /etc/passwd.

mac2ip

Enables the mapping of a MAC address to an ip address.

mac2vlan

Enables the mapping of a MAC address to an vlan id.

smbpasswd

Performs SMB authentication using a flat password file.

redis

Provides connectivity to single and clustered instances of Redis. This module exposes a string expansion that may be used to execute queries against Redis.

redis_ippool

Implements a fast and scalable IP allocation system using Redis. Supports both IPv4 and IPv6 address and prefix allocation, and implements pre-allocation for use with DHCPv4.

rediswho

Records which users are currently logged into the service. The file is used mainly for Simultaneous-Use checking to see who has current sessions.

rest

Sends HTTP requests to remote servers and decodes the responses.

sql

Provides an abstraction over multiple SQL backends, via database specific drivers.

sqlippool

SQL based IP allocation module used to create ip pools.

sqlcounter

Records statistics for users such as data transfer and session time, and prevent further logins when limits are reached.

redundant_sql

Configure a redundant sql server for redundancy or load-balancing purposes.

unix

Retrieves a user’s encrypted password from the local system and places it into the control.Password.Crypt attribute. The password is retrieved via the getpwent() and getspwent() system calls.