{I guess you know that rlm_policy doesn't compile in HEAD, due to lack of parent argument to compile_modgroup(). Also, ../../doc/README.failover, does not seem to exist.} I was looking for a module that might deal with selecting a L2/PPP termination machine from a list of machines, either randomly, or round robin. I didn't find one, but in the process, I made the following list, and decided that a file per module would make sense. Yes, there are man pages for a couple of them. I'm personally tired of nroff. git/cogito might have it right with "asciidoc", I'm not 100% convinced. I think that I can still commit this, if you approve of documentating in this way, and I haven't missed some other document. Some modules have README files, but often they don't even tell you what the purpose of the module is. (It self-evident) commit 59fa93c7b01dae302723f6ac45746ae7f96b0dfb Author: Michael Richardson <mcr@xelerance.com> Date: Sat Aug 5 14:30:40 2006 -0400 added list of modules and empty files for documentation of each module Signed-off-by: Michael Richardson <mcr@xelerance.com> diff --git a/doc/modules-description.txt b/doc/modules-description.txt new file mode 100644 index 0000000..76e0857 --- /dev/null +++ b/doc/modules-description.txt @@ -0,0 +1,48 @@ +-*- emacs-wiki -*- + +[[rlm_acct_unique]] - create a unique accounting key, adding Acct-Unique-Session-ID. +[[rlm_always]] - always return a specific result, and possibly change simulation +[[rlm_attr_filter]] - filter out A/V pairs from proxy, from an attribute file +[[rlm_attr_rewrite]] - change a particular attribute value +[[rlm_caching]] - cache the result of an authorization result, and use it again later +[[rlm_chap]] - perform CHAP-style authentication if user has a CHAP-style password +[[rlm_checkval]] - check an attribute for a particular value +[[rlm_copy_packet]] - copies all attributes from access request to access reply +[[rlm_counter]] - allow access based on accumulated usage of a resource (time, bytes) +[[rlm_cram]] - implements CRAM authentication method (for email. APOP/CRAM-MD5) +[[rlm_dbm]] - pull users data from dbm file +[[rlm_detail]] - log radius packets to a detailed file, primarily for accounting +[[rlm_digest]] - authenticated based upon (Cisco) SIP authentiation attributes +[[rlm_eap]] - implements EAP methods, and various subtypes +[[rlm_example]] - sample module (example only) +[[rlm_exec]] - implements Exec-Program && Exec-Program-Wait. +[[rlm_expiration]] - process expiration attribute, for expired logins +[[rlm_expr]] - invoked by dynamic expansion of strings %{expr:} to do calculations +[[rlm_fastusers]] - cached/hashing version of "users" file +[[rlm_files]] - read and parse the "users" file for authorization information +[[rlm_ippool]] - maintain a pool of IP addresses in a .db file +[[rlm_krb5]] - authenticate against KERBEROS v5 server +[[rlm_ldap]] - authorized and authenticate against LDAP server +[[rlm_linelog]] - log things to a file based upon radius_xlat(). +[[rlm_logintime]] - implement time of day restrictions on logins. +[[rlm_mschap]] - perform MS-CHAP/MS-CHAPv2 authentication +[[rlm_otp]] - implements various OTP mechanism via seperate daemon (XXX?) +[[rlm_pam]] - use PAM modules to authenticate users +[[rlm_pap]] - authenticate based upon User-Password attribute (PPP PAP) +[[rlm_passwd]] - authenticated based upon /etc/passwd-like method. +[[rlm_perl]] - create modules using perl +[[rlm_policy]] - implements the policy language +[[rlm_preprocess]] - deal with various NAS' notions of ports, mapping to huntgroups +[[rlm_protocol_filter]] - filter out certain value-pairs from requests +[[rlm_python]] - create modules using python +[[rlm_radutmp]] - maintain a utmp file of who is logged in, and do simultaenous checks +[[rlm_realm]] - parses the User-Name attribute into a User section and a Realm section +[[rlm_sim_files]] - loads EAP-SIM triplets from a file +[[rlm_smb]] - validate a user against an SMB/NMB server +[[rlm_sql]] - provides an interface to SQL databases for configuration files +[[rlm_sql_log]] - defers logging of accounting information, do it asynchronously +[[rlm_sqlcounter]] - limit users by resources, kept in a database +[[rlm_sqlippool]] - maintain a pool of IP addresses in a SQL database file +[[rlm_unix]] - authenticates against standard system unix crypt(3) passwords, +[[rlm_x99_token]] - X9.9 tokens (not complete) + diff --git a/doc/rlm_acct_unique b/doc/rlm_acct_unique new file mode 100644 index 0000000..8a46993 --- /dev/null +++ b/doc/rlm_acct_unique @@ -0,0 +1,2 @@ +-*- emacs-wiki -*- + diff --git a/doc/rlm_always b/doc/rlm_always new file mode 100644 index 0000000..8a46993 --- /dev/null +++ b/doc/rlm_always @@ -0,0 +1,2 @@ +-*- emacs-wiki -*- + diff --git a/doc/rlm_attr_filter b/doc/rlm_attr_filter new file mode 100644 index 0000000..8a46993 --- /dev/null +++ b/doc/rlm_attr_filter @@ -0,0 +1,2 @@ +-*- emacs-wiki -*- + diff --git a/doc/rlm_attr_rewrite b/doc/rlm_attr_rewrite new file mode 100644 index 0000000..8a46993 --- /dev/null +++ b/doc/rlm_attr_rewrite @@ -0,0 +1,2 @@ +-*- emacs-wiki -*- + diff --git a/doc/rlm_caching b/doc/rlm_caching new file mode 100644 index 0000000..0b5eb26 --- /dev/null +++ b/doc/rlm_caching @@ -0,0 +1 @@ +-*- emacs-wiki -*- diff --git a/doc/rlm_chap b/doc/rlm_chap new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_chap @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_checkval b/doc/rlm_checkval new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_checkval @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_copy_packet b/doc/rlm_copy_packet new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_copy_packet @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_counter b/doc/rlm_counter new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_counter @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_cram b/doc/rlm_cram new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_cram @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_detail b/doc/rlm_detail new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_detail @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_digest b/doc/rlm_digest new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_digest @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_example b/doc/rlm_example new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_example @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_exec b/doc/rlm_exec new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_exec @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_expr b/doc/rlm_expr new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_expr @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_files b/doc/rlm_files new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_files @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_ippool b/doc/rlm_ippool new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_ippool @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_linelog b/doc/rlm_linelog new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_linelog @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_logintime b/doc/rlm_logintime new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_logintime @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_mschap b/doc/rlm_mschap new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_mschap @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_otp b/doc/rlm_otp new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_otp @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_pap b/doc/rlm_pap new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_pap @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_perl b/doc/rlm_perl new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_perl @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_policy b/doc/rlm_policy new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_policy @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_preprocess b/doc/rlm_preprocess new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_preprocess @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_protocol_filter b/doc/rlm_protocol_filter new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_protocol_filter @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_radutmp b/doc/rlm_radutmp new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_radutmp @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_realm b/doc/rlm_realm new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_realm @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_sim_files b/doc/rlm_sim_files new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_sim_files @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_smb b/doc/rlm_smb new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_smb @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_sql_log b/doc/rlm_sql_log new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_sql_log @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_sqlippool b/doc/rlm_sqlippool new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_sqlippool @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_unix b/doc/rlm_unix new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_unix @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME diff --git a/doc/rlm_x99_token b/doc/rlm_x99_token new file mode 100644 index 0000000..1367855 --- /dev/null +++ b/doc/rlm_x99_token @@ -0,0 +1,3 @@ +-*- emacs-wiki -*- + +WRITE ME