1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Asterisk Project : Application_Authenticate</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
Asterisk Project : Application_Authenticate
</span>
</div>
<div class="pagesubheading">
This page last changed on Mar 30, 2011 by <font color="#0050B2">wikibot</font>.
</div>
<h1><a name="Application_Authenticate-Authenticate%28%29"></a>Authenticate()</h1>
<h3><a name="Application_Authenticate-Synopsis"></a>Synopsis</h3>
<p>Authenticate a user</p>
<h3><a name="Application_Authenticate-Description"></a>Description</h3>
<p>This application asks the caller to enter a given password in order to continue dialplan execution. </p>
<p>If the password begins with the <tt>/</tt> character, it is interpreted as a file which contains a list of valid passwords, listed 1 password per line in the file. </p>
<p>When using a database key, the value associated with the key can be anything. </p>
<p>Users have three attempts to authenticate before the channel is hung up.</p>
<h3><a name="Application_Authenticate-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>Authenticate(password[,options[,maxdigits[,prompt]]])</pre>
</div></div>
<h5><a name="Application_Authenticate-Arguments"></a>Arguments</h5>
<ul>
<li><tt>password</tt> - Password the user should know</li>
<li><tt>options</tt>
<ul>
<li><tt>a</tt> - Set the channels' account code to the password that is entered</li>
<li><tt>d</tt> - Interpret the given path as database key, not a literal file</li>
<li><tt>m</tt> - Interpret the given path as a file which contains a list of account codes and password hashes delimited with <tt>:</tt>, listed one per line in the file. When one of the passwords is matched, the channel will have its account code set to the corresponding account code in the file.</li>
<li><tt>r</tt> - Remove the database key upon successful entry (valid with <tt>d</tt> only)</li>
</ul>
</li>
<li><tt>maxdigits</tt> - maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press the <tt>#</tt> key). Defaults to 0 - no limit - wait for the user press the <tt>#</tt> key.</li>
<li><tt>prompt</tt> - Override the agent-pass prompt file.</li>
</ul>
<h3><a name="Application_Authenticate-SeeAlso"></a>See Also</h3>
<p><a href="Application_VMAuthenticate.html" title="Application_VMAuthenticate">Application_VMAuthenticate</a><br/>
<a href="Application_DISA.html" title="Application_DISA">Application_DISA</a></p>
<h3><a name="Application_Authenticate-ImportVersion"></a>Import Version</h3>
<p>This documentation was imported from Asterisk version SVN-branch-1.8-r311874.</p>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.asterisk.org/wiki/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Oct 04, 2011 12:42</font></td>
</tr>
</table>
</body>
</html>
|
