Module: kamailio
Branch: master
Commit: 7c715fc208848351a711df1b1200dfa767963849
URL: 
https://github.com/kamailio/kamailio/commit/7c715fc208848351a711df1b1200dfa767963849

Author: Daniel-Constantin Mierla <[email protected]>
Committer: Daniel-Constantin Mierla <[email protected]>
Date: 2026-07-01T12:59:03+02:00

auth_xkeys: docs for hmac_engine parameter

---

Modified: src/modules/auth_xkeys/doc/auth_xkeys_admin.xml

---

Diff:  
https://github.com/kamailio/kamailio/commit/7c715fc208848351a711df1b1200dfa767963849.diff
Patch: 
https://github.com/kamailio/kamailio/commit/7c715fc208848351a711df1b1200dfa767963849.patch

---

diff --git a/src/modules/auth_xkeys/doc/auth_xkeys_admin.xml 
b/src/modules/auth_xkeys/doc/auth_xkeys_admin.xml
index dff030c6943..d0a85876125 100644
--- a/src/modules/auth_xkeys/doc/auth_xkeys_admin.xml
+++ b/src/modules/auth_xkeys/doc/auth_xkeys_admin.xml
@@ -137,6 +137,37 @@
 ...
 modparam("auth_xkeys", "xkey", "id=abc;name=xyz;value=secret;expires=72000")
 ...
+</programlisting>
+               </example>
+       </section>
+       <section id="auth_xkeys.p.hmac_engine">
+               <title><varname>hmac_engine</varname> (str)</title>
+               <para>
+                       Specify the module to use for computing HMAC signature. 
Values:
+               </para>
+               <itemizedlist>
+                       <listitem>
+                       <para>
+                               <emphasis>crypto</emphasis>
+                       </para>
+                       </listitem>
+                       <listitem>
+                       <para>
+                               <emphasis>gcrypt</emphasis>
+                       </para>
+                       </listitem>
+               </itemizedlist>
+               <para>
+               <emphasis>
+                       Default value is empty.
+               </emphasis>
+               </para>
+               <example>
+               <title>Set <varname>hmac_engine</varname> parameter</title>
+               <programlisting format="linespecific">
+...
+modparam("auth_xkeys", "hmac_engine", "gcrypt")
+...
 </programlisting>
                </example>
        </section>
@@ -154,7 +185,7 @@ modparam("auth_xkeys", "xkey", 
"id=abc;name=xyz;value=secret;expires=72000")
                include variables.
                </para>
                <para>
-               The algorithm can be: sha256, sha384, sha512.
+               The algorithm can be: sha256, sha384, sha512, hmac-sha256.
                </para>
                <para>
                This function can be used from ANY_ROUTE.
@@ -179,7 +210,7 @@ auth_xkeys_add("X-My-Key", "abc", "sha256", 
"$Ri:$fu:$ru:$hdr(CSeq)");
                of parameter data. The parameters can include variables.
                </para>
                <para>
-               The algorithm can be: sha256, sha384, sha512.
+               The algorithm can be: sha256, sha384, sha512, hmac-sha256.
                </para>
                <para>
                Note that the header is not removed by the function, it is 
recommended
@@ -204,4 +235,3 @@ remove_hf("X-My-Key");
 
        </section>
 </chapter>
-

_______________________________________________
Kamailio - Development Mailing List -- [email protected]
To unsubscribe send an email to [email protected]
Important: keep the mailing list in the recipients, do not reply only to the 
sender!

Reply via email to