diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dev.html | 3 | ||||
| -rw-r--r-- | doc/dev.tex | 3 | ||||
| -rw-r--r-- | doc/guide.html | 31 | ||||
| -rw-r--r-- | doc/guide.tex | 41 |
4 files changed, 71 insertions, 7 deletions
diff --git a/doc/dev.html b/doc/dev.html index 4b8e6bfe9..8cdf2d2ed 100644 --- a/doc/dev.html +++ b/doc/dev.html @@ -194,6 +194,9 @@ operation are as follows: auth:User:Server:Password (check if a username/password pair is correct) </LI><LI CLASS="li-itemize">isuser:User:Server (check if it’s a valid user) </LI><LI CLASS="li-itemize">setpass:User:Server:Password (set user’s password) +</LI><LI CLASS="li-itemize">tryregister:User:Server:Password (try to register an account) +</LI><LI CLASS="li-itemize">removeuser:User:Server (remove this account) +</LI><LI CLASS="li-itemize">removeuser3:User:Server:Password (remove this account if the password is correct) </LI></UL> </LI></UL> </LI><LI CLASS="li-itemize">write to stdout: AABB diff --git a/doc/dev.tex b/doc/dev.tex index f597d591e..1e46c1af2 100644 --- a/doc/dev.tex +++ b/doc/dev.tex @@ -176,6 +176,9 @@ That script is supposed to do theses actions, in an infinite loop: \item auth:User:Server:Password (check if a username/password pair is correct) \item isuser:User:Server (check if it's a valid user) \item setpass:User:Server:Password (set user's password) + \item tryregister:User:Server:Password (try to register an account) + \item removeuser:User:Server (remove this account) + \item removeuser3:User:Server:Password (remove this account if the password is correct) \end{itemize} \end{itemize} \item write to stdout: AABB diff --git a/doc/guide.html b/doc/guide.html index 0e1294080..635afe51e 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -1030,14 +1030,13 @@ for user authentication. The syntax is: </P><DL CLASS="description"><DT CLASS="dt-description"><B><TT>{auth_method, [Method, ...]}.</TT></B></DT></DL><P>The following authentication methods are supported by <TT>ejabberd</TT>: </P><UL CLASS="itemize"><LI CLASS="li-itemize"> internal (default) — See section <A HREF="#internalauth">3.1.4</A>. -</LI><LI CLASS="li-itemize">external — There are <A HREF="http://www.ejabberd.im/extauth">some -example authentication scripts</A>. +</LI><LI CLASS="li-itemize">external — See section <A HREF="#extauth">3.1.4</A>. </LI><LI CLASS="li-itemize">ldap — See section <A HREF="#ldap">3.2.5</A>. </LI><LI CLASS="li-itemize">odbc — See section <A HREF="#mysql">3.2.1</A>, <A HREF="#pgsql">3.2.3</A>, <A HREF="#mssql">3.2.2</A> and <A HREF="#odbc">3.2.4</A>. </LI><LI CLASS="li-itemize">anonymous — See section <A HREF="#saslanonymous">3.1.4</A>. </LI><LI CLASS="li-itemize">pam — See section <A HREF="#pam">3.1.4</A>. -</LI></UL><P>Account creation is only supported by internal and odbc methods.</P><P> <A NAME="internalauth"></A> </P><!--TOC subsubsection Internal--> +</LI></UL><P>Account creation is only supported by internal, external and odbc methods.</P><P> <A NAME="internalauth"></A> </P><!--TOC subsubsection Internal--> <H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#internalauth">Internal</A></H4><!--SEC END --><P> <A NAME="internalauth"></A> </P><P><TT>ejabberd</TT> uses its internal Mnesia database as the default authentication method. The value <TT>internal</TT> will enable the internal authentication method.</P><P>Examples: @@ -1048,7 +1047,31 @@ authentication on <TT>example.net</TT>: {host_config, "example.net", [{auth_method, [ldap]}]}. </PRE></LI><LI CLASS="li-itemize">To use internal authentication on all virtual hosts: <PRE CLASS="verbatim">{auth_method, internal}. -</PRE></LI></UL><P> <A NAME="saslanonymous"></A> </P><!--TOC subsubsection SASL Anonymous and Anonymous Login--> +</PRE></LI></UL><P> <A NAME="extauth"></A> </P><!--TOC subsubsection External Script--> +<H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#extauth">External Script</A></H4><!--SEC END --><P> <A NAME="extauth"></A> +</P><P>In this authentication method, when <TT>ejabberd</TT> starts, +it start a script, and calls it to perform authentication tasks.</P><P>The server administrator can write the external authentication script +in any language. +The details on the interface between ejabberd and the script are described +in the <TT>ejabberd Developers Guide</TT>. +There are also <A HREF="http://www.ejabberd.im/extauth">several example authentication scripts</A>.</P><P>These are the specific options: +</P><DL CLASS="description"><DT CLASS="dt-description"> +<B><TT>{extauth_program, PathToScript}</TT></B></DT><DD CLASS="dd-description"> +Indicate in this option the full path to the external authentication script. +The script must be executable by ejabberd.</DD><DT CLASS="dt-description"><B><TT>{extauth_cache, false|CacheTimeInteger}</TT></B></DT><DD CLASS="dd-description"> +The value <TT>false</TT> disables the caching feature, this is the default. +The integer <TT>0</TT> (zero) enables caching for statistics, but doesn’t use that cached information to authenticate users. +If another integer value is set, caching is enabled both for statistics and for authentication: +the CacheTimeInteger indicates the number of seconds that ejabberd can reuse +the authentication information since the user last disconnected, +to verify again the user authentication without querying again the extauth script. +Note: caching should not be enabled in a host if internal auth is also enabled. +If caching is enabled, <TT>mod_last</TT> or <TT>mod_last_odbc</TT> must be enabled also in that vhost. +</DD></DL><P>This example sets external authentication, the extauth script, and enables caching for 10 minutes: +</P><PRE CLASS="verbatim">{auth_method, [external]}. +{extauth_program, "/etc/ejabberd/JabberAuth.class.php"}. +{extauth_cache, 600}. +</PRE><P> <A NAME="saslanonymous"></A> </P><!--TOC subsubsection SASL Anonymous and Anonymous Login--> <H4 CLASS="subsubsection"><!--SEC ANCHOR --><A HREF="#saslanonymous">SASL Anonymous and Anonymous Login</A></H4><!--SEC END --><P> <A NAME="saslanonymous"></A> </P><P>The value <TT>anonymous</TT> will enable the internal authentication method.</P><P>The anonymous authentication method can be configured with the following options. Remember that you can use the <TT>host_config</TT> option to set virtual diff --git a/doc/guide.tex b/doc/guide.tex index 44e8a3af8..9463d57aa 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -1187,8 +1187,7 @@ for user authentication. The syntax is: The following authentication methods are supported by \ejabberd{}: \begin{itemize} \item internal (default) --- See section~\ref{internalauth}. -\item external --- There are \footahref{http://www.ejabberd.im/extauth}{some - example authentication scripts}. +\item external --- See section~\ref{extauth}. \item ldap --- See section~\ref{ldap}. \item odbc --- See section~\ref{mysql}, \ref{pgsql}, \ref{mssql} and \ref{odbc}. @@ -1196,7 +1195,7 @@ The following authentication methods are supported by \ejabberd{}: \item pam --- See section~\ref{pam}. \end{itemize} -Account creation is only supported by internal and odbc methods. +Account creation is only supported by internal, external and odbc methods. \makesubsubsection{internalauth}{Internal} \ind{internal authentication}\ind{Mnesia} @@ -1218,6 +1217,42 @@ Examples: \end{verbatim} \end{itemize} +\makesubsubsection{extauth}{External Script} +\ind{external authentication} + +In this authentication method, when \ejabberd{} starts, +it start a script, and calls it to perform authentication tasks. + +The server administrator can write the external authentication script +in any language. +The details on the interface between ejabberd and the script are described +in the \term{ejabberd Developers Guide}. +There are also \footahref{http://www.ejabberd.im/extauth}{several example authentication scripts}. + +These are the specific options: +\begin{description} + \titem{\{extauth\_program, PathToScript\}} + Indicate in this option the full path to the external authentication script. + The script must be executable by ejabberd. + + \titem{\{extauth\_cache, false|CacheTimeInteger\}} + The value \term{false} disables the caching feature, this is the default. + The integer \term{0} (zero) enables caching for statistics, but doesn't use that cached information to authenticate users. + If another integer value is set, caching is enabled both for statistics and for authentication: + the CacheTimeInteger indicates the number of seconds that ejabberd can reuse + the authentication information since the user last disconnected, + to verify again the user authentication without querying again the extauth script. + Note: caching should not be enabled in a host if internal auth is also enabled. + If caching is enabled, \term{mod\_last} or \term{mod\_last\_odbc} must be enabled also in that vhost. +\end{description} + +This example sets external authentication, the extauth script, and enables caching for 10 minutes: +\begin{verbatim} +{auth_method, [external]}. +{extauth_program, "/etc/ejabberd/JabberAuth.class.php"}. +{extauth_cache, 600}. +\end{verbatim} + \makesubsubsection{saslanonymous}{SASL Anonymous and Anonymous Login} \ind{sasl anonymous}\ind{anonymous login} |