[asterisk-doc] r2 - /dsssl/ /en/config/ /en/reference/general/
/en/reference/general/functio...
commits at digium.com
commits at digium.com
Tue May 2 08:34:17 MST 2006
Author: beckman
Date: Tue May 2 10:34:17 2006
New Revision: 2
URL: http://svncommunity.digium.com/view/asterisk-docs?rev=2&view=rev
Log:
Added General reference section
Added Authenticate() documentation
Cleaned up extensions.conf documentation
Added:
en/reference/general/
en/reference/general/functions/
en/reference/general/functions.xml
en/reference/general/functions/authenticate.xml
en/reference/general/reference.xml
Modified:
dsssl/version.dsl
en/config/extensions.xml
entities/builtin-extensions.xml
entities/file-entities.ent
entities/version.ent
Modified: dsssl/version.dsl
URL: http://svncommunity.digium.com/view/asterisk-docs/dsssl/version.dsl?rev=2&r1=1&r2=2&view=diff
==============================================================================
--- dsssl/version.dsl (original)
+++ dsssl/version.dsl Tue May 2 10:34:17 2006
@@ -74,7 +74,7 @@
((equal-ci? (data nl) "Voicemail") (literal "Asterisk 0.x >= 0.8, Asterisk 1.x"))
((equal-ci? (data nl) "Dial") (literal "Asterisk 0.x, Asterisk 1.x"))
((equal-ci? (data nl) "Goto") (literal "Asterisk 0.x, Asterisk 1.x"))
- ((equal-ci? (data nl) "empty") (literal "PHP 3, PHP 4, PHP 5"))
+ ((equal-ci? (data nl) "Authenticate") (literal "Asterisk 0.x, Asterisk 1.x"))
((equal-ci? (data nl) "eval") (literal "PHP 3, PHP 4, PHP 5"))
((equal-ci? (data nl) "exit") (literal "PHP 3, PHP 4, PHP 5"))
((equal-ci? (data nl) "isset") (literal "PHP 3, PHP 4, PHP 5"))
Modified: en/config/extensions.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/config/extensions.xml?rev=2&r1=1&r2=2&view=diff
==============================================================================
--- en/config/extensions.xml (original)
+++ en/config/extensions.xml Tue May 2 10:34:17 2006
@@ -39,10 +39,12 @@
</para>
</sect2>
- <para>
- <example>
- <title>Sample &extensions.conf;</title>
- <programlisting role='astconf'>
+ <sect2 id="category.sample">
+ <title>Sample &extensions.conf;</title>
+ <para>
+ <example>
+ <title>Sample &extensions.conf;</title>
+ <programlisting role='astconf'>
<![CDATA[
;
; Static extension configuration file, used by
@@ -467,7 +469,7 @@
; voicemail, etc.
;
exten => 1234,1,Playback(transfer,skip) ; "Please hold while..."
- ; (but skip if channel is not up)
+ ; (but skip if channel is not up)
exten => 1234,n,Macro(stdexten,1234,${CONSOLE})
exten => 1235,1,Voicemail(u1234) ; Right to voicemail
@@ -612,9 +614,10 @@
; use that particular application in this file, the dial plan.
;
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
+ </para>
+ </sect2>
</sect1>
</chapter>
Added: en/reference/general/functions.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/general/functions.xml?rev=2&view=auto
==============================================================================
--- en/reference/general/functions.xml (added)
+++ en/reference/general/functions.xml Tue May 2 10:34:17 2006
@@ -1,0 +1,1 @@
+&reference.general.functions.authenticate;
Added: en/reference/general/functions/authenticate.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/general/functions/authenticate.xml?rev=2&view=auto
==============================================================================
--- en/reference/general/functions/authenticate.xml (added)
+++ en/reference/general/functions/authenticate.xml Tue May 2 10:34:17 2006
@@ -1,0 +1,142 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.20 $ -->
+ <refentry id="function.authenticate">
+ <refnamediv>
+ <refname>Authenticate</refname>
+ <refpurpose>
+ Authenticate a user
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <methodsynopsis>
+ <methodname>Authenticate</methodname>
+ <methodparam><type>string</type><parameter>password</parameter></methodparam>
+ <methodparam choice="opt"><type>string</type><parameter>options</parameter></methodparam>
+ <methodparam choice="opt"><type>int</type><parameter>maxdigits</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ This application asks the caller to enter a given password in order to
+ continue dialplan execution. If the password begins with the '/'
+ character, it is interpreted as a file which contains a list of valid
+ passwords, listed 1 password per line in the file.
+ </para>
+
+ <para>
+ When using a database key, the value associated with the key can be
+ anything. Users have three attempts to authenticate before the channel
+ is hung up. If the passsword is invalid, the 'j' option is specified, and
+ priority n+101 exists, dialplan execution will continnue at this
+ location.
+ </para>
+
+ <para>
+ <parameter>maxdigits</parameter> is the maximum number of digits for the
+ password. Authenticate will attempt to match the password immediately as
+ soon as <parameter>maxdigits</parameter> is matched, without requiring
+ the user to press the # key. Defaults to 0, or no limit, and waits for
+ the # key to be pressed.
+ <note>
+ <simpara>
+ <parameter>maxdigits</parameter> was added in Asterisk 1.3.
+ </simpara>
+ </note>
+ </para>
+
+ <para>
+ When the <parameter>password</parameter> is a file path, and the
+ <parameter>options</parameter> contains 'm' the file is expected to have
+ a list of account codes and password hashes delimited with a colon (:).
+ A matching password will set the account code for the call to the account
+ code corresponding with the matched password.
+ <example>
+ <title>Using <parameter>password</parameter></title>
+ <programlisting role="astdialplan">
+<![CDATA[
+; Authenticate the password
+exten => s,1,Authenticate(5321)
+
+; Authenticate the password against a password file, one password per line
+exten => s,1,Authenticate(/path/to/passwd/file)
+
+; Authenticate from the db, using /db-keyfamily/<password>, i.e. /FEATURE/1234
+exten => s,1,Authenticate(/db-keyfamily, d)
+
+]]>
+ </programlisting>
+ </example>
+ </para>
+
+ <para>
+ <parameter>options</parameter> can be one or more of the following:
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ <literal>a</literal> - Set the channels' account code to the password
+ that is entered
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <literal>d</literal> - Interpret the given path as database key, not a
+ literal file
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <literal>j</literal> - Support jumping to n+101 if authentication
+ fails
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <literal>m</literal> - Interpret the given path as a file which
+ contains a list of account codes and password hashes delimited with
+ ':', 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.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <literal>r</literal> - Remove the database key upon successful entry
+ (valid with 'd' only)
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <simpara>
+ Option <parameter>r</parameter> can only be used in conjunction with
+ option <parameter>d</parameter>. The
+ </simpara>
+ </note>
+ </para>
+
+ <para>
+ Returns 0 if the user enteres a valid password within 3 tries, or -1
+ otherwise (or on hangup).
+ </para>
+
+ </refsect1>
+ </refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Added: en/reference/general/reference.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/en/reference/general/reference.xml?rev=2&view=auto
==============================================================================
--- en/reference/general/reference.xml (added)
+++ en/reference/general/reference.xml Tue May 2 10:34:17 2006
@@ -1,0 +1,44 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.16 $ -->
+<!-- Purpose: basic.text -->
+<!-- Membership: bundled -->
+
+<reference id="ref.general">
+ <title>General</title>
+ <titleabbrev>General</titleabbrev>
+
+ <partintro>
+ <section id="general.intro">
+ &reftitle.intro;
+ <para>
+ Applications of general interest. This section should probably be rewritten and recategorized and removed.
+ </para>
+ </section>
+
+ </partintro>
+
+&reference.general.functions;
+
+</reference>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+
Modified: entities/builtin-extensions.xml
URL: http://svncommunity.digium.com/view/asterisk-docs/entities/builtin-extensions.xml?rev=2&r1=1&r2=2&view=diff
==============================================================================
--- entities/builtin-extensions.xml (original)
+++ entities/builtin-extensions.xml Tue May 2 10:34:17 2006
@@ -5,5 +5,6 @@
&reference.agi.reference;
&reference.callmgmt.reference;
&reference.flowcontrol.reference;
+ &reference.general.reference;
&reference.voicemail.reference;
</part>
Modified: entities/file-entities.ent
URL: http://svncommunity.digium.com/view/asterisk-docs/entities/file-entities.ent?rev=2&r1=1&r2=2&view=diff
==============================================================================
--- entities/file-entities.ent (original)
+++ entities/file-entities.ent Tue May 2 10:34:17 2006
@@ -36,6 +36,10 @@
<!ENTITY reference.callmgmt.functions.retrydial SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/callmgmt/functions/retrydial.xml'>
<!ENTITY reference.callmgmt.reference SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/callmgmt/reference.xml'>
<!ENTITY reference.callmgmt.functions SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/callmgmt/functions.xml'>
+<!ENTITY reference.general.reference SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/general/reference.xml'>
+<!ENTITY reference.general.functions SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/general/functions.xml'>
+<!ENTITY reference.general.functions.authenticate SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/general/functions/authenticate.xml'>
+<!ENTITY reference.general.functions SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/reference/general/functions.xml'>
<!ENTITY config.intro SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/config/intro.xml'>
<!ENTITY config.extensions SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/config/extensions.xml'>
<!ENTITY language.constants SYSTEM '/usr/local/www/vhosts/asterisk-docs/astdoc/en/language/constants.xml'>
Modified: entities/version.ent
URL: http://svncommunity.digium.com/view/asterisk-docs/entities/version.ent?rev=2&r1=1&r2=2&view=diff
==============================================================================
--- entities/version.ent (original)
+++ entities/version.ent Tue May 2 10:34:17 2006
@@ -1,1 +1,1 @@
-<!ENTITY php.build-date "2006-04-24">
+<!ENTITY php.build-date "2006-05-02">
More information about the asterisk-doc
mailing list