sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

xml doc changes for clarity - 'auth' config object and auth's 'auth_type' config option 

(issue ASTERISK-22108)
(closes issue ASTERISK-22108)


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@396900 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Rusty Newton 2013-08-17 17:40:34 +00:00
parent 115c078e9d
commit fdfe1ea82e
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
res/res_pjsip.c
View File

@ -623,16 +623,18 @@
<configObject name="auth"> <configObject name="auth">
<synopsis>Authentication type</synopsis> <synopsis>Authentication type</synopsis>
<description><para> <description><para>
Authentication objects hold the authenitcation information for use Authentication objects hold the authentication information for use
by <literal>endpoints</literal>. This also allows for multiple <literal> by other objects such as <literal>endpoints</literal> or <literal>registrations</literal>.
endpoints</literal> to use the same information. Choice of MD5/plaintext This also allows for multiple objects to use a single auth object. See
and setting of username. the <literal>auth_type</literal> config option for password style choices.
</para></description> </para></description>
<configOption name="auth_type" default="userpass"> <configOption name="auth_type" default="userpass">
<synopsis>Authentication type</synopsis> <synopsis>Authentication type</synopsis>
<description><para> <description><para>
This option specifies which of the password style config options should be read, This option specifies which of the password style config options should be read
either 'password' or 'md5_cred' when trying to authenticate an endpoint inbound request. when trying to authenticate an endpoint inbound request. If set to <literal>userpass</literal>
then we'll read from the 'password' option. For <literal>md5</literal> we'll read
from 'md5_cred'.
</para> </para>
<enumlist> <enumlist>
<enum name="md5"/> <enum name="md5"/>