$Revision: 1.2 $
$Date: 2003/11/24 19:23:48 $
User's Guide
Overview
This module implements SIP authentication and authorization with
DIAMETER server, namely DIameter Server Client (DISC).
The digest authentication mechanism is presented in next figure.
Digest Authentication
...
a) First phase of Digest Authentication for SIP:
+----+ SIP INVITE +=====+ DIAMETER +------+ +------+
| | no Auth hdr #/////# AA-Request | | | |
| |---------1--->#/////#-------2------->| |---2-->| |
|UAC | #UAS//# |DClnt | |DSrv |
| |<-----4-------#(SER)#<------3--------|(DISC)|<--3---|(DISC)|
| | 401 #/////# DIAMETER | | | |
+----+ Unauthorized +=====+ AA-Answer +------+ +------+
Result-Code=4001
b) Second phase of Digest Authentication for SIP:
+----+ SIP INVITE +=====+ DIAMETER +------+ +----+
| | Auth hdr #/////# AA-Request | | | |
| |--------1---->#/////#-------2------>| |---2-->| |
|UAC | #UAS//# |DClnt | |DSrv|
| |<-------4-----#(SER)#<------3-------| |<--3---| |
| | 200 OK #/////# DIAMETER | | | |
+----+ +=====+ AA-Answer +------+ +----+
Result-Code=2001
...
Dependencies
&ser; Modules
The following modules must be loaded before this module:
sl - used to send stateless replies.
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Parameters
<varname>diameter_client_host</varname> (string)
Hostname of the machine where the DIAMETER Client is running.
Default value is localhost
.
Set <varname>diameter_client_host</varname> parameter
...
modparam("auth_diameter", "diameter_client_host", "10.10.10.10")
...
<varname>diameter_client_port</varname> (int)
Port number where the DIAMETER Client is listening.
Default value is 3000
.
Set <varname>diameter_client_port</varname> parameter
...
modparam("auth_diameter", "diameter_client_port", 3000)
...
<varname>use_domain</varname> (int)
Specifies whether the domain name part of URI is used when checking the
user's privileges.
Default value is 0 (0==false and 1==true )
.
Set <varname>use_domain</varname> parameter
...
modparam("auth_diameter", "use_domain", 1)
...
Exported Functions
<function moreinfo="none">diameter_www_authorize(realm)</function>
SIP Server checks for authorization having a DIAMETER server in backend.
If no credentials are provided inside the SIP request then a challenge
is sent back to UAC. If the credentials don't match the ones computed by
DISC then 403 Forbidden
is sent back.
Meaning of the parameters is as follows:
realm - the realm to be use for
authentication and authorization.
<function>diameter_www_authorize</function> usage
...
if(!diameter_www_authorize("iptel.org"))
{ /* user is not authorized */
break;
};
...
<function moreinfo="none">diameter_proxy_authorize(realm)</function>
SIP Proxy checks for authorization having a DIAMETER server in backend.
If no credentials are provided inside the SIP request then a challenge
is sent back to UAC. If the credentials don't match the ones computed by
DISC then 403 Forbidden
is sent back.
Meaning of the parameters is as follows:
realm - the realm to be use for
authentication and authorization.
<function>diameter_proxy_authorize</function> usage
...
if(!diameter_proxy_authorize("iptel.org"))
{ /* user is not authorized */
break;
};
...
<function moreinfo="none">diameter_is_user_in(who, group)</function>
The method performs group membership checking with DISC.
Meaning of the parameters is as follows:
who - what header to be used to get the
SIP URI that is wanted to be checked being member in a certain group.
It can be: Request-URI
, From
,
To
or Credentials
.
group - the group name where to check if
the user is part of.
<function>diameter_is_user_in</function> usage
...
if(!diameter_is_user_in("From", "voicemail"))
{ /* user is not authorized */
break;
};
...
Installation & Running
Notes about installation and running.