[sr-dev] git:master:90666477: ims_auth: docs for functions used for av_mode=1

Module: kamailio Branch: master Commit: 906664775ace76fcfa941022b5f1ed168563082a URL: https://github.com/kamailio/kamailio/commit/906664775ace76fcfa941022b5f1ed1… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2025-01-12T20:44:38+01:00 ims_auth: docs for functions used for av_mode=1 --- Modified: src/modules/ims_auth/doc/ims_auth_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/906664775ace76fcfa941022b5f1ed1… Patch: https://github.com/kamailio/kamailio/commit/906664775ace76fcfa941022b5f1ed1… --- diff --git a/src/modules/ims_auth/doc/ims_auth_admin.xml b/src/modules/ims_auth/doc/ims_auth_admin.xml index 82ec3d721e1..4d7b1dbf85e 100644 --- a/src/modules/ims_auth/doc/ims_auth_admin.xml +++ b/src/modules/ims_auth/doc/ims_auth_admin.xml @@ -690,6 +690,59 @@ route[REG_MAR_REPLY] is kept for backward compatibility, since it was named this way first time but it actually does user authentication.</para> </section> + + <section> + <title><function moreinfo="none">ims_auth_data_set(key, op, op_c, amf)</function></title> + + <para>Set the key, op, op_c and amf to be used for AKAv1-MD5 authentication + when av_mode parameter is set to 1 (authentication vector generated + locally). It has to be used before the function for doing authentication. + </para> + <para> + The parameters can be variables, their values can be retrieved from a backend + (e.g., from database using sqlops module or from a REST API server using + http_client module). + </para> + + <itemizedlist> + <listitem> + <para><emphasis>key</emphasis> - the SIM key</para> + <para><emphasis>op</emphasis> - the operator key (can be empty if op_c is set)</para> + <para><emphasis>op_c</emphasis> - the derived operator key (can be empty if op is set)</para> + <para><emphasis>amf</emphasis> - the amf code</para> + </listitem> + </itemizedlist> + + <para>This function can be used from REQUEST_ROUTE.</para> + + <example> + <title>ims_auth_data_set</title> + + <programlisting format="linespecific"> +... +ims_auth_data_set("...", "...", "...", "..."); +... +</programlisting> + </example> + </section> + + <section> + <title><function moreinfo="none">ims_auth_data_reset()</function></title> + + <para>Reset the authentication attributes when av_mode parameter is set to 1.</para> + <para>This function can be used from REQUEST_ROUTE.</para> + + <example> + <title>ims_auth_data_reset</title> + + <programlisting format="linespecific"> +... +ims_auth_data_reset(); +... +</programlisting> + </example> + </section> + </section> <section>