|
|
@@ -12,13 +12,13 @@
|
|
|
<!-- misc_radius Module User's Guide -->
|
|
|
|
|
|
<chapter>
|
|
|
-
|
|
|
+
|
|
|
<title>&adminguide;</title>
|
|
|
-
|
|
|
+
|
|
|
<section>
|
|
|
<title>Overview</title>
|
|
|
<para>
|
|
|
- The <emphasis>misc_radius</emphasis> module implements various
|
|
|
+ The <emphasis>misc_radius</emphasis> module implements various
|
|
|
RADIUS related functions.
|
|
|
Functions exist for loading caller's or callee's
|
|
|
attributes into AVPs, checking if user belongs to a group, and
|
|
|
@@ -59,7 +59,7 @@
|
|
|
<para>
|
|
|
Unlike in old avp_radius module, functions
|
|
|
radius_load_calle[re]_avps() do not prefix string names of AVPs
|
|
|
- by string
|
|
|
+ by string
|
|
|
<quote>caller_</quote> or <quote>callee_</quote> depending if
|
|
|
caller's or callee's attributes were loaded. If you need these
|
|
|
prefixes, make your RADIUS server to prepend them into attribute
|
|
|
@@ -77,7 +77,7 @@
|
|
|
<section>
|
|
|
<title>&kamailio; Modules</title>
|
|
|
<para>
|
|
|
- The module depends on the following modules (in the other words
|
|
|
+ The module depends on the following modules (in the other words
|
|
|
the listed modules must be loaded before this module):
|
|
|
<itemizedlist>
|
|
|
<listitem>
|
|
|
@@ -123,14 +123,14 @@
|
|
|
|
|
|
<section>
|
|
|
<title>Parameters</title>
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.config">
|
|
|
<title><varname>radius_config</varname> (string)</title>
|
|
|
<para>
|
|
|
- This is the location of the configuration file of radius client
|
|
|
+ This is the location of the configuration file of radius client
|
|
|
libraries.
|
|
|
</para>
|
|
|
<para>
|
|
|
- Default value is
|
|
|
+ Default value is
|
|
|
<quote>/usr/local/etc/radiusclient-ng/radiusclient.conf</quote>.
|
|
|
</para>
|
|
|
<example>
|
|
|
@@ -138,10 +138,11 @@
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
modparam("misc_radius", "radius_config", "/etc/radiusclient.conf")
|
|
|
+...
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.caller_srv_type">
|
|
|
<title><varname>caller_service_type</varname> (integer)</title>
|
|
|
<para>
|
|
|
This is the value of the Service-Type radius attribute to be
|
|
|
@@ -156,10 +157,11 @@ modparam("misc_radius", "radius_config", "/etc/radiusclient.conf")
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
modparam("misc_radius", "caller_service_type", 18)
|
|
|
+...
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.callee_srv_type">
|
|
|
<title><varname>callee_service_type</varname> (integer)</title>
|
|
|
<para>
|
|
|
This is the value of the Service-Type radius attribute to be
|
|
|
@@ -174,10 +176,11 @@ modparam("misc_radius", "caller_service_type", 18)
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
modparam("misc_radius", "callee_service_type", 19)
|
|
|
+...
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.group_srv_type">
|
|
|
<title><varname>group_service_type</varname> (integer)</title>
|
|
|
<para>
|
|
|
This is the value of Service-Type RADIUS attribute to be
|
|
|
@@ -192,10 +195,11 @@ modparam("misc_radius", "callee_service_type", 19)
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
modparam("misc_radius", "group_service_type", 20)
|
|
|
+...
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.uri_srv_type">
|
|
|
<title><varname>uri_service_type</varname> (integer)</title>
|
|
|
<para>
|
|
|
This is the value of Service-Type RADIUS attribute to be
|
|
|
@@ -211,15 +215,16 @@ modparam("misc_radius", "group_service_type", 20)
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
modparam("misc_radius", "uri_service_type", 21)
|
|
|
+...
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.caller_extra">
|
|
|
<title><varname>caller_extra</varname> (string)</title>
|
|
|
<para>
|
|
|
Semi-colon separated list of extra RADIUS
|
|
|
attribute name=pseudo variable pairs. When
|
|
|
- radius_load_caller_avps() is called, the listed extra
|
|
|
+ radius_load_caller_avps() is called, the listed extra
|
|
|
attributes are included RADIUS request with
|
|
|
current values of corresponding pseudo variables.
|
|
|
</para>
|
|
|
@@ -232,15 +237,16 @@ modparam("misc_radius", "uri_service_type", 21)
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
modparam("misc_radius", "caller_extra", "Calling-Station-Id=$fu")
|
|
|
+...
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.callee_extra">
|
|
|
<title><varname>callee_extra</varname> (string)</title>
|
|
|
<para>
|
|
|
Semi-colon separated list of extra RADIUS
|
|
|
attribute name=pseudo variable pairs. When
|
|
|
- radius_load_callee_avps() is called, the listed extra
|
|
|
+ radius_load_callee_avps() is called, the listed extra
|
|
|
attributes are included RADIUS request with
|
|
|
current values of corresponding pseudo variables.
|
|
|
</para>
|
|
|
@@ -253,15 +259,16 @@ modparam("misc_radius", "caller_extra", "Calling-Station-Id=$fu")
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
modparam("misc_radius", "callee_extra", "SIP-URI-User=$rU;SIP-URI-Host=$rd")
|
|
|
+...
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.group_extra">
|
|
|
<title><varname>group_extra</varname> (string)</title>
|
|
|
<para>
|
|
|
Semi-colon separated list of extra RADIUS
|
|
|
attribute name=pseudo variable pairs. When
|
|
|
- radius_is_user_in() is called, the listed extra
|
|
|
+ radius_is_user_in() is called, the listed extra
|
|
|
attributes are included RADIUS request with
|
|
|
current values of corresponding pseudo variables.
|
|
|
</para>
|
|
|
@@ -274,16 +281,17 @@ modparam("misc_radius", "callee_extra", "SIP-URI-User=$rU;SIP-URI-Host=$rd")
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
modparam("misc_radius", "group_extra", "My-Special=$avp(i:100)")
|
|
|
+...
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.uri_extra">
|
|
|
<title><varname>uri_extra</varname> (string)</title>
|
|
|
<para>
|
|
|
Semi-colon separated list of extra RADIUS
|
|
|
attribute name=pseudo variable pairs. When
|
|
|
radius_does_uri[_user]_exist() function is called, the
|
|
|
- listed extra
|
|
|
+ listed extra
|
|
|
attributes are included in RADIUS request with
|
|
|
current values of corresponding pseudo variables.
|
|
|
</para>
|
|
|
@@ -296,11 +304,12 @@ modparam("misc_radius", "group_extra", "My-Special=$avp(i:100)")
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
modparam("misc_radius", "uri_extra", "Called-Station-Id=$tu")
|
|
|
+...
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.use_sip_uri_host">
|
|
|
<title><varname>use_sip_uri_host</varname> (integer)</title>
|
|
|
<para>
|
|
|
If zero, radius_does_uri_exist() function sends to
|
|
|
@@ -317,10 +326,11 @@ modparam("misc_radius", "uri_extra", "Called-Station-Id=$tu")
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
modparam("misc_radius", "use_sip_uri_host", 1)
|
|
|
+...
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
- <section>
|
|
|
+ <section id="mrad.p.common_response">
|
|
|
<title><varname>common_response</varname> (integer)</title>
|
|
|
<para>
|
|
|
Set it to 1 if you need common radius response attributes to
|
|
|
@@ -371,7 +381,7 @@ $avp(SIP-AVP) has string value "email:[email protected] session-tim
|
|
|
<section>
|
|
|
<title>Functions</title>
|
|
|
|
|
|
- <section>
|
|
|
+ <section id="mrad.f.load_caller_avps">
|
|
|
<title><function
|
|
|
moreinfo="none">radius_load_caller_avps(caller)</function></title>
|
|
|
<para>
|
|
|
@@ -395,7 +405,7 @@ radius_load_caller_avps("$au@$ar"); # take caller from Authorization
|
|
|
</example>
|
|
|
</section>
|
|
|
|
|
|
- <section>
|
|
|
+ <section id="mrad.f.load_callee_avps">
|
|
|
<title><function
|
|
|
moreinfo="none">radius_load_callee_avps(callee)</function></title>
|
|
|
<para>
|
|
|
@@ -417,7 +427,7 @@ radius_load_callee_avps("$rU@$rd"); # take callee from Request-URI
|
|
|
</example>
|
|
|
</section>
|
|
|
|
|
|
- <section>
|
|
|
+ <section id="mrad.f.is_user_in">
|
|
|
<title><function
|
|
|
moreinfo="none">radius_is_user_in(user, group)</function></title>
|
|
|
<para>
|
|
|
@@ -443,13 +453,13 @@ radius_is_user_in("$au@$ar", "group_x");# take user from credentials
|
|
|
</example>
|
|
|
</section>
|
|
|
|
|
|
- <section>
|
|
|
+ <section id="mrad.f.does_uri_exist">
|
|
|
<title><function
|
|
|
- moreinfo="none">radius_does_uri_exist([uri])</function></title>
|
|
|
+ moreinfo="none">radius_does_uri_exist([uri])</function></title>
|
|
|
<para>
|
|
|
Checks from RADIUS if userpart@hostpart of Request-URI
|
|
|
or of an URI stored in optional pseudo variable argument
|
|
|
- belongs to a local
|
|
|
+ belongs to a local
|
|
|
user. In case of positive result, loads AVPs from
|
|
|
SIP-AVP reply items, if any.
|
|
|
</para>
|
|
|
@@ -469,7 +479,7 @@ if (radius_does_uri_exist("$avp(i:99)")) ... # check URI in $avp(i:99)
|
|
|
</example>
|
|
|
</section>
|
|
|
|
|
|
- <section>
|
|
|
+ <section id="mrad.f.does_uri_user_exist">
|
|
|
<title><function
|
|
|
moreinfo="none">radius_does_uri_user_exist([user])</function></title>
|
|
|
<para>
|
Daniel-Constantin Mierla