#
# :toc:
#
-# $Id$
+# $Id$
#######################################################################
#
-# ## ADFAB PSK Module
+# = ADFAB PSK Module
#
-# The `abfab_psk_sql` module is used to authorize PSK from `ABFAB` trust router.
+# The `abfab_psk_sql` module is used to authorize PSK from `ABFAB` trust router.
#
-# ## Default instance
+
+#
+# ## Default instance
#
#
#
# driver:: Database driver.
#
- driver = "rlm_sql_sqlite"
+ driver = "rlm_sql_sqlite"
#
# sqlite { ... }:: Database statement based on `driver` setting.
#######################################################################
#
-# ## Always Module
+# = Always Module
#
# The `always` module simply returns the same result, always, without
# doing anything else. It is here for use in complex policies.
#
-
-#
-# ## Sample configuration
-#
-
#always <value> {
#
# rcode:: Return code.
#}
#
-# ### Default instances
+# ## Default instances
#
# The following default instances allow the use of return codes like
# `reject` or `ok` in `unlang` policies.
#######################################################################
#
-# ## Attr_filter Module
+# = Attr_filter Module
#
# The `attr_filter` module defines a number of instances of the "attr_filter".
#
-
-#
-# ## Sample configuration
-#
-
#attr_filter attr_filter.<section> {
#
# key::
# filename = </path/><section>
#}
-# ## Default instances
+# ## Default instances
#
# The following default instances.
#######################################################################
#
-# ## Cache Module
+# = Cache Module
#
# The `cache` module is used to cache attributes. The idea is that you can look
# up information in a database, and then cache it. Repeated requests for the same
#
# ### Memcached cache driver
+#
# memcached {
#
- # options:: Memcached configuration options.
+ # options:: Memcached configuration options.
#
# The memcached options are documented at
# http://docs.libmemcached.org/libmemcached_configuration.html#memcached
#
# ### Redis cache driver
+#
# redis {
#
- # server:: Redis Server name.
+ # server:: Redis Server name.
#
# If using Redis cluster, multiple 'bootstrap' servers may be
# listed here (as separate config items). These will be contacted
# }
#
- # key:: The `key` used to index the cache. It is dynamically expanded at run time.
+ # key:: The `key` used to index the cache. It is dynamically expanded at run time.
#
key = &User-Name
#
- # ttl::
+ # ttl::
#
# The TTL of cache entries, in seconds. Entries older than this
# will be expired.
# You should never set the "epoch" configuration item in this file.
#
- # add_stats::
+ # add_stats::
#
# If `yes` the following attributes will be added to the request:
# * `&request:Cache-Entry-Hits` - The number of times this entry
#######################################################################
#
-# ## Cache EAP Module
+# = Cache EAP Module
#
# The `cache_eap` module caches EAP replies.
#
#######################################################################
#
-# ## Cache TLS Session Module
+# = Cache TLS Session Module
#
-# The `cache_tls_session` module caches TLS sessions for resiliency.
+# The `cache_tls` module caches TLS sessions for resiliency.
#
# This module should be listed in a `send Access-Accept` section to
# write the cache, and in `recv Access-Request` to read the cache.
#######################################################################
#
-# ## CHAP module
+# = CHAP module
#
# This module authenticates requests containing a `CHAP-Password`
# attribute.
#######################################################################
#
-# ## Cipher Module
+# = Cipher Module
#
# The `cipher` module is used to transform plaintext in some way that is dependent
# on a key or key pair, producing encrypted ciphertext.
# You should use armouring expansions i.e. `%{base64_encode:}`, `%{base64_decode:}` if the values
# are to be passed outside of FreeRADIUS.
#
-# E.g:
+# e.g:
#
# %{base64_encode:%{cipher_encrypt:<plaintext>}}
# %{cipher_decrypt:%{base64_decode:<ciphertext>}}
#
cipher {
#
- # ### RSA asymmetrically keyed ciphering
- #
-
- #
- # type::
+ # type::
#
# Available schemes are:
#
#
type = rsa
+ #
+ # ### RSA asymmetrically keyed ciphering
+ #
rsa {
# private_key_password::
#
#######################################################################
#
-# ## Client Module
+# = Client Module
#
# The `client` module loads RADIUS clients as needed, rather than when the server
# starts.
# In addition to loading `client` definitions in from flat files, the clients module can
# also be used to access data from previously defined clients.
#
-# #### Client config item to attribute mapping.
+# ### Client config item to attribute mapping.
#
# Maps arbitrary fields from a client definition to attributes in the current request.
#
# [source,unlang]
# ---
-# map client [<ipaddr>] { // <1>
-# &Tmp-String-0 = 'nas_type' // <2>
-# &Tmp-String-1 := 'shortname' // <3>
-# &Tmp-String-3 += 'groups' // <4>
+# map client [<ipaddr>] { // <1>
+# &Tmp-String-0 = 'nas_type' // <2>
+# &Tmp-String-1 := 'shortname' // <3>
+# &Tmp-String-3 += 'groups' // <4>
# }
# ---
#
# <2> Assigns the value of the `nas_type` field from the client definition to
# `&Tmp-String-0` if `&Tmp-String-0` doesn't exist.
# <3> Assigns the value of the `shortname` field from the client definition to
-# `&Tmp-String-1`
+# `&Tmp-String-1`.
# <4> Creates multiple `&Tmp-String-3` attributes from a custom group field associated
# with the client.
#
-# #### Client config item access expansion.
+# ### Client config item access expansion.
#
# [options="header,autowidth"]
# |===
# | XLAT | Description
-# | `%{client:nas_type}` | Expands to client's `nas_type` (or "" if nas_type not set)
+# | `%{client:nas_type}` | Expands to client's `nas_type` (or "" if nas_type not set).
# | `%{client:<ipaddr>.nas_type}` | Expands to the `nas_type` of the client specified
# by `<ipaddr>` (or "" if `nas_type` not set).
# |===
#
+#
# ## Default instance
#
# This module takes no configuration.
# :toc:
#
# $Id$
+
#######################################################################
#
-# ## Couchbase Module
+# = Couchbase Module
#
# The `couchbase` module is used to provides connections to a Couchbase database.
#
#######################################################################
#
-# ## CSV Module
+# = CSV Module
#
# Read CSV files and use them in maps.
#
#######################################################################
#
-# ## CUI Module
+# = CUI Module
#
# The module `cui` (`Chargeable-User-Identity`) writes
# `Chargeable-User-Identity` log to an SQL database. It uses the `sql`
# :toc:
#
# $Id$
+
#######################################################################
#
-# ## Date Module
+# = Date Module
#
# The `date` module xlat does convert time formats.
#
#
# ."Get time" mode:
#
- # If the input is the string "request", the `xlat` will format the
+ # If the input is the string `request`, the `xlat` will format the
# time the current request packet arrived according to the format
# string, and return it as a string.
#
- # If the input is the string "now", the `xlat` will behave as
+ # If the input is the string `now`, the `xlat` will behave as
# above, for the current time.
#
# See also the core provided expansions which are equivalent to
#
# ### ISO format
#
-# The core xlat, `%T` returns the request timestamp in `ISO` format
+# The core `xlat`, `%T` returns the request timestamp in `ISO` format
# including milliseconds. This expansion returns it without the
# millisecond component.
#
#######################################################################
#
-# ## Delay Module
+# = Delay Module
#
# The `delay` module delays the processing of a request in a
# non-blocking fashion.
#######################################################################
#
-# ## Detail Module
+# = Detail Module
#
# Write a detailed log of all accounting records received.
#
#######################################################################
#
-# ## Detail Module (Sample)
+# = Detail Module (Sample)
#
# Please see the `detail` module for full documentation.
#
#######################################################################
#
-# ## Detail Module (Log Sample)
+# = Detail Module (Log Sample)
#
# More examples of doing detail logs.
#
#######################################################################
#
-# ## DHCP SQL-IP-Pool Module
+# = DHCP SQL-IP-Pool Module
#
# The module `dhcp_sqlippool` provides configuration for `DHCP` to use `SQL IP Pools`.
#
# * See `raddb/sites-available/dhcp` for instructions on how to configure the DHCP server.
# ====
#
-# ## Default instance
+# # Default instance
#
sqlippool dhcp_sqlippool {
#
#######################################################################
#
-# ## DHCPv4 Module
+# = DHCPv4 Module
#
# The `dhcpv4` module is useful only for `xlat`. To use it,
# put `dhcp` into the `instantiate { ... }` section.
#
#
-# ## Default instance
+# # Default instance
#
# This module takes no configuration.
#
#######################################################################
#
-# ## Digest Module
+# = Digest Module
#
# The `digest` module is used for performing authentication against a Cisco SIP server.
#
#######################################################################
#
-# ## Echo Module
+# = Echo Module
#
# The `echo` module is used for execute an external program in more than
# one section (e.g. `recv`, `pre_proxy`, etc), then it is probably best
#######################################################################
#
-# ## Escape Module
+# = Escape Module
#
# The `escape` module registers two `xlat` functions.
#
#
escape {
#
- # safe_characters:: List with allowed characters.
+ # safe_characters::
+ #
+ # Characters that will not be encoded by the `%{escape}` `xlat` function.
#
safe_characters = "@abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_: /äéöüàâæçèéêëîïôœùûüaÿÄÉÖÜßÀÂÆÇÈÉÊËÎÏÔŒÙÛÜŸ"
}
#######################################################################
#
-# ## etc_group Module
+# = etc_group Module
#
# The `etc_group` module provides group names from the `/etc/group` file.
#
#######################################################################
#
-# ## Exec Module
+# = Exec Module
#
# The module `exec` is used for executing external programs.
#
#######################################################################
#
-# ## Expiration Module
+# = Expiration Module
#
# The `expiration` module manages the `Expiration` attribute.
#
#
#
-# ## Sample configuration
+# ## Default instance
#
# This module takes no configuration.
#
projects / thirdparty / freeradius-server.git / commitdiff
