rlm_counter(5) [centos man page]

rlm_counter(5)							 FreeRADIUS Module						    rlm_counter(5)

NAME

       rlm_counter - FreeRADIUS Module

DESCRIPTION

       The  rlm_counter module provides a general framework to allow access based on accumulated usage of a resource, such as total time online in
       a given period, total data transferred in a given period, etc.  This is very useful in a 'Prepaid Service' situation, where a user has paid
       for a finite amount of usage and should not be allowed to use more than that service.  Collection, monitoring, and replenishment of prepaid
       services are beyond the scope of this module.

       The main configuration items to be aware of are:

       filename
	      The filename where the usage data is stored.

       key    An attribute which will be present in the Access-Request to be used as the 'index' value for the counter. A counter entry is tracked
	      for each unique key.  The most likely key you will want to use is User-Name.

       count_attribute
	      An  attribute  which  will  be  used to increment the counter value.  If this attribute is Acct-Session-Time or an integer value the
	      counter data is incremented by the Attribute value.  For all other attribute types the counter is incremented by one.

       reset  How frequently the counter data should be set back to 0.	Valid values for this variable are: hourly, daily, weekly,  monthly,  orn-
	      ever  Alternatively, it can be user defined, in the form: num[hdwm].  num is a numeric value, followed by one or none of the follow-
	      ing letters.  h: hours, d: days, w: weeks, m: months.

       check_name
	      This defines an attribute name which will be registered by the counter module and can be used to set the maximum allowed	value  for
	      the  counter  after which the user is rejected.  If Daily-Session-Time is set, you can use the following syntax in the Users file to
	      set a cap of 3600 seconds ( 8 hours ):

       DEFAULT Max-Daily-Session := 3600

       reply_name
	      This is the name of the attribute which will contain the remaining value for the counter in the reply packet when the user  is  suc-
	      cessfully authorized. The default attribute name is "Session-Timeout".

       allowed_service_type
	      This can be used to only apply the limitations to specific service types of sessions.  For example, setting this to Framed-User will
	      only apply the counter module to Framed sessions, excluding other types such as Telnet or Rlogin.

       cache_size
	      The maximum size of the cache to be used by the module.  The default is 1000.

NOTES

       This module registers an attribute, so it should be added to the instantiate section, to be called on server startup.   When  used  in  the
       authorize section, it must come after any modules which set the 'check_name' attribute.

SECTIONS

       instantiate, authorize, accounting

FILES

       /etc/raddb/radiusd.conf

SEE ALSO

       radiusd(8), radiusd.conf(5) rlm_sqlcounter(5)

AUTHOR

       Chris Parker, cparker@segv.org

								   13 March 2004						    rlm_counter(5)

Check Out this Related Man Page

rlm_files(5)							 FreeRADIUS Module						      rlm_files(5)

NAME

       rlm_files - FreeRADIUS Module

DESCRIPTION

       The  rlm_files  module  uses  the 'users' file for accessing authorization information for users.  Additionally, it supports a 'users' file
       syntax to be applied to the accounting and pre-proxy sections.

       The main configuration items to be aware of are:

       usersfile
	      The filename of the 'users' file, which is parsed during the authorization stage of this module.

       acctusersfile
	      The filename of the 'users' file, which is parsed during the accounting stage of this module.

       preproxy_usersfile
	      The filename of the 'users' file, which is parsed during the pre_proxy stage of this module.

       compat This option allows FreeRADIUS to parse an old style Cistron syntax.  The default is 'no'.  If you need to parse an old style Cistron
	      file, set this option to 'cistron'.

       key    This option lets you set the attribute to use as a key to find entries.  The default is "%{Stripped-User-Name:-%{User-Name}}".  Note
	      that the key MUST supply real data.  Dynamic attributes like "Group" will not work, because the "Group" attribute can only  be  used
	      as a comparison, to see if a user is in a Unix group.  It will not return the name of the Unix group that a user is in.

       If you want to use groups as a key, see the rlm_passed, which will create a real attribute that contains the group name.

       This configuration entry enables you to have configurations that perform per-group checks, and return per-group attributes, where the group
       membership is dynamically defined by a previous module.	It also lets you do things like key off of attributes in the  reply,  and  express
       policies like like "when I send replies containing attribute FOO with value BAR, do more checks, and maybe send additional attributes".

CONFIGURATION

       modules {
	 ... stuff here ...
	 files {
	   usersfile = %{confdir}/users
	   acctusersfile = %{confdir}/acct_users
	   preproxy_usersfile = %{confdir}/preproxy_users
	   compat = no
	   key = %{Stripped-User-Name:-%{User-Name}}
	 }
	 ... stuff here ...
       }

SECTIONS

       authorization, accounting, pre_proxy

FILES

       /etc/raddb/radiusd.conf, /etc/raddb/users, /etc/raddb/acct_users, /etc/raddb/preproxy_users

SEE ALSO

       radiusd(8), radiusd.conf(5), users(5)

AUTHORS

       Chris Parker, cparker@segv.org

								  5 February 2004						      rlm_files(5)

Linux and UNIX Man Pages

rlm_counter(5) [centos man page]

Check Out this Related Man Page