Skip to content

Commit 422f815

Browse files
committed
[uac] update and improve docs for uac_auth()
1 parent 6940ca8 commit 422f815

File tree

1 file changed

+33
-17
lines changed

1 file changed

+33
-17
lines changed

modules/uac/doc/uac_admin.xml

Lines changed: 33 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,6 @@
1616
If the dialog module is loaded and a dialog can be created,
1717
then the auto mode can be done more efficiently.
1818
</para>
19-
<para>
20-
Known limitations in this version:
21-
</para>
22-
<itemizedlist>
23-
<listitem>
24-
<para>
25-
authentication does not support qop auth-int, just qop auth;
26-
</para>
27-
</listitem>
28-
<listitem>
29-
<para>
30-
CSeq not increased during authentication - the response
31-
may be rejected.
32-
</para>
33-
</listitem>
34-
</itemizedlist>
3519
</section>
3620

3721
<section id="dependencies" xreflabel="Dependencies">
@@ -290,7 +274,7 @@ uac_restore_from();
290274
</example>
291275
</section>
292276

293-
<section id="func_uac_auth" xreflabel="uac_auth()">
277+
<section id="func_uac_auth" xreflabel="uac_auth([algs])">
294278
<title>
295279
<function moreinfo="none">uac_auth()</function>
296280
</title>
@@ -303,13 +287,45 @@ uac_restore_from();
303287
or via AVPs).
304288
</para>
305289
<para>
290+
As optional parameter, the function may receive a list of auth
291+
algorithms to be considered / supported during authentication:
292+
</para>
293+
<itemizedlist>
294+
<listitem>
295+
<para>MD5, MD5-sess</para>
296+
</listitem>
297+
<listitem>
298+
<para>SHA-256, SHA-256-sess (may be missing, depends on lib support)</para>
299+
</listitem>
300+
<listitem>
301+
<para>SHA-512-256, SHA-512-256-sess (may be missing, depends on lib support)</para>
302+
</listitem>
303+
</itemizedlist>
304+
<para>
305+
Note that the CSeq is automatically increased during authentication.
306+
</para>
307+
<para>
306308
This function can be used from FAILURE_ROUTE.
307309
</para>
308310
<example>
309311
<title><function>uac_auth</function> usage</title>
310312
<programlisting format="linespecific">
311313
...
312314
uac_auth();
315+
...
316+
failure_route[check_auth] {
317+
...
318+
if ($T_reply_code==407) {
319+
if (uac_auth("MD5,MD5-sess")) {
320+
# auth is succesful, just relay
321+
t_relay();
322+
exit;
323+
}
324+
# auth failed (no credentials maybe)
325+
# so continue handling the 407 reply
326+
}
327+
...
328+
}
313329
...
314330
</programlisting>
315331
</example>

0 commit comments

Comments
 (0)