1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<!-- Module User's Guide -->
<chapter>
<chapterinfo>
<revhistory>
<revision>
<revnumber>$Revision: 1.4 $</revnumber>
<date>$Date: 2006/03/01 18:07:36 $</date>
</revision>
</revhistory>
</chapterinfo>
<title>User's Guide</title>
<section>
<title>Overview</title>
<para>
This module implements SIP authentication and authorization with
DIAMETER server, namely DIameter Server Client (DISC).
</para>
<para>
The digest authentication mechanism is presented in next figure.
</para>
<example>
<title>Digest Authentication</title>
<programlisting format="linespecific">
...
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
...
</programlisting>
</example>
</section>
<section>
<title>Dependencies</title>
<section>
<title>&ser; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>sl</emphasis> - used to send stateless replies.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>External Libraries or Applications</title>
<para>
The following libraries or applications must be installed before running
&ser; with this module loaded:
<itemizedlist>
<listitem>
<para>
<emphasis>None</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section>
<title>Exported Parameters</title>
<section>
<title><varname>diameter_client_host</varname> (string)</title>
<para>
Hostname of the machine where the DIAMETER Client is running.
</para>
<para>
<emphasis>
Default value is <quote>localhost</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>diameter_client_host</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("auth_diameter", "diameter_client_host", "10.10.10.10")
...
</programlisting>
</example>
</section>
<section>
<title><varname>diameter_client_port</varname> (int)</title>
<para>
Port number where the DIAMETER Client is listening.
</para>
<para>
<emphasis>
Default value is <quote>3000</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>diameter_client_port</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("auth_diameter", "diameter_client_port", 3000)
...
</programlisting>
</example>
</section>
<section>
<title><varname>use_domain</varname> (int)</title>
<para>
Specifies whether the domain name part of URI is used when checking the
user's privileges.
</para>
<para>
<emphasis>
Default value is <quote>0 (0==false and 1==true )</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>use_domain</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("auth_diameter", "use_domain", 1)
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Exported Functions</title>
<section>
<title>
<function moreinfo="none">diameter_www_authorize(realm)</function>
</title>
<para>
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 <quote>403 Forbidden</quote> is sent back.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>realm</emphasis> - the realm to be use for
authentication and authorization. The string may contain
pseudo variables.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE.
</para>
<example>
<title><function>diameter_www_authorize</function> usage</title>
<programlisting format="linespecific">
...
if(!diameter_www_authorize("siphub.net"))
{ /* user is not authorized */
break;
};
...
</programlisting>
</example>
</section>
<section>
<title>
<function moreinfo="none">diameter_proxy_authorize(realm)</function>
</title>
<para>
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 <quote>403 Forbidden</quote> is sent back.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>realm</emphasis> - the realm to be use for
authentication and authorization. The string may contain
pseudo variables.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE.
</para>
<example>
<title><function>diameter_proxy_authorize</function> usage</title>
<programlisting format="linespecific">
...
if(!diameter_proxy_authorize("siphub.net"))
{ /* user is not authorized */
break;
};
...
</programlisting>
</example>
</section>
<section>
<title>
<function moreinfo="none">diameter_is_user_in(who, group)</function>
</title>
<para>
The method performs group membership checking with DISC.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>who</emphasis> - 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: <quote>Request-URI</quote>, <quote>From</quote>,
<quote>To</quote> or <quote>Credentials</quote>.
</para>
</listitem>
<listitem>
<para><emphasis>group</emphasis> - the group name where to check if
the user is part of.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE.
</para>
<example>
<title><function>diameter_is_user_in</function> usage</title>
<programlisting format="linespecific">
...
if(!diameter_is_user_in("From", "voicemail"))
{ /* user is not authorized */
break;
};
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Installation & Running</title>
<para>Notes about installation and running.</para>
</section>
</chapter>
<!-- Keep this element at the end of the file
Local Variables:
sgml-parent-document: ("auth_diameter.sgml" "Book" "chapter")
End:
-->
|
