<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2023"><meta name="DC.rights.owner" content="(C) Copyright 2023"><meta name="DC.type" content="topic"><meta name="prodname" content="All Mediatrix Products"><meta name="version" content="DGW 49.12.28842941"><meta name="platform" content="All"><meta name="DC.date.modified" content="2023-0308-2809"><meta name="DC.date.issued" content="2023-0308-2809"><meta name="DC.date.available" content="2023-0308-2809"><meta name="ChapterNumbering" content="no"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="topic_title_Basic_Concepts_d1e15"><link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/62825785/commonltr.css"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/62825785/custom.css"><title>SIP Authentication</title></head><body class="nobody"><header role="banner"><div class="topicmeta title">SIP Authentication</div><div class="topicmeta date">2023-0308-28<09</div><div class="topicmeta product">All Mediatrix Products</div><div class="topicmeta version">DGW 49.12.2884<2941</div><div class="topicmeta pdf"><a href="https://documentation.media5corp.com/download/attachments/62825785/SIP%20Authentication.pdf" rel="nofollow">Download PDF Document</a></div><hr><span style="float: inline-end;"></span></header><nav role="toc"><ul><li><a href="#topic_title_Basic_Concepts_d1e15">Basic Concepts</a><ul><li><a href="#concept_sth_tpv_qfb">SIP Authentication</a></li><li><a href="#reference_lcc_c5v_qfb">Important Information To Know before Using Sip Authentication</a></li><li><a href="#concept_l4y_5y5_5fb">Authentication Table Entries - Order is Important</a></li></ul></li><li><a href="#topic_title_Basic_Tasks_d1e19">Basic Tasks</a><ul><li><a href="#task_ukc_zc1_bq">Defining Authentication Credentials for a Gateway</a></li><li><a href="#task_mwl_mn5_1q">Defining Authentication Credentials for an Endpoint</a></li><li><a href="#task_xgv_xh5_1q">Defining Authentication Credentials for the Unit</a></li><li><a href="#task_pjn_s21_bq">Defining Authentication Credentials for a Username </a></li><li><a href="#task_blz_4m5_1q">Selecting the Priority Level of an Authentication</a></li><li><a href="#task_rj1_f34_pkb">Erasing Authentication Credentials</a></li></ul></li><li><a href="#reference_j4g_nbv_gfb">Online Help</a></li><li><a href="#concept_v4k_q3h_1r">DGW Documentation</a></li><li><a href="#concept_fqm_rv4_k4">Copyright Notice</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="nested0" aria-labelledby="ariaid-title1" id="topic_title_Basic_Concepts_d1e15">
<h1 class="title topictitle1" id="ariaid-title1">Basic Concepts</h1>
<article class="topic concept nested1" aria-labelledby="ariaid-title2" id="concept_sth_tpv_qfb">
<h2 class="title topictitle2" id="ariaid-title2">SIP Authentication</h2>
<div class="body conbody"><p class="shortdesc">SIP authentication is a security feature that allows a SIP server to validate the
authenticity of the sender, and to accept only the requests when they have the proper
credentials. </p>
<p class="p">To authenticate a SIP request, the server issues an authentication challenge to which the SIP
client must respond with the proper username/password credentials. The Mediatrix unit can be
configured with the authentication information needed to respond to the authentication
challenges issued by SIP servers. </p>
<p class="p">The authentication information is configured in the <span class="keyword wintitle">Authentication</span> table. Each entry of the
table has a <span class="keyword wintitle">Criteria</span> and a <span class="keyword wintitle">Realm</span>, if it is enabled, that define when it
is appropriate to use this entry. </p>
<div class="p">There are 4 criteria categories: <ul class="ul" id="concept_sth_tpv_qfb__ul_yqf_z5t_wfb">
<li class="li"><span class="keyword wintitle">endpoint-specific: </span>Applies only to challenges received for SIP
requests related to a specific endpoint. For instance, the registration associated with
the endpoint in the user agent table or the INVITE sent to initiate a call from the
endpoint.</li>
<li class="li"><span class="keyword wintitle">gateway-specific</span>: Applies only to challenges received for SIP
requests on a specific SIP gateway. </li>
<li class="li"><span class="keyword wintitle">user-name specific</span>: Applies only to challenges for a context that
uses a specific user name.</li>
<li class="li"><span class="keyword wintitle">global to the whole unit:</span> Applies to all challenges received for
SIP dialogs. The defined user names and passwords will apply to all the endpoints of the
unit. </li>
</ul></div>
<div class="note important note_important"><span class="note__title">IMPORTANT:</span> If authentication credentials are required for several realms, create a
separate table entry for reach realm.</div>
<p class="p">The <span class="keyword wintitle">Authentication</span> table may have
between 20 and 100 rows. If you have less than 20 rows, the Mediatrix unit automatically adds
new rows up to the minimum of 20.</p>
<div class="p">When a challenge occurs (either 401 Unauthorized or 407 Proxy Authentication Required), the
first entry in the <span class="keyword wintitle">Authentication</span>
table having a criteria that matches the challenge is used to reply to the challenge. The
username and password of a criteria can be configured in the Web interface in the <span class="keyword wintitle">SIP</span>/<span class="keyword wintitle">Authentication</span>/ <span class="keyword wintitle">Authentication</span> table. The entries of the
<span class="keyword wintitle">Authentication</span> table are tried
from the first row to the last row. To have a match, the realm in the <span class="keyword wintitle">Authentication</span> table entry must match the
realm in the challenge or the <span class="keyword wintitle">Validate Realm</span> field of the entry must be set
to <span class="keyword wintitle">Disable</span>. For each entry matching
certain criteria (described below), the challenge is replied with the entry's user name and
password. If authentication fails, the SIP server may issue another authentication challenge,
provided it has been configured to do so. (Because of the increased risks of hacking, servers
usually give only a single chance). In that case, the next entry in the table having a
matching criteria is used to reply to this new challenge. This can be repeated until no more
matching entry is found. If no entry matches the criteria, the authentication fails. To match
the authentication request, the entry must also meet one of the following criteria: <ul class="ul" id="concept_sth_tpv_qfb__ul_lfb_sxt_wfb">
<li class="li"> The challenge needs to be for a SIP request related to the endpoint specified in the
<span class="keyword wintitle">Endpoint</span> column if the
corresponding <span class="keyword wintitle">Criteria</span> column is
set to <span class="keyword wintitle">Endpoint</span>. </li>
<li class="li">The challenge needs to be for a SIP request performed on the SIP gateway specified in
the <span class="keyword wintitle">Gateway</span> column if the
corresponding <span class="keyword wintitle">Criteria</span> column is
set to <span class="keyword wintitle">Gateway</span>.</li>
<li class="li">The challenge needs to be for a context that uses the user name specified in the
<span class="keyword wintitle">User Name</span> field if the
corresponding <span class="keyword wintitle">Criteria</span> column is
set to <span class="keyword wintitle">username</span>. The
user name associated with a context is: <ul class="ul" id="concept_sth_tpv_qfb__ul_tyg_vxt_wfb">
<li class="li">the user name of the FROM if the context sent the original SIP request, or</li>
<li class="li">the user name of the request URI if the context received the original SIP
request</li>
</ul></li>
<li class="li">The challenge applies to a unit if the corresponding <span class="keyword wintitle">Criteria</span> column is set to <span class="keyword wintitle">Unit</span>.</li>
</ul></div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested1" aria-labelledby="ariaid-title3" id="reference_lcc_c5v_qfb">
<h2 class="title topictitle2" id="ariaid-title3">Important Information To Know before Using Sip Authentication</h2>
<div class="body refbody">
<section class="section"><h3 class="title sectiontitle">Access Rights</h3> The <span class="keyword wintitle">SIP</span> /<span class="keyword wintitle">Authentication</span> page is not accessible if you
have the User or Observer access right.</section>
<section class="section"><h3 class="title sectiontitle">Naming </h3>The SIP username (i.e. the one in the username criteria) is
checked against SIP username syntax of RFC3261.</section>
<section class="section"><h3 class="title sectiontitle">Authentication</h3>The <span class="keyword wintitle">Authentication</span> table (under <span class="keyword wintitle">SIP</span> /<span class="keyword wintitle">Authentication</span>) may have between 20 and 100
rows. If you have less than 20 rows, the Mediatrix unit automatically adds new rows up to the
minimum of 20.</section>
<section class="section"><h3 class="title sectiontitle">Authentication Order</h3>The order of the tried entries in the <span class="keyword wintitle">SIP</span>/<span class="keyword wintitle">Authentication</span> table is from the first row
to the last row. The row sequence is important. Refer to <a class="xref" href="#concept_l4y_5y5_5fb" title="The priority of an entry in the Authentication table is important. The most specific authentication credential must be set before the more generic ones, otherwise the challenges will be responded with the generic credentials rather than the specific ones. If authentication fails with the credentials found in the Authentication table, the SIP server may issue another authentication challenge. In that case, the next entry in the table having a matching criteria is used to reply to this new challenge. This can be repeated until no more matching entry is found.">Authentication Table Entries - Order is Important</a> .</section>
<section class="section"><h3 class="title sectiontitle">Endpoint Authentication </h3>
<ul class="ul" id="reference_lcc_c5v_qfb__ul_onx_cbx_qfb">
<li class="li">Several usernames/passwords can be defined for a single Endpoint.</li>
<li class="li">Endpoint Authentication can be defined for all types of endpoints i.e.
E1T1/FXS/FXO/BRI/PRI. </li>
</ul>
</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested1" aria-labelledby="ariaid-title4" id="concept_l4y_5y5_5fb">
<h2 class="title topictitle2" id="ariaid-title4">Authentication Table Entries - Order is Important</h2>
<div class="body conbody"><p class="shortdesc">The priority of an entry in the <span class="keyword wintitle">Authentication</span> table is important. The most
specific authentication credential must be set before the more generic ones, otherwise the
challenges will be responded with the generic credentials rather than the specific ones. If
authentication fails with the credentials found in the <span class="keyword wintitle">Authentication</span> table, the SIP server may issue
another authentication challenge. In that case, the next entry in the table having a matching
criteria is used to reply to this new challenge. This can be repeated until no more matching
entry is found.</p>
<div class="p">For example <br><img class="image" id="concept_l4y_5y5_5fb__image_p3g_m1v_5fb" src="https://documentation.media5corp.com/download/attachments/62825785/example.png" width="800"><br></div>
<div class="p">
<ul class="ul" id="concept_l4y_5y5_5fb__ul_qcp_rmk_yfb">
<li class="li">Three gateways are defined in the <span class="keyword wintitle">Gateway</span> table (under <span class="keyword wintitle">SIP</span>/<span class="keyword wintitle">Gateways</span>)<ul class="ul" id="concept_l4y_5y5_5fb__ul_ezy_smk_yfb">
<li class="li"><span class="keyword wintitle">gateway_1</span></li>
<li class="li"><span class="keyword wintitle">gateway_2</span></li>
<li class="li"><span class="keyword wintitle">gateway_3</span></li>
</ul></li>
<li class="li">The unit has 4 endpoints: <ul class="ul" id="concept_l4y_5y5_5fb__ul_ogr_5mk_yfb">
<li class="li"><span class="keyword wintitle">Slot4/FXS1</span></li>
<li class="li"><span class="keyword wintitle">Slot4/FXS2</span></li>
<li class="li"><span class="keyword wintitle">Slot4/FXS3</span></li>
<li class="li"><span class="keyword wintitle">Slot4/FXS4</span></li>
</ul></li>
<li class="li">The SIP requests related to <span class="keyword wintitle">Slot4/FXS1</span>, <span class="keyword wintitle">Slot4/FXS3</span>, and<span class="keyword wintitle">Slot4/FXS4</span> are sent via <span class="keyword wintitle">gateway_2</span></li>
<li class="li">The SIP requests related to <span class="keyword wintitle">Slot4/FXS2</span> are sent via <span class="keyword wintitle">gateway_3</span></li>
</ul>
</div>
<table class="table frame-all" id="concept_l4y_5y5_5fb__table_yrx_zmk_yfb"><caption><span class="table--title-label">Table 1. </span><span class="title">Scenario 1</span></caption><colgroup><col style="width:19.493177387914233%"><col style="width:80.50682261208577%"></colgroup><thead class="thead">
<tr class="row">
<th class="entry colsep-1 rowsep-1" id="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__1">Step</th>
<th class="entry colsep-1 rowsep-1" id="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__2">Description</th>
</tr>
</thead><tbody class="tbody">
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__1">1</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__2">Endpoint <span class="keyword wintitle">Slot4/FXS3</span>
needs to register to the SIP server.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__1">2</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__2">A SIP REGISTER request is sent to the SIP server.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__1">3</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__2">The SIP server must authenticate the request, so it challenges the request with a
<span class="keyword wintitle">401 Unauthorized</span> challenge
response.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__1">4</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__2">Upon reception of this challenge, the Mediatrix unit searches the <span class="keyword wintitle">Authentication</span> table to find the
first matching <span class="keyword wintitle">Criteria</span>
entry.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__1">5</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__2">Entry #1 of the <span class="keyword wintitle">Authentication</span> table has a <span class="keyword wintitle">Criteria</span> that matches endpoint
<span class="keyword wintitle">Slot4/FXS1</span>, but because the
REGISTER was issued for <span class="keyword wintitle">Slot4/FXS3</span>, the match fails.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__1">6</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__2">Entry #2 of the <span class="keyword wintitle">Authentication</span> table has a <span class="keyword wintitle">Criteria</span> that matches endpoint
<span class="keyword wintitle">Slot4/FXS3</span> and because the
REGISTER was issued for <span class="keyword wintitle">Slot4/FXS3</span>, the match succeeds, and
the credentials of this entry are used to respond to the challenge.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__1">7</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_yrx_zmk_yfb__entry__2">If the credentials configured in entry #2 are good, the SIP server accepts to
handle the REGISTER request.</td>
</tr>
</tbody></table>
<table class="table frame-all" id="concept_l4y_5y5_5fb__table_h1y_vnk_yfb"><caption><span class="table--title-label">Table 2. </span><span class="title">Scenario 2</span></caption><colgroup><col style="width:17.98561151079137%"><col style="width:82.01438848920863%"></colgroup><thead class="thead">
<tr class="row">
<th class="entry colsep-1 rowsep-1" id="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__1">Step</th>
<th class="entry colsep-1 rowsep-1" id="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__2">Description</th>
</tr>
</thead><tbody class="tbody">
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__1">1</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__2">Endpoint <span class="keyword wintitle">Slot4/FXS4</span> must
register to the SIP server.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__1">2</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__2">A SIP REGISTER request is sent to the SIP server.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__1">3</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__2">The SIP server must authenticate the request, so it challenges the request with a
<span class="keyword wintitle">401 Unauthorized</span> challenge
response.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__1">4</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__2">Upon reception of this challenge, the Mediatrix unit searches the <span class="keyword wintitle">Authentication</span> table to find the
first matching <span class="keyword wintitle">Criteria</span>
entry.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__1">5</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__2">Entry #1 of the <span class="keyword wintitle">Authentication</span> table has a <span class="keyword wintitle">Criteria</span> to match endpoint <span class="keyword wintitle">Slot4/FXS1</span> but because the REGISTER
was issued for <span class="keyword wintitle">Slot4/FXS4</span>,
the match fails.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__1">6</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__2">Entry #2 of the <span class="keyword wintitle">Authentication</span> table has a <span class="keyword wintitle">Criteria</span> to match endpoint <span class="keyword wintitle">Slot4/FXS3</span> but because the REGISTER
was issued for <span class="keyword wintitle">Slot4/FXS4</span>,
the match fails.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__1">7</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__2">Entry #3 of the <span class="keyword wintitle">Authentication</span> table has a <span class="keyword wintitle">Criteria</span> to match gateway <span class="keyword wintitle">gateway_1</span> but because the REGISTER
was issued via <span class="keyword wintitle">gateway_2</span>, the
match fails.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__1">8</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__2">Entry #4 of the <span class="keyword wintitle">Authentication</span> table has a <span class="keyword wintitle">Criteria</span> to match <span class="keyword wintitle">gateway_2</span> and because the REGISTER
was issued via <span class="keyword wintitle">gateway_2</span>, the
match succeeds, and the credentials of this entry are used to respond to the
challenge.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__1">9</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_h1y_vnk_yfb__entry__2">If the credentials configured in entry #4 are good, the SIP server accepts to
handle the REGISTER request.</td>
</tr>
</tbody></table>
<table class="table frame-all" id="concept_l4y_5y5_5fb__table_bsj_q4k_yfb"><caption><span class="table--title-label">Table 3. </span><span class="title">Scenario 3</span></caption><colgroup><col style="width:17.513134851138354%"><col style="width:82.48686514886164%"></colgroup><thead class="thead">
<tr class="row">
<th class="entry colsep-1 rowsep-1" id="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">Step</th>
<th class="entry colsep-1 rowsep-1" id="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">Description</th>
</tr>
</thead><tbody class="tbody">
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">1</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">Endpoint <span class="keyword wintitle">Slot4/FXS2</span> must
register to the SIP server.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">2</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">A SIP REGISTER request is sent to the SIP server.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">3</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">The SIP server must authenticate the request, so it challenges the request with a
<span class="keyword wintitle">401 Unauthorized</span> challenge
response.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">4</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">Upon reception of this challenge, the Mediatrix unit searches the <span class="keyword wintitle">Authentication</span> table to find the
first matching <span class="keyword wintitle">Criteria</span>
entry.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">5</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">Entry #1 of the <span class="keyword wintitle">Authentication</span> table has a <span class="keyword wintitle">Criteria</span> to match endpoint <span class="keyword wintitle">Slot4/FXS1</span>, but because the REGISTER
was issued for <span class="keyword wintitle">Slot4/FXS2</span>,
the match fails.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">6</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">Entry #2 of the <span class="keyword wintitle">Authentication</span> table has a <span class="keyword wintitle">Criteria</span> to match endpoint <span class="keyword wintitle">Slot4/FXS3</span>, but because the REGISTER
was issued for <span class="keyword wintitle">Slot4/FXS2</span>,
the match fails.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">7</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">Entry #3 of the <span class="keyword wintitle">Authentication</span> table has a <span class="keyword wintitle">Criteria</span> to match gateway <span class="keyword wintitle">gateway_1</span>, but because the REGISTER
was issued via <span class="keyword wintitle">gateway_3</span>, the
match fails.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">8</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">Entry #4 of the <span class="keyword wintitle">Authentication</span> table has a criteria
to match gateway <span class="keyword wintitle">gateway_2</span>,
but because the REGISTER was issued via <span class="keyword wintitle">gateway_3</span>, the match fails.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">9</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">Entry #5 of the <span class="keyword wintitle">Authentication</span> table has a criteria
to match the whole unit, so the match succeeds, and the credentials of this entry are
used to respond to the challenge.</td>
</tr>
<tr class="row">
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__1">10</td>
<td class="entry colsep-1 rowsep-1" headers="concept_l4y_5y5_5fb__table_bsj_q4k_yfb__entry__2">If the credentials configured in entry #5 are good, the SIP server accepts to
handle the REGISTER request.</td>
</tr>
</tbody></table>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic nested0 nobody" aria-labelledby="ariaid-title5" id="topic_title_Basic_Tasks_d1e19">
<h1 class="title topictitle1" id="ariaid-title5">Basic Tasks</h1>
<article class="topic task nested1" aria-labelledby="ariaid-title6" id="task_ukc_zc1_bq">
<h2 class="title topictitle2" id="ariaid-title6">Defining Authentication Credentials for a Gateway</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div><ul class="ul" id="task_ukc_zc1_bq__ul_stn_wm1_bq">
<li class="li">Administrator access rights are required to access this page.</li>
<li class="li">The <span class="keyword wintitle">Mediatrix</span> unit can
support up to 5 gateways.</li>
</ul></section>
<section id="task_ukc_zc1_bq__steps_jgj_sn5_1q"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_ukc_zc1_bq__steps_jgj_sn5_1q"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SIP</span>/<span class="keyword wintitle">Authentication</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="task_ukc_zc1_bq__image_imq_vxv_qfb" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="15"> located on the first row.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> By default, 20 unconfigured entries are included in the <span class="keyword wintitle">Authentication</span> table. If
the first 20 entries are configured, click <img class="image" id="task_ukc_zc1_bq__image_vth_xyw_qfb" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg" width="15">, to
add a new row at the bottom of the table. </div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Authentication</span>
table, from the <span class="keyword wintitle">Criteria</span> selection list, select <span class="keyword wintitle">Gateway</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Gateway</span>
selection list, select a gateway. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Enter a password and username for the gateway.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> You can optionally enable realm validation, if needed.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The username and password will be used to respond to authentication challenges
received for SIP requests related to the gateway specified in the <span class="keyword wintitle">Gateway</span> column. If they do not match
the specified credentials, the communication will fail. <br><img class="image" id="task_ukc_zc1_bq__image_tyg_25w_qfb" src="https://documentation.media5corp.com/download/attachments/62825785/Authentication_gateway.png" width="800"><br></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title7" id="task_mwl_mn5_1q">
<h2 class="title topictitle2" id="ariaid-title7">Defining Authentication Credentials for an Endpoint</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>You will not be able to access this page is you have a User or Observer access
right.</section>
<section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>If different usernames/passwords are needed for different realms, use multiple
table entries. </section>
<section id="task_mwl_mn5_1q__steps_jgj_sn5_1q"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_mwl_mn5_1q__steps_jgj_sn5_1q"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SIP</span>/<span class="keyword wintitle">Authentication</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> By default, 20 unconfigured entries are included in the <span class="keyword wintitle">Authentication</span> table. If
the first 20 entries are configured, click <img class="image" id="task_mwl_mn5_1q__image_vth_xyw_qfb" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg" width="15">, to
add a new row at the bottom of the table. </div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Edit</span> located on
the first row.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Criteria</span>
selection list, select <span class="keyword wintitle">Endpoint</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Endpoint</span>
selection list, select an endpoint. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Enter a password and username for the endpoint.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> You can optionally enable realm validation, if needed.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> or
<span class="keyword wintitle">Apply and Refresh
Registration</span>
</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The username and password will be used to respond to authentication challenges
received for SIP requests related to the endpoint specified in the <span class="keyword wintitle">Endpoint</span> column. If they do not
match the specified credentials, the communication will fail. <br><img class="image" id="task_mwl_mn5_1q__image_bbb_dww_qfb" src="https://documentation.media5corp.com/download/attachments/62825785/Authentication_Endpoint_generic.png" width="800"><br></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title8" id="task_xgv_xh5_1q">
<h2 class="title topictitle2" id="ariaid-title8">Defining Authentication Credentials for the Unit</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div><ul class="ul" id="task_xgv_xh5_1q__ul_n55_zm1_bq">
<li class="li">You will not be able to access this page if you have a User or Observer access
right.</li>
<li class="li">The challenge applies to a unit if the corresponding <span class="keyword wintitle">Criteria</span> column is set to
<span class="keyword wintitle">Unit</span>.</li>
</ul></section>
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SIP</span>/<span class="keyword wintitle">Authentication</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> By default, 20 unconfigured entries are included in the <span class="keyword wintitle">Authentication</span> table. If
the first 20 entries are configured, click <img class="image" id="task_xgv_xh5_1q__image_vth_xyw_qfb" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg" width="15">, to
add a new row at the bottom of the table. </div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Edit</span> located on
the first row.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Criteria</span>
selection list, select <span class="keyword wintitle">Unit</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Enter a password and username for the unit.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> You can optionally enable realm validation, if needed.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> or
<span class="keyword wintitle">Apply and Refresh
Registration</span>
</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The username and password will be used to respond to authentication challenges
received for SIP requests related to any gateway or endpoint of the unit. If they do not
match the specified credentials, the communication will fail. <br><img class="image" id="task_xgv_xh5_1q__image_y5x_mww_qfb" src="https://documentation.media5corp.com/download/attachments/62825785/Authentication_Unit.png" width="800"><br>
</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title9" id="task_pjn_s21_bq">
<h2 class="title topictitle2" id="ariaid-title9">Defining Authentication Credentials for a Username </h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>You will not be able to access this page is you have a User or Observer access
right.</section>
<section id="task_pjn_s21_bq__steps_jgj_sn5_1q"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_pjn_s21_bq__steps_jgj_sn5_1q"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SIP</span>/<span class="keyword wintitle">Authentication</span>.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> By default, 20 unconfigured entries are included in the <span class="keyword wintitle">Authentication</span> table. If
the first 20 entries are configured, click <img class="image" id="task_pjn_s21_bq__image_vth_xyw_qfb" src="https://documentation.media5corp.com/download/attachments/62825785/Plusbleu.jpg" width="15">, to
add a new row at the bottom of the table. </div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <img class="image" id="task_pjn_s21_bq__image_ikr_tyv_qfb" src="https://documentation.media5corp.com/download/attachments/62825785/pencilbleu.jpg" width="15"> located on the first row.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">From the <span class="keyword wintitle">Criteria</span>
selection list, select <span class="keyword wintitle">User Name</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">In the <span class="keyword wintitle">Username Criteria</span>, enter the name of a username. </span>
</li><li class="li step stepexpand">
<span class="ph cmd">Enter a password and username for the username.</span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> You can optionally enable realm validation, if needed.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> or
<span class="keyword wintitle">Apply and Refresh
Registration</span>
</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The username and password will be used to respond to authentication challenges
received for SIP requests related to a specific username. If they do not match the
specified credentials, the communication will fail. <br><img class="image" id="task_pjn_s21_bq__image_abg_kxw_qfb" src="https://documentation.media5corp.com/download/attachments/62825785/Authentication_UserName.png" width="800"><br></section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title10" id="task_blz_4m5_1q">
<h2 class="title topictitle2" id="ariaid-title10">Selecting the Priority Level of an Authentication</h2>
<div class="body taskbody">
<section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
<span class="ph cmd">Go to <span class="keyword wintitle">SIP</span>/<span class="keyword wintitle">Authentication</span>.</span>
</li><li class="li step stepexpand">
<span class="ph cmd">Use the arrows to move an authentication entry up or down the table. </span>
<div class="itemgroup info">
<div class="note note note_note"><span class="note__title">Note:</span> Search is performed from the first entry of the table down to the
last.</div>
</div>
</li><li class="li step stepexpand">
<span class="ph cmd">Click <span class="keyword wintitle">Apply</span> or
<span class="keyword wintitle">Apply and Refresh
Registration</span></span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The Authentication table will be searched in the selected order to find which
credentials to use.</section>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title11" id="task_rj1_f34_pkb">
<h2 class="title topictitle2" id="ariaid-title11">Erasing Authentication Credentials</h2>
<div class="body taskbody">
<section class="section prereq"><div class="tasklabel"><strong class="sectiontitle tasklabel">Before you begin</strong></div>Administrator access rights are required to access this page.</section>
<section id="task_rj1_f34_pkb__steps_rry_334_pkb"><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps" id="task_rj1_f34_pkb__steps_rry_334_pkb"><li class="li step">
<span class="ph cmd">Go to <span class="keyword wintitle">SIP</span>/<span class="keyword wintitle">Authentication</span>.</span>
</li><li class="li step">
<span class="ph cmd">Click <img class="image" id="task_rj1_f34_pkb__image_jkw_bj4_pkb" src="https://documentation.media5corp.com/download/attachments/62825785/minus.jpg" width="13">
located at the end of the row containing the credential to erase.</span>
</li><li class="li step">
<span class="ph cmd">Click <span class="keyword wintitle">Refresh Registration</span>.</span>
</li></ol></section>
<section class="section result"><div class="tasklabel"><strong class="sectiontitle tasklabel">Result</strong></div>The entry will be permanently erased from the unit.</section>
</div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested0" aria-labelledby="ariaid-title12" id="reference_j4g_nbv_gfb">
<h1 class="title topictitle1" id="ariaid-title12">Online Help</h1>
<p class="shortdesc"><span class="ph">If you are not familiar with the meaning of the fields and
buttons, click <span class="keyword wintitle">Show Help</span>, located at the upper right corner of
the Web page. When activated, the fields and buttons that offer online help will
change to green and if you hover over them, the description will bedisplayed.</span></p>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title13" id="concept_v4k_q3h_1r">
<h1 class="title topictitle1" id="ariaid-title13">DGW Documentation</h1>
<div class="body conbody"><p class="shortdesc">Mediatrix devices are supplied with an exhaustive set of documentation. </p>
<p class="p">Mediatrix user documentation is available on the <a class="xref" href="http://documentation.media5corp.com" target="_blank">Media5 Documentation
Portal</a>.</p>
<div class="p">Several types of documents were created to clearly present the information you are looking for.
Our documentation includes:<ul class="ul" id="concept_v4k_q3h_1r__ul_bqy_cjh_1r">
<li class="li"><strong class="ph b">Release notes</strong>: Generated at each GA release, this document includes the known and
solved issues of the software. It also outlines the changes and the new features the release
includes.</li>
<li class="li"><strong class="ph b">Configuration notes</strong>: These documents are created to facilitate the configuration of a
specific use case. They address a configuration aspect we consider that most users will need to
perform. However, in some cases, a configuration note is created after receiving a question
from a customer. They provide standard step-by-step procedures detailing the values of the
parameters to use. They provide a means of validation and present some conceptual information.
The configuration notes are specifically created to guide the user through an aspect of the
configuration. </li>
<li class="li"><strong class="ph b">Technical bulletins</strong>: These documents are created to facilitate the configuration of a
specific technical action, such as performing a firmware upgrade.</li>
<li class="li"><strong class="ph b">Hardware installation guide</strong>: They provide the detailed procedure on how to safely and
adequately install the unit. It provides information on card installation, cable connections,
and how to access for the first time the Management interface.</li>
<li class="li"><strong class="ph b">User guide</strong>: The user guide explains how to customise to your needs the configuration
of the unit. Although this document is task oriented, it provides conceptual information to
help the user understand the purpose and impact of each task. The User Guide will provide
information such as where and how TR-069 can be configured in the Management Interface, how to
set firewalls, or how to use the CLI to configure parameters that are not available in the
Management Interface.</li>
<li class="li"><strong class="ph b">Reference guide</strong>: This exhaustive document has been created for advanced users. It
includes a description of all the parameters used by all the services of the Mediatrix units.
You will find, for example, scripts to configure a specific parameter, notification messages
sent by a service, or an action description used to create Rulesets. This document includes
reference information such as a dictionary, and it does not include any step-by-step
procedures. </li>
</ul></div>
</div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title14" id="concept_fqm_rv4_k4">
<h1 class="title topictitle1" id="ariaid-title14">Copyright Notice</h1>
<div class="body conbody"><p class="shortdesc">Copyright © 2023 Media5 Corporation.</p>
<p class="p">This document contains information that is proprietary to Media5 Corporation.</p>
<p class="p">Media5 Corporation reserves all rights to this document as well as to the Intellectual Property
of the document and the technology and know-how that it includes and represents.</p>
<p class="p">This publication cannot be reproduced, neither in whole nor in part, in any form whatsoever,
without written prior approval by Media5 Corporation.</p>
<p class="p">Media5 Corporation reserves the right to revise this publication and make changes at any time
and without the obligation to notify any person and/or entity of such revisions and/or
changes.</p>
</div>
</article></article></main></body></html> |
