[cols="20%,80%"]
|=====
| Module | Description
-| xref:chap.adoc[chap] | Performs Challenge Handshake Authentication Protocol (CHAP) authentication, as described by RFC 2865.
-| xref:cram.adoc[cram] | Implements CRAM-MD5 authentication, a challenge response protocol similar to CHAP. CRAM is defined by RFC 2195.
-| xref:digest.adoc[digest] | The digest module performs HTTP digest authentication, usually for a SIP server. See draft-sterman-aaa-sip-00.txt for
+| xref:mods-available/chap.adoc[chap] | Performs Challenge Handshake Authentication Protocol (CHAP) authentication, as described by RFC 2865.
+| xref:mods-available/digest.adoc[digest] | The digest module performs HTTP digest authentication, usually for a SIP server. See draft-sterman-aaa-sip-00.txt for
details. The module does not support RFC 5090.
-| xref:eap.adoc[eap] | Implements the base protocol for EAP (Extensible Authentication Protocol).
-| xref:krb5.adoc[krb5] | Implements kerberos authentication, using the result of decrypting the TGT as an indication that the provided
+| xref:mods-available/eap.adoc[eap] | Implements the base protocol for EAP (Extensible Authentication Protocol).
+| xref:mods-available/krb5.adoc[krb5] | Implements kerberos authentication, using the result of decrypting the TGT as an indication that the provided
password was correct.
-| xref:ldap.adoc[ldap] | Allows LDAP directory entries to be retrieved, modified, inserted and deleted.
-| xref:mschap.adoc[mschap] | Supports MS-CHAP and MS-CHAPv2 authentication. It also enforces the SMB-Account-Ctrl attribute.
-| xref:opendirectory.adoc[opendirectory] | Integrates with an Apple OpenDirectory service on the same host as FreeRADIUS to allow OpenDirectory users to
+| xref:mods-available/ldap.adoc[ldap] | Allows LDAP directory entries to be retrieved, modified, inserted and deleted.
+| xref:mods-available/mschap.adoc[mschap] | Supports MS-CHAP and MS-CHAPv2 authentication. It also enforces the SMB-Account-Ctrl attribute.
+| xref:mods-available/opendirectory.adoc[opendirectory] | Integrates with an Apple OpenDirectory service on the same host as FreeRADIUS to allow OpenDirectory users to
authenticate.
-| xref:pam.adoc[pam] | Performs password checking via the Pluggable Authentication Module (PAM) framework.
-| xref:pap.adoc[pap] | Accepts a large number of formats for the "known good" (reference) password, such as crypt hashes, md5 hashes,
+| xref:mods-available/pam.adoc[pam] | Performs password checking via the Pluggable Authentication Module (PAM) framework.
+| xref:mods-available/pap.adoc[pap] | Accepts a large number of formats for the "known good" (reference) password, such as crypt hashes, md5 hashes,
and etc. The module takes the User-Password and performs the necessary transformations of the user submitted password
to match the copy of the password the server has retrieved.
-| xref:securid.adoc[securid] | Supports authentication against an RSA SecurID ACE instance.
-| xref:sigtran.adoc[sigtran] | Supports authentication against a Sigtran interface.
-| xref:soh.adoc[soh] | Implements support for Microsoft's Statement of Health (SoH) protocol, which can run inside of PEAP or DHCP.
-| xref:wimax.adoc[wimax] | Implements WiMAX authentication over RADIUS.
-| xref:winbind.adoc[winbind] | The module also allows for direct connection to Samba winbindd (version 4.2.1 or above), which communicates with
+| xref:mods-available/securid.adoc[securid] | Supports authentication against an RSA SecurID ACE instance.
+| xref:mods-available/sigtran.adoc[sigtran] | Supports authentication against a Sigtran interface.
+| xref:mods-available/soh.adoc[soh] | Implements support for Microsoft's Statement of Health (SoH) protocol, which can run inside of PEAP or DHCP.
+| xref:mods-available/wimax.adoc[wimax] | Implements WiMAX authentication over RADIUS.
+| xref:mods-available/winbind.adoc[winbind] | The module also allows for direct connection to Samba winbindd (version 4.2.1 or above), which communicates with
Active-Directory to retrieve group information and the user's NT-Password.
-| xref:yubikey.adoc[yubikey] | Supports authentication of yubikey tokens where the PSK is known to FreeRADIUS, and integrates with the Yubico
+| xref:mods-available/yubikey.adoc[yubikey] | Supports authentication of yubikey tokens where the PSK is known to FreeRADIUS, and integrates with the Yubico
cloud-based authentication service.
|=====
[cols="20%,80%"]
|=====
| Module | Description
-| xref:cache.adoc[cache] | Stores attributes and/or lists and adds them back to a subsequent request or to the current request on a later execution
+| xref:mods-available/cache.adoc[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.
-| xref:couchbase.adoc[couchbase] | Allows attributes to be stored and retrieved from a couchbase server. Client definitions may also be bulk loaded from a
+| xref:mods-available/client.adoc[client] | Reads client definitions from flat files.
+| xref:mods-available/couchbase.adoc[couchbase] | Allows attributes to be stored and retrieved from a couchbase server. Client definitions may also be bulk loaded from a
couchbase server as FreeRADIUS starts.
-| xref:csv.adoc[csv] | Maps values in a CSV file to FreeRADIUS attributes and adds them to the request.
-| xref:dict.adoc[dict] | Registers xlats and maps to access dictionary data
-| xref:dynamic_clients.adoc[dynamic_clients] | Reads client definitions from flat files.
-| xref:passwd.adoc[passwd] | Reads and caches line-oriented files that are in a format similar to ``/etc/passwd``.
-| xref:radutmp.adoc[radutmp] | Writes a utmp style file that lists the users who are logged in. The file is used mainly for Simultaneous-Use checking
+| xref:mods-available/csv.adoc[csv] | Maps values in a CSV file to FreeRADIUS attributes and adds them to the request.
+| xref:mods-available/dict.adoc[dict] | Registers xlats and maps to access dictionary data
+| xref:mods-available/passwd.adoc[passwd] | Reads and caches line-oriented files that are in a format similar to ``/etc/passwd``.
+| xref:mods-available/radutmp.adoc[radutmp] | Writes a utmp style file that lists the users who are logged in. The file is used mainly for Simultaneous-Use checking
and by radwho to see who has current sessions.
-| xref:redis.adoc[redis] | Provides connectivity to single and clustered instances of Redis. This module exposes a string expansion that may be
+| xref:mods-available/redis.adoc[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.
-| xref:redis_ippool.adoc[redis_ippool] | Implements a fast and scalable IP allocation system using Redis. Supports both IPv4 and IPv6 address and prefix
+| xref:mods-available/redis_ippool.adoc[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.
-| xref:redis_who.adoc[redis_who] | Records which users are currently logged into the service. The file is used mainly for Simultaneous-Use checking to see
+| xref:mods-available/rediswho.adoc[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.
-| xref:sql.adoc[sql] | Provides an abstraction over multiple SQL backends, via database specific drivers.
-| xref:sqlippool.adoc[sqlippool] | SQL based IP allocation module.
-| xref:unix.adoc[unix] | Retrieves a user's encrypted password from the local system and places it into the ``control:Crypt-Password`` attribute.
+| xref:mods-available/sql.adoc[sql] | Provides an abstraction over multiple SQL backends, via database specific drivers.
+| xref:mods-available/sqlippool.adoc[sqlippool] | SQL based IP allocation module.
+| xref:mods-available/unix.adoc[unix] | Retrieves a user's encrypted password from the local system and places it into the ``control:Crypt-Password`` attribute.
The password is retrieved via the ``getpwent()`` and ``getspwent()`` system calls.
|=====
[cols="20%,80%"]
|=====
| Module | Description
-| xref:detail.adoc[detail] | Writes attributes from a request list to a flat file in 'detail' format.
-| xref:dhcpv4.adoc[dhcpv4] | Implements DHCPv4 (Dynamic Host Configuration Protocol for IPv4) client and relay.
-| xref:files.adoc[files] | Implements a traditional Livingston-style users file.
-| xref:linelog.adoc[linelog] | Creates log entries from attributes, string expansions, or static strings, and writes them to a variety of backends,
+| xref:mods-available/detail.adoc[detail] | Writes attributes from a request list to a flat file in 'detail' format.
+| xref:mods-available/dhcpv4.adoc[dhcpv4] | Implements DHCPv4 (Dynamic Host Configuration Protocol for IPv4) client and relay.
+| xref:mods-available/files.adoc[files] | Implements a traditional Livingston-style users file.
+| xref:mods-available/linelog.adoc[linelog] | Creates log entries from attributes, string expansions, or static strings, and writes them to a variety of backends,
including syslog, flat files, and raw UDP/TCP sockets.
-| xref:logtee.adoc[logtee] | Tee's request logging at runtime, sending it to additional log destinations.
-| xref:radius_client.adoc[radius_client] | Allows Access-Requests, Accounting-Requests, CoA-Requests and Disconnect-Messages to be sent during request processing.
-| xref:rest.adoc[rest] | Sends HTTP requests to remote servers and decodes the responses.
-| xref:unbound.adoc[unbound] | Performs queries against a DNS service to allow FQDNs to be resolved during request processing.
+| xref:mods-available/logtee.adoc[logtee] | Tee's request logging at runtime, sending it to additional log destinations.
+| xref:mods-available/radius.adoc[radius] | Allows Access-Requests, Accounting-Requests, CoA-Requests and Disconnect-Messages to be sent during request processing.
+| xref:mods-available/rest.adoc[rest] | Sends HTTP requests to remote servers and decodes the responses.
+| xref:mods-available/unbound.adoc[unbound] | Performs queries against a DNS service to allow FQDNs to be resolved during request processing.
|=====
== Language Modules
[cols="20%,80%"]
|=====
| Module | Description
-| xref:exec.adoc[exec] | Executes an external script, passing in FreeRADIUS attributes as environmental variables or as arguments.
-| xref:lua.adoc[lua] | Allows the server to call embedded lua scripts.
-| xref:mruby.adoc[mruby] | Allows the server to call a persistent, embedded mRuby script.
-| xref:perl.adoc[perl] | Allows the server to call a persistent, embedded Perl script.
-| xref:python.adoc[python] | Allows the server to call a persistent, embedded Python script.
+| xref:mods-available/exec.adoc[exec] | Executes an external script, passing in FreeRADIUS attributes as environmental variables or as arguments.
+| xref:mods-available/lua.adoc[lua] | Allows the server to call embedded lua scripts.
+| xref:mods-available/mruby.adoc[mruby] | Allows the server to call a persistent, embedded mRuby script.
+| xref:mods-available/perl.adoc[perl] | Allows the server to call a persistent, embedded Perl script.
+| xref:mods-available/python.adoc[python] | Allows the server to call a persistent, embedded Python script.
|=====
== Miscellaneous Modules
[cols="20%,80%"]
|=====
| Module | Description
-| xref:abfab_psk_sql.adoc[abfab_psk_sql] | ADFAB PSK
-| xref:cache_eap.adoc[cache_eap] | Cache EAP
-| xref:cache_tls.adoc[cache_tls] | Cache TLS Session
-| xref:cipher.adoc[cipher] | Cipher
-| xref:client.adoc[client] | Client
-| xref:cui.adoc[cui] | CUI
-| xref:detail.example.com.adoc[detail.example.com] | Detail (Sample)
-| xref:detail.log.adoc[detail.log] | Detail (Log Sample)
-| xref:dhcp_sqlippool.adoc[dhcp_sqlippool] | DHCP SQL-IP-Pool
-| xref:eap_inner.adoc[eap_inner] | EAP/Inner
-| xref:echo.adoc[echo] | Echo
-| xref:etc_group.adoc[etc_group] | etc_group
-| xref:isc_dhcp.adoc[isc_dhcp] | isc_dhcp
-| xref:mac2ip.adoc[mac2ip] | Mac2IP
-| xref:mac2vlan.adoc[mac2vlan] | Mac2Vlan
-| xref:ntlm_auth.adoc[ntlm_auth] | NTLM Auth
-| xref:radius.adoc[radius] | Radius
-| xref:rediswho.adoc[rediswho] | REDISWho
-| xref:smbpasswd.adoc[smbpasswd] | SMBPasswd
-| xref:sradutmp.adoc[sradutmp] | sRadutmp
-| xref:stats.adoc[stats] | Stats
+| xref:mods-available/abfab_psk_sql.adoc[abfab_psk_sql] | ADFAB PSK
+| xref:mods-available/cache_eap.adoc[cache_eap] | Cache EAP
+| xref:mods-available/cache_tls.adoc[cache_tls] | Cache TLS Session
+| xref:mods-available/cipher.adoc[cipher] | Cipher
+| xref:mods-available/cui.adoc[cui] | CUI
+| xref:mods-available/detail.example.com.adoc[detail.example.com] | Detail (Sample)
+| xref:mods-available/detail.log.adoc[detail.log] | Detail (Log Sample)
+| xref:mods-available/dhcp_sqlippool.adoc[dhcp_sqlippool] | DHCP SQL-IP-Pool
+| xref:mods-available/eap_inner.adoc[eap_inner] | EAP/Inner
+| xref:mods-available/echo.adoc[echo] | Echo
+| xref:mods-available/etc_group.adoc[etc_group] | etc_group
+| xref:mods-available/isc_dhcp.adoc[isc_dhcp] | isc_dhcp
+| xref:mods-available/mac2ip.adoc[mac2ip] | Mac2IP
+| xref:mods-available/mac2vlan.adoc[mac2vlan] | Mac2Vlan
+| xref:mods-available/ntlm_auth.adoc[ntlm_auth] | NTLM Auth
+| xref:mods-available/smbpasswd.adoc[smbpasswd] | SMBPasswd
+| xref:mods-available/sradutmp.adoc[sradutmp] | sRadutmp
+| xref:mods-available/stats.adoc[stats] | Stats
|=====
== Policy Modules
[cols="20%,80%"]
|=====
| Module | Description
-| xref:always.adoc[always] | Returns a pre-configured result code such as 'ok', 'noop', 'reject' etc...
-| xref:attr_filter.adoc[attr_filter] | Filters attributes in a request. Can delete attributes or permit them to have only certain values.
-| xref:date.adoc[date] | Converts date strings between user configurable formats.
-| xref:delay.adoc[delay] | Introduces an artificial non-blocking delay when processing a request.
-| xref:escape.adoc[escape] | Escapes and unescapes strings using the MIME escape format
-| xref:example.adoc[example] | An example module to use as a template when writing new modules.
+| xref:mods-available/always.adoc[always] | Returns a pre-configured result code such as 'ok', 'noop', 'reject' etc...
+| xref:mods-available/attr_filter.adoc[attr_filter] | Filters attributes in a request. Can delete attributes or permit them to have only certain values.
+| xref:mods-available/date.adoc[date] | Converts date strings between user configurable formats.
+| xref:mods-available/delay.adoc[delay] | Introduces an artificial non-blocking delay when processing a request.
+| xref:mods-available/escape.adoc[escape] | Escapes and unescapes strings using the MIME escape format
+| xref:mods-available/example.adoc[example] | An example module to use as a template when writing new modules.
An example module to use as a template when writing new modules.
-| xref:expiration.adoc[expiration] | Determines whether a user account has expired, with the expiration time set by another module.
-| xref:expr.adoc[expr] | Registers a string expansion "%{expr:}" that allows basic arithmetic and binary operations.
-| xref:idn.adoc[idn] | Converts internationalized domain names to ASCII.
-| xref:json.adoc[json] | Parses JSON strings into an in memory format using the json-c library.
-| xref:logintime.adoc[logintime] | Enforces the time span during which a user may login to the system.
-| xref:sometimes.adoc[sometimes] | Is a hashing and distribution protocol, that will sometimes return one code or another depending on the input value
+| xref:mods-available/expiration.adoc[expiration] | Determines whether a user account has expired, with the expiration time set by another module.
+| xref:mods-available/expr.adoc[expr] | Registers a string expansion "%{expr:}" that allows basic arithmetic and binary operations.
+| xref:mods-available/idn.adoc[idn] | Converts internationalized domain names to ASCII.
+| xref:mods-available/json.adoc[json] | Parses JSON strings into an in memory format using the json-c library.
+| xref:mods-available/logintime.adoc[logintime] | Enforces the time span during which a user may login to the system.
+| xref:mods-available/sometimes.adoc[sometimes] | Is a hashing and distribution protocol, that will sometimes return one code or another depending on the input value
configured.
-| xref:sqlcounter.adoc[sqlcounter] | Records statistics for users such as data transfer and session time, and prevent further logins when limits are reached.
-| xref:test.adoc[test] | Contains test stubs for CIT and the ``make test`` build target.
-| xref:unpack.adoc[unpack] | Unpacks binary data from octets type attributes into individual attributes.
-| xref:utf8.adoc[utf8] | Checks all attributes of type string in the current request, to ensure that they only contain valid UTF8 sequences.
+| xref:mods-available/sqlcounter.adoc[sqlcounter] | Records statistics for users such as data transfer and session time, and prevent further logins when limits are reached.
+| xref:mods-available/test.adoc[test] | Contains test stubs for CIT and the ``make test`` build target.
+| xref:mods-available/unpack.adoc[unpack] | Unpacks binary data from octets type attributes into individual attributes.
+| xref:mods-available/utf8.adoc[utf8] | Checks all attributes of type string in the current request, to ensure that they only contain valid UTF8 sequences.
|=====
projects / thirdparty / freeradius-server.git / commitdiff
