Skip to content

UAC_REGISTRANT module enhancements #3783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vladpaiu wants to merge 8 commits into
base: master
Choose a base branch
from
Open

UAC_REGISTRANT module enhancements #3783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
534d827
Add reg_delete and reg_upsert MI commands
vladpaiu Dec 2, 2025
3852ef0
Add E_REGISTRANT REGISTERING/AUTHENTICATING/REGISTERED
vladpaiu Dec 8, 2025
3f85761
Add remaining events for states & refactor code
vladpaiu Dec 9, 2025
fff467a
add linked list delete
vladpaiu Dec 10, 2025
d8b83e2
Increase max number of MI params
vladpaiu Dec 10, 2025
7106cf4
Don't let registrations expire ( if expires < timer_interal, do it no…
vladpaiu Dec 12, 2025
5e45a18
Add reregister_expiry_percentage parameter
vladpaiu Dec 12, 2025
4435eef
Add documentation
vladpaiu Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions lib/sliblist.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,3 +215,35 @@ void slinkedl_list_destroy(slinkedl_list_t *list)
return;
}

int slinkedl_delete(slinkedl_list_t *list, slinkedl_match_f *func, void *data)
{
slinkedl_element_t *prev = NULL;
slinkedl_element_t *element;
int ret = 0;

if (!list || !func)
return 0;

element = list->head;
while (element) {
ret = (*func)(element->data, data, NULL);
if (ret) {
if (prev)
prev->next = element->next;
else
list->head = element->next;

/* fix tail if we removed the last element */
if (element == list->tail)
list->tail = prev;

list->dealloc(element);
return ret;
}

prev = element;
element = element->next;
}

return 0; /* not found */
}
12 changes: 12 additions & 0 deletions lib/sliblist.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,18 @@ int slinkedl_replace(slinkedl_list_t *list, slinkedl_match_f match,
*/
void *slinkedl_peek(slinkedl_list_t *list);

/**
* Delete from the list the first element that matches is found
*
* @psram lit The list to traverse.
* @param match_func The function used for matching the list element to delete
* @param data The data to be used by run_data function.
* @return The return code from last match_func call.
* @see slinkedl_match_f()
*/
int slinkedl_delete(slinkedl_list_t *list, slinkedl_match_f *match_func, void *data);


/**
* Destroy the list.
* Any element in the list will be silently destroyed.
Expand Down
2 changes: 1 addition & 1 deletion mi/mi.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
#include "../str.h"
#include "item.h"

#define MAX_MI_PARAMS 10
#define MAX_MI_PARAMS 20
#define MAX_MI_RECIPES 48

/* async MI command */
Expand Down
285 changes: 285 additions & 0 deletions modules/uac_registrant/doc/uac_registrant_admin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,6 +521,26 @@ modparam("uac_registrant", "state_column", "status")
</example>
</section>

<section id="param_reregister_expiry_percentage" xreflabel="reregister_expiry_percentage">
<title><varname>reregister_expiry_percentage</varname> (integer)</title>
<para>
Percentage describing how much sooner a RE-REGISTER needs to be send based on the Expiry. a 100 value means the RE-REGISTER will be send right on the edge of expiry ( old behavior ), which might lead to registration loss. a 90 value means the RE-REGISTER will be sent sooner , at 90% of the Expiry, etc.
</para>
<para>
<emphasis>
Default value is <quote>100</quote>.
</emphasis>
</para>
<example>
<title>Set <quote>reregister_expiry_percentage</quote> parameter</title>
<programlisting format="linespecific">
...
modparam("uac_registrant", "reregister_expiry_percentage", 90)
...
</programlisting>
</example>
</section>

</section>

<section id="exported_functions" xreflabel="exported_functions">
Expand Down Expand Up @@ -687,6 +707,271 @@ opensips-cli -x mi reg_force_register sip:alice@opensips.org sip:alice@127.0.0.
</programlisting>
</section>

<section id="mi_reg_upsert" xreflabel="reg_upsert">
<title><function moreinfo="none">reg_upsert</function></title>
<para>Inserts or updates the in-memory contents of the AOR/Contact/Registrar. No Database queries are done when calling this MI command, all parameters are passed via MI </para>
<para>Name: <emphasis>reg_upsert</emphasis></para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - URI defining the address
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - Contact URI
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - URI pointing to the remote registrar
</para></listitem>
<listitem><para>
<emphasis>proxy</emphasis> - URI of a registration proxy
</para></listitem>
<listitem><para>
<emphasis>third_party_registrant</emphasis> - 3rd party registrant
</para></listitem>
<listitem><para>
<emphasis>username</emphasis> - the username for auth purposes
</para></listitem>

<listitem><para>
<emphasis>password</emphasis> - the password for auth purposes
</para></listitem>
<listitem><para>
<emphasis>binding_params</emphasis> - params to be added to the registration
</para></listitem>
<listitem><para>
<emphasis>expiry</emphasis> - number of seconds that the registration will be valid
</para></listitem>
<listitem><para>
<emphasis>forced_socket</emphasis> - opensips socket to send out the register out through
</para></listitem>
<listitem><para>
<emphasis>cluster_shtag</emphasis> - the sharing tag for this registration
</para></listitem>
<listitem><para>
<emphasis>state</emphasis> - 0 for enabled, 1 for disabled
</para></listitem>
</itemizedlist>
<para>MI FIFO Command Format:</para>
<programlisting format="linespecific">
opensips-cli -x mi reg_upsert aor=sip:vlad@test.com contact=sip:test@localhost registrar=sip:127.0.0.1:5061 proxy="" third_party_registrant="" username="vlad" password="1234" binding_params="" expiry=60 forced_socket="" cluster_shtag="" state=0
</programlisting>
</section>

<section id="mi_reg_delete" xreflabel="reg_delete">
<title><function moreinfo="none">reg_delete</function></title>
<para>Deletes the in-memory contents of the AOR/Contact/Registrar. No Database queries are done when calling this MI command, all parameters are passed via MI </para>
<para>Name: <emphasis>reg_delete</emphasis></para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - URI defining the address
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - Contact URI
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - URI pointing to the remote registrar
</para></listitem>
</itemizedlist>
<para>MI FIFO Command Format:</para>
<programlisting format="linespecific">
opensips-cli -x mi reg_delete aor=sip:vlad@test.com contact=sip:test@localhost registrar=sip:127.0.0.1:5061
</programlisting>
</section>

</section>

<section id="exported_events" xreflabel="Exported Events">
<title>Exported Events</title>
<section id="event_E_REGISTRANT_REGISTERING" xreflabel="E_REGISTRANT_REGISTERING">
<title>
<function moreinfo="none">E_REGISTRANT_REGISTERING</function>
</title>
<para>
This event is raised when the module sent the initial REGISTER and started the registration process.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - the AOR
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - the Contact
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - the Registrar
</para></listitem>
</itemizedlist>
</section>

<section id="event_E_REGISTRANT_AUTHENTICATING" xreflabel="E_REGISTRANT_AUTHENTICATING">
<title>
<function moreinfo="none">E_REGISTRANT_AUTHENTICATING</function>
</title>
<para>
This event is raised when the initial REGISTER has been challenged and a new REGISTER with credentials has been sent out.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - the AOR
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - the Contact
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - the Registrar
</para></listitem>
</itemizedlist>
</section>

<section id="event_E_REGISTRANT_REGISTERED" xreflabel="E_REGISTRANT_REGISTERED">
<title>
<function moreinfo="none">E_REGISTRANT_REGISTERED</function>
</title>
<para>
This event is raised when a REGISTER has been 200 OKd.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - the AOR
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - the Contact
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - the Registrar
</para></listitem>
</itemizedlist>
</section>

<section id="event_E_REGISTRANT_REGISTER_TIMEOUT" xreflabel="E_REGISTRANT_REGISTER_TIMEOUT">
<title>
<function moreinfo="none">E_REGISTRANT_REGISTER_TIMEOUT</function>
</title>
<para>
This event is raised when a REGISTER received no reply from the registrar.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - the AOR
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - the Contact
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - the Registrar
</para></listitem>
</itemizedlist>
</section>

<section id="event_E_REGISTRANT_INTERNAL_ERROR" xreflabel="E_REGISTRANT_INTERNAL_ERROR">
<title>
<function moreinfo="none">E_REGISTRANT_INTERNAL_ERROR</function>
</title>
<para>
This event is raised when a REGISTER procesing was stopped due to an internal OpenSIPS error.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - the AOR
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - the Contact
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - the Registrar
</para></listitem>
</itemizedlist>
</section>

<section id="event_E_REGISTRANT_WRONG_CREDENTIALS" xreflabel="E_REGISTRANT_WRONG_CREDENTIALS">
<title>
<function moreinfo="none">E_REGISTRANT_WRONG_CREDENTIALS</function>
</title>
<para>
This event is raised when a REGISTER with credentials was still rejected by the registrar
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - the AOR
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - the Contact
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - the Registrar
</para></listitem>
</itemizedlist>
</section>

<section id="event_E_REGISTRANT_REGISTRAR_EROR" xreflabel="E_REGISTRANT_REGISTRAR_ERROR">
<title>
<function moreinfo="none">E_REGISTRANT_REGISTRAR_ERROR</function>
</title>
<para>
This event is raised when a REGISTER is rejected by the registrar with a non-standard sip code.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - the AOR
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - the Contact
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - the Registrar
</para></listitem>
</itemizedlist>
</section>

<section id="event_E_REGISTRANT_UNREGISTERING" xreflabel="E_REGISTRANT_UNREGISTERING">
<title>
<function moreinfo="none">E_REGISTRANT_UNREGISTERING</function>
</title>
<para>
This event is raised when a de-REGISTER is sent by OpenSIPS.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - the AOR
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - the Contact
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - the Registrar
</para></listitem>
</itemizedlist>
</section>

<section id="event_E_REGISTRANT_AUTHENTICATING_UNREGISTER" xreflabel="E_REGISTRANT_AUTHENTICATING_UNREGISTER">
<title>
<function moreinfo="none">E_REGISTRANT_AUTHENTICATING_UNREGISTER</function>
</title>
<para>
This event is raised when a de-REGISTER is challenged and auth is sent by OpenSIPS.
</para>
<para>Parameters:</para>
<itemizedlist>
<listitem><para>
<emphasis>aor</emphasis> - the AOR
</para></listitem>
<listitem><para>
<emphasis>contact</emphasis> - the Contact
</para></listitem>
<listitem><para>
<emphasis>registrar</emphasis> - the Registrar
</para></listitem>
</itemizedlist>
</section>

</section>
</chapter>

Loading
Loading