diff options
| -rw-r--r-- | ChangeLog | 9 | ||||
| -rw-r--r-- | doc/guide.html | 1662 | ||||
| -rw-r--r-- | doc/guide.tex | 341 | ||||
| -rw-r--r-- | src/ejabberd_auth_ldap.erl | 353 | ||||
| -rw-r--r-- | src/eldap/Makefile.in | 3 | ||||
| -rw-r--r-- | src/eldap/Makefile.win32 | 3 | ||||
| -rw-r--r-- | src/eldap/eldap_filter.erl | 269 | ||||
| -rw-r--r-- | src/mod_vcard_ldap.erl | 877 |
8 files changed, 2445 insertions, 1072 deletions
@@ -1,3 +1,12 @@ +2006-09-14 Alexey Shchepin <alexey@sevcom.net> + + * doc/guide.tex: Updated (thanks to Evgeniy Khramtsov) + + * src/ejabberd_auth_ldap.erl: Better LDAP support (thanks to + Evgeniy Khramtsov) + * src/mod_vcard_ldap.erl: Likewise + * src/eldap/eldap_filter.erl: Likewise + 2006-09-11 Mickael Remond <mickael.remond@process-one.net> * src/odbc/mssql.sql: Removed unused fields. diff --git a/doc/guide.html b/doc/guide.html index 5c9558f34..3c8a473e0 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -1,46 +1,29 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> <HTML> +<HEAD><TITLE>Ejabberd 1.1.1 Installation and Operation Guide</TITLE> -<HEAD> - -<TITLE>Ejabberd 1.1.1 Installation and Operation Guide</TITLE> - -<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> -<META name="GENERATOR" content="hevea 1.08"> -<STYLE type="text/css"> -.toc{list-style:none;} -.title{margin:auto;text-align:center} -.center{text-align:center;margin-left:auto;margin-right:auto;} -.flushleft{text-align:left;margin-left:0ex;margin-right:auto;} -.flushright{text-align:right;margin-left:auto;margin-right:0ex;} -DIV TABLE{margin-left:inherit;margin-right:inherit;} -PRE{text-align:left;margin-left:0ex;margin-right:auto;} -BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} -.part{margin:auto;text-align:center} -</STYLE> +<META http-equiv="Content-Type" content="text/html; charset=KOI8-R"> +<META name="GENERATOR" content="hevea 1.07"> </HEAD> - <BODY > -<!--HEVEA command line is: hevea guide.tex --> +<!--HEVEA command line is: /usr/bin/hevea guide.tex --> <!--HTMLHEAD--> <!--ENDHTML--> <!--PREFIX <ARG ></ARG>--> <!--CUT DEF section 1 --> - <BR> <BR> <A NAME="sec:titlepage"></A> - <TABLE CLASS="title"> -<TR><TD> -<H1 CLASS="titlemain">Ejabberd 1.1.1 Installation and Operation Guide</H1> -<H3 CLASS="titlerest">Alexey Shchepin<BR> + +<H1 ALIGN=center>Ejabberd 1.1.1 Installation and Operation Guide</H1> + +<H3 ALIGN=center>Alexey Shchepin<BR> <A HREF="mailto:alexey@sevcom.net"><TT>mailto:alexey@sevcom.net</TT></A><BR> -<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A></H3></TD> -</TR></TABLE><BR> +<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A></H3> <BR> -<DIV CLASS="center"> +<DIV ALIGN=center> <IMG SRC="logo.png"> @@ -49,117 +32,125 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} <BR> </DIV> -<BLOCKQUOTE CLASS="quotation"><I>I can thoroughly recommend ejabberd for ease of setup – +<BLOCKQUOTE><I>I can thoroughly recommend ejabberd for ease of setup -- Kevin Smith, Current maintainer of the Psi project</I></BLOCKQUOTE> -<!--TOC section Contents--> +<!--TOC section Table of Contents--> -<H2 CLASS="section">Contents</H2><!--SEC END --> +<H2>Table of Contents</H2><!--SEC END --> -<UL CLASS="toc"><LI CLASS="li-toc"> +<UL><LI> <A HREF="#htoc1">1 Introduction</A> -<UL CLASS="toc"><LI CLASS="li-toc"> +<UL><LI> <A HREF="#htoc2">1.1 Key Features</A> -<LI CLASS="li-toc"><A HREF="#htoc3">1.2 Additional Features</A> +<LI><A HREF="#htoc3">1.2 Additional Features</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc4">2 Installation from Source</A> -<UL CLASS="toc"><LI CLASS="li-toc"> +<LI><A HREF="#htoc4">2 Installation from Source</A> +<UL><LI> <A HREF="#htoc5">2.1 Installation Requirements</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc6">2.1.1 “Unix-like” operating systems</A> -<LI CLASS="li-toc"><A HREF="#htoc7">2.1.2 Windows</A> +<UL><LI> +<A HREF="#htoc6">2.1.1 ``Unix-like'' operating systems</A> +<LI><A HREF="#htoc7">2.1.2 Windows</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc8">2.2 Obtaining <TT>ejabberd</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc9">2.3 Compilation</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc10">2.3.1 “Unix-like” operating systems</A> -<LI CLASS="li-toc"><A HREF="#htoc11">2.3.2 Windows</A> +<LI><A HREF="#htoc8">2.2 Obtaining <TT>ejabberd</TT></A> +<LI><A HREF="#htoc9">2.3 Compilation</A> +<UL><LI> +<A HREF="#htoc10">2.3.1 ``Unix-like'' operating systems</A> +<LI><A HREF="#htoc11">2.3.2 Windows</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc12">2.4 Starting</A> +<LI><A HREF="#htoc12">2.4 Starting</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc13">3 Configuration</A> -<UL CLASS="toc"><LI CLASS="li-toc"> +<LI><A HREF="#htoc13">3 Configuration</A> +<UL><LI> <A HREF="#htoc14">3.1 Initial Configuration</A> -<UL CLASS="toc"><LI CLASS="li-toc"> +<UL><LI> <A HREF="#htoc15">3.1.1 Host Names</A> -<LI CLASS="li-toc"><A HREF="#htoc16">3.1.2 Default Language</A> -<LI CLASS="li-toc"><A HREF="#htoc17">3.1.3 Access Rules</A> -<LI CLASS="li-toc"><A HREF="#htoc18">3.1.4 Shapers</A> -<LI CLASS="li-toc"><A HREF="#htoc19">3.1.5 Limitation of the number of opened sessions</A> -<LI CLASS="li-toc"><A HREF="#htoc20">3.1.6 Listened Sockets</A> -<LI CLASS="li-toc"><A HREF="#htoc21">3.1.7 Modules</A> -<LI CLASS="li-toc"><A HREF="#htoc22">3.1.8 Virtual Hosting</A> -<LI CLASS="li-toc"><A HREF="#htoc23">3.1.9 SASL anonymous and anonymous login</A> +<LI><A HREF="#htoc16">3.1.2 Default Language</A> +<LI><A HREF="#htoc17">3.1.3 Access Rules</A> +<LI><A HREF="#htoc18">3.1.4 Shapers</A> +<LI><A HREF="#htoc19">3.1.5 Limitation of the number of opened sessions</A> +<LI><A HREF="#htoc20">3.1.6 Listened Sockets</A> +<LI><A HREF="#htoc21">3.1.7 Modules</A> +<LI><A HREF="#htoc22">3.1.8 Virtual Hosting</A> +<LI><A HREF="#htoc23">3.1.9 SASL anonymous and anonymous login</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc24">3.2 Relational Database Support</A> -<UL CLASS="toc"><LI CLASS="li-toc"> +<LI><A HREF="#htoc24">3.2 Relational Database Support</A> +<UL><LI> <A HREF="#htoc25">3.2.1 Preliminary steps</A> -<LI CLASS="li-toc"><A HREF="#htoc26">3.2.2 Authentication against a relational database</A> -<LI CLASS="li-toc"><A HREF="#htoc27">3.2.3 Relational database for other modules</A> +<LI><A HREF="#htoc26">3.2.2 Authentication against a relational database</A> +<LI><A HREF="#htoc27">3.2.3 Relational database for other modules</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc28">3.3 Creating an Initial Administrator</A> -<LI CLASS="li-toc"><A HREF="#htoc29">3.4 Online Configuration and Monitoring</A> -<UL CLASS="toc"><LI CLASS="li-toc"> +<LI><A HREF="#htoc28">3.3 Creating an Initial Administrator</A> +<LI><A HREF="#htoc29">3.4 Online Configuration and Monitoring</A> +<UL><LI> <A HREF="#htoc30">3.4.1 Web Interface</A> -<LI CLASS="li-toc"><A HREF="#htoc31">3.4.2 <TT>ejabberdctl</TT></A> +<LI><A HREF="#htoc31">3.4.2 <TT>ejabberdctl</TT></A> </UL> </UL> -<LI CLASS="li-toc"><A HREF="#htoc32">4 Firewall Settings</A> -<LI CLASS="li-toc"><A HREF="#htoc33">5 SRV Records</A> -<LI CLASS="li-toc"><A HREF="#htoc34">6 Clustering</A> -<UL CLASS="toc"><LI CLASS="li-toc"> +<LI><A HREF="#htoc32">4 Firewall Settings</A> +<LI><A HREF="#htoc33">5 SRV Records</A> +<LI><A HREF="#htoc34">6 Clustering</A> +<UL><LI> <A HREF="#htoc35">6.1 How it Works</A> -<UL CLASS="toc"><LI CLASS="li-toc"> +<UL><LI> <A HREF="#htoc36">6.1.1 Router</A> -<LI CLASS="li-toc"><A HREF="#htoc37">6.1.2 Local Router</A> -<LI CLASS="li-toc"><A HREF="#htoc38">6.1.3 Session Manager</A> -<LI CLASS="li-toc"><A HREF="#htoc39">6.1.4 s2s Manager</A> +<LI><A HREF="#htoc37">6.1.2 Local Router</A> +<LI><A HREF="#htoc38">6.1.3 Session Manager</A> +<LI><A HREF="#htoc39">6.1.4 s2s Manager</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc40">6.2 Clustering Setup</A> +<LI><A HREF="#htoc40">6.2 Clustering Setup</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc41">A Built-in Modules</A> -<UL CLASS="toc"><LI CLASS="li-toc"> +<LI><A HREF="#htoc41">A Built-in Modules</A> +<UL><LI> <A HREF="#htoc42">A.1 Overview</A> -<LI CLASS="li-toc"><A HREF="#htoc43">A.2 Common Options</A> -<UL CLASS="toc"><LI CLASS="li-toc"> +<LI><A HREF="#htoc43">A.2 Common Options</A> +<UL><LI> <A HREF="#htoc44">A.2.1 <TT>iqdisc</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc45">A.2.2 <TT>hosts</TT></A> +<LI><A HREF="#htoc45">A.2.2 <TT>hosts</TT></A> +</UL> +<LI><A HREF="#htoc46">A.3 <TT>mod_announce</TT></A> +<LI><A HREF="#htoc47">A.4 <TT>mod_disco</TT></A> +<LI><A HREF="#htoc48">A.5 <TT>mod_echo</TT></A> +<LI><A HREF="#htoc49">A.6 <TT>mod_irc</TT></A> +<LI><A HREF="#htoc50">A.7 <TT>mod_last</TT></A> +<LI><A HREF="#htoc51">A.8 <TT>mod_muc</TT></A> +<LI><A HREF="#htoc52">A.9 <TT>mod_muc_log</TT></A> +<LI><A HREF="#htoc53">A.10 <TT>mod_offline</TT></A> +<LI><A HREF="#htoc54">A.11 <TT>mod_privacy</TT></A> +<LI><A HREF="#htoc55">A.12 <TT>mod_private</TT></A> +<LI><A HREF="#htoc56">A.13 <TT>mod_pubsub</TT></A> +<LI><A HREF="#htoc57">A.14 <TT>mod_register</TT></A> +<LI><A HREF="#htoc58">A.15 <TT>mod_roster</TT></A> +<LI><A HREF="#htoc59">A.16 <TT>mod_service_log</TT></A> +<LI><A HREF="#htoc60">A.17 <TT>mod_shared_roster</TT></A> +<LI><A HREF="#htoc61">A.18 <TT>mod_stats</TT></A> +<LI><A HREF="#htoc62">A.19 <TT>mod_time</TT></A> +<LI><A HREF="#htoc63">A.20 <TT>mod_vcard</TT></A> +<LI><A HREF="#htoc64">A.21 LDAP and <TT>mod_vcard_ldap</TT></A> +<UL><LI> +<A HREF="#htoc65">A.21.1 Features</A> +<LI><A HREF="#htoc66">A.21.2 Connection</A> +<LI><A HREF="#htoc67">A.21.3 Authentication</A> +<LI><A HREF="#htoc68">A.21.4 vCards and Search</A> +<LI><A HREF="#htoc69">A.21.5 Examples</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc46">A.3 <TT>mod_announce</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc47">A.4 <TT>mod_disco</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc48">A.5 <TT>mod_echo</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc49">A.6 <TT>mod_irc</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc50">A.7 <TT>mod_last</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc51">A.8 <TT>mod_muc</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc52">A.9 <TT>mod_muc_log</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc53">A.10 <TT>mod_offline</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc54">A.11 <TT>mod_privacy</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc55">A.12 <TT>mod_private</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc56">A.13 <TT>mod_pubsub</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc57">A.14 <TT>mod_register</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc58">A.15 <TT>mod_roster</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc59">A.16 <TT>mod_service_log</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc60">A.17 <TT>mod_shared_roster</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc61">A.18 <TT>mod_stats</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc62">A.19 <TT>mod_time</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc63">A.20 <TT>mod_vcard</TT></A> -<LI CLASS="li-toc"><A HREF="#htoc64">A.21 <TT>mod_version</TT></A> +<LI><A HREF="#htoc70">A.22 <TT>mod_version</TT></A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc65">B Internationalization and Localization</A> -<LI CLASS="li-toc"><A HREF="#htoc66">C Release Notes</A> -<UL CLASS="toc"><LI CLASS="li-toc"> -<A HREF="#htoc67">C.1 ejabberd 0.9</A> -<LI CLASS="li-toc"><A HREF="#htoc68">C.2 ejabberd 0.9.1</A> -<LI CLASS="li-toc"><A HREF="#htoc69">C.3 ejabberd 0.9.8</A> -<LI CLASS="li-toc"><A HREF="#htoc70">C.4 ejabberd 1.0.0</A> -<LI CLASS="li-toc"><A HREF="#htoc71">C.5 ejabberd 1.1.0</A> -<LI CLASS="li-toc"><A HREF="#htoc72">C.6 ejabberd 1.1.1</A> +<LI><A HREF="#htoc71">B Internationalization and Localization</A> +<LI><A HREF="#htoc72">C Release Notes</A> +<UL><LI> +<A HREF="#htoc73">C.1 ejabberd 0.9</A> +<LI><A HREF="#htoc74">C.2 ejabberd 0.9.1</A> +<LI><A HREF="#htoc75">C.3 ejabberd 0.9.8</A> +<LI><A HREF="#htoc76">C.4 ejabberd 1.0.0</A> +<LI><A HREF="#htoc77">C.5 ejabberd 1.1.0</A> +<LI><A HREF="#htoc78">C.6 ejabberd 1.1.1</A> </UL> -<LI CLASS="li-toc"><A HREF="#htoc73">D Acknowledgements</A> +<LI><A HREF="#htoc79">D Acknowledgements</A> </UL> <!--TOC section Introduction--> -<H2 CLASS="section"><A NAME="htoc1">1</A> Introduction</H2><!--SEC END --> +<H2><A NAME="htoc1">1</A> Introduction</H2><!--SEC END --> <A NAME="sec:intr"></A> @@ -171,135 +162,135 @@ BLOCKQUOTE{margin-left:4ex;margin-right:4ex;text-align:left;} <BR> <!--TOC subsection Key Features--> -<H3 CLASS="subsection"><A NAME="htoc2">1.1</A> Key Features</H3><!--SEC END --> +<H3><A NAME="htoc2">1.1</A> Key Features</H3><!--SEC END --> <A NAME="sec:keyfeatures"></A> <TT>ejabberd</TT> is: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Multiplatform: <TT>ejabberd</TT> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.<BR> <BR> -<LI CLASS="li-itemize">Distributed: You can run <TT>ejabberd</TT> on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.<BR> +<LI>Distributed: You can run <TT>ejabberd</TT> on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.<BR> <BR> -<LI CLASS="li-itemize">Fault-tolerant: You can deploy an <TT>ejabberd</TT> cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced “on the fly”.<BR> +<LI>Fault-tolerant: You can deploy an <TT>ejabberd</TT> cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ``on the fly''.<BR> <BR> -<LI CLASS="li-itemize">Administrator Friendly: <TT>ejabberd</TT> is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<LI>Administrator Friendly: <TT>ejabberd</TT> is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include: +<UL><LI> Comprehensive documentation. -<LI CLASS="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. -<LI CLASS="li-itemize">Web interface for administration tasks. -<LI CLASS="li-itemize">Shared Roster Groups. -<LI CLASS="li-itemize">Command line administration tool. -<LI CLASS="li-itemize">Can integrate with existing authentication mechanisms. -<LI CLASS="li-itemize">Capability to send announce messages. +<LI>Straightforward installers for Linux, Mac OS X, and Windows. +<LI>Web interface for administration tasks. +<LI>Shared Roster Groups. +<LI>Command line administration tool. +<LI>Can integrate with existing authentication mechanisms. +<LI>Capability to send announce messages. </UL><BR> <BR> -<LI CLASS="li-itemize">Internationalized: <TT>ejabberd</TT> leads in internationalization. Hence it is very well suited in a globalized world. Related features are: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<LI>Internationalized: <TT>ejabberd</TT> leads in internationalization. Hence it is very well suited in a globalized world. Related features are: +<UL><LI> Translated in 11 languages. -<LI CLASS="li-itemize">Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>. +<LI>Support for <A HREF="http://www.ietf.org/rfc/rfc3490.txt">IDNA</A>. </UL><BR> <BR> -<LI CLASS="li-itemize">Open Standards: <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard. -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<LI>Open Standards: <TT>ejabberd</TT> is the first Open Source Jabber server claiming to fully comply to the XMPP standard. +<UL><LI> Fully XMPP compliant -<LI CLASS="li-itemize">XML-based protocol -<LI CLASS="li-itemize"><A HREF="http://ejabberd.jabber.ru/protocols">Many JEPs supported</A>. +<LI>XML-based protocol +<LI><A HREF="http://ejabberd.jabber.ru/protocols">Many JEPs supported</A>. </UL></UL> <!--TOC subsection Additional Features--> -<H3 CLASS="subsection"><A NAME="htoc3">1.2</A> Additional Features</H3><!--SEC END --> +<H3><A NAME="htoc3">1.2</A> Additional Features</H3><!--SEC END --> <A NAME="sec:addfeatures"></A> Besides common Jabber server features, <TT>ejabberd</TT> comes with a wide range of other features: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Modular -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Load only the modules you want. -<LI CLASS="li-itemize">Extend <TT>ejabberd</TT> with your own custom modules. +<LI>Extend <TT>ejabberd</TT> with your own custom modules. </UL> -<LI CLASS="li-itemize">Security -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<LI>Security +<UL><LI> SASL and STARTTLS for c2s and s2s connections. -<LI CLASS="li-itemize">STARTTLS and Dialback s2s connections. -<LI CLASS="li-itemize">Web interface accessible via HTTPS secure access. +<LI>STARTTLS and Dialback s2s connections. +<LI>Web interface accessible via HTTPS secure access. </UL> -<LI CLASS="li-itemize">Databases -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<LI>Databases +<UL><LI> Native MySQL support. -<LI CLASS="li-itemize">Native PostgreSQL support. -<LI CLASS="li-itemize">Mnesia. -<LI CLASS="li-itemize">ODBC data storage support. -<LI CLASS="li-itemize">Microsoft SQL Server support (via ODBC). +<LI>Native PostgreSQL support. +<LI>Mnesia. +<LI>ODBC data storage support. +<LI>Microsoft SQL Server support (via ODBC). </UL> -<LI CLASS="li-itemize">Authentication -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<LI>Authentication +<UL><LI> LDAP and ODBC. -<LI CLASS="li-itemize">External Authentication script. -<LI CLASS="li-itemize">Internal Authentication. +<LI>External Authentication script. +<LI>Internal Authentication. </UL> -<LI CLASS="li-itemize">Others -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<LI>Others +<UL><LI> Compressing XML streams with Stream Compression (<A HREF="http://www.jabber.org/jeps/jep-0138.html">JEP-0138</A>). -<LI CLASS="li-itemize">Interface with networks such as AIM, ICQ and MSN. -<LI CLASS="li-itemize">Statistics via Statistics Gathering (<A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A>). -<LI CLASS="li-itemize">IPv6 support both for c2s and s2s connections. -<LI CLASS="li-itemize"><A HREF="http://www.jabber.org/jeps/jep-0045.html">Multi-User Chat</A> module with logging. -<LI CLASS="li-itemize">Users Directory based on users vCards. -<LI CLASS="li-itemize"><A HREF="http://www.jabber.org/jeps/jep-0060.html">Publish-Subscribe</A> component. -<LI CLASS="li-itemize">Support for virtual hosting. -<LI CLASS="li-itemize"><A HREF="http://www.jabber.org/jeps/jep-0025.html">HTTP Polling</A> service. -<LI CLASS="li-itemize">IRC transport. +<LI>Interface with networks such as AIM, ICQ and MSN. +<LI>Statistics via Statistics Gathering (<A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A>). +<LI>IPv6 support both for c2s and s2s connections. +<LI><A HREF="http://www.jabber.org/jeps/jep-0045.html">Multi-User Chat</A> module with logging. +<LI>Users Directory based on users vCards. +<LI><A HREF="http://www.jabber.org/jeps/jep-0060.html">Publish-Subscribe</A> component. +<LI>Support for virtual hosting. +<LI><A HREF="http://www.jabber.org/jeps/jep-0025.html">HTTP Polling</A> service. +<LI>IRC transport. </UL> </UL> <!--TOC section Installation from Source--> -<H2 CLASS="section"><A NAME="htoc4">2</A> Installation from Source</H2><!--SEC END --> +<H2><A NAME="htoc4">2</A> Installation from Source</H2><!--SEC END --> <A NAME="sec:installation"></A> <!--TOC subsection Installation Requirements--> -<H3 CLASS="subsection"><A NAME="htoc5">2.1</A> Installation Requirements</H3><!--SEC END --> +<H3><A NAME="htoc5">2.1</A> Installation Requirements</H3><!--SEC END --> <A NAME="sec:installreq"></A> -<!--TOC subsubsection “Unix-like” operating systems--> +<!--TOC subsubsection ``Unix-like'' operating systems--> -<H4 CLASS="subsubsection"><A NAME="htoc6">2.1.1</A> “Unix-like” operating systems</H4><!--SEC END --> +<H4><A NAME="htoc6">2.1.1</A> ``Unix-like'' operating systems</H4><!--SEC END --> <A NAME="sec:installrequnix"></A> -To compile <TT>ejabberd</TT> on a “Unix-like” operating system, you need: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +To compile <TT>ejabberd</TT> on a ``Unix-like'' operating system, you need: +<UL><LI> GNU Make; -<LI CLASS="li-itemize">GCC; -<LI CLASS="li-itemize">libexpat 1.95 or higher; -<LI CLASS="li-itemize">Erlang/OTP R9C-2 or higher; -<LI CLASS="li-itemize">OpenSSL 0.9.6 or higher (optional). -<LI CLASS="li-itemize">Zlib 1.2.3 or higher (optional). -<LI CLASS="li-itemize">GNU Iconv 1.8 or higher (optional, not needed at all on systems with GNU libc). +<LI>GCC; +<LI>libexpat 1.95 or higher; +<LI>Erlang/OTP R9C-2 or higher; +<LI>OpenSSL 0.9.6 or higher (optional). +<LI>Zlib 1.2.3 or higher (optional). +<LI>GNU Iconv 1.8 or higher (optional, not needed at all on systems with GNU libc). </UL> <!--TOC subsubsection Windows--> -<H4 CLASS="subsubsection"><A NAME="htoc7">2.1.2</A> Windows</H4><!--SEC END --> +<H4><A NAME="htoc7">2.1.2</A> Windows</H4><!--SEC END --> <A NAME="sec:installreqwin"></A> To compile <TT>ejabberd</TT> on a Windows flavour, you need: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> MS Visual C++ 6.0 Compiler -<LI CLASS="li-itemize"><A HREF="http://erlang.org/download.html">Erlang/OTP R9C-2 or higher</A> -<LI CLASS="li-itemize"><A HREF="http://sourceforge.net/project/showfiles.php?group_id=10127&package_id=11277">Expat 1.95.7 or higher</A> -<LI CLASS="li-itemize"><A HREF="http://www.gnu.org/software/libiconv/">GNU Iconv 1.9.1</A> +<LI><A HREF="http://erlang.org/download.html">Erlang/OTP R9C-2 or higher</A> +<LI><A HREF="http://sourceforge.net/project/showfiles.php?group_id=10127&package_id=11277">Expat 1.95.7 or higher</A> +<LI><A HREF="http://www.gnu.org/software/libiconv/">GNU Iconv 1.9.1</A> (optional) -<LI CLASS="li-itemize"><A HREF="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL</A> +<LI><A HREF="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL</A> (to enable SSL connections) -<LI CLASS="li-itemize"><A HREF="http://www.zlib.net/">Zlib 1.2.3 or higher</A> +<LI><A HREF="http://www.zlib.net/">Zlib 1.2.3 or higher</A> </UL> <!--TOC subsection Obtaining <TT>ejabberd</TT>--> -<H3 CLASS="subsection"><A NAME="htoc8">2.2</A> Obtaining <TT>ejabberd</TT></H3><!--SEC END --> +<H3><A NAME="htoc8">2.2</A> Obtaining <TT>ejabberd</TT></H3><!--SEC END --> <A NAME="sec:obtaining"></A> @@ -308,49 +299,49 @@ Released versions of <TT>ejabberd</TT> can be obtained from <BR> <BR> The latest development version can be retrieved from the Subversion repository. -<PRE CLASS="verbatim"> +<PRE> svn co http://svn.process-one.net/ejabberd/trunk ejabberd </PRE> <!--TOC subsection Compilation--> -<H3 CLASS="subsection"><A NAME="htoc9">2.3</A> Compilation</H3><!--SEC END --> +<H3><A NAME="htoc9">2.3</A> Compilation</H3><!--SEC END --> <A NAME="sec:compilation"></A> -<!--TOC subsubsection “Unix-like” operating systems--> +<!--TOC subsubsection ``Unix-like'' operating systems--> -<H4 CLASS="subsubsection"><A NAME="htoc10">2.3.1</A> “Unix-like” operating systems</H4><!--SEC END --> +<H4><A NAME="htoc10">2.3.1</A> ``Unix-like'' operating systems</H4><!--SEC END --> <A NAME="sec:compilationunix"></A> -Compile <TT>ejabberd</TT> on a “Unix-like” operating system by executing: -<PRE CLASS="verbatim"> +Compile <TT>ejabberd</TT> on a ``Unix-like'' operating system by executing: +<PRE> ./configure make su make install </PRE> These commands will: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> install <TT>ejabberd</TT> into the directory <CODE>/var/lib/ejabberd</CODE>, -<LI CLASS="li-itemize">install the configuration file into <CODE>/etc/ejabberd</CODE>, -<LI CLASS="li-itemize">create a directory called <CODE>/var/log/ejabberd</CODE> to store log files. +<LI>install the configuration file into <CODE>/etc/ejabberd</CODE>, +<LI>create a directory called <CODE>/var/log/ejabberd</CODE> to store log files. </UL> <!--TOC subsubsection Windows--> -<H4 CLASS="subsubsection"><A NAME="htoc11">2.3.2</A> Windows</H4><!--SEC END --> +<H4><A NAME="htoc11">2.3.2</A> Windows</H4><!--SEC END --> <A NAME="sec:compilationwin"></A> -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Install Erlang emulator (for example, into <CODE>C:\Program Files\erl5.3</CODE>). -<LI CLASS="li-itemize">Install Expat library into <CODE>C:\Program Files\Expat-1.95.7</CODE> +<LI>Install Expat library into <CODE>C:\Program Files\Expat-1.95.7</CODE> directory.<BR> <BR> Copy file <CODE>C:\Program Files\Expat-1.95.7\Libs\libexpat.dll</CODE> to your Windows system directory (for example, <CODE>C:\WINNT</CODE> or <CODE>C:\WINNT\System32</CODE>) -<LI CLASS="li-itemize">Build and install the Iconv library into the directory +<LI>Build and install the Iconv library into the directory <CODE>C:\Program Files\iconv-1.9.1</CODE>.<BR> <BR> Copy file <CODE>C:\Program Files\iconv-1.9.1\bin\iconv.dll</CODE> to your @@ -362,25 +353,25 @@ Note: instead of copying libexpat.dll and iconv.dll to the Windows <CODE>C:\Program Files\Expat-1.95.7\Libs</CODE> and <CODE>C:\Program Files\iconv-1.9.1\bin</CODE> to the <CODE>PATH</CODE> environment variable. -<LI CLASS="li-itemize">While in the directory <CODE>ejabberd\src</CODE> run: -<PRE CLASS="verbatim"> +<LI>While in the directory <CODE>ejabberd\src</CODE> run: +<PRE> configure.bat nmake -f Makefile.win32 -</PRE><LI CLASS="li-itemize">Edit the file <CODE>ejabberd\src\ejabberd.cfg</CODE> and run -<PRE CLASS="verbatim"> +</PRE><LI>Edit the file <CODE>ejabberd\src\ejabberd.cfg</CODE> and run +<PRE> werl -s ejabberd -name ejabberd </PRE></UL> <!--TOC subsection Starting--> -<H3 CLASS="subsection"><A NAME="htoc12">2.4</A> Starting</H3><!--SEC END --> +<H3><A NAME="htoc12">2.4</A> Starting</H3><!--SEC END --> <A NAME="sec:starting"></A> Execute the following command to start <TT>ejabberd</TT>: -<PRE CLASS="verbatim"> +<PRE> erl -pa /var/lib/ejabberd/ebin -name ejabberd -s ejabberd </PRE>or -<PRE CLASS="verbatim"> +<PRE> erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd </PRE>In the latter case the Erlang node will be identified using only the first part of the host name, i. e. other Erlang nodes outside this domain can't contact @@ -392,7 +383,7 @@ for storing its user database and for logging.<BR> <BR> To specify the path to the configuration file, the log files and the Mnesia database directory, you may use the following command: -<PRE CLASS="verbatim"> +<PRE> erl -pa /var/lib/ejabberd/ebin \ -sname ejabberd \ -s ejabberd \ @@ -406,25 +397,25 @@ You can find other useful options in the Erlang manual page <BR> To use more than 1024 connections, you should set the environment variable <CODE>ERL_MAX_PORTS</CODE>: -<PRE CLASS="verbatim"> +<PRE> export ERL_MAX_PORTS=32000 </PRE>Note that with this value, <TT>ejabberd</TT> will use more memory (approximately 6 MB more).<BR> <BR> To reduce memory usage, you may set the environment variable <CODE>ERL_FULLSWEEP_AFTER</CODE>: -<PRE CLASS="verbatim"> +<PRE> export ERL_FULLSWEEP_AFTER=0 </PRE>But in this case <TT>ejabberd</TT> can start to work slower.<BR> <BR> <!--TOC section Configuration--> -<H2 CLASS="section"><A NAME="htoc13">3</A> Configuration</H2><!--SEC END --> +<H2><A NAME="htoc13">3</A> Configuration</H2><!--SEC END --> <A NAME="sec:configuration"></A> <!--TOC subsection Initial Configuration--> -<H3 CLASS="subsection"><A NAME="htoc14">3.1</A> Initial Configuration</H3><!--SEC END --> +<H3><A NAME="htoc14">3.1</A> Initial Configuration</H3><!--SEC END --> <A NAME="sec:initconfig"></A> @@ -435,12 +426,12 @@ configuration file are appended to the entries in the database. The configuration file contains a sequence of Erlang terms. Lines beginning with a <TT>`%'</TT> sign are ignored. Each term is a tuple of which the first element is the name of an option, and any further elements are that option's values. If the -configuration file do not contain for instance the “hosts” option, the old +configuration file do not contain for instance the ``hosts'' option, the old host name(s) stored in the database will be used.<BR> <BR> You can override the old values stored in the database by adding next lines to the configuration file: -<PRE CLASS="verbatim"> +<PRE> override_global. override_local. override_acls. @@ -449,7 +440,7 @@ before new ones are added.<BR> <BR> <!--TOC subsubsection Host Names--> -<H4 CLASS="subsubsection"><A NAME="htoc15">3.1.1</A> Host Names</H4><!--SEC END --> +<H4><A NAME="htoc15">3.1.1</A> Host Names</H4><!--SEC END --> <A NAME="sec:confighostname"></A> @@ -457,23 +448,23 @@ The option <TT>hosts</TT> defines a list containing one or more domains that <TT>ejabberd</TT> will serve.<BR> <BR> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Serving one domain: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -<PRE CLASS="verbatim"> +<UL><LI> +<PRE> {hosts, ["example.org"]}. -</PRE><LI CLASS="li-itemize">Backwards compatibility with older <TT>ejabberd</TT> versions can be retained +</PRE><LI>Backwards compatibility with older <TT>ejabberd</TT> versions can be retained with: - <PRE CLASS="verbatim"> + <PRE> {host, "example.org"}. </PRE></UL> -<LI CLASS="li-itemize">Serving two domains: -<PRE CLASS="verbatim"> +<LI>Serving two domains: +<PRE> {hosts, ["example.net", "example.com"]}. </PRE></UL> <!--TOC subsubsection Default Language--> -<H4 CLASS="subsubsection"><A NAME="htoc16">3.1.2</A> Default Language</H4><!--SEC END --> +<H4><A NAME="htoc16">3.1.2</A> Default Language</H4><!--SEC END --> <A NAME="sec:configlanguage"></A> @@ -484,82 +475,82 @@ option <TT>language</TT> is <TT>"en"</TT>. In order to take effect there must be translation file <TT><language>.msg</TT> in <TT>ejabberd</TT>'s <TT>msgs</TT> directory.<BR> <BR> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> To set Russian as default language: -<PRE CLASS="verbatim"> +<PRE> {language, "ru"}. -</PRE><LI CLASS="li-itemize">To set Spanish as default language: -<PRE CLASS="verbatim"> +</PRE><LI>To set Spanish as default language: +<PRE> {language, "es"}. </PRE></UL> <!--TOC subsubsection Access Rules--> -<H4 CLASS="subsubsection"><A NAME="htoc17">3.1.3</A> Access Rules</H4><!--SEC END --> +<H4><A NAME="htoc17">3.1.3</A> Access Rules</H4><!--SEC END --> <A NAME="sec:configaccess"></A> Access control in <TT>ejabberd</TT> is performed via Access Control Lists (ACLs). The declarations of ACLs in the configuration file have the following syntax: -<PRE CLASS="verbatim"> +<PRE> {acl, <aclname>, {<acltype>, ...}}. </PRE> <TT><acltype></TT> can be one of the following: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>all</TT></B><DD CLASS="dd-description"> Matches all JIDs. Example: -<PRE CLASS="verbatim"> +<DL COMPACT=compact><DT> +<B><TT>all</TT></B><DD> Matches all JIDs. Example: +<PRE> {acl, all, all}. -</PRE><DT CLASS="dt-description"><B><TT>{user, <username>}</TT></B><DD CLASS="dd-description"> Matches the user with the name +</PRE><DT><B><TT>{user, <username>}</TT></B><DD> Matches the user with the name <TT><username></TT> at the first virtual host. Example: -<PRE CLASS="verbatim"> +<PRE> {acl, admin, {user, "yozhik"}}. -</PRE><DT CLASS="dt-description"><B><TT>{user, <username>, <server>}</TT></B><DD CLASS="dd-description"> Matches the user with the JID +</PRE><DT><B><TT>{user, <username>, <server>}</TT></B><DD> Matches the user with the JID <TT><username>@<server></TT> and any resource. Example: -<PRE CLASS="verbatim"> +<PRE> {acl, admin, {user, "yozhik", "example.org"}}. -</PRE><DT CLASS="dt-description"><B><TT>{server, <server>}</TT></B><DD CLASS="dd-description"> Matches any JID from server +</PRE><DT><B><TT>{server, <server>}</TT></B><DD> Matches any JID from server <TT><server></TT>. Example: -<PRE CLASS="verbatim"> +<PRE> {acl, exampleorg, {server, "example.org"}}. -</PRE><DT CLASS="dt-description"><B><TT>{user_regexp, <regexp>}</TT></B><DD CLASS="dd-description"> Matches any local user with a name that +</PRE><DT><B><TT>{user_regexp, <regexp>}</TT></B><DD> Matches any local user with a name that matches <TT><regexp></TT> at the first virtual host. Example: -<PRE CLASS="verbatim"> +<PRE> {acl, tests, {user, "^test[0-9]*$"}}. -</PRE><DT CLASS="dt-description"><B><TT>{user_regexp, <regexp>, <server>}</TT></B><DD CLASS="dd-description"> Matches any user with a name +</PRE><DT><B><TT>{user_regexp, <regexp>, <server>}</TT></B><DD> Matches any user with a name that matches <TT><regexp></TT> at server <TT><server></TT>. Example: -<PRE CLASS="verbatim"> +<PRE> {acl, tests, {user, "^test", "example.org"}}. -</PRE><DT CLASS="dt-description"><B><TT>{server_regexp, <regexp>}</TT></B><DD CLASS="dd-description"> Matches any JID from the server that +</PRE><DT><B><TT>{server_regexp, <regexp>}</TT></B><DD> Matches any JID from the server that matches <TT><regexp></TT>. Example: -<PRE CLASS="verbatim"> +<PRE> {acl, icq, {server, "^icq\\."}}. -</PRE><DT CLASS="dt-description"><B><TT>{node_regexp, <user_regexp>, <server_regexp>}</TT></B><DD CLASS="dd-description"> Matches any user +</PRE><DT><B><TT>{node_regexp, <user_regexp>, <server_regexp>}</TT></B><DD> Matches any user with a name that matches <TT><user_regexp></TT> at any server that matches <TT><server_regexp></TT>. Example: -<PRE CLASS="verbatim"> +<PRE> {acl, yohzik, {node_regexp, "^yohzik$", "^example.(com|org)$"}}. -</PRE><DT CLASS="dt-description"><B><TT>{user_glob, <glob>}</TT></B><DD CLASS="dd-description"> -<DT CLASS="dt-description"><B><TT>{user_glob, <glob>, <server>}</TT></B><DD CLASS="dd-description"> -<DT CLASS="dt-description"><B><TT>{server_glob, <glob>}</TT></B><DD CLASS="dd-description"> -<DT CLASS="dt-description"><B><TT>{node_glob, <user_glob>, <server_glob>}</TT></B><DD CLASS="dd-description"> This is the same as +</PRE><DT><B><TT>{user_glob, <glob>}</TT></B><DD> +<DT><B><TT>{user_glob, <glob>, <server>}</TT></B><DD> +<DT><B><TT>{server_glob, <glob>}</TT></B><DD> +<DT><B><TT>{node_glob, <user_glob>, <server_glob>}</TT></B><DD> This is the same as above. However, it uses shell glob patterns instead of regexp. These patterns can have the following special characters: - <DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> - <B><TT>*</TT></B><DD CLASS="dd-description"> matches any string including the null string. - <DT CLASS="dt-description"><B><TT>?</TT></B><DD CLASS="dd-description"> matches any single character. - <DT CLASS="dt-description"><B><TT>[...]</TT></B><DD CLASS="dd-description"> matches any of the enclosed characters. Character + <DL COMPACT=compact><DT> + <B><TT>*</TT></B><DD> matches any string including the null string. + <DT><B><TT>?</TT></B><DD> matches any single character. + <DT><B><TT>[...]</TT></B><DD> matches any of the enclosed characters. Character ranges are specified by a pair of characters separated by a <TT>`-'</TT>. If the first character after <TT>`['</TT> is a <TT>`!'</TT>, any character not enclosed is matched. </DL> </DL> The following ACLs are pre-defined: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>all</TT></B><DD CLASS="dd-description"> Matches any JID. -<DT CLASS="dt-description"><B><TT>none</TT></B><DD CLASS="dd-description"> Matches no JID. +<DL COMPACT=compact><DT> +<B><TT>all</TT></B><DD> Matches any JID. +<DT><B><TT>none</TT></B><DD> Matches no JID. </DL> An entry allowing or denying access to different services looks similar to this: -<PRE CLASS="verbatim"> +<PRE> {access, <accessname>, [{allow, <aclname>}, {deny, <aclname>}, ... @@ -567,57 +558,57 @@ this: </PRE>When a JID is checked to have access to <TT><accessname></TT>, the server sequentially checks if that JID mathes any of the ACLs that are named in the second elements of the tuples in the list. If it matches, the first element of -the first matched tuple is returned, otherwise “<TT>deny</TT>” is returned.<BR> +the first matched tuple is returned, otherwise ``<TT>deny</TT>'' is returned.<BR> <BR> Example: -<PRE CLASS="verbatim"> +<PRE> {access, configure, [{allow, admin}]}. {access, something, [{deny, badmans}, {allow, all}]}. </PRE> The following access rules are pre-defined: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>all</TT></B><DD CLASS="dd-description"> Always returns “<TT>allow</TT>” -<DT CLASS="dt-description"><B><TT>none</TT></B><DD CLASS="dd-description"> Always returns “<TT>deny</TT>” +<DL COMPACT=compact><DT> +<B><TT>all</TT></B><DD> Always returns ``<TT>allow</TT>'' +<DT><B><TT>none</TT></B><DD> Always returns ``<TT>deny</TT>'' </DL> <!--TOC subsubsection Shapers--> -<H4 CLASS="subsubsection"><A NAME="htoc18">3.1.4</A> Shapers</H4><!--SEC END --> +<H4><A NAME="htoc18">3.1.4</A> Shapers</H4><!--SEC END --> <A NAME="sec:configshaper"></A> Shapers enable you to limit connection traffic. The syntax of shapers is like this: -<PRE CLASS="verbatim"> +<PRE> {shaper, <shapername>, <kind>}. </PRE>Currently only one kind of shaper called <TT>maxrate</TT> is available. It has the following syntax: -<PRE CLASS="verbatim"> +<PRE> {maxrate, <rate>} </PRE>where <TT><rate></TT> stands for the maximum allowed incomig rate in bytes per second.<BR> <BR> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -To define a shaper named “<TT>normal</TT>” with traffic speed limited to +<UL><LI> +To define a shaper named ``<TT>normal</TT>'' with traffic speed limited to 1,000 bytes/second: -<PRE CLASS="verbatim"> +<PRE> {shaper, normal, {maxrate, 1000}}. -</PRE><LI CLASS="li-itemize">To define a shaper named “<TT>fast</TT>” with traffic speed limited to +</PRE><LI>To define a shaper named ``<TT>fast</TT>'' with traffic speed limited to 50,000 bytes/second: -<PRE CLASS="verbatim"> +<PRE> {shaper, fast, {maxrate, 50000}}. </PRE></UL> <!--TOC subsubsection Limitation of the number of opened sessions--> -<H4 CLASS="subsubsection"><A NAME="htoc19">3.1.5</A> Limitation of the number of opened sessions</H4><!--SEC END --> +<H4><A NAME="htoc19">3.1.5</A> Limitation of the number of opened sessions</H4><!--SEC END --> <A NAME="sec:configmaxsessions"></A> This option specifies the maximum number of sessions (authenticated connections) per user. If a user tries to open more than the maximum number of allowed sessions, with different resources, the first opened session will be -disconnected. The error “<TT>session replaced</TT>” is send to the +disconnected. The error ``<TT>session replaced</TT>'' is send to the disconnected session. This value is either a number or <TT>infinity</TT>. For example <CODE>{max\_user\_sessions, 10}</CODE>. The default value is <TT>10</TT>.<BR> <BR> @@ -625,21 +616,21 @@ This option can be define per virtual host. See section <A HREF="#sec:confi <BR> <!--TOC subsubsection Listened Sockets--> -<H4 CLASS="subsubsection"><A NAME="htoc20">3.1.6</A> Listened Sockets</H4><!--SEC END --> +<H4><A NAME="htoc20">3.1.6</A> Listened Sockets</H4><!--SEC END --> <A NAME="sec:configlistened"></A> The option <TT>listen</TT> defines for which addresses and ports <TT>ejabberd</TT> will listen and what services will be run on them. Each element of the list is a tuple with the following elements: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Port number. -<LI CLASS="li-itemize">Module that serves this port. -<LI CLASS="li-itemize">Options to this module. +<LI>Module that serves this port. +<LI>Options to this module. </UL> Currently next modules are implemented: -<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> +<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV> <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1> <TR><TD VALIGN=top ALIGN=left NOWRAP><TT>ejabberd_c2s</TT></TD> @@ -683,18 +674,18 @@ Currently next modules are implemented: <TD VALIGN=top ALIGN=left><TT>certfile</TT>, <TT>http_poll</TT>, <TT>inet6</TT>, <TT>ip</TT>, <TT>tls</TT>, <TT>web_admin</TT></TD> </TR></TABLE> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> +<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> (*) The mechanism for <A HREF="http://ejabberd.jabber.ru/tutorials-transports">external components</A> is defined in Jabber Component Protocol (<A HREF="http://www.jabber.org/jeps/jep-0114.html">JEP-0114</A>).<BR> <BR> The following options are available: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> - <B><TT>{access, <access rule>}</TT></B><DD CLASS="dd-description"> This option defines - access to the port. The default value is “<TT>all</TT>”. - <DT CLASS="dt-description"><B><TT>{certfile, Path}</TT></B><DD CLASS="dd-description"> Path to a file containing the SSL certificate. - <DT CLASS="dt-description"><B><TT>{hosts, [Hostnames], [HostOptions]}</TT></B><DD CLASS="dd-description"> This option +<DL COMPACT=compact><DT> + <B><TT>{access, <access rule>}</TT></B><DD> This option defines + access to the port. The default value is ``<TT>all</TT>''. + <DT><B><TT>{certfile, Path}</TT></B><DD> Path to a file containing the SSL certificate. + <DT><B><TT>{hosts, [Hostnames], [HostOptions]}</TT></B><DD> This option defines one or more hostnames of connected services and enables you to specify additional options including <TT>{password, Secret}</TT>. - <DT CLASS="dt-description"><B><TT>http_poll</TT></B><DD CLASS="dd-description"> + <DT><B><TT>http_poll</TT></B><DD> This option enables HTTP Polling (<A HREF="http://www.jabber.org/jeps/jep-0025.html">JEP-0025</A>) support. HTTP Polling enables access via HTTP requests to <TT>ejabberd</TT> from behind firewalls which do not allow outgoing sockets on port 5222.<BR> @@ -706,85 +697,85 @@ If HTTP Polling is enabled, it will be available at <A HREF="http://jwchat.sourceforge.net/">JWChat</A> (there is a tutorial to <A HREF="http://ejabberd.jabber.ru/jwchat">install JWChat</A> with instructions for <TT>ejabberd</TT>). - <DT CLASS="dt-description"><B><TT>inet6</TT></B><DD CLASS="dd-description"> Set up the socket for IPv6. - <DT CLASS="dt-description"><B><TT>{ip, IPAddress}</TT></B><DD CLASS="dd-description"> This option specifies which network + <DT><B><TT>inet6</TT></B><DD> Set up the socket for IPv6. + <DT><B><TT>{ip, IPAddress}</TT></B><DD> This option specifies which network interface to listen for. For example <CODE>{ip, {192, 168, 1, 1}}</CODE>. - <DT CLASS="dt-description"><B><TT>{max_stanza_size, Size}</TT></B><DD CLASS="dd-description"> This + <DT><B><TT>{max_stanza_size, Size}</TT></B><DD> This option specifies an approximate maximal size in bytes of XML stanzas. For example <CODE>{max\_stanza\_size, 65536}</CODE>. The default value - is “<TT>infinity</TT>”. - <DT CLASS="dt-description"><B><TT>{shaper, <access rule>}</TT></B><DD CLASS="dd-description"> This option defines a + is ``<TT>infinity</TT>''. + <DT><B><TT>{shaper, <access rule>}</TT></B><DD> This option defines a shaper for the port (see section <A HREF="#sec:configshaper">3.1.4</A>). The default value - is “<TT>none</TT>”. - <DT CLASS="dt-description"><B><TT>ssl</TT></B><DD CLASS="dd-description"> This option specifies that traffic on + is ``<TT>none</TT>''. + <DT><B><TT>ssl</TT></B><DD> This option specifies that traffic on the port will be encrypted using SSL. You should also set the <TT>certfile</TT> option. It is recommended to use the <TT>tls</TT> option instead. - <DT CLASS="dt-description"><B><TT>starttls</TT></B><DD CLASS="dd-description"> This option + <DT><B><TT>starttls</TT></B><DD> This option specifies that STARTTLS encryption is available on connections to the port. You should also set the <TT>certfile</TT> option. - <DT CLASS="dt-description"><B><TT>starttls_required</TT></B><DD CLASS="dd-description"> This option + <DT><B><TT>starttls_required</TT></B><DD> This option specifies that STARTTLS encryption is required on connections to the port. No unencrypted connections will be allowed. You should also set the <TT>certfile</TT> option. - <DT CLASS="dt-description"><B><TT>tls</TT></B><DD CLASS="dd-description"> This option specifies that traffic on + <DT><B><TT>tls</TT></B><DD> This option specifies that traffic on the port will be encrypted using SSL immediately after connecting. You should also set the <TT>certfile</TT> option. - <DT CLASS="dt-description"><B><TT>zlib</TT></B><DD CLASS="dd-description"> This + <DT><B><TT>zlib</TT></B><DD> This option specifies that Zlib stream compression (as defined in <A HREF="http://www.jabber.org/jeps/jep-0138.html">JEP-0138</A>) is available on connections to the port. Client cannot use stream compression and stream encryption simultaneously, so if you specify both <TT>tls</TT> (or <TT>ssl</TT>) and <TT>zlib</TT> the latter option will not affect connection at all. - <DT CLASS="dt-description"><B><TT>web_admin</TT></B><DD CLASS="dd-description"> This option + <DT><B><TT>web_admin</TT></B><DD> This option enables the web interface for <TT>ejabberd</TT> administration which is available at <CODE>http://server:port/admin/</CODE>. Login and password are the username and password of one of the registered users who are granted access by the - “configure” access rule. + ``configure'' access rule. </DL> Also the following global options are available for s2s connections: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> - <B><TT>{s2s_use_starttls, true|false}</TT></B><DD CLASS="dd-description"> +<DL COMPACT=compact><DT> + <B><TT>{s2s_use_starttls, true|false}</TT></B><DD> This option defines whether to use STARTTLS for s2s connections. - <DT CLASS="dt-description"><B><TT>{s2s_certfile, Path}</TT></B><DD CLASS="dd-description"> Path to the + <DT><B><TT>{s2s_certfile, Path}</TT></B><DD> Path to the file containing the SSL certificate. - <DT CLASS="dt-description"><B><TT>{domain_certfile, Domain, Path}</TT></B><DD CLASS="dd-description"> Path + <DT><B><TT>{domain_certfile, Domain, Path}</TT></B><DD> Path to the file containing the SSL certificate for the specified domain. </DL> For instance, the following configuration defines that: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> c2s connections are listened for on port 5222 and 5223 (SSL) and denied - for the user “<TT>bad</TT>” -<LI CLASS="li-itemize">s2s connections are listened for on port 5269 with STARTTLS for secured + for the user ``<TT>bad</TT>'' +<LI>s2s connections are listened for on port 5269 with STARTTLS for secured traffic enabled. -<LI CLASS="li-itemize">Port 5280 is serving the web interface and the HTTP Polling service. Note +<LI>Port 5280 is serving the web interface and the HTTP Polling service. Note that it is also possible to serve them on different ports. The second example in section <A HREF="#sec:webadm">3.4.1</A> shows how exactly this can be done. -<LI CLASS="li-itemize">All users except for the administrators have a traffic of limit +<LI>All users except for the administrators have a traffic of limit 1,000 Bytes/second -<LI CLASS="li-itemize">The +<LI>The <A HREF="http://ejabberd.jabber.ru/pyaimt">AIM transport</A> <TT>aim.example.org</TT> is connected to port 5233 with password - “<TT>aimsecret</TT>” -<LI CLASS="li-itemize">The ICQ transport JIT (<TT>icq.example.org</TT> and + ``<TT>aimsecret</TT>'' +<LI>The ICQ transport JIT (<TT>icq.example.org</TT> and <TT>sms.example.org</TT>) is connected to port 5234 with password - “<TT>jitsecret</TT>” -<LI CLASS="li-itemize">The + ``<TT>jitsecret</TT>'' +<LI>The <A HREF="http://ejabberd.jabber.ru/pymsnt">MSN transport</A> <TT>msn.example.org</TT> is connected to port 5235 with password - “<TT>msnsecret</TT>” -<LI CLASS="li-itemize">The + ``<TT>msnsecret</TT>'' +<LI>The <A HREF="http://ejabberd.jabber.ru/yahoo-transport-2">Yahoo! transport</A> <TT>yahoo.example.org</TT> is connected to port 5236 with password - “<TT>yahoosecret</TT>” -<LI CLASS="li-itemize">The <A HREF="http://ejabberd.jabber.ru/jabber-gg-transport">Gadu-Gadu transport</A> <TT>gg.example.org</TT> is - connected to port 5237 with password “<TT>ggsecret</TT>” -<LI CLASS="li-itemize">The + ``<TT>yahoosecret</TT>'' +<LI>The <A HREF="http://ejabberd.jabber.ru/jabber-gg-transport">Gadu-Gadu transport</A> <TT>gg.example.org</TT> is + connected to port 5237 with password ``<TT>ggsecret</TT>'' +<LI>The <A HREF="http://ejabberd.jabber.ru/jmc">Jabber Mail Component</A> <TT>jmc.example.org</TT> is connected to port 5238 with password - “<TT>jmcsecret</TT>” + ``<TT>jmcsecret</TT>'' </UL> -<PRE CLASS="verbatim"> +<PRE> {acl, blocked, {user, "bad"}}. {access, c2s, [{deny, blocked}, {allow, all}]}. @@ -815,7 +806,7 @@ c2s connections are listened for on port 5222 and 5223 (SSL) and denied {s2s_certfile, "/path/to/ssl.pem"}. </PRE>Note, that for jabberd 1.4- or WPJabber-based services you have to make the transports log and do XDB by themselves: -<PRE CLASS="verbatim"> +<PRE> <!-- You have to add elogger and rlogger entries here when using ejabberd. In this case the transport will do the logging. @@ -847,7 +838,7 @@ services you have to make the transports log and do XDB by themselves: </PRE> <!--TOC subsubsection Modules--> -<H4 CLASS="subsubsection"><A NAME="htoc21">3.1.7</A> Modules</H4><!--SEC END --> +<H4><A NAME="htoc21">3.1.7</A> Modules</H4><!--SEC END --> <A NAME="sec:configmodules"></A> @@ -857,17 +848,17 @@ element is the name of a module and the second is a list of options for that module. Read section <A HREF="#sec:modules">A</A> for detailed information about modules.<BR> <BR> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> In this simple example, only the module <TT>mod_echo</TT> is loaded and no options are specified between square brackets: - <PRE CLASS="verbatim"> + <PRE> {modules, [{mod_echo, []} ]}. -</PRE><LI CLASS="li-itemize">The second example is also simple: the modules <TT>mod_echo</TT>, <TT>mod_time</TT>, and +</PRE><LI>The second example is also simple: the modules <TT>mod_echo</TT>, <TT>mod_time</TT>, and <TT>mod_version</TT> are loaded without options. Remark that, besides the last entry, all entries end with a comma: - <PRE CLASS="verbatim"> + <PRE> {modules, [{mod_echo, []}, {mod_time, []}, @@ -876,22 +867,22 @@ In this simple example, only the module <TT>mod_echo</TT> is loaded and no </PRE></UL> <!--TOC subsubsection Virtual Hosting--> -<H4 CLASS="subsubsection"><A NAME="htoc22">3.1.8</A> Virtual Hosting</H4><!--SEC END --> +<H4><A NAME="htoc22">3.1.8</A> Virtual Hosting</H4><!--SEC END --> <A NAME="sec:configvirtualhost"></A> Options can be defined separately for every virtual host using the <TT>host_config</TT> option. It has the following syntax: -<PRE CLASS="verbatim"> +<PRE> {host_config, <hostname>, [<option>, <option>, ...]}. </PRE> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Domain <TT>example.net</TT> is using the internal authentication method while domain <TT>example.com</TT> is using the LDAP server running on the domain <TT>localhost</TT> to perform authentication: -<PRE CLASS="verbatim"> +<PRE> {host_config, "example.net", [{auth_method, internal}]}. {host_config, "example.com", [{auth_method, ldap}, @@ -900,10 +891,10 @@ Domain <TT>example.net</TT> is using the internal authentication method while {ldap_rootdn, "dc=localdomain"}, {ldap_rootdn, "dc=example,dc=com"}, {ldap_password, ""}]}. -</PRE><LI CLASS="li-itemize">Domain <TT>example.net</TT> is using ODBC to perform authentication +</PRE><LI>Domain <TT>example.net</TT> is using ODBC to perform authentication while domain <TT>example.com</TT> is using the LDAP servers running on the domains <TT>localhost</TT> and <TT>otherhost</TT>: -<PRE CLASS="verbatim"> +<PRE> {host_config, "example.net", [{auth_method, odbc}, {odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}]}. @@ -916,24 +907,24 @@ Domain <TT>example.net</TT> is using the internal authentication method while </PRE></UL> <!--TOC subsubsection SASL anonymous and anonymous login--> -<H4 CLASS="subsubsection"><A NAME="htoc23">3.1.9</A> SASL anonymous and anonymous login</H4><!--SEC END --> +<H4><A NAME="htoc23">3.1.9</A> SASL anonymous and anonymous login</H4><!--SEC END --> <A NAME="sec:configsaslanonymous"></A> The configuration of the anonymous mode can be done with three <TT>host_config</TT> parameters: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> <TT>auth_method</TT>: This value is used for defining the authentication method: internal, odbc, ldap, external). You now have a special extra option to enable anonymous mode: anonymous.<BR> <BR> -<LI CLASS="li-itemize"><TT>allow_multiple_connections</TT>: This option can be either true or false and +<LI><TT>allow_multiple_connections</TT>: This option can be either true or false and is only used when the anonymous mode is enabled. Setting it to true means that the same username will be able to be taken several time in anonymous login mode if different resource are used to connect. This option is only useful in very special cases. It defaults to false.<BR> <BR> -<LI CLASS="li-itemize"><TT>anonymous_protocol</TT>: This option can take three values: +<LI><TT>anonymous_protocol</TT>: This option can take three values: <TT>sasl_anon</TT>, <TT>login_anon</TT> or both. <TT>sasl_anon</TT> means that SASL anonymous mode is enabled. <TT>login_anon</TT> means that anonymous login mode is enabled. both means that SASL anonymous and login anonymous are @@ -943,26 +934,26 @@ Those options are defined for each virtual host with the <TT>host_config</TT> parameter (see section <A HREF="#sec:configvirtualhost">3.1.8</A>).<BR> <BR> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> To enable anonymous login on a virtual host: -<PRE CLASS="verbatim"> +<PRE> {host_config, "public.example.org", [{auth_method, anonymous}, {anonymous_protocol, login_anon}]}. -</PRE><LI CLASS="li-itemize">To enable anonymous login and internal authentication on a virtual host: -<PRE CLASS="verbatim"> +</PRE><LI>To enable anonymous login and internal authentication on a virtual host: +<PRE> {host_config, "public.example.org", [{auth_method, [anonymous,internal]}, {anonymous_protocol, login_anon}]}. -</PRE><LI CLASS="li-itemize">To enable SASL anonymous on a virtual host: -<PRE CLASS="verbatim"> +</PRE><LI>To enable SASL anonymous on a virtual host: +<PRE> {host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, sasl_anon}]}. -</PRE><LI CLASS="li-itemize">To enable SASL anonymous and anonymous login on a virtual host: -<PRE CLASS="verbatim"> +</PRE><LI>To enable SASL anonymous and anonymous login on a virtual host: +<PRE> {host_config, "public.example.org", [{auth_method, [anonymous]}, {anonymous_protocol, both}]}. -</PRE><LI CLASS="li-itemize">To enable SASL anonymous, anonymous login and internal authentication on +</PRE><LI>To enable SASL anonymous, anonymous login and internal authentication on a virtual host: -<PRE CLASS="verbatim"> +<PRE> {host_config, "public.example.org", [{auth_method, [anonymous,internal]}, {anonymous_protocol, both}]}. </PRE></UL> @@ -972,12 +963,12 @@ available from: <BR> <!--TOC subsection Relational Database Support--> -<H3 CLASS="subsection"><A NAME="htoc24">3.2</A> Relational Database Support</H3><!--SEC END --> +<H3><A NAME="htoc24">3.2</A> Relational Database Support</H3><!--SEC END --> <A NAME="sec:relationaldatabase"></A> <!--TOC subsubsection Preliminary steps--> -<H4 CLASS="subsubsection"><A NAME="htoc25">3.2.1</A> Preliminary steps</H4><!--SEC END --> +<H4><A NAME="htoc25">3.2.1</A> Preliminary steps</H4><!--SEC END --> <A NAME="sec:relationaldatabasecompilation"></A> If you have installed ejabberd using a binary version, the compilation steps @@ -987,17 +978,17 @@ Otherwise, to be able to use ejabberd with a relational database you need to enable ODBC modules during compilation, even if you want to use ejabberd with MySQL or PostgreSQL in native mode. The following <TT>configure</TT> command can be used to enable the relational modules: -<PRE CLASS="verbatim"> +<PRE> ./configure --enable-odbc </PRE> If you are planning to use Microsoft SQL Server with ODBC, you need to specify it from the <TT>configure</TT> command before compilation: -<PRE CLASS="verbatim"> +<PRE> ./configure --enable-odbc --enable-mssql </PRE> <!--TOC subsubsection Authentication against a relational database--> -<H4 CLASS="subsubsection"><A NAME="htoc26">3.2.2</A> Authentication against a relational database</H4><!--SEC END --> +<H4><A NAME="htoc26">3.2.2</A> Authentication against a relational database</H4><!--SEC END --> <A NAME="sec:relationaldatabaseauth"></A> ejabberd use its internal Mnesia database as a default. It is however possible @@ -1010,7 +1001,7 @@ system.<BR> The option value name be misleading, as the method name is use both for access to relational database through ODBC or through the native interface. In any case, the first step is to define the odbc <TT>auth_method</TT>. For example: -<PRE CLASS="verbatim"> +<PRE> {host_config, "public.example.org", [{auth_method, [odbc]}]}. </PRE> The actual database access is defined in the option <TT>odbc_server</TT>. Its @@ -1019,16 +1010,16 @@ interface available, PostgreSQL or MySQL.<BR> <BR> To use a relational database through ODBC, you can pass the ODBC connection string as <TT>odbc_server</TT> parameter. For example: -<PRE CLASS="verbatim"> +<PRE> {odbc_server, "DSN=database;UID=ejabberd;PWD=password"}. </PRE> To use the native PostgreSQL interface, you can pass a tuple of the following form as parameter: -<PRE CLASS="verbatim"> +<PRE> {pgsql, "Server", "Database", "Username", "Password"} </PRE> <TT>pgsql</TT> is a keyword that should be kept as is. For example: -<PRE CLASS="verbatim"> +<PRE> {odbc_server, {pgsql, "localhost", "database", "ejabberd", "password"}}. </PRE> Note that you need to install the Erlang PgSQL library first. This library is @@ -1037,11 +1028,11 @@ available from Sourceforge: <A HREF="http://cvs.sourceforge.net/viewcvs.py/junge To use the native MySQL interface, the same tuple should be passed, except that you now have to use the <TT>mysql</TT> keyword instead of the <TT>pgsql</TT> keyword: -<PRE CLASS="verbatim"> +<PRE> {mysql, "Server", "Database", "Username", "Password"} </PRE> <TT>mysql</TT> is a keyword that should be kept as is. For example: -<PRE CLASS="verbatim"> +<PRE> {odbc_server, {mysql, "localhost", "test", "root", "password"}}. </PRE> Note that you need to install the Erlang MySQL library first. This library is @@ -1052,61 +1043,61 @@ available from: <A HREF="http://support.process-one.net/doc/display/MESSENGER/Us <BR> <!--TOC subsubsection Relational database for other modules--> -<H4 CLASS="subsubsection"><A NAME="htoc27">3.2.3</A> Relational database for other modules</H4><!--SEC END --> +<H4><A NAME="htoc27">3.2.3</A> Relational database for other modules</H4><!--SEC END --> <A NAME="sec:relationaldatabaseextra"></A> It is possible to use a relational database to store pieces of information. You can do this by changing the module name to a name with an <TT>_odbc</TT> suffix in <TT>ejabberd</TT> config file. You can use a relational database for the following data: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Last connection date and time: Use <TT>mod_last_odbc</TT> instead of <TT>mod_last</TT>. -<LI CLASS="li-itemize">Offline messages: Use <TT>mod_offline_odbc</TT> instead of +<LI>Offline messages: Use <TT>mod_offline_odbc</TT> instead of <TT>mod_offline</TT>. -<LI CLASS="li-itemize">Rosters: Use <TT>mod_roster_odbc</TT> instead of <TT>mod_roster</TT>. -<LI CLASS="li-itemize">Users' VCARD: Use <TT>mod_vcard_odbc</TT> instead of <TT>mod_vcard</TT>. +<LI>Rosters: Use <TT>mod_roster_odbc</TT> instead of <TT>mod_roster</TT>. +<LI>Users' VCARD: Use <TT>mod_vcard_odbc</TT> instead of <TT>mod_vcard</TT>. </UL> <!--TOC subsection Creating an Initial Administrator--> -<H3 CLASS="subsection"><A NAME="htoc28">3.3</A> Creating an Initial Administrator</H3><!--SEC END --> +<H3><A NAME="htoc28">3.3</A> Creating an Initial Administrator</H3><!--SEC END --> <A NAME="sec:initialadmin"></A> Before the web interface can be entered to perform administration tasks, an account with administrator rights is needed on your <TT>ejabberd</TT> deployment.<BR> <BR> Instructions to create an initial administrator account: -<OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> +<OL type=1><LI> Register an account on your <TT>ejabberd</TT> deployment. An account can be created in two ways: - <OL CLASS="enumerate" type=a><LI CLASS="li-enumerate"> + <OL type=a><LI> Using the tool <TT>ejabberdctl</TT> (see section <A HREF="#sec:ejabberdctl">3.4.2</A>): - <PRE CLASS="verbatim"> + <PRE> % ejabberdctl node@host register admin example.org password -</PRE><LI CLASS="li-enumerate">Using In-Band Registration (see section <A HREF="#sec:modregister">A.14</A>): you can +</PRE><LI>Using In-Band Registration (see section <A HREF="#sec:modregister">A.14</A>): you can use a Jabber client to register an account. </OL> -<LI CLASS="li-enumerate">Edit the configuration file to promote the account created in the previous +<LI>Edit the configuration file to promote the account created in the previous step to an account with administrator rights. Note that if you want to add more administrators, a seperate acl entry is needed for each administrator. - <PRE CLASS="verbatim"> + <PRE> {acl, admins, {user, "admin", "example.org"}}. {access, configure, [{allow, admins}]}. -</PRE><LI CLASS="li-enumerate">Restart <TT>ejabberd</TT> to load the new configuration. -<LI CLASS="li-enumerate">Open the web interface (<CODE>http://server:port/admin/</CODE>) in your +</PRE><LI>Restart <TT>ejabberd</TT> to load the new configuration. +<LI>Open the web interface (<CODE>http://server:port/admin/</CODE>) in your favourite browser. Make sure to enter the <EM>full</EM> JID as username (in this example: <TT>admin@example.org</TT>. The reason that you also need to enter the suffix, is because <TT>ejabberd</TT>'s virtual hosting support. </OL> <!--TOC subsection Online Configuration and Monitoring--> -<H3 CLASS="subsection"><A NAME="htoc29">3.4</A> Online Configuration and Monitoring</H3><!--SEC END --> +<H3><A NAME="htoc29">3.4</A> Online Configuration and Monitoring</H3><!--SEC END --> <A NAME="sec:onlineconfig"></A> <!--TOC subsubsection Web Interface--> -<H4 CLASS="subsubsection"><A NAME="htoc30">3.4.1</A> Web Interface</H4><!--SEC END --> +<H4><A NAME="htoc30">3.4.1</A> Web Interface</H4><!--SEC END --> <A NAME="sec:webadm"></A> @@ -1117,24 +1108,22 @@ section <A HREF="#sec:configlistened">3.1.6</A>). Then you can open will be asked to enter the username (the <EM>full</EM> Jabber ID) and password of an <TT>ejabberd</TT> user with administrator rights. After authentication you will see a page similar to figure <A HREF="#fig:webadmmain">1</A>. -<BLOCKQUOTE CLASS="figure"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> +<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV> <IMG SRC="webadmmain.png"> <BR> -<BR> -<DIV CLASS="center">Figure 1: Top page from the web interface</DIV><BR> -<BR> +<DIV ALIGN=center>Figure 1: Top page from the web interface</DIV><BR> <A NAME="fig:webadmmain"></A> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> +<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> Here you can edit access restrictions, manage users, create backups, manage the database, enable/disable ports listened for, view server statistics,...<BR> <BR> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> You can serve the web interface on the same port as the HTTP Polling interface. In this example you should point your web browser to <CODE>http://example.org:5280/admin/</CODE> to @@ -1143,11 +1132,11 @@ You can serve the web interface on the same port as the the virtual host <TT>example.com</TT>. Before you get access to the web interface you need to enter as username, the JID and password from a registered user that is allowed to configure <TT>ejabberd</TT>. In this example you can enter as - username “<TT>admin@example.net</TT>” to administer all virtual hosts (first - URL). If you log in with “<TT>admin@example.com</TT>” on<BR> + username ``<TT>admin@example.net</TT>'' to administer all virtual hosts (first + URL). If you log in with ``<TT>admin@example.com</TT>'' on<BR> <CODE>http://example.org:5280/admin/server/example.com/</CODE> you can only administer the virtual host <TT>example.com</TT>. - <PRE CLASS="verbatim"> + <PRE> ... {acl, admins, {user, "admin", "example.net"}}. {host_config, "example.com", [{acl, admins, {user, "admin", "example.com"}}]}. @@ -1161,11 +1150,11 @@ You can serve the web interface on the same port as the ... ] }. -</PRE><LI CLASS="li-itemize">For security reasons, you can serve the web interface on a secured +</PRE><LI>For security reasons, you can serve the web interface on a secured connection, on a port differing from the HTTP Polling interface, and bind it to the internal LAN IP. The web interface will be accessible by pointing your web browser to <CODE>https://192.168.1.1:5280/admin/</CODE>: - <PRE CLASS="verbatim"> + <PRE> ... {hosts, ["example.org"]}. ... @@ -1180,13 +1169,13 @@ You can serve the web interface on the same port as the </PRE></UL> <!--TOC subsubsection <TT>ejabberdctl</TT>--> -<H4 CLASS="subsubsection"><A NAME="htoc31">3.4.2</A> <TT>ejabberdctl</TT></H4><!--SEC END --> +<H4><A NAME="htoc31">3.4.2</A> <TT>ejabberdctl</TT></H4><!--SEC END --> <A NAME="sec:ejabberdctl"></A> It is possible to do some administration operations using the command line tool <TT>ejabberdctl</TT>. You can list all available options by running <TT>ejabberdctl</TT> without arguments: -<PRE CLASS="verbatim"> +<PRE> % ejabberdctl Usage: ejabberdctl node command @@ -1211,27 +1200,27 @@ Example: ejabberdctl ejabberd@host restart </PRE> Additional information: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>reopen-log </TT></B><DD CLASS="dd-description"> If you use a tool to rotate logs, you have to configure it +<DL COMPACT=compact><DT> +<B><TT>reopen-log </TT></B><DD> If you use a tool to rotate logs, you have to configure it so that this command is executed after each rotation. -<DT CLASS="dt-description"><B><TT>backup, restore, install-fallback, dump, load</TT></B><DD CLASS="dd-description"> You can use these +<DT><B><TT>backup, restore, install-fallback, dump, load</TT></B><DD> You can use these commands to create and restore backups. -<DT CLASS="dt-description"><B><TT>import-file, import-dir</TT></B><DD CLASS="dd-description"> +<DT><B><TT>import-file, import-dir</TT></B><DD> These options can be used to migrate from other Jabber/XMPP servers. There exist tutorials to <A HREF="http://ejabberd.jabber.ru/jabberd1-to-ejabberd">migrate from jabberd 1.4</A> and to <A HREF="http://ejabberd.jabber.ru/jabberd2-to-ejabberd">migrate from jabberd2</A>. -<DT CLASS="dt-description"><B><TT>delete-expired-messages</TT></B><DD CLASS="dd-description"> This option can be used to delete old messages +<DT><B><TT>delete-expired-messages</TT></B><DD> This option can be used to delete old messages in offline storage. This might be useful when the number of offline messages is very high. </DL> <!--TOC section Firewall Settings--> -<H2 CLASS="section"><A NAME="htoc32">4</A> Firewall Settings</H2><!--SEC END --> +<H2><A NAME="htoc32">4</A> Firewall Settings</H2><!--SEC END --> <A NAME="sec:firewall"></A> You need to take the following TCP ports in mind when configuring your firewall: -<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> +<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV> <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1> <TR><TD ALIGN=left NOWRAP>Port</TD> <TD ALIGN=left NOWRAP>Description</TD> @@ -1252,28 +1241,28 @@ You need to take the following TCP ports in mind when configuring your firewall: <TD ALIGN=left NOWRAP>Only for clustring (see <A HREF="#sec:clustering">6</A>). This range is configurable (see <A HREF="#sec:starting">2.4</A>).</TD> </TR></TABLE> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> +<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> <!--TOC section SRV Records--> -<H2 CLASS="section"><A NAME="htoc33">5</A> SRV Records</H2><!--SEC END --> +<H2><A NAME="htoc33">5</A> SRV Records</H2><!--SEC END --> <A NAME="sec:srv"></A> -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> General information: <A HREF="http://en.wikipedia.org/wiki/SRV_record">SRV record</A> -<LI CLASS="li-itemize">Practical information: +<LI>Practical information: <A HREF="http://jabberd.jabberstudio.org/2/docs/section05.html#5_7">Setting DNS SRV Records</A> </UL> <!--TOC section Clustering--> -<H2 CLASS="section"><A NAME="htoc34">6</A> Clustering</H2><!--SEC END --> +<H2><A NAME="htoc34">6</A> Clustering</H2><!--SEC END --> <A NAME="sec:clustering"></A> <!--TOC subsection How it Works--> -<H3 CLASS="subsection"><A NAME="htoc35">6.1</A> How it Works</H3><!--SEC END --> +<H3><A NAME="htoc35">6.1</A> How it Works</H3><!--SEC END --> <A NAME="sec:howitworks"></A> @@ -1286,15 +1275,15 @@ needed because all nodes exchange information about connected users, s2s connections, registered services, etc...<BR> <BR> Each <TT>ejabberd</TT> node has the following modules: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> router, -<LI CLASS="li-itemize">local router, -<LI CLASS="li-itemize">session manager, -<LI CLASS="li-itemize">s2s manager. +<LI>local router, +<LI>session manager, +<LI>s2s manager. </UL> <!--TOC subsubsection Router--> -<H4 CLASS="subsubsection"><A NAME="htoc36">6.1.1</A> Router</H4><!--SEC END --> +<H4><A NAME="htoc36">6.1.1</A> Router</H4><!--SEC END --> This module is the main router of Jabber packets on each node. It @@ -1305,7 +1294,7 @@ appropriate process. If not, it is sent to the s2s manager.<BR> <BR> <!--TOC subsubsection Local Router--> -<H4 CLASS="subsubsection"><A NAME="htoc37">6.1.2</A> Local Router</H4><!--SEC END --> +<H4><A NAME="htoc37">6.1.2</A> Local Router</H4><!--SEC END --> This module routes packets which have a destination domain equal to @@ -1315,7 +1304,7 @@ on its content.<BR> <BR> <!--TOC subsubsection Session Manager--> -<H4 CLASS="subsubsection"><A NAME="htoc38">6.1.3</A> Session Manager</H4><!--SEC END --> +<H4><A NAME="htoc38">6.1.3</A> Session Manager</H4><!--SEC END --> This module routes packets to local users. It looks up to which user @@ -1325,7 +1314,7 @@ storage, or bounced back.<BR> <BR> <!--TOC subsubsection s2s Manager--> -<H4 CLASS="subsubsection"><A NAME="htoc39">6.1.4</A> s2s Manager</H4><!--SEC END --> +<H4><A NAME="htoc39">6.1.4</A> s2s Manager</H4><!--SEC END --> This module routes packets to other Jabber servers. First, it @@ -1336,52 +1325,52 @@ serving this connection, otherwise a new connection is opened.<BR> <BR> <!--TOC subsection Clustering Setup--> -<H3 CLASS="subsection"><A NAME="htoc40">6.2</A> Clustering Setup</H3><!--SEC END --> +<H3><A NAME="htoc40">6.2</A> Clustering Setup</H3><!--SEC END --> <A NAME="sec:cluster"></A> Suppose you already configured <TT>ejabberd</TT> on one machine named (<TT>first</TT>), and you need to setup another one to make an <TT>ejabberd</TT> cluster. Then do following steps: -<OL CLASS="enumerate" type=1><LI CLASS="li-enumerate"> +<OL type=1><LI> Copy <CODE>~ejabberd/.erlang.cookie</CODE> file from <TT>first</TT> to <TT>second</TT>.<BR> <BR> -(alt) You can also add “<CODE>-cookie content_of_.erlang.cookie</CODE>” - option to all “<TT>erl</TT>” commands below.<BR> +(alt) You can also add ``<CODE>-cookie content_of_.erlang.cookie</CODE>'' + option to all ``<TT>erl</TT>'' commands below.<BR> <BR> -<LI CLASS="li-enumerate">On <TT>second</TT> run as the `<TT>ejabberd</TT>' user in the directory +<LI>On <TT>second</TT> run as the `<TT>ejabberd</TT>' user in the directory where <TT>ejabberd</TT> will work later the following command: -<PRE CLASS="verbatim"> +<PRE> erl -sname ejabberd \ -mnesia extra_db_nodes "['ejabberd@first']" \ -s mnesia </PRE> This will start Mnesia serving the same database as <TT>ejabberd@first</TT>. - You can check this by running the command “<CODE>mnesia:info().</CODE>”. You + You can check this by running the command ``<CODE>mnesia:info().</CODE>''. You should see a lot of remote tables and a line like the following: -<PRE CLASS="verbatim"> +<PRE> running db nodes = [ejabberd@first, ejabberd@second] </PRE><BR> <BR> -<LI CLASS="li-enumerate">Now run the following in the same “<TT>erl</TT>” session: -<PRE CLASS="verbatim"> +<LI>Now run the following in the same ``<TT>erl</TT>'' session: +<PRE> mnesia:change_table_copy_type(schema, node(), disc_copies). </PRE> This will create local disc storage for the database.<BR> <BR> -(alt) Change storage type of `<TT>scheme</TT>' table to “RAM and disc - copy” on the second node via the web interface.<BR> +(alt) Change storage type of `<TT>scheme</TT>' table to ``RAM and disc + copy'' on the second node via the web interface.<BR> <BR> -<LI CLASS="li-enumerate">Now you can add replicas of various tables to this node with - “<CODE>mnesia:add_table_copy</CODE>” or - “<CODE>mnesia:change_table_copy_type</CODE>” as above (just replace - “<CODE>schema</CODE>” with another table name and “<CODE>disc_copies</CODE>” - can be replaced with “<CODE>ram_copies</CODE>” or - “<CODE>disc_only_copies</CODE>”).<BR> +<LI>Now you can add replicas of various tables to this node with + ``<CODE>mnesia:add_table_copy</CODE>'' or + ``<CODE>mnesia:change_table_copy_type</CODE>'' as above (just replace + ``<CODE>schema</CODE>'' with another table name and ``<CODE>disc_copies</CODE>'' + can be replaced with ``<CODE>ram_copies</CODE>'' or + ``<CODE>disc_only_copies</CODE>'').<BR> <BR> Which tables to replicate is very dependant on your needs, you can get - some hints from the command “<CODE>mnesia:info().</CODE>”, by looking at the + some hints from the command ``<CODE>mnesia:info().</CODE>'', by looking at the size of tables and the default storage type for each table on 'first'.<BR> <BR> Replicating a table makes lookups in this table faster on this node. @@ -1393,13 +1382,13 @@ Also <A HREF="http://www.erlang.se/doc/doc-5.4.9/lib/mnesia-4.2.2/doc/html/Mnesi <BR> (alt) Same as in previous item, but for other tables.<BR> <BR> -<LI CLASS="li-enumerate">Run “<CODE>init:stop().</CODE>” or just “<CODE>q().</CODE>” to exit from +<LI>Run ``<CODE>init:stop().</CODE>'' or just ``<CODE>q().</CODE>'' to exit from the Erlang shell. This probably can take some time if Mnesia has not yet transfered and processed all data it needed from <TT>first</TT>.<BR> <BR> -<LI CLASS="li-enumerate">Now run <TT>ejabberd</TT> on <TT>second</TT> with almost the same config as - on <TT>first</TT> (you probably don't need to duplicate “<CODE>acl</CODE>” - and “<CODE>access</CODE>” options — they will be taken from +<LI>Now run <TT>ejabberd</TT> on <TT>second</TT> with almost the same config as + on <TT>first</TT> (you probably don't need to duplicate ``<CODE>acl</CODE>'' + and ``<CODE>access</CODE>'' options --- they will be taken from <TT>first</TT>, and <CODE>mod_muc</CODE> and <CODE>mod_irc</CODE> should be enabled only on one machine in the cluster). </OL> @@ -1409,13 +1398,13 @@ domain.<BR> <!--TOC section Built-in Modules--> -<H2 CLASS="section"><A NAME="htoc41">A</A> Built-in Modules</H2><!--SEC END --> +<H2><A NAME="htoc41">A</A> Built-in Modules</H2><!--SEC END --> <A NAME="sec:modules"></A> <!--TOC subsection Overview--> -<H3 CLASS="subsection"><A NAME="htoc42">A.1</A> Overview</H3><!--SEC END --> +<H3><A NAME="htoc42">A.1</A> Overview</H3><!--SEC END --> <A NAME="sec:modoverview"></A> @@ -1427,14 +1416,14 @@ that they can contain severe bugs and security leaks. Therefore, use them at your own risk!<BR> <BR> You can see which database backend each module needs by looking at the suffix: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -“_ldap”, this means that the module needs an LDAP server as backend. -<LI CLASS="li-itemize">“_odbc”, this means that the module needs an ODBC compatible database, +<UL><LI> +``_ldap'', this means that the module needs an LDAP server as backend. +<LI>``_odbc'', this means that the module needs an ODBC compatible database, a MySQL database, or a PostgreSQL database as backend. -<LI CLASS="li-itemize">Nothing, this means that the modules uses Erlang's built-in database +<LI>Nothing, this means that the modules uses Erlang's built-in database Mnesia as backend. </UL> -<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> +<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV> <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1> <TR><TD ALIGN=left NOWRAP>Module</TD> <TD ALIGN=left NOWRAP>Feature</TD> @@ -1621,13 +1610,13 @@ You can see which database backend each module needs by looking at the suffix: <TD ALIGN=left NOWRAP> </TD> <TD ALIGN=left NOWRAP>No</TD> </TR></TABLE> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> +<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> (*) This module or a similar one with another database backend is needed for XMPP compliancy.<BR> <BR> <!--TOC subsection Common Options--> -<H3 CLASS="subsection"><A NAME="htoc43">A.2</A> Common Options</H3><!--SEC END --> +<H3><A NAME="htoc43">A.2</A> Common Options</H3><!--SEC END --> <A NAME="sec:modcommonopts"></A> The following options are used by many modules. Therefore, they are described in @@ -1635,7 +1624,7 @@ this separate section.<BR> <BR> <!--TOC subsubsection <TT>iqdisc</TT>--> -<H4 CLASS="subsubsection"><A NAME="htoc44">A.2.1</A> <TT>iqdisc</TT></H4><!--SEC END --> +<H4><A NAME="htoc44">A.2.1</A> <TT>iqdisc</TT></H4><!--SEC END --> <A NAME="sec:modiqdiscoption"></A> @@ -1643,23 +1632,23 @@ Many modules define handlers for processing IQ queries of different namespaces to this server or to a user (e. g. to <TT>example.org</TT> or to <TT>user@example.org</TT>). This option defines processing discipline for these queries. Possible values are: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>no_queue</TT></B><DD CLASS="dd-description"> All queries of a namespace with this processing discipline are +<DL COMPACT=compact><DT> +<B><TT>no_queue</TT></B><DD> All queries of a namespace with this processing discipline are processed immediately. This also means that no other packets can be processed until this one has been completely processed. Hence this discipline is not recommended if the processing of a query can take a relatively long time. -<DT CLASS="dt-description"><B><TT>one_queue</TT></B><DD CLASS="dd-description"> In this case a separate queue is created for the processing +<DT><B><TT>one_queue</TT></B><DD> In this case a separate queue is created for the processing of IQ queries of a namespace with this discipline. In addition, the processing of this queue is done in parallel with that of other packets. This discipline is most recommended. -<DT CLASS="dt-description"><B><TT>parallel</TT></B><DD CLASS="dd-description"> For every packet with this discipline a separate Erlang process +<DT><B><TT>parallel</TT></B><DD> For every packet with this discipline a separate Erlang process is spawned. Consequently, all these packets are processed in parallel. Although spawning of Erlang process has a relatively low cost, this can break the server's normal work, because the Erlang emulator has a limit on the number of processes (32000 by default). </DL> Example: -<PRE CLASS="verbatim"> +<PRE> {modules, [ ... @@ -1669,7 +1658,7 @@ Example: </PRE> <!--TOC subsubsection <TT>hosts</TT>--> -<H4 CLASS="subsubsection"><A NAME="htoc45">A.2.2</A> <TT>hosts</TT></H4><!--SEC END --> +<H4><A NAME="htoc45">A.2.2</A> <TT>hosts</TT></H4><!--SEC END --> <A NAME="sec:modhostsoption"></A> @@ -1677,19 +1666,19 @@ A module acting as a service can have one or more hostnames. These hostnames can be defined with the <TT>hosts</TT> option.<BR> <BR> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Serving the echo module on one domain: - <UL CLASS="itemize"><LI CLASS="li-itemize"> - <PRE CLASS="verbatim"> + <UL><LI> + <PRE> {modules, [ ... {mod_echo, [{hosts, ["echo.example.org"]}]}, ... ]}. -</PRE><LI CLASS="li-itemize">Backwards compatibility with older ejabberd versions can be retained +</PRE><LI>Backwards compatibility with older ejabberd versions can be retained with: - <PRE CLASS="verbatim"> + <PRE> {modules, [ ... @@ -1697,8 +1686,8 @@ Serving the echo module on one domain: ... ]}. </PRE></UL> - <LI CLASS="li-itemize">Serving the echo module on two domains: - <PRE CLASS="verbatim"> + <LI>Serving the echo module on two domains: + <PRE> {modules, [ ... @@ -1708,7 +1697,7 @@ Serving the echo module on one domain: </PRE></UL> <!--TOC subsection <TT>mod_announce</TT>--> -<H3 CLASS="subsection"><A NAME="htoc46">A.3</A> <TT>mod_announce</TT></H3><!--SEC END --> +<H3><A NAME="htoc46">A.3</A> <TT>mod_announce</TT></H3><!--SEC END --> <A NAME="sec:modannounce"></A> @@ -1718,36 +1707,36 @@ Jabber client by sending messages to specific JIDs. These JIDs are listed in next paragraph. The first JID in each entry will apply only to the virtual host <TT>example.org</TT>, while the JID between brackets will apply to all virtual hosts: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>example.org/announce/all (example.org/announce/all-hosts/all)</TT></B><DD CLASS="dd-description"> The +<DL COMPACT=compact><DT> +<B><TT>example.org/announce/all (example.org/announce/all-hosts/all)</TT></B><DD> The message is sent to all registered users. If the user is online and connected to several resources, only the resource with the highest priority will receive the message. If the registered user is not connected, the message will be stored offline in assumption that offline storage (see section <A HREF="#sec:modoffline">A.10</A>) is enabled. -<DT CLASS="dt-description"><B><TT>example.org/announce/online (example.org/announce/all-hosts/online)</TT></B><DD CLASS="dd-description">The +<DT><B><TT>example.org/announce/online (example.org/announce/all-hosts/online)</TT></B><DD>The message is sent to all connected users. If the user is online and connected to several resources, all resources will receive the message. -<DT CLASS="dt-description"><B><TT>example.org/announce/motd (example.org/announce/all-hosts/motd)</TT></B><DD CLASS="dd-description">The +<DT><B><TT>example.org/announce/motd (example.org/announce/all-hosts/motd)</TT></B><DD>The message is set as the message of the day (MOTD) and is sent to users when they login. In addition the message is sent to all connected users (similar to <TT>announce/online</TT>). -<DT CLASS="dt-description"><B><TT>example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)</TT></B><DD CLASS="dd-description"> +<DT><B><TT>example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)</TT></B><DD> The message is set as message of the day (MOTD) and is sent to users when they login. The message is <EM>not sent</EM> to any currently connected user. -<DT CLASS="dt-description"><B><TT>example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)</TT></B><DD CLASS="dd-description"> +<DT><B><TT>example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)</TT></B><DD> Any message sent to this JID removes the existing message of the day (MOTD). </DL> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>access</TT></B><DD CLASS="dd-description"> This option specifies who is allowed to +<DL COMPACT=compact><DT> +<B><TT>access</TT></B><DD> This option specifies who is allowed to send announcements and to set the message of the day (by default, nobody is able to send such messages). </DL> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Only administrators can send announcements: - <PRE CLASS="verbatim"> + <PRE> {access, announce, [{allow, admins}]}. {modules, @@ -1756,8 +1745,8 @@ Only administrators can send announcements: {mod_announce, [{access, announce}]}, ... ]}. -</PRE><LI CLASS="li-itemize">Administrators as well as the direction can send announcements: - <PRE CLASS="verbatim"> +</PRE><LI>Administrators as well as the direction can send announcements: + <PRE> {acl, direction, {user, "big_boss", "example.org"}}. {acl, direction, {user, "assistant", "example.org"}}. {acl, admins, {user, "admin", "example.org"}}. @@ -1774,7 +1763,7 @@ Only administrators can send announcements: </PRE></UL> <!--TOC subsection <TT>mod_disco</TT>--> -<H3 CLASS="subsection"><A NAME="htoc47">A.4</A> <TT>mod_disco</TT></H3><!--SEC END --> +<H3><A NAME="htoc47">A.4</A> <TT>mod_disco</TT></H3><!--SEC END --> <A NAME="sec:moddisco"></A> @@ -1787,26 +1776,26 @@ the newer Service Discovery protocol if you want them be able to discover the services you offer.<BR> <BR> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies +<DL COMPACT=compact><DT> +<B><TT>iqdisc</TT></B><DD> This specifies the processing discipline for Service Discovery (<TT>http://jabber.org/protocol/disco#items</TT> and <TT>http://jabber.org/protocol/disco#info</TT>) IQ queries (see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). -<DT CLASS="dt-description"><B><TT>extra_domains</TT></B><DD CLASS="dd-description"> With this option, +<DT><B><TT>extra_domains</TT></B><DD> With this option, extra domains can be added to the Service Discovery item list. </DL> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> To serve a link to the Jabber User Directory on <TT>jabber.org</TT>: - <PRE CLASS="verbatim"> + <PRE> {modules, [ ... {mod_disco, [{extra_domains, ["users.jabber.org"]}]}, ... ]}. -</PRE><LI CLASS="li-itemize">To serve a link to the transports on another server: - <PRE CLASS="verbatim"> +</PRE><LI>To serve a link to the transports on another server: + <PRE> {modules, [ ... @@ -1814,8 +1803,8 @@ To serve a link to the Jabber User Directory on <TT>jabber.org</TT>: "msn.example.com"]}]}, ... ]}. -</PRE><LI CLASS="li-itemize">To serve a link to a few friendly servers: - <PRE CLASS="verbatim"> +</PRE><LI>To serve a link to a few friendly servers: + <PRE> {modules, [ ... @@ -1826,7 +1815,7 @@ To serve a link to the Jabber User Directory on <TT>jabber.org</TT>: </PRE></UL> <!--TOC subsection <TT>mod_echo</TT>--> -<H3 CLASS="subsection"><A NAME="htoc48">A.5</A> <TT>mod_echo</TT></H3><!--SEC END --> +<H3><A NAME="htoc48">A.5</A> <TT>mod_echo</TT></H3><!--SEC END --> <A NAME="sec:modecho"></A> @@ -1835,31 +1824,31 @@ packet back to the sender. This mirror can be of interest for <TT>ejabberd</TT> and Jabber client debugging.<BR> <BR> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> +<DL COMPACT=compact><DT> - <B><TT>hosts</TT></B><DD CLASS="dd-description"> This option defines the hostnames of the + <B><TT>hosts</TT></B><DD> This option defines the hostnames of the service (see section <A HREF="#sec:modhostsoption">A.2.2</A>). If neither <TT>hosts</TT> nor - the old <TT>host</TT> is present, the prefix “<TT>echo.</TT>” is added to all + the old <TT>host</TT> is present, the prefix ``<TT>echo.</TT>'' is added to all <TT>ejabberd</TT> hostnames. </DL> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Mirror, mirror, on the wall, who is the most beautiful of them all? - <PRE CLASS="verbatim"> + <PRE> {modules, [ ... {mod_echo, [{hosts, ["mirror.example.org"]}]}, ... ]}. -</PRE><LI CLASS="li-itemize">If you still do not understand the inner workings of <TT>mod_echo</TT>, +</PRE><LI>If you still do not understand the inner workings of <TT>mod_echo</TT>, you can find a few more examples in section <A HREF="#sec:modhostsoption">A.2.2</A>. </UL> <!--TOC subsection <TT>mod_irc</TT>--> -<H3 CLASS="subsection"><A NAME="htoc49">A.6</A> <TT>mod_irc</TT></H3><!--SEC END --> +<H3><A NAME="htoc49">A.6</A> <TT>mod_irc</TT></H3><!--SEC END --> <A NAME="sec:modirc"></A> @@ -1868,50 +1857,50 @@ servers.<BR> <BR> End user information: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -A Jabber client with “groupchat 1.0” support or Multi-User +<UL><LI> +A Jabber client with ``groupchat 1.0'' support or Multi-User Chat support (<A HREF="http://www.jabber.org/jeps/jep-0045.html">JEP-0045</A>) is necessary to join IRC channels. -<LI CLASS="li-itemize">An IRC channel can be joined in nearly the same way as joining a +<LI>An IRC channel can be joined in nearly the same way as joining a Jabber Multi-User Chat room. The difference is that the room name will - be “channel%<TT>irc.example.org</TT>” in case <TT>irc.example.org</TT> is - the IRC server hosting “channel”. And of course the host should point + be ``channel%<TT>irc.example.org</TT>'' in case <TT>irc.example.org</TT> is + the IRC server hosting ``channel''. And of course the host should point to the IRC transport instead of the Multi-User Chat service. -<LI CLASS="li-itemize">You can register your nickame by sending “IDENTIFY password” to<BR> +<LI>You can register your nickame by sending ``IDENTIFY password'' to<BR> <TT>nickserver!irc.example.org@irc.jabberserver.org</TT>. -<LI CLASS="li-itemize">Entering your password is possible by sending “LOGIN nick password”<BR> +<LI>Entering your password is possible by sending ``LOGIN nick password''<BR> to <TT>nickserver!irc.example.org@irc.jabberserver.org</TT>. -<LI CLASS="li-itemize">When using a popular Jabber server, it can occur that no +<LI>When using a popular Jabber server, it can occur that no connection can be achieved with some IRC servers because they limit the number of conections from one IP. </UL> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> +<DL COMPACT=compact><DT> - <B><TT>hosts</TT></B><DD CLASS="dd-description"> This option defines the hostnames of the + <B><TT>hosts</TT></B><DD> This option defines the hostnames of the service (see section <A HREF="#sec:modhostsoption">A.2.2</A>). If neither <TT>hosts</TT> nor - the old <TT>host</TT> is present, the prefix “<TT>irc.</TT>” is added to all + the old <TT>host</TT> is present, the prefix ``<TT>irc.</TT>'' is added to all <TT>ejabberd</TT> hostnames. -<DT CLASS="dt-description"><B><TT>access</TT></B><DD CLASS="dd-description"> This option can be used to specify who +<DT><B><TT>access</TT></B><DD> This option can be used to specify who may use the IRC transport (default value: <TT>all</TT>). </DL> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> In the first example, the IRC transport is available on (all) your - virtual host(s) with the prefix “<TT>irc.</TT>”. Furthermore, anyone is + virtual host(s) with the prefix ``<TT>irc.</TT>''. Furthermore, anyone is able to use the transport. - <PRE CLASS="verbatim"> + <PRE> {modules, [ ... {mod_irc, [{access, all}]}, ... ]}. -</PRE><LI CLASS="li-itemize">In next example the IRC transport is available on the two virtual hosts +</PRE><LI>In next example the IRC transport is available on the two virtual hosts <TT>example.net</TT> and <TT>example.com</TT> with different prefixes on each host. Moreover, the transport is only accessible by paying customers registered on our domains and on other servers. - <PRE CLASS="verbatim"> + <PRE> {acl, paying_customers, {user, "customer1", "example.net"}}. {acl, paying_customers, {user, "customer2", "example.com"}}. {acl, paying_customers, {user, "customer3", "example.org"}}. @@ -1929,7 +1918,7 @@ In the first example, the IRC transport is available on (all) your </PRE></UL> <!--TOC subsection <TT>mod_last</TT>--> -<H3 CLASS="subsection"><A NAME="htoc50">A.7</A> <TT>mod_last</TT></H3><!--SEC END --> +<H3><A NAME="htoc50">A.7</A> <TT>mod_last</TT></H3><!--SEC END --> <A NAME="sec:modlast"></A> @@ -1939,14 +1928,14 @@ connected user was last active on the server, or to query the uptime of the <TT>ejabberd</TT> server.<BR> <BR> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies +<DL COMPACT=compact><DT> +<B><TT>iqdisc</TT></B><DD> This specifies the processing discipline for Last activity (<TT>jabber:iq:last</TT>) IQ queries (see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). </DL> <!--TOC subsection <TT>mod_muc</TT>--> -<H3 CLASS="subsection"><A NAME="htoc51">A.8</A> <TT>mod_muc</TT></H3><!--SEC END --> +<H3><A NAME="htoc51">A.8</A> <TT>mod_muc</TT></H3><!--SEC END --> <A NAME="sec:modmuc"></A> @@ -1955,34 +1944,34 @@ With this module enabled, your server will support Multi-User Chat that this module is not (yet) clusterable.<BR> <BR> Some of the features of Multi-User Chat: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Sending private messages to room participants. -<LI CLASS="li-itemize">Inviting users. -<LI CLASS="li-itemize">Setting a conference topic. -<LI CLASS="li-itemize">Creating password protected rooms. -<LI CLASS="li-itemize">Kicking and banning participants. +<LI>Inviting users. +<LI>Setting a conference topic. +<LI>Creating password protected rooms. +<LI>Kicking and banning participants. </UL> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> +<DL COMPACT=compact><DT> - <B><TT>hosts</TT></B><DD CLASS="dd-description"> This option defines the hostnames of the + <B><TT>hosts</TT></B><DD> This option defines the hostnames of the service (see section <A HREF="#sec:modhostsoption">A.2.2</A>). If neither <TT>hosts</TT> nor - the old <TT>host</TT> is present, the prefix “<TT>conference.</TT>” is added to all + the old <TT>host</TT> is present, the prefix ``<TT>conference.</TT>'' is added to all <TT>ejabberd</TT> hostnames. -<DT CLASS="dt-description"><B><TT>access</TT></B><DD CLASS="dd-description"> You can specify who is allowed to use +<DT><B><TT>access</TT></B><DD> You can specify who is allowed to use the Multi-User Chat service (by default, everyone is allowed to use it). -<DT CLASS="dt-description"><B><TT>access_create</TT></B><DD CLASS="dd-description"> To configure who is +<DT><B><TT>access_create</TT></B><DD> To configure who is allowed to create new rooms at the Multi-User Chat service, this option can be used (by default, everybody is allowed to create rooms). -<DT CLASS="dt-description"><B><TT>access_admin</TT></B><DD CLASS="dd-description"> This option specifies +<DT><B><TT>access_admin</TT></B><DD> This option specifies who is allowed to administrate the Multi-User Chat service (the default value is <TT>none</TT>, which means that only the room creator can administer his room). By sending a message to the service JID, administrators can send service messages that will be displayed in every active room.<BR> <BR> -<DT CLASS="dt-description"><B><TT>history_size</TT></B><DD CLASS="dd-description"> a small history of the +<DT><B><TT>history_size</TT></B><DD> a small history of the current discussion is send to users when they enter the room. This option make it possible to define the number of history messages to keep and send to the user joining the room. The value is a integer. Setting the value to <TT>0</TT> @@ -1990,17 +1979,17 @@ Options: is <TT>20</TT>. This value is global and affects all MUC rooms on the server. </DL> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> In the first example everyone is allowed to use the Multi-User Chat service. Everyone will also be able to create new rooms but only the user <TT>admin@example.org</TT> is allowed to administrate any room. In this example he is also a global administrator. When <TT>admin@example.org</TT> - sends a message such as “Tomorrow, the Jabber server will be moved + sends a message such as ``Tomorrow, the Jabber server will be moved to new hardware. This will involve service breakdowns around 23:00 UMT. - We apologise for this inconvenience.” to <TT>conference.example.org</TT>, + We apologise for this inconvenience.'' to <TT>conference.example.org</TT>, it will be displayed in all active rooms. In this example the history feature is disabled. - <PRE CLASS="verbatim"> + <PRE> {acl, admins, {user, "admin", "example.org"}}. ... {access, muc_admins, [{allow, admins}]}. @@ -2014,17 +2003,17 @@ In the first example everyone is allowed to use the Multi-User Chat {history_size, 0}]}, ... ]}. -</PRE><LI CLASS="li-itemize">In the second example the Multi-User Chat service is only accessible by +</PRE><LI>In the second example the Multi-User Chat service is only accessible by paying customers registered on our domains and on other servers. Of course the administrator is also allowed to access rooms. In addition, he is the only authority able to create and administer rooms. When - <TT>admin@example.org</TT> sends a message such as “Tomorrow, the Jabber + <TT>admin@example.org</TT> sends a message such as ``Tomorrow, the Jabber server will be moved to new hardware. This will involve service breakdowns - around 23:00 UMT. We apologise for this inconvenience.” to + around 23:00 UMT. We apologise for this inconvenience.'' to <TT>conference.example.org</TT>, it will be displayed in all active rooms. No <TT>history_size</TT> option is used, this means that the feature is enabled and the default value of 20 history messages will be send to the users. - <PRE CLASS="verbatim"> + <PRE> {acl, paying_customers, {user, "customer1", "example.net"}}. {acl, paying_customers, {user, "customer2", "example.com"}}. {acl, paying_customers, {user, "customer3", "example.org"}}. @@ -2047,7 +2036,7 @@ In the first example everyone is allowed to use the Multi-User Chat </PRE></UL> <!--TOC subsection <TT>mod_muc_log</TT>--> -<H3 CLASS="subsection"><A NAME="htoc52">A.9</A> <TT>mod_muc_log</TT></H3><!--SEC END --> +<H3><A NAME="htoc52">A.9</A> <TT>mod_muc_log</TT></H3><!--SEC END --> <A NAME="sec:modmuclog"></A> @@ -2056,53 +2045,53 @@ Once you enable this module, join a chatroom with enought privileges using a MUC request the configuration form and there you will have an option to enable chatroom logging.<BR> <BR> Some of the features of generated logs: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> A lot of information about chatroom is added on top of the page: Room title, JID, subject author, subject and configuration. -<LI CLASS="li-itemize">Room title and JID are links to join the chatroom (using XMPP-IRI). -<LI CLASS="li-itemize">Subject and chatroom configuration changes are tracked and displayed. -<LI CLASS="li-itemize">Joins, leaves, nick changes, kicks, bans and /me are tracked and displayed, including the reason when available. -<LI CLASS="li-itemize">Generated HTML files are XHTML 1.0 Transitional and CSS compliant. -<LI CLASS="li-itemize">Timestamps are self-referencing links. -<LI CLASS="li-itemize">Links on top for quicker navigation: Previous day, Next day, Up. -<LI CLASS="li-itemize">CSS is used for style definition, and a custom CSS file can be used. -<LI CLASS="li-itemize">URLs on messages and subjects are converted to hyperlinks. -<LI CLASS="li-itemize">Timezone used on timestamps is shown on the log files. -<LI CLASS="li-itemize">A custom link can be added on top of page. +<LI>Room title and JID are links to join the chatroom (using XMPP-IRI). +<LI>Subject and chatroom configuration changes are tracked and displayed. +<LI>Joins, leaves, nick changes, kicks, bans and /me are tracked and displayed, including the reason when available. +<LI>Generated HTML files are XHTML 1.0 Transitional and CSS compliant. +<LI>Timestamps are self-referencing links. +<LI>Links on top for quicker navigation: Previous day, Next day, Up. +<LI>CSS is used for style definition, and a custom CSS file can be used. +<LI>URLs on messages and subjects are converted to hyperlinks. +<LI>Timezone used on timestamps is shown on the log files. +<LI>A custom link can be added on top of page. </UL> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>access_log</TT></B><DD CLASS="dd-description"> +<DL COMPACT=compact><DT> +<B><TT>access_log</TT></B><DD> Restricts which users are allowed to enable or disable chatroom logging using ACL and ACCESS. Default: <TT>muc_admin</TT>. If you want to allow any chatroom owner put: <TT>muc</TT>. -<DT CLASS="dt-description"><B><TT>cssfile</TT></B><DD CLASS="dd-description"> +<DT><B><TT>cssfile</TT></B><DD> If HTMLs will use a custom CSS file or the embedded one. Allowed values: <TT>false</TT>: HTMLs will include the standard CSS code; <TT>"CSS-URL"</TT>: the URL of the CSS file (for example: "http://example.com/my.css"). Default: <TT>false</TT>. -<DT CLASS="dt-description"><B><TT>dirtype</TT></B><DD CLASS="dd-description"> +<DT><B><TT>dirtype</TT></B><DD> Type of directory that will be created. Allowed values: <TT>subdirs</TT>: creates subdirectories for year and month; <TT>plain</TT>: the filename contains the full date, no subdirs. Default: <TT>subdirs</TT>. -<DT CLASS="dt-description"><B><TT>outdir</TT></B><DD CLASS="dd-description"> +<DT><B><TT>outdir</TT></B><DD> Full path to the directory where html will be generated. Make sure the system user has write access on that directory. Default: <TT>"www/muc"</TT>. -<DT CLASS="dt-description"><B><TT>timezone</TT></B><DD CLASS="dd-description"> +<DT><B><TT>timezone</TT></B><DD> What timezone should be used. Allowed values: <TT>local</TT>: use local time, as reported to Erlang by the operating system; <TT>universal</TT>: use GMT/UTC time. Default: <TT>local</TT>. -<DT CLASS="dt-description"><B><TT>top_link</TT></B><DD CLASS="dd-description"> +<DT><B><TT>top_link</TT></B><DD> Customizable link on top right corner. Syntax of this option: <TT>{"URL", "Text"}</TT>. Default: <TT>{"/", "Home"}</TT>. </DL> Example configuration: -<PRE CLASS="verbatim"> +<PRE> {modules, [ ... @@ -2119,7 +2108,7 @@ Example configuration: </PRE> <!--TOC subsection <TT>mod_offline</TT>--> -<H3 CLASS="subsection"><A NAME="htoc53">A.10</A> <TT>mod_offline</TT></H3><!--SEC END --> +<H3><A NAME="htoc53">A.10</A> <TT>mod_offline</TT></H3><!--SEC END --> <A NAME="sec:modoffline"></A> @@ -2131,78 +2120,78 @@ online again. Thus it is very similar to how email works. Note that <BR> <!--TOC subsection <TT>mod_privacy</TT>--> -<H3 CLASS="subsection"><A NAME="htoc54">A.11</A> <TT>mod_privacy</TT></H3><!--SEC END --> +<H3><A NAME="htoc54">A.11</A> <TT>mod_privacy</TT></H3><!--SEC END --> <A NAME="sec:modprivacy"></A> This module implements Blocking Communication (also known as Privacy Rules) as defined in section 10 from XMPP IM. If end users have support for it in their Jabber client, they will be able to: -<BLOCKQUOTE CLASS="quote"> -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<BLOCKQUOTE> +<UL><LI> Retrieving one's privacy lists. -<LI CLASS="li-itemize">Adding, removing, and editing one's privacy lists. -<LI CLASS="li-itemize">Setting, changing, or declining active lists. -<LI CLASS="li-itemize">Setting, changing, or declining the default list (i.e., the list that +<LI>Adding, removing, and editing one's privacy lists. +<LI>Setting, changing, or declining active lists. +<LI>Setting, changing, or declining the default list (i.e., the list that is active by default). -<LI CLASS="li-itemize">Allowing or blocking messages based on JID, group, or subscription type +<LI>Allowing or blocking messages based on JID, group, or subscription type (or globally). -<LI CLASS="li-itemize">Allowing or blocking inbound presence notifications based on JID, group, +<LI>Allowing or blocking inbound presence notifications based on JID, group, or subscription type (or globally). -<LI CLASS="li-itemize">Allowing or blocking outbound presence notifications based on JID, group, +<LI>Allowing or blocking outbound presence notifications based on JID, group, or subscription type (or globally). -<LI CLASS="li-itemize">Allowing or blocking IQ stanzas based on JID, group, or subscription type +<LI>Allowing or blocking IQ stanzas based on JID, group, or subscription type (or globally). -<LI CLASS="li-itemize">Allowing or blocking all communications based on JID, group, or +<LI>Allowing or blocking all communications based on JID, group, or subscription type (or globally). </UL> (from <A HREF="http://www.xmpp.org/specs/rfc3921.html#privacy"><TT>http://www.xmpp.org/specs/rfc3921.html#privacy</TT></A>) </BLOCKQUOTE> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies +<DL COMPACT=compact><DT> +<B><TT>iqdisc</TT></B><DD> This specifies the processing discipline for Blocking Communication (<TT>jabber:iq:privacy</TT>) IQ queries (see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). </DL> <!--TOC subsection <TT>mod_private</TT>--> -<H3 CLASS="subsection"><A NAME="htoc55">A.12</A> <TT>mod_private</TT></H3><!--SEC END --> +<H3><A NAME="htoc55">A.12</A> <TT>mod_private</TT></H3><!--SEC END --> <A NAME="sec:modprivate"></A> This module adds support for Private XML Storage (<A HREF="http://www.jabber.org/jeps/jep-0049.html">JEP-0049</A>): -<BLOCKQUOTE CLASS="quote"> +<BLOCKQUOTE> Using this method, Jabber entities can store private data on the server and retrieve it whenever necessary. The data stored might be anything, as long as it is valid XML. One typical usage for this namespace is the server-side storage of client-specific preferences; another is Bookmark Storage (<A HREF="http://www.jabber.org/jeps/jep-0048.html">JEP-0048</A>). </BLOCKQUOTE> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies +<DL COMPACT=compact><DT> +<B><TT>iqdisc</TT></B><DD> This specifies the processing discipline for Private XML Storage (<TT>jabber:iq:private</TT>) IQ queries (see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). </DL> <!--TOC subsection <TT>mod_pubsub</TT>--> -<H3 CLASS="subsection"><A NAME="htoc56">A.13</A> <TT>mod_pubsub</TT></H3><!--SEC END --> +<H3><A NAME="htoc56">A.13</A> <TT>mod_pubsub</TT></H3><!--SEC END --> <A NAME="sec:modpubsub"></A> This module offers a Publish-Subscribe Service (<A HREF="http://www.jabber.org/jeps/jep-0060.html">JEP-0060</A>). Publish-Subscribe can be used to develop (examples are taken from the JEP): -<BLOCKQUOTE CLASS="quote"> -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<BLOCKQUOTE> +<UL><LI> news feeds and content syndacation, -<LI CLASS="li-itemize">avatar management, -<LI CLASS="li-itemize">shared bookmarks, -<LI CLASS="li-itemize">auction and trading systems, -<LI CLASS="li-itemize">online catalogs, -<LI CLASS="li-itemize">workflow systems, -<LI CLASS="li-itemize">network management systems, -<LI CLASS="li-itemize">NNTP gateways, -<LI CLASS="li-itemize">vCard/profile management, -<LI CLASS="li-itemize">and weblogs. +<LI>avatar management, +<LI>shared bookmarks, +<LI>auction and trading systems, +<LI>online catalogs, +<LI>workflow systems, +<LI>network management systems, +<LI>NNTP gateways, +<LI>vCard/profile management, +<LI>and weblogs. </UL> </BLOCKQUOTE> @@ -2212,21 +2201,21 @@ known as ESB, the Enterprise Service Bus). The J-EAI project builts upon <TT>ejabberd</TT>'s codebase and has contributed several features to <TT>mod_pubsub</TT>.<BR> <BR> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> +<DL COMPACT=compact><DT> - <B><TT>hosts</TT></B><DD CLASS="dd-description"> This option defines the hostnames of the + <B><TT>hosts</TT></B><DD> This option defines the hostnames of the service (see section <A HREF="#sec:modhostsoption">A.2.2</A>). If neither <TT>hosts</TT> nor - the old <TT>host</TT> is present, the prefix “<TT>pubsub.</TT>” is added to all + the old <TT>host</TT> is present, the prefix ``<TT>pubsub.</TT>'' is added to all <TT>ejabberd</TT> hostnames. -<DT CLASS="dt-description"><B><TT>served_hosts</TT></B><DD CLASS="dd-description"> To specify which hosts needs to +<DT><B><TT>served_hosts</TT></B><DD> To specify which hosts needs to be served, you can use this option. If absent, only the main <TT>ejabberd</TT> - host is served. <DT CLASS="dt-description"><B><TT>access_createnode</TT></B><DD CLASS="dd-description"> + host is served. <DT><B><TT>access_createnode</TT></B><DD> Restricts which users are allowed to create pubsub nodes using ACL and ACCESS. Default: <TT>pubsub_createnode</TT>. </DL> Example: -<PRE CLASS="verbatim"> +<PRE> {modules, [ ... @@ -2238,38 +2227,37 @@ Example: </PRE> <!--TOC subsection <TT>mod_register</TT>--> -<H3 CLASS="subsection"><A NAME="htoc57">A.14</A> <TT>mod_register</TT></H3><!--SEC END --> +<H3><A NAME="htoc57">A.14</A> <TT>mod_register</TT></H3><!--SEC END --> <A NAME="sec:modregister"></A> This module adds support for In-Band Registration (<A HREF="http://www.jabber.org/jeps/jep-0077.html">JEP-0077</A>). This protocol enables end users to use a Jabber client to: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Register a new account on the server. -<LI CLASS="li-itemize">Change the password from an existing account on the server. -<LI CLASS="li-itemize">Delete an existing account on the server. +<LI>Change the password from an existing account on the server. +<LI>Delete an existing account on the server. </UL> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>access</TT></B><DD CLASS="dd-description"> This option can be configured to specify - rules to restrict registration. If a rule returns “deny” on the requested +<DL COMPACT=compact><DT> +<B><TT>access</TT></B><DD> This option can be configured to specify + rules to restrict registration. If a rule returns ``deny'' on the requested user name, registration for that user name is dennied. (there are no restrictions by default). -<DT CLASS="dt-description"><B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies +<DT><B><TT>iqdisc</TT></B><DD> This specifies the processing discipline for In-Band Registration (<TT>jabber:iq:register</TT>) IQ queries (see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). </DL> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> -Next example prohibits the registration of too short account names and of - account names with exotic characters in it: - <PRE CLASS="verbatim"> +<UL><LI> +Next example prohibits the registration of too short account names: +<PRE> {acl, shortname, {user_glob, "?"}}. {acl, shortname, {user_glob, "??"}}. - {acl, strangename, {user_regexp, "^..?$"}}. + % The same using regexp: + %{acl, shortname, {user_regexp, "^..?$"}}. ... {access, register, [{deny, shortname}, - {deny, strangename}, {allow, all}]}. ... {modules, @@ -2278,12 +2266,12 @@ Next example prohibits the registration of too short account names and of {mod_register, [{access, register}]}, ... ]}. -</PRE><LI CLASS="li-itemize">The in-band registration of new accounts can be prohibited by changing the +</PRE><LI>The in-band registration of new accounts can be prohibited by changing the <TT>access</TT> option. If you really want to disable all In-Band Registration functionality, that is changing passwords in-band and deleting accounts in-band, you have to remove <TT>mod_register</TT> from the modules list. In this example all In-Band Registration functionality is disabled: - <PRE CLASS="verbatim"> + <PRE> {access, register, [{deny, all}]}. {modules, @@ -2295,21 +2283,21 @@ Next example prohibits the registration of too short account names and of </PRE></UL> <!--TOC subsection <TT>mod_roster</TT>--> -<H3 CLASS="subsection"><A NAME="htoc58">A.15</A> <TT>mod_roster</TT></H3><!--SEC END --> +<H3><A NAME="htoc58">A.15</A> <TT>mod_roster</TT></H3><!--SEC END --> <A NAME="sec:modroster"></A> This module implements roster management as defined in <A HREF="http://www.xmpp.org/specs/rfc3921.html#roster">RFC 3921: XMPP IM</A>.<BR> <BR> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies +<DL COMPACT=compact><DT> +<B><TT>iqdisc</TT></B><DD> This specifies the processing discipline for Roster Management (<TT>jabber:iq:roster</TT>) IQ queries (see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). </DL> <!--TOC subsection <TT>mod_service_log</TT>--> -<H3 CLASS="subsection"><A NAME="htoc59">A.16</A> <TT>mod_service_log</TT></H3><!--SEC END --> +<H3><A NAME="htoc59">A.16</A> <TT>mod_service_log</TT></H3><!--SEC END --> <A NAME="sec:modservicelog"></A> @@ -2320,25 +2308,25 @@ packets are encapsulated in a <CODE><route/></CODE> element and sent to th service(s).<BR> <BR> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>loggers</TT></B><DD CLASS="dd-description"> With this option a (list of) service(s) +<DL COMPACT=compact><DT> +<B><TT>loggers</TT></B><DD> With this option a (list of) service(s) that will receive the packets can be specified. </DL> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> To log all end user packets to the Bandersnatch service running on <TT>bandersnatch.example.com</TT>: - <PRE CLASS="verbatim"> + <PRE> {modules, [ ... {mod_service_log, [{loggers, ["bandersnatch.example.com"]}]}, ... ]}. -</PRE><LI CLASS="li-itemize">To log all end user packets to the Bandersnatch service running on +</PRE><LI>To log all end user packets to the Bandersnatch service running on <TT>bandersnatch.example.com</TT> and the backup service on <TT>bandersnatch.example.org</TT>: - <PRE CLASS="verbatim"> + <PRE> {modules, [ ... @@ -2349,7 +2337,7 @@ To log all end user packets to the Bandersnatch service running on </PRE></UL> <!--TOC subsection <TT>mod_shared_roster</TT>--> -<H3 CLASS="subsection"><A NAME="htoc60">A.17</A> <TT>mod_shared_roster</TT></H3><!--SEC END --> +<H3><A NAME="htoc60">A.17</A> <TT>mod_shared_roster</TT></H3><!--SEC END --> <A NAME="sec:modsharedroster"></A> @@ -2361,21 +2349,21 @@ users from the shared roster groups.<BR> <BR> Shared roster groups can be edited <EM>only</EM> via the web interface. Each group has a unique identification and the following parameters: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B>Name</B><DD CLASS="dd-description"> The name of the group, which will be displayed in the roster. -<DT CLASS="dt-description"><B>Description</B><DD CLASS="dd-description"> The description of the group. This parameter doesn't affect +<DL COMPACT=compact><DT> +<B>Name</B><DD> The name of the group, which will be displayed in the roster. +<DT><B>Description</B><DD> The description of the group. This parameter doesn't affect anything. -<DT CLASS="dt-description"><B>Members</B><DD CLASS="dd-description"> A list of full JIDs of group members, entered one per line in +<DT><B>Members</B><DD> A list of full JIDs of group members, entered one per line in the web interface. -<DT CLASS="dt-description"><B>Displayed groups</B><DD CLASS="dd-description"> A list of groups that will be in the rosters of this +<DT><B>Displayed groups</B><DD> A list of groups that will be in the rosters of this group's members. </DL> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Take the case of a computer club that wants all its members seeing each other in their rosters. To achieve this, they need to create a shared roster group similar to next table: -<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> +<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV> <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1> <TR><TD ALIGN=left NOWRAP>Identification</TD> <TD ALIGN=left NOWRAP>Group `<TT>club_members</TT>'</TD> @@ -2398,14 +2386,14 @@ Take the case of a computer club that wants all its members seeing each <TR><TD ALIGN=left NOWRAP>Displayed groups</TD> <TD ALIGN=left NOWRAP><TT>club_members</TT></TD> </TR></TABLE> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> -<LI CLASS="li-itemize">In another case we have a company which has three divisions: Management, +<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> +<LI>In another case we have a company which has three divisions: Management, Marketing and Sales. All group members should see all other members in their rosters. Additonally, all managers should have all marketing and sales people in their roster. Simultaneously, all marketeers and the whole sales team should see all managers. This scenario can be achieved by creating shared roster groups as shown in the following table: -<BLOCKQUOTE CLASS="table"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> +<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV> <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=1> <TR><TD ALIGN=left NOWRAP>Identification</TD> <TD ALIGN=left NOWRAP>Group `<TT>management</TT>'</TD> @@ -2472,25 +2460,25 @@ Take the case of a computer club that wants all its members seeing each <TR><TD ALIGN=left NOWRAP><TT>sales</TT></TD> </TR></TABLE></TD> </TR></TABLE> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> +<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> </UL> <!--TOC subsection <TT>mod_stats</TT>--> -<H3 CLASS="subsection"><A NAME="htoc61">A.18</A> <TT>mod_stats</TT></H3><!--SEC END --> +<H3><A NAME="htoc61">A.18</A> <TT>mod_stats</TT></H3><!--SEC END --> <A NAME="sec:modstats"></A> This module adds support for Statistics Gathering (<A HREF="http://www.jabber.org/jeps/jep-0039.html">JEP-0039</A>). This protocol allows you to retrieve next statistics from your <TT>ejabberd</TT> deployment: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Total number of registered users on the current virtual host (users/total). -<LI CLASS="li-itemize">Total number of registered users on all virtual hosts (users/all-hosts/total). -<LI CLASS="li-itemize">Total number of online users on the current virtual host (users/online). -<LI CLASS="li-itemize">Total number of online users on all virtual hosts (users/all-hosts/online). +<LI>Total number of registered users on all virtual hosts (users/all-hosts/total). +<LI>Total number of online users on the current virtual host (users/online). +<LI>Total number of online users on all virtual hosts (users/all-hosts/online). </UL> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies +<DL COMPACT=compact><DT> +<B><TT>iqdisc</TT></B><DD> This specifies the processing discipline for Statistics Gathering (<TT>http://jabber.org/protocol/stats</TT>) IQ queries (see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). </DL> @@ -2498,18 +2486,18 @@ As there are only a small amount of clients (for example <A HREF="http://tkabber.jabber.ru/">Tkabber</A>) and software libraries with support for this JEP, a few examples are given of the XML you need to send in order to get the statistics. Here they are: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> You can request the number of online users on the current virtual host (<TT>example.org</TT>) by sending: - <PRE CLASS="verbatim"> + <PRE> <iq to='example.org' type='get'> <query xmlns='http://jabber.org/protocol/stats'> <stat name='users/online'/> </query> </iq> -</PRE><LI CLASS="li-itemize">You can request the total number of registered users on all virtual hosts +</PRE><LI>You can request the total number of registered users on all virtual hosts by sending: - <PRE CLASS="verbatim"> + <PRE> <iq to='example.org' type='get'> <query xmlns='http://jabber.org/protocol/stats'> <stat name='users/all-hosts/total'/> @@ -2518,7 +2506,7 @@ You can request the number of online users on the current virtual host </PRE></UL> <!--TOC subsection <TT>mod_time</TT>--> -<H3 CLASS="subsection"><A NAME="htoc62">A.19</A> <TT>mod_time</TT></H3><!--SEC END --> +<H3><A NAME="htoc62">A.19</A> <TT>mod_time</TT></H3><!--SEC END --> <A NAME="sec:modtime"></A> @@ -2526,14 +2514,14 @@ This module features support for Entity Time (<A HREF="http://www.jabber.org/jep you are able to discover the time at another entity's location.<BR> <BR> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies +<DL COMPACT=compact><DT> +<B><TT>iqdisc</TT></B><DD> This specifies the processing discipline for Entity Time (<TT>jabber:iq:time</TT>) IQ queries (see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). </DL> <!--TOC subsection <TT>mod_vcard</TT>--> -<H3 CLASS="subsection"><A NAME="htoc63">A.20</A> <TT>mod_vcard</TT></H3><!--SEC END --> +<H3><A NAME="htoc63">A.20</A> <TT>mod_vcard</TT></H3><!--SEC END --> <A NAME="sec:modvcard"></A> @@ -2543,39 +2531,39 @@ implements an uncomplicated Jabber User Directory based on the vCards of these users. Moreover, it enables the server to send its vCard when queried.<BR> <BR> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> +<DL COMPACT=compact><DT> - <B><TT>hosts</TT></B><DD CLASS="dd-description"> This option defines the hostnames of the + <B><TT>hosts</TT></B><DD> This option defines the hostnames of the service (see section <A HREF="#sec:modhostsoption">A.2.2</A>). If neither <TT>hosts</TT> nor - the old <TT>host</TT> is present, the prefix “<TT>vjud.</TT>” is added to all + the old <TT>host</TT> is present, the prefix ``<TT>vjud.</TT>'' is added to all <TT>ejabberd</TT> hostnames. -<DT CLASS="dt-description"><B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies +<DT><B><TT>iqdisc</TT></B><DD> This specifies the processing discipline for <TT>vcard-temp</TT> IQ queries (see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). -<DT CLASS="dt-description"><B><TT>search</TT></B><DD CLASS="dd-description"> This option specifies whether the search +<DT><B><TT>search</TT></B><DD> This option specifies whether the search functionality is enabled (value: <TT>true</TT>) or disabled (value: <TT>false</TT>). If disabled, the option <TT>hosts</TT> will be ignored and the Jabber User Directory service will not appear in the Service Discovery item list. The default value is <TT>true</TT>. -<DT CLASS="dt-description"><B><TT>matches</TT></B><DD CLASS="dd-description"> With this option, the number of reported +<DT><B><TT>matches</TT></B><DD> With this option, the number of reported search results can be limited. If the option's value is set to <TT>infinity</TT>, all search results are reported. The default value is <TT>30</TT>. -<DT CLASS="dt-description"><B><TT>allow_return_all</TT></B><DD CLASS="dd-description"> This option enables +<DT><B><TT>allow_return_all</TT></B><DD> This option enables you to specify if search operations with empty input fields should return all users who added some information to their vCard. The default value is <TT>false</TT>. -<DT CLASS="dt-description"><B><TT>search_all_hosts</TT></B><DD CLASS="dd-description"> If this option is +<DT><B><TT>search_all_hosts</TT></B><DD> If this option is set to <TT>true</TT>, search operations will apply to all virtual hosts. Otherwise only the current host will be searched. The default value is <TT>true</TT>. </DL> Examples: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> In this first situation, search results are limited to twenty items, every user who added information to their vCard will be listed when people do an empty search, and only users from the current host will be returned: - <PRE CLASS="verbatim"> + <PRE> {modules, [ ... @@ -2585,9 +2573,9 @@ In this first situation, search results are limited to twenty items, {search_all_hosts, false}]}, ... ]}. -</PRE><LI CLASS="li-itemize">The second situation differs in a way that search results are not limited, +</PRE><LI>The second situation differs in a way that search results are not limited, and that all virtual hosts will be searched instead of only the current one: - <PRE CLASS="verbatim"> + <PRE> {modules, [ ... @@ -2597,9 +2585,338 @@ In this first situation, search results are limited to twenty items, ... ]}. </PRE></UL> +<!--TOC subsection LDAP and <TT>mod_vcard_ldap</TT>--> + +<H3><A NAME="htoc64">A.21</A> LDAP and <TT>mod_vcard_ldap</TT></H3><!--SEC END --> + +<A NAME="sec:ldap"></A> + +<!--TOC subsubsection Features--> + +<H4><A NAME="htoc65">A.21.1</A> Features</H4><!--SEC END --> + +<A NAME="sec:ldapfeatures"></A> +<TT>ejabberd</TT> has built-in LDAP support. You can authenticate users against LDAP +server and use LDAP directory as vCard storage. Shared rosters are not +supported yet.<BR> +<BR> +<!--TOC subsubsection Connection--> + +<H4><A NAME="htoc66">A.21.2</A> Connection</H4><!--SEC END --> + +<A NAME="sec:ldapconnection"></A> +Parameters: +<DL COMPACT=compact><DT> +<B><TT>ldap_server</TT></B><DD> IP address or dns name of your +LDAP server. This option is required. +<DT><B><TT>ldap_port</TT></B><DD> Port to connect to LDAP server. +Default is 389. +<DT><B><TT>ldap_rootdn</TT></B><DD> Bind DN. Default is <TT>""</TT> +which means anonymous connection. +<DT><B><TT>ldap_password</TT></B><DD> Bind password. Default +is <TT>""</TT>. +</DL> +Example: +<PRE> + {auth_method, ldap}. + {ldap_servers, ["ldap.mydomain.org"]}. + {ldap_port, 389}. + {ldap_rootdn, "cn=Manager,dc=domain,dc=org"}. + {ldap_password, "secret"}. +</PRE> +Note that current LDAP implementation doesn't support SSL connection and SASL +authentication.<BR> +<BR> +<!--TOC subsubsection Authentication--> + +<H4><A NAME="htoc67">A.21.3</A> Authentication</H4><!--SEC END --> + +<A NAME="sec:ldapauthentication"></A> +You can authenticate users against LDAP directory. Available parameters are +listed below: +<DL COMPACT=compact><DT> +<B><TT>ldap_base</TT></B><DD> LDAP base directory which stores users +accounts. This option is required. +<DT><B><TT>ldap_uidattr</TT></B><DD> LDAP attribute which holds +user's part of JID. Default is <TT>"uid"</TT>. +<DT><B><TT>ldap_uidattr_format</TT></B><DD> Format of the +<TT>ldap_uidattr</TT> variable. Format MUST contain one and only one pattern +variable <TT>"%u"</TT> which will be replaced by user's part of JID. For example, +<TT>"%u@mydomain.org"</TT>. Default value is <TT>"%u"</TT>. +<DT><B><TT>ldap_filter</TT></B><DD> RFC 2254 LDAP filter. Default is +<TT>none</TT>. Example: <TT>"(&(objectClass=shadowAccount)(memberOf=Jabber + Users))"</TT>. Please, don't forget closing brackets and don't use superfluous +whitespaces. Also you MUST NOT use <TT>ldap_uidattr</TT> attribute in filter +because this attribute will be substituted in LDAP filter automatically. +</DL> +<!--TOC subsubsection vCards and Search--> + +<H4><A NAME="htoc68">A.21.4</A> vCards and Search</H4><!--SEC END --> + +<A NAME="sec:modvcardldap"></A> +<TT>ejabberd</TT> can map LDAP attributes to vCard fields. This behaviour is +implemented in <TT>mod_vcard_ldap</TT> module. This module doesn't depend on +authentication method. <TT>mod_vcard_ldap</TT> module has it's own optional +parameters. The first group of parameters has the same meaning as top-level +LDAP parameters: <TT>ldap_servers</TT>, <TT>ldap_port</TT>, +<TT>ldap_rootdn</TT>, <TT>ldap_password</TT>, <TT>ldap_base</TT>, +<TT>ldap_uidattr</TT>, <TT>ldap_uidattr_format</TT> and +<TT>ldap_filter</TT>. If one of this option is not set <TT>ejabberd</TT> will look +for top-level option with the same name. The second group of parameters +consists of the following options: +<DL COMPACT=compact><DT> + + <B><TT>hosts</TT></B><DD> This option defines the hostnames of the + service (see section <A HREF="#sec:modhostsoption">A.2.2</A>). If neither <TT>hosts</TT> nor + the old <TT>host</TT> is present, the prefix ``<TT>vjud.</TT>'' is added to all + <TT>ejabberd</TT> hostnames. + +<DT><B><TT>iqdisc</TT></B><DD> This specifies +the processing discipline for <TT>vcard-temp</TT> IQ queries +(see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). +<DT><B><TT>search</TT></B><DD> This option specifies whether the search + functionality is enabled (value: <TT>true</TT>) or disabled + (value: <TT>false</TT>). If disabled, the option <TT>hosts</TT> will be + ignored and the Jabber User Directory service will not appear in the + Service Discovery item list. The default value is <TT>true</TT>. +<DT><B><TT>ldap_vcard_map</TT></B><DD> the table which defines +reflection of LDAP attributes to vCard fields. + Format is: + <TT>[Name_of_vcard_field, Pattern, List_of_LDAP_attributes, ...]</TT> + where + <TT>Name_of_vcard_field</TT> is the type name of vCard as defined + in RFC 2426, + Pattern is a string which contains pattern variables <TT>"%u"</TT>, <TT>"%d"</TT> or <TT>"%s"</TT>, + <TT>List_of_LDAP_attributes</TT> is the list which contains of LDAP attributes. + Pattern variables <TT>"%s"</TT> will be sequentially replaced with the values of + LDAP attributes from <TT>List_of_LDAP_attributes</TT>; <TT>"%u"</TT> will be replaced with + user's part of JID and <TT>"%d"</TT> will be replaced with domain part of JID. + Example: +<PRE> + {ldap_vcard_map, + [{"NICKNAME", "%u", []}, + {"FN", "%s", ["displayName"]}, + {"CTRY", "Russia", []}, + {"EMAIL", "%u@%d", []}, + {"DESC", "%s\n%s", ["title", "description"]} + ]}, +</PRE> +Default is: +<PRE> + [{"NICKNAME", "%u", []}, + {"FN", "%s", ["displayName"]}, + {"FAMILY", "%s", ["sn"]}, + {"GIVEN", "%s", ["givenName"]}, + {"MIDDLE", "%s", ["initials"]}, + {"ORGNAME", "%s", ["o"]}, + {"ORGUNIT", "%s", ["ou"]}, + {"CTRY", "%s", ["c"]}, + {"LOCALITY", "%s", ["l"]}, + {"STREET", "%s", ["street"]}, + {"REGION", "%s", ["st"]}, + {"PCODE", "%s", ["postalCode"]}, + {"TITLE", "%s", ["title"]}, + {"URL", "%s", ["labeleduri"]}, + {"DESC", "%s", ["description"]}, + {"TEL", "%s", ["telephoneNumber"]}, + {"EMAIL", "%s", ["mail"]}, + {"BDAY", "%s", ["birthDay"]}, + {"ROLE", "%s", ["employeeType"]}, + {"PHOTO", "%s", ["jpegPhoto"]}] +</PRE><DT><B><TT>ldap_search_fields</TT></B><DD> This option defines +search form and LDAP attributes to search. + Format: + <TT>[Name, Attribute, ...]</TT> + where + <TT>Name</TT> is the name of field in the search form. Will be automatically + translated according to definitions in translation files (see + <TT>msgs/*.msg</TT> for available words). + Attribute is the LDAP attribute or the pattern <TT>"%u"</TT> + Example: +<PRE> + {ldap_search_fields, + [{"User", "uid"}, + {"Full Name", "displayName"}, + {"Email", "mail"} + ]}, +</PRE> +Default is: +<PRE> + [{"User", "%u"}, + {"Full Name", "displayName"}, + {"Given Name", "givenName"}, + {"Middle Name", "initials"}, + {"Family Name", "sn"}, + {"Nickname", "%u"}, + {"Birthday", "birthDay"}, + {"Country", "c"}, + {"City", "l"}, + {"Email", "mail"}, + {"Organization Name", "o"}, + {"Organization Unit", "ou"}] +</PRE><DT><B><TT>ldap_search_reported</TT></B><DD> This option defines search fields to be reported. + Format: + <TT>[Name, VCard_Name, ...]</TT> + where + <TT>Name</TT> is the name of field in the search form. Will be automatically + translated according to definitions in translation files (see + <TT>msgs/*.msg</TT> for available words). + <TT>VCard_Name</TT> is the name of vCard field defined in <TT>ldap_vcard_map</TT> option. + Example: +<PRE> + {ldap_search_reported, + [{"Full Name", "FN"}, + {"Email", "EMAIL"}, + {"Birthday", "BDAY"}, + {"Nickname", "NICKNAME"} + ]}, +</PRE> +Default is: +<PRE> + [{"Full Name", "FN"}, + {"Given Name", "GIVEN"}, + {"Middle Name", "MIDDLE"}, + {"Family Name", "FAMILY"}, + {"Nickname", "NICKNAME"}, + {"Birthday", "BDAY"}, + {"Country", "CTRY"}, + {"City", "LOCALITY"}, + {"Email", "EMAIL"}, + {"Organization Name", "ORGNAME"}, + {"Organization Unit", "ORGUNIT"}] +</PRE></DL> +<!--TOC subsubsection Examples--> + +<H4><A NAME="htoc69">A.21.5</A> Examples</H4><!--SEC END --> + +<A NAME="sec:ldapexamples"></A> +<!--TOC paragraph Common example--> + +<H5>Common example</H5><!--SEC END --> + +Let's say <TT>ldap.mydomain.org</TT> is the name of our LDAP server. We have +users with their passwords in <TT>"ou=Users,dc=mydomain,dc=org"</TT> directory. +Also we have addressbook, which contains users emails and their additional +infos in <TT>"ou=AddressBook,dc=mydomain,dc=org"</TT> directory. Corresponding +authentication section should looks like this: +<PRE> + %% authentication method + {auth_method, ldap}. + %% DNS name of our LDAP server + {ldap_servers, ["ldap.mydomain.org"]}. + %% Bind to LDAP server as "cn=Manager,dc=mydomain,dc=org" with password "secret" + {ldap_rootdn, "cn=Manager,dc=mydomain,dc=org"}. + {ldap_password, "secret"}. + %% define the user's base + {ldap_base, "ou=Users,dc=mydomain,dc=org"}. + %% We want to authorize users from 'shadowAccount' object class only + {ldap_filter, "(objectClass=shadowAccount)"}. +</PRE> +Now we want to use users LDAP-info as their vCards. We have four attributes +defined in our LDAP schema: <TT>"mail"</TT> --- email address, <TT>"givenName"</TT> +--- first name, <TT>"sn"</TT> --- second name, <TT>"birthDay"</TT> --- birthday. +Also we want users to search each other. Let's see how we can set it up: +<PRE> + {modules, + ... + {mod_vcard_ldap, + [ + %% We use the same server and port, but want to bind anonymously because + %% our LDAP server accepts anonymous requests to + %% "ou=AddressBook,dc=mydomain,dc=org" subtree. + {ldap_rootdn, ""}, + {ldap_password, ""}, + %% define the addressbook's base + {ldap_base, "ou=AddressBook,dc=mydomain,dc=org"}, + %% user's part of JID is located in the "mail" attribute + {ldap_uidattr, "mail"}, + %% common format for our emails + {ldap_uidattr_format, "%u@mail.mydomain.org"}, + %% We have to define empty filter here, because entries in addressbook doesn't + %% belong to shadowAccount object class + {ldap_filter, ""}, + %% Now we want to define vCard pattern + {ldap_vcard_map, + [{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname + {"GIVEN", "%s", ["givenName"]}, + {"FAMILY", "%s", ["sn"]}, + {"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John" + {"EMAIL", "%s", ["mail"]}, + {"BDAY", "%s", ["birthDay"]}]}, + %% Search form + {ldap_search_fields, + [{"User", "%u"}, + {"Name", "givenName"}, + {"Family Name", "sn"}, + {"Email", "mail"}, + {"Birthday", "birthDay"}]}, + %% vCard fields to be reported + %% Note that JID is always returned with search results + {ldap_search_reported, + [{"Full Name", "FN"}, + {"Nickname", "NICKNAME"}, + {"Birthday", "BDAY"}]} + ]} + ... + }. +</PRE> +Note that <TT>mod_vcard_ldap</TT> module checks an existence of the user before +searching his info in LDAP.<BR> +<BR> +<!--TOC paragraph Active Directory--> + +<H5>Active Directory</H5><!--SEC END --> + +Active Directory is just an LDAP-server with predefined attributes. Sample +config file is listed below: +<PRE> + {auth_method, ldap}. + {ldap_servers, ["office.org"]}. % List of LDAP servers + {ldap_base, "DC=office,DC=org"}. % Search base of LDAP directory + {ldap_rootdn, "CN=Administrator,CN=Users,DC=office,DC=org"}. % LDAP manager + {ldap_password, "*******"}. % Password to LDAP manager + {ldap_uidattr, "sAMAccountName"}. + {ldap_filter, "(memberOf=*)"}. + + {mod_vcard_ldap, + [{ldap_vcard_map, + [{"NICKNAME", "%u", []}, + {"GIVEN", "%s", ["givenName"]}, + {"MIDDLE", "%s", ["initials"]}, + {"FAMILY", "%s", ["sn"]}, + {"FN", "%s", ["displayName"]}, + {"EMAIL", "%s", ["mail"]}, + {"ORGNAME", "%s", ["company"]}, + {"ORGUNIT", "%s", ["department"]}, + {"CTRY", "%s", ["c"]}, + {"LOCALITY", "%s", ["l"]}, + {"STREET", "%s", ["streetAddress"]}, + {"REGION", "%s", ["st"]}, + {"PCODE", "%s", ["postalCode"]}, + {"TITLE", "%s", ["title"]}, + {"URL", "%s", ["wWWHomePage"]}, + {"DESC", "%s", ["description"]}, + {"TEL", "%s", ["telephoneNumber"]}]}, + {ldap_search_fields, + [{"User", "%u"}, + {"Name", "givenName"}, + {"Family Name", "sn"}, + {"Email", "mail"}, + {"Company", "company"}, + {"Department", "department"}, + {"Role", "title"}, + {"Description", "description"}, + {"Phone", "telephoneNumber"}]}, + {ldap_search_reported, + [{"Full Name", "FN"}, + {"Nickname", "NICKNAME"}, + {"Email", "EMAIL"}]} + ] + }. +</PRE> <!--TOC subsection <TT>mod_version</TT>--> -<H3 CLASS="subsection"><A NAME="htoc64">A.21</A> <TT>mod_version</TT></H3><!--SEC END --> +<H3><A NAME="htoc70">A.22</A> <TT>mod_version</TT></H3><!--SEC END --> <A NAME="sec:modversion"></A> @@ -2607,20 +2924,20 @@ This module implements Software Version (<A HREF="http://www.jabber.org/jeps/jep answers <TT>ejabberd</TT>'s version when queried.<BR> <BR> Options: -<DL CLASS="description" COMPACT=compact><DT CLASS="dt-description"> -<B><TT>iqdisc</TT></B><DD CLASS="dd-description"> This specifies +<DL COMPACT=compact><DT> +<B><TT>iqdisc</TT></B><DD> This specifies the processing discipline for Software Version (<TT>jabber:iq:version</TT>) IQ queries (see section <A HREF="#sec:modiqdiscoption">A.2.1</A>). </DL> <!--TOC section Internationalization and Localization--> -<H2 CLASS="section"><A NAME="htoc65">B</A> Internationalization and Localization</H2><!--SEC END --> +<H2><A NAME="htoc71">B</A> Internationalization and Localization</H2><!--SEC END --> <A NAME="sec:i18nl10n"></A> All built-in modules support the <TT>xml:lang</TT> attribute inside IQ queries. Figure <A HREF="#fig:discorus">2</A>, for example, shows the reply to the following query: -<PRE CLASS="verbatim"> +<PRE> <iq id='5' to='example.org' type='get' @@ -2628,44 +2945,40 @@ Figure <A HREF="#fig:discorus">2</A>, for example, shows the reply to the f <query xmlns='http://jabber.org/protocol/disco#items'/> </iq> </PRE> -<BLOCKQUOTE CLASS="figure"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> +<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV> <IMG SRC="discorus.png"> <BR> -<BR> -<DIV CLASS="center">Figure 2: Service Discovery when <TT>xml:lang='ru'</TT></DIV><BR> -<BR> +<DIV ALIGN=center>Figure 2: Service Discovery when <TT>xml:lang='ru'</TT></DIV><BR> <A NAME="fig:discorus"></A> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> +<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> The web interface also supports the <CODE>Accept-Language</CODE> HTTP header (compare figure <A HREF="#fig:webadmmainru">3</A> with figure <A HREF="#fig:webadmmain">1</A>) -<BLOCKQUOTE CLASS="figure"><DIV CLASS="center"><DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV> +<BLOCKQUOTE><DIV ALIGN=center><DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV> <IMG SRC="webadmmainru.png"> <BR> -<BR> -<DIV CLASS="center">Figure 3: Top page from the web interface with HTTP header - “Accept-Language: ru”</DIV><BR> -<BR> +<DIV ALIGN=center>Figure 3: Top page from the web interface with HTTP header + ``Accept-Language: ru''</DIV><BR> <A NAME="fig:webadmmainru"></A> -<DIV CLASS="center"><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> +<DIV ALIGN=center><HR WIDTH="80%" SIZE=2></DIV></DIV></BLOCKQUOTE> <!--TOC section Release Notes--> -<H2 CLASS="section"><A NAME="htoc66">C</A> Release Notes</H2><!--SEC END --> +<H2><A NAME="htoc72">C</A> Release Notes</H2><!--SEC END --> <A NAME="sec:releasenotes"></A> <!--TOC subsection ejabberd 0.9--> -<H3 CLASS="subsection"><A NAME="htoc67">C.1</A> ejabberd 0.9</H3><!--SEC END --> +<H3><A NAME="htoc73">C.1</A> ejabberd 0.9</H3><!--SEC END --> -<PRE CLASS="verbatim"> +<PRE> Release notes ejabberd 0.9 @@ -2757,9 +3070,9 @@ Bugfixes </PRE> <!--TOC subsection ejabberd 0.9.1--> -<H3 CLASS="subsection"><A NAME="htoc68">C.2</A> ejabberd 0.9.1</H3><!--SEC END --> +<H3><A NAME="htoc74">C.2</A> ejabberd 0.9.1</H3><!--SEC END --> -<PRE CLASS="verbatim"> +<PRE> Release notes ejabberd 0.9.1 @@ -2825,9 +3138,9 @@ Bugfixes </PRE> <!--TOC subsection ejabberd 0.9.8--> -<H3 CLASS="subsection"><A NAME="htoc69">C.3</A> ejabberd 0.9.8</H3><!--SEC END --> +<H3><A NAME="htoc75">C.3</A> ejabberd 0.9.8</H3><!--SEC END --> -<PRE CLASS="verbatim"> +<PRE> Release notes ejabberd 0.9.8 2005-08-01 @@ -2930,9 +3243,9 @@ END </PRE> <!--TOC subsection ejabberd 1.0.0--> -<H3 CLASS="subsection"><A NAME="htoc70">C.4</A> ejabberd 1.0.0</H3><!--SEC END --> +<H3><A NAME="htoc76">C.4</A> ejabberd 1.0.0</H3><!--SEC END --> -<PRE CLASS="verbatim"> +<PRE> Release Notes ejabberd 1.0.0 14 December 2005 @@ -3056,9 +3369,9 @@ END </PRE> <!--TOC subsection ejabberd 1.1.0--> -<H3 CLASS="subsection"><A NAME="htoc71">C.5</A> ejabberd 1.1.0</H3><!--SEC END --> +<H3><A NAME="htoc77">C.5</A> ejabberd 1.1.0</H3><!--SEC END --> -<PRE CLASS="verbatim"> +<PRE> Release Notes ejabberd 1.1.0 24 April 2006 @@ -3177,9 +3490,9 @@ END </PRE> <!--TOC subsection ejabberd 1.1.1--> -<H3 CLASS="subsection"><A NAME="htoc72">C.6</A> ejabberd 1.1.1</H3><!--SEC END --> +<H3><A NAME="htoc78">C.6</A> ejabberd 1.1.1</H3><!--SEC END --> -<PRE CLASS="verbatim"> +<PRE> Release Notes ejabberd 1.1.1 28 April 2006 @@ -3302,23 +3615,26 @@ END </PRE> <!--TOC section Acknowledgements--> -<H2 CLASS="section"><A NAME="htoc73">D</A> Acknowledgements</H2><!--SEC END --> +<H2><A NAME="htoc79">D</A> Acknowledgements</H2><!--SEC END --> <A NAME="sec:acknowledgements"></A> Thanks to all people who contributed to this guide: -<UL CLASS="itemize"><LI CLASS="li-itemize"> +<UL><LI> Alexey Shchepin (<A HREF="xmpp:aleksey@jabber.ru"><TT>xmpp:aleksey@jabber.ru</TT></A>) -<LI CLASS="li-itemize">Florian Zumbiehl (<A HREF="xmpp:florz@florz.de"><TT>xmpp:florz@florz.de</TT></A>) -<LI CLASS="li-itemize">Michael Grigutsch (<A HREF="xmpp:migri@jabber.i-pobox.net"><TT>xmpp:migri@jabber.i-pobox.net</TT></A>) -<LI CLASS="li-itemize">Mickael Remond (<A HREF="xmpp:mremond@erlang-projects.org"><TT>xmpp:mremond@erlang-projects.org</TT></A>) -<LI CLASS="li-itemize">Sander Devrieze (<A HREF="xmpp:sander@devrieze.dyndns.org"><TT>xmpp:sander@devrieze.dyndns.org</TT></A>) -<LI CLASS="li-itemize">Sergei Golovan (<A HREF="xmpp:sgolovan@nes.ru"><TT>xmpp:sgolovan@nes.ru</TT></A>) -<LI CLASS="li-itemize">Vsevolod Pelipas (<A HREF="xmpp:vsevoload@jabber.ru"><TT>xmpp:vsevoload@jabber.ru</TT></A>) +<LI>Florian Zumbiehl (<A HREF="xmpp:florz@florz.de"><TT>xmpp:florz@florz.de</TT></A>) +<LI>Michael Grigutsch (<A HREF="xmpp:migri@jabber.i-pobox.net"><TT>xmpp:migri@jabber.i-pobox.net</TT></A>) +<LI>Mickael Remond (<A HREF="xmpp:mremond@erlang-projects.org"><TT>xmpp:mremond@erlang-projects.org</TT></A>) +<LI>Sander Devrieze (<A HREF="xmpp:sander@devrieze.dyndns.org"><TT>xmpp:sander@devrieze.dyndns.org</TT></A>) +<LI>Sergei Golovan (<A HREF="xmpp:sgolovan@nes.ru"><TT>xmpp:sgolovan@nes.ru</TT></A>) +<LI>Vsevolod Pelipas (<A HREF="xmpp:vsevoload@jabber.ru"><TT>xmpp:vsevoload@jabber.ru</TT></A>) </UL> <!--HTMLFOOT--> <!--ENDHTML--> <!--FOOTER--> -<HR SIZE=2><BLOCKQUOTE CLASS="quote"><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by -</EM><A HREF="http://pauillac.inria.fr/~maranget/hevea/index.html"><EM>H<FONT SIZE=2><sup>E</sup></FONT>V<FONT SIZE=2><sup>E</sup></FONT>A</EM></A><EM>.</EM></BLOCKQUOTE></BODY> +<HR SIZE=2> +<BLOCKQUOTE><EM>This document was translated from L<sup>A</sup>T<sub>E</sub>X by +</EM><A HREF="http://pauillac.inria.fr/~maranget/hevea/index.html"><EM>H<FONT SIZE=2><sup>E</sup></FONT>V<FONT SIZE=2><sup>E</sup></FONT>A</EM></A><EM>. +</EM></BLOCKQUOTE> +</BODY> </HTML> diff --git a/doc/guide.tex b/doc/guide.tex index 53a07c585..ae37b8d04 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -1985,15 +1985,14 @@ Options: Examples: \begin{itemize} -\item Next example prohibits the registration of too short account names and of - account names with exotic characters in it: - \begin{verbatim} +\item Next example prohibits the registration of too short account names: +\begin{verbatim} {acl, shortname, {user_glob, "?"}}. {acl, shortname, {user_glob, "??"}}. - {acl, strangename, {user_regexp, "^..?$"}}. + % The same using regexp: + %{acl, shortname, {user_regexp, "^..?$"}}. ... {access, register, [{deny, shortname}, - {deny, strangename}, {allow, all}]}. ... {modules, @@ -2292,6 +2291,338 @@ Examples: \end{verbatim} \end{itemize} +\subsection{LDAP and \modvcardldap{}} +\label{sec:ldap} +\ind{modules!\modvcardldap{}}\ind{JUD}\ind{Jabber User Directory}\ind{vCard}\ind{protocols!JEP-0054: vcard-temp} + + +\subsubsection{Features} +\label{sec:ldapfeatures} + +\ejabberd{} has built-in LDAP support. You can authenticate users against LDAP +server and use LDAP directory as vCard storage. Shared rosters are not +supported yet. + + +\subsubsection{Connection} +\label{sec:ldapconnection} + +Parameters: + +\begin{description} +\titem{ldap\_server} \ind{options!ldap_server}IP address or dns name of your +LDAP server. This option is required. +\titem{ldap\_port} \ind{options!ldap_port}Port to connect to LDAP server. +Default is~389. +\titem{ldap\_rootdn} \ind{options!ldap_rootdn}Bind DN. Default is~\term{""} +which means anonymous connection. +\titem{ldap\_password} \ind{options!ldap_password}Bind password. Default +is~\term{""}. +\end{description} + +Example: +\begin{verbatim} + {auth_method, ldap}. + {ldap_servers, ["ldap.mydomain.org"]}. + {ldap_port, 389}. + {ldap_rootdn, "cn=Manager,dc=domain,dc=org"}. + {ldap_password, "secret"}. +\end{verbatim} + +Note that current LDAP implementation doesn't support SSL connection and SASL +authentication. + + +\subsubsection{Authentication} +\label{sec:ldapauthentication} + +You can authenticate users against LDAP directory. Available parameters are +listed below: + +\begin{description} +\titem{ldap\_base} \ind{options!ldap_base}LDAP base directory which stores users +accounts. This option is required. +\titem{ldap\_uidattr} \ind{options!ldap_uidattr}LDAP attribute which holds +user's part of JID. Default is \term{"uid"}. +\titem{ldap\_uidattr\_format} \ind{options!ldap_uidattr_format}Format of the +\term{ldap\_uidattr} variable. Format MUST contain one and only one pattern +variable \term{"\%u"} which will be replaced by user's part of JID. For example, +\term{"\%u@mydomain.org"}. Default value is \term{"\%u"}. +\titem{ldap\_filter} \ind{options!ldap_filter}RFC 2254 LDAP filter. Default is +\term{none}. Example: \term{"(\&(objectClass=shadowAccount)(memberOf=Jabber + Users))"}. Please, don't forget closing brackets and don't use superfluous +whitespaces. Also you MUST NOT use \option{ldap\_uidattr} attribute in filter +because this attribute will be substituted in LDAP filter automatically. +\end{description} + + +\subsubsection{vCards and Search} +\label{sec:modvcardldap} + +\ejabberd{} can map LDAP attributes to vCard fields. This behaviour is +implemented in \modvcardldap{} module. This module doesn't depend on +authentication method. \modvcardldap{} module has it's own optional +parameters. The first group of parameters has the same meaning as top-level +LDAP parameters: \option{ldap\_servers}, \option{ldap\_port}, +\option{ldap\_rootdn}, \option{ldap\_password}, \option{ldap\_base}, +\option{ldap\_uidattr}, \option{ldap\_uidattr\_format} and +\option{ldap\_filter}. If one of this option is not set \ejabberd{} will look +for top-level option with the same name. The second group of parameters +consists of the following options: + +\begin{description} +\hostitem{vjud} +\iqdiscitem{\ns{vcard-temp}} +\titem{search} \ind{options!search}This option specifies whether the search + functionality is enabled (value: \term{true}) or disabled + (value: \term{false}). If disabled, the option \term{hosts} will be + ignored and the \Jabber{} User Directory service will not appear in the + Service Discovery item list. The default value is \term{true}. +\titem{ldap\_vcard\_map} \ind{options!ldap_vcard_map}the table which defines +reflection of LDAP attributes to vCard fields. + Format is: + \term{[{Name\_of\_vcard\_field, Pattern, List\_of\_LDAP\_attributes}, ...]} + where + \term{Name\_of\_vcard\_field} is the type name of vCard as defined + in RFC 2426, + Pattern is a string which contains pattern variables \term{"\%u"}, \term{"\%d"} or \term{"\%s"}, + \term{List\_of\_LDAP\_attributes} is the list which contains of LDAP attributes. + Pattern variables \term{"\%s"} will be sequentially replaced with the values of + LDAP attributes from \term{List\_of\_LDAP\_attributes}; \term{"\%u"} will be replaced with + user's part of JID and \term{"\%d"} will be replaced with domain part of JID. + Example: +\begin{verbatim} + {ldap_vcard_map, + [{"NICKNAME", "%u", []}, + {"FN", "%s", ["displayName"]}, + {"CTRY", "Russia", []}, + {"EMAIL", "%u@%d", []}, + {"DESC", "%s\n%s", ["title", "description"]} + ]}, +\end{verbatim} + +Default is: +\begin{verbatim} + [{"NICKNAME", "%u", []}, + {"FN", "%s", ["displayName"]}, + {"FAMILY", "%s", ["sn"]}, + {"GIVEN", "%s", ["givenName"]}, + {"MIDDLE", "%s", ["initials"]}, + {"ORGNAME", "%s", ["o"]}, + {"ORGUNIT", "%s", ["ou"]}, + {"CTRY", "%s", ["c"]}, + {"LOCALITY", "%s", ["l"]}, + {"STREET", "%s", ["street"]}, + {"REGION", "%s", ["st"]}, + {"PCODE", "%s", ["postalCode"]}, + {"TITLE", "%s", ["title"]}, + {"URL", "%s", ["labeleduri"]}, + {"DESC", "%s", ["description"]}, + {"TEL", "%s", ["telephoneNumber"]}, + {"EMAIL", "%s", ["mail"]}, + {"BDAY", "%s", ["birthDay"]}, + {"ROLE", "%s", ["employeeType"]}, + {"PHOTO", "%s", ["jpegPhoto"]}] +\end{verbatim} +\titem{ldap\_search\_fields} \ind{options!ldap_search_fields}This option defines +search form and LDAP attributes to search. + Format: + \term{[{Name, Attribute}, ...]} + where + \term{Name} is the name of field in the search form. Will be automatically + translated according to definitions in translation files (see + \term{msgs/*.msg} for available words). + Attribute is the LDAP attribute or the pattern \term{"\%u"} + Example: +\begin{verbatim} + {ldap_search_fields, + [{"User", "uid"}, + {"Full Name", "displayName"}, + {"Email", "mail"} + ]}, +\end{verbatim} + +Default is: +\begin{verbatim} + [{"User", "%u"}, + {"Full Name", "displayName"}, + {"Given Name", "givenName"}, + {"Middle Name", "initials"}, + {"Family Name", "sn"}, + {"Nickname", "%u"}, + {"Birthday", "birthDay"}, + {"Country", "c"}, + {"City", "l"}, + {"Email", "mail"}, + {"Organization Name", "o"}, + {"Organization Unit", "ou"}] +\end{verbatim} +\titem{ldap\_search\_reported} \ind{options!ldap_search_reported}This option defines search fields to be reported. + Format: + \term{[{Name, VCard\_Name}, ...]} + where + \term{Name} is the name of field in the search form. Will be automatically + translated according to definitions in translation files (see + \term{msgs/*.msg} for available words). + \term{VCard\_Name} is the name of vCard field defined in \option{ldap\_vcard\_map} option. + Example: +\begin{verbatim} + {ldap_search_reported, + [{"Full Name", "FN"}, + {"Email", "EMAIL"}, + {"Birthday", "BDAY"}, + {"Nickname", "NICKNAME"} + ]}, +\end{verbatim} + +Default is: +\begin{verbatim} + [{"Full Name", "FN"}, + {"Given Name", "GIVEN"}, + {"Middle Name", "MIDDLE"}, + {"Family Name", "FAMILY"}, + {"Nickname", "NICKNAME"}, + {"Birthday", "BDAY"}, + {"Country", "CTRY"}, + {"City", "LOCALITY"}, + {"Email", "EMAIL"}, + {"Organization Name", "ORGNAME"}, + {"Organization Unit", "ORGUNIT"}] +\end{verbatim} +\end{description} + + +\subsubsection{Examples} +\label{sec:ldapexamples} + +\paragraph{Common example} + +Let's say \term{ldap.mydomain.org} is the name of our LDAP server. We have +users with their passwords in \term{"ou=Users,dc=mydomain,dc=org"} directory. +Also we have addressbook, which contains users emails and their additional +infos in \term{"ou=AddressBook,dc=mydomain,dc=org"} directory. Corresponding +authentication section should looks like this: + +\begin{verbatim} + %% authentication method + {auth_method, ldap}. + %% DNS name of our LDAP server + {ldap_servers, ["ldap.mydomain.org"]}. + %% Bind to LDAP server as "cn=Manager,dc=mydomain,dc=org" with password "secret" + {ldap_rootdn, "cn=Manager,dc=mydomain,dc=org"}. + {ldap_password, "secret"}. + %% define the user's base + {ldap_base, "ou=Users,dc=mydomain,dc=org"}. + %% We want to authorize users from 'shadowAccount' object class only + {ldap_filter, "(objectClass=shadowAccount)"}. +\end{verbatim} + +Now we want to use users LDAP-info as their vCards. We have four attributes +defined in our LDAP schema: \term{"mail"} --- email address, \term{"givenName"} +--- first name, \term{"sn"} --- second name, \term{"birthDay"} --- birthday. +Also we want users to search each other. Let's see how we can set it up: + +\begin{verbatim} + {modules, + ... + {mod_vcard_ldap, + [ + %% We use the same server and port, but want to bind anonymously because + %% our LDAP server accepts anonymous requests to + %% "ou=AddressBook,dc=mydomain,dc=org" subtree. + {ldap_rootdn, ""}, + {ldap_password, ""}, + %% define the addressbook's base + {ldap_base, "ou=AddressBook,dc=mydomain,dc=org"}, + %% user's part of JID is located in the "mail" attribute + {ldap_uidattr, "mail"}, + %% common format for our emails + {ldap_uidattr_format, "%u@mail.mydomain.org"}, + %% We have to define empty filter here, because entries in addressbook doesn't + %% belong to shadowAccount object class + {ldap_filter, ""}, + %% Now we want to define vCard pattern + {ldap_vcard_map, + [{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname + {"GIVEN", "%s", ["givenName"]}, + {"FAMILY", "%s", ["sn"]}, + {"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John" + {"EMAIL", "%s", ["mail"]}, + {"BDAY", "%s", ["birthDay"]}]}, + %% Search form + {ldap_search_fields, + [{"User", "%u"}, + {"Name", "givenName"}, + {"Family Name", "sn"}, + {"Email", "mail"}, + {"Birthday", "birthDay"}]}, + %% vCard fields to be reported + %% Note that JID is always returned with search results + {ldap_search_reported, + [{"Full Name", "FN"}, + {"Nickname", "NICKNAME"}, + {"Birthday", "BDAY"}]} + ]} + ... + }. +\end{verbatim} + +Note that \modvcardldap{} module checks an existence of the user before +searching his info in LDAP. + + +\paragraph{Active Directory} + +Active Directory is just an LDAP-server with predefined attributes. Sample +config file is listed below: + +\begin{verbatim} + {auth_method, ldap}. + {ldap_servers, ["office.org"]}. % List of LDAP servers + {ldap_base, "DC=office,DC=org"}. % Search base of LDAP directory + {ldap_rootdn, "CN=Administrator,CN=Users,DC=office,DC=org"}. % LDAP manager + {ldap_password, "*******"}. % Password to LDAP manager + {ldap_uidattr, "sAMAccountName"}. + {ldap_filter, "(memberOf=*)"}. + + {mod_vcard_ldap, + [{ldap_vcard_map, + [{"NICKNAME", "%u", []}, + {"GIVEN", "%s", ["givenName"]}, + {"MIDDLE", "%s", ["initials"]}, + {"FAMILY", "%s", ["sn"]}, + {"FN", "%s", ["displayName"]}, + {"EMAIL", "%s", ["mail"]}, + {"ORGNAME", "%s", ["company"]}, + {"ORGUNIT", "%s", ["department"]}, + {"CTRY", "%s", ["c"]}, + {"LOCALITY", "%s", ["l"]}, + {"STREET", "%s", ["streetAddress"]}, + {"REGION", "%s", ["st"]}, + {"PCODE", "%s", ["postalCode"]}, + {"TITLE", "%s", ["title"]}, + {"URL", "%s", ["wWWHomePage"]}, + {"DESC", "%s", ["description"]}, + {"TEL", "%s", ["telephoneNumber"]}]}, + {ldap_search_fields, + [{"User", "%u"}, + {"Name", "givenName"}, + {"Family Name", "sn"}, + {"Email", "mail"}, + {"Company", "company"}, + {"Department", "department"}, + {"Role", "title"}, + {"Description", "description"}, + {"Phone", "telephoneNumber"}]}, + {ldap_search_reported, + [{"Full Name", "FN"}, + {"Nickname", "NICKNAME"}, + {"Email", "EMAIL"}]} + ] + }. +\end{verbatim} + + \subsection{\modversion{}} \label{sec:modversion} \ind{modules!\modversion{}}\ind{protocols!JEP-0092: Software Version} diff --git a/src/ejabberd_auth_ldap.erl b/src/ejabberd_auth_ldap.erl index 6e454cb80..a1ce74609 100644 --- a/src/ejabberd_auth_ldap.erl +++ b/src/ejabberd_auth_ldap.erl @@ -10,8 +10,21 @@ -author('alexey@sevcom.net'). -vsn('$Revision$ '). +-behaviour(gen_server). + +%% gen_server callbacks +-export([init/1, + handle_info/2, + handle_call/3, + handle_cast/2, + terminate/2, + code_change/3 + ]). + %% External exports -export([start/1, + stop/1, + start_link/1, set_password/3, check_password/3, check_password/5, @@ -29,39 +42,84 @@ -include("ejabberd.hrl"). -include("eldap/eldap.hrl"). +-record(state, {host, + eldap_id, + servers, + port, + dn, + password, + base, + uidattr, + uidattr_format, + ufilter, + sfilter, + dn_filter, + dn_filter_attrs + }). + +%% Unused callbacks. +handle_cast(_Request, State) -> + {noreply, State}. +code_change(_OldVsn, State, _Extra) -> + {ok, State}. +handle_info(_Info, State) -> + {noreply, State}. +%% ----- + %%%---------------------------------------------------------------------- %%% API %%%---------------------------------------------------------------------- + start(Host) -> - LDAPServers = ejabberd_config:get_local_option({ldap_servers, Host}), - RootDN = ejabberd_config:get_local_option({ldap_rootdn, Host}), - Password = ejabberd_config:get_local_option({ldap_password, Host}), - eldap:start_link(get_eldap_id(Host, ejabberd), - LDAPServers, 389, RootDN, Password), - eldap:start_link(get_eldap_id(Host, ejabberd_bind), - LDAPServers, 389, RootDN, Password), + Proc = gen_mod:get_module_proc(Host, ?MODULE), + ChildSpec = { + Proc, {?MODULE, start_link, [Host]}, + permanent, 1000, worker, [?MODULE] + }, + supervisor:start_child(ejabberd_sup, ChildSpec). + +stop(Host) -> + Proc = gen_mod:get_module_proc(Host, ?MODULE), + gen_server:call(Proc, stop), + supervisor:terminate_child(ejabberd_sup, Proc), + supervisor:delete_child(ejabberd_sup, Proc). + +start_link(Host) -> + Proc = gen_mod:get_module_proc(Host, ?MODULE), + gen_server:start_link({local, Proc}, ?MODULE, Host, []). + +terminate(_Reason, State) -> + ejabberd_ctl:unregister_commands( + State#state.host, + [{"registered-users", "list all registered users"}], + ejabberd_auth, ctl_process_get_registered). + +init(Host) -> + State = parse_options(Host), + eldap:start_link(State#state.eldap_id, + State#state.servers, + State#state.port, + State#state.dn, + State#state.password), ejabberd_ctl:register_commands( Host, [{"registered-users", "list all registered users"}], ejabberd_auth, ctl_process_get_registered), - ok. + {ok, State}. + +-define(REPLY_TIMEOUT, 10000). plain_password_required() -> true. check_password(User, Server, Password) -> - case find_user_dn(User, Server) of - false -> + Proc = gen_mod:get_module_proc(Server, ?MODULE), + case catch gen_server:call(Proc, + {check_pass, User, Password}, ?REPLY_TIMEOUT) of + {'EXIT', _} -> false; - DN -> - LServer = jlib:nameprep(Server), - case eldap:bind(get_eldap_id(LServer, ejabberd_bind), - DN, Password) of - ok -> - true; - _ -> - false - end + Result -> + Result end. check_password(User, Server, Password, _StreamID, _Digest) -> @@ -77,31 +135,13 @@ dirty_get_registered_users() -> get_vh_registered_users(?MYNAME). get_vh_registered_users(Server) -> - LServer = jlib:nameprep(Server), - Attr = ejabberd_config:get_local_option({ldap_uidattr, LServer}), - Filter = eldap:present(Attr), - Base = ejabberd_config:get_local_option({ldap_base, LServer}), - case eldap:search(get_eldap_id(LServer, ejabberd), - [{base, Base}, - {filter, Filter}, - {attributes, [Attr]}]) of - #eldap_search_result{entries = Es} -> - lists:flatmap( - fun(E) -> - case lists:keysearch(Attr, 1, E#eldap_entry.attributes) of - {value, {_, [U]}} -> - case jlib:nodeprep(U) of - error -> - []; - LU -> - [{LU, LServer}] - end; - _ -> - [] - end - end, Es); - _ -> - [] + Proc = gen_mod:get_module_proc(Server, ?MODULE), + case catch gen_server:call(Proc, + get_vh_registered_users, ?REPLY_TIMEOUT) of + {'EXIT', _} -> + []; + Result -> + Result end. get_password(_User, _Server) -> @@ -111,11 +151,13 @@ get_password_s(_User, _Server) -> "". is_user_exists(User, Server) -> - case find_user_dn(User, Server) of - false -> + Proc = gen_mod:get_module_proc(Server, ?MODULE), + case catch gen_server:call(Proc, + {is_user_exists, User}, ?REPLY_TIMEOUT) of + {'EXIT', _} -> false; - _DN -> - true + Result -> + Result end. remove_user(_User, _Server) -> @@ -124,25 +166,212 @@ remove_user(_User, _Server) -> remove_user(_User, _Server, _Password) -> not_allowed. - %%%---------------------------------------------------------------------- %%% Internal functions %%%---------------------------------------------------------------------- +handle_call({check_pass, User, Password}, _From, State) -> + Reply = case find_user_dn(User, State) of + false -> + false; + DN -> + case eldap:bind(State#state.eldap_id, DN, Password) of + ok -> true; + _ -> false + end + end, + {reply, Reply, State}; + +handle_call(get_vh_registered_users, _From, State) -> + UA = State#state.uidattr, + UAF = State#state.uidattr_format, + Eldap_ID = State#state.eldap_id, + Server = State#state.host, + SortedDNAttrs = usort_attrs(State#state.dn_filter_attrs), + Reply = case eldap_filter:parse(State#state.sfilter) of + {ok, EldapFilter} -> + case eldap:search(Eldap_ID, [{base, State#state.base}, + {filter, EldapFilter}, + {attributes, SortedDNAttrs}]) of + #eldap_search_result{entries = Entries} -> + lists:flatmap( + fun(#eldap_entry{attributes = Attrs, + object_name = DN}) -> + case is_valid_dn(DN, Attrs, State) of + false -> []; + _ -> + case get_ldap_attr(UA, Attrs) of + "" -> []; + User -> + case get_user_part(User, UAF) of + {ok, U} -> + case jlib:nodeprep(U) of + error -> []; + LU -> [{LU, jlib:nameprep(Server)}] + end; + _ -> [] + end + end + end + end, Entries); + _ -> + [] + end; + _ -> + [] + end, + {reply, Reply, State}; + +handle_call({is_user_exists, User}, _From, State) -> + Reply = case find_user_dn(User, State) of + false -> false; + _DN -> true + end, + {reply, Reply, State}; + +handle_call(stop, _From, State) -> + {stop, normal, ok, State}; -find_user_dn(User, Server) -> - LServer = jlib:nameprep(Server), - Attr = ejabberd_config:get_local_option({ldap_uidattr, LServer}), - Filter = eldap:equalityMatch(Attr, User), - Base = ejabberd_config:get_local_option({ldap_base, LServer}), - case eldap:search(get_eldap_id(LServer, ejabberd), - [{base, Base}, - {filter, Filter}, - {attributes, []}]) of - #eldap_search_result{entries = [E | _]} -> - E#eldap_entry.object_name; +handle_call(_Request, _From, State) -> + {reply, bad_request, State}. + +find_user_dn(User, State) -> + DNAttrs = usort_attrs(State#state.dn_filter_attrs), + case eldap_filter:parse(State#state.ufilter, [{"%u", User}]) of + {ok, Filter} -> + case eldap:search(State#state.eldap_id, [{base, State#state.base}, + {filter, Filter}, + {attributes, DNAttrs}]) of + #eldap_search_result{entries = [#eldap_entry{attributes = Attrs, + object_name = DN} | _]} -> + is_valid_dn(DN, Attrs, State); + _ -> + false + end; _ -> false end. -get_eldap_id(Host, Name) -> - atom_to_list(gen_mod:get_module_proc(Host, Name)). +is_valid_dn(DN, _, #state{dn_filter = undefined}) -> + DN; + +is_valid_dn(DN, Attrs, State) -> + DNAttrs = State#state.dn_filter_attrs, + UA = State#state.uidattr, + UAF = State#state.uidattr_format, + Values = [{"%s", get_ldap_attr(Attr, Attrs), 1} || Attr <- DNAttrs], + SubstValues = case get_ldap_attr(UA, Attrs) of + "" -> Values; + S -> + case get_user_part(S, UAF) of + {ok, U} -> [{"%u", U} | Values]; + _ -> Values + end + end ++ [{"%d", State#state.host}, {"%D", DN}], + case eldap_filter:parse(State#state.dn_filter, SubstValues) of + {ok, EldapFilter} -> + case eldap:search(State#state.eldap_id, [ + {base, State#state.base}, + {filter, EldapFilter}, + {attributes, ["dn"]}]) of + #eldap_search_result{entries = [_|_]} -> + DN; + _ -> + false + end; + _ -> + false + end. + +%%%---------------------------------------------------------------------- +%%% Auxiliary functions +%%%---------------------------------------------------------------------- +get_user_part(String, Pattern) -> + F = fun(S, P) -> + First = string:str(P, "%u"), + TailLength = length(P) - (First+1), + string:sub_string(S, First, length(S) - TailLength) + end, + case catch F(String, Pattern) of + {'EXIT', _} -> + {error, badmatch}; + Result -> + case regexp:sub(Pattern, "%u", Result) of + {ok, String, _} -> {ok, Result}; + _ -> {error, badmatch} + end + end. + +case_insensitive_match(X, Y) -> + X1 = stringprep:tolower(X), + Y1 = stringprep:tolower(Y), + if + X1 == Y1 -> true; + true -> false + end. + +get_ldap_attr(LDAPAttr, Attributes) -> + Res = lists:filter( + fun({Name, _}) -> + case_insensitive_match(Name, LDAPAttr) + end, Attributes), + case Res of + [{_, [Value|_]}] -> Value; + _ -> "" + end. + +usort_attrs(Attrs) when is_list(Attrs) -> + lists:usort(Attrs); + +usort_attrs(_) -> + []. + +parse_options(Host) -> + Eldap_ID = atom_to_list(gen_mod:get_module_proc(Host, ?MODULE)), + LDAPServers = ejabberd_config:get_local_option({ldap_servers, Host}), + LDAPPort = case ejabberd_config:get_local_option({ldap_port, Host}) of + undefined -> 389; + P -> P + end, + RootDN = case ejabberd_config:get_local_option({ldap_rootdn, Host}) of + undefined -> ""; + RDN -> RDN + end, + Password = case ejabberd_config:get_local_option({ldap_password, Host}) of + undefined -> ""; + Pass -> Pass + end, + UIDAttr = case ejabberd_config:get_local_option({ldap_uidattr, Host}) of + undefined -> "uid"; + UA -> UA + end, + UIDAttrFormat = case ejabberd_config:get_local_option({ldap_uidattr_format, Host}) of + undefined -> "%u"; + UAF -> UAF + end, + SubFilter = "(" ++ UIDAttr ++ "=" ++ UIDAttrFormat ++ ")", + UserFilter = case ejabberd_config:get_local_option({ldap_filter, Host}) of + undefined -> SubFilter; + "" -> SubFilter; + F -> "(&" ++ SubFilter ++ F ++ ")" + end, + SearchFilter = eldap_filter:do_sub(UserFilter, [{"%u", "*"}]), + LDAPBase = ejabberd_config:get_local_option({ldap_base, Host}), + {DNFilter, DNFilterAttrs} = + case ejabberd_config:get_local_option({ldap_dn_filter, Host}) of + undefined -> {undefined, undefined}; + {DNF, DNFA} -> {DNF, DNFA} + end, + #state{host = Host, + eldap_id = Eldap_ID, + servers = LDAPServers, + port = LDAPPort, + dn = RootDN, + password = Password, + base = LDAPBase, + uidattr = UIDAttr, + uidattr_format = UIDAttrFormat, + ufilter = UserFilter, + sfilter = SearchFilter, + dn_filter = DNFilter, + dn_filter_attrs = DNFilterAttrs + }. diff --git a/src/eldap/Makefile.in b/src/eldap/Makefile.in index 91384b328..72e7b4632 100644 --- a/src/eldap/Makefile.in +++ b/src/eldap/Makefile.in @@ -12,7 +12,8 @@ OUTDIR = .. EFLAGS = -I .. -pz .. OBJS = \ $(OUTDIR)/eldap.beam \ - $(OUTDIR)/ELDAPv3.beam + $(OUTDIR)/ELDAPv3.beam \ + $(OUTDIR)/eldap_filter.beam all: $(OBJS) diff --git a/src/eldap/Makefile.win32 b/src/eldap/Makefile.win32 index 6feda635c..5d737d05a 100644 --- a/src/eldap/Makefile.win32 +++ b/src/eldap/Makefile.win32 @@ -6,7 +6,8 @@ EFLAGS = -I .. -pz .. OBJS = \ $(OUTDIR)\eldap.beam \ - $(OUTDIR)\ELDAPv3.beam + $(OUTDIR)\ELDAPv3.beam \ + $(OUTDIR)\eldap_filter.beam ALL : $(OBJS) diff --git a/src/eldap/eldap_filter.erl b/src/eldap/eldap_filter.erl new file mode 100644 index 000000000..76fb7aede --- /dev/null +++ b/src/eldap/eldap_filter.erl @@ -0,0 +1,269 @@ +%%%==================================================== +%%% File: eldap_filter.erl +%%% Purpose: Converts String Representation of +%%% LDAP Search Filter (RFC 2254) +%%% to eldap's representation of filter +%%% Author: Evgeniy Khramtsov <xramtsov@gmail.com> +%%% License: GPL +%%%==================================================== + +-module(eldap_filter). +-author('xram@jabber.ru'). + +%%%====================== +%%% Export functions +%%%====================== + +-export([parse/1, + parse/2, + do_sub/2 + ]). + +%%%------------------------------------------------------------------------- +%%% Arity: parse/1 +%%% Function: parse(RFC2254_Filter) -> {ok, EldapFilter} | +%%% {error, bad_filter} +%%% +%%% RFC2254_Filter = string(). +%%% +%%% Description: Converts String Representation of LDAP Search Filter (RFC 2254) +%%% to eldap's representation of filter. +%%% +%%% Example: +%%% > eldap_filter:parse("(&(!(uid<=100))(mail=*))"). +%%% +%%% {ok,{'and',[{'not',{lessOrEqual,{'AttributeValueAssertion',"uid","100"}}}, +%%% {present,"mail"}]}} +%%%------------------------------------------------------------------------- +parse(RFC2254_Filter) -> + parse(RFC2254_Filter, []). + +%%%------------------------------------------------------------------------- +%%% Arity: parse/2 +%%% Function: parse(RFC2254_Filter, [SubstValue |...]) -> +%%% {ok, EldapFilter} | +%%% {error, bad_filter} | +%%% {error, bad_regexp} | +%%% {error, max_substitute_recursion} +%%% +%%% SubstValue = {RegExp, Value} | {RegExp, Value, N}, +%%% RFC2254_Filter = RegExp = Value = string(), +%%% N = integer(). +%%% +%%% Description: The same as parse/1, but substitutes N or all occurences +%%% of RegExp with Value *after* parsing. +%%% +%%% Example: +%%% > eldap_filter:parse( +%%% "(|(mail=%u@%d)(jid=%u@%d))", +%%% [{"%u", "xramtsov"},{"%d","gmail.com"}]). +%%% +%%% {ok,{'or',[{equalityMatch,{'AttributeValueAssertion', +%%% "mail", +%%% "xramtsov@gmail.com"}}, +%%% {equalityMatch,{'AttributeValueAssertion', +%%% "jid", +%%% "xramtsov@gmail.com"}}]}} +%%%-------------------------------------------------------------------------- +parse(RFC2254_Filter, ListOfSubValues) -> + case catch convert_filter(parse_filter(RFC2254_Filter), ListOfSubValues) of + [EldapFilter] when is_tuple(EldapFilter) -> + {ok, EldapFilter}; + {regexp, Error} -> + {error, Error}; + _ -> + {error, bad_filter} + end. + +%%%========================== +%%% Internal functions +%%%========================== + +%%%---------------------- +%%% split/1,4 +%%%---------------------- +split(Filter) -> + split(Filter, 0, [], []). + +split([], _, _, Result) -> + Result; + +split([H|T], Num, Rest, Result) -> + NewNum = case H of + $( -> Num + 1; + $) -> Num - 1; + _ -> Num + end, + if + NewNum == 0 -> + X = Rest++[H], + LenX = length(X), + if + LenX > 2 -> + split(T, 0, [], Result ++ [lists:sublist(X, 2, LenX-2)]); + true -> + split(T, 0, Rest, Result) + end; + true -> + split(T, NewNum, Rest++[H], Result) + end. + +%%%----------------------- +%%% parse_filter/1 +%%%----------------------- +parse_filter(Filter) -> + case Filter of + [$! | T] -> + {'not', parse_filter(T)}; + [$| | T] -> + {'or', parse_filter(T)}; + [$& | T] -> + {'and', parse_filter(T)}; + [$( | _] -> + parse_filter(split(Filter)); + [List | _] when is_list(List) -> + [parse_filter(X) || X <- Filter]; + _ -> + Filter + end. + +%%%-------------------- +%%% convert_filter/2 +%%%-------------------- +convert_filter({'not', [Val | _]}, Replace) -> + eldap:'not'(convert_filter(Val, Replace)); + +convert_filter({'or', Vals}, Replace) -> + eldap:'or'([convert_filter(X, Replace) || X <- Vals]); + +convert_filter({'and', Vals}, Replace) -> + eldap:'and'([convert_filter(X, Replace) || X <- Vals]); + +convert_filter([H|_] = Filter, Replace) when is_integer(H) -> + parse_attr(Filter, Replace); + +convert_filter(Filter, Replace) when is_list(Filter) -> + [convert_filter(X, Replace) || X <- Filter]. + +%%%----------------- +%%% parse_attr/2,3 +%%%----------------- +parse_attr(Attr, ListOfSubValues) -> + {Action, [_|_] = Name, [_|_] = Value} = split_attribute(Attr), + parse_attr(Action, {Name, Value}, ListOfSubValues). + +parse_attr(approx, {Name, Value}, ListOfSubValues) -> + NewValue = do_sub(Value, ListOfSubValues), + eldap:approxMatch(Name, NewValue); + +parse_attr(greater, {Name, Value}, ListOfSubValues) -> + NewValue = do_sub(Value, ListOfSubValues), + eldap:greaterOrEqual(Name, NewValue); + +parse_attr(less, {Name, Value}, ListOfSubValues) -> + NewValue = do_sub(Value, ListOfSubValues), + eldap:lessOrEqual(Name, NewValue); + +parse_attr(equal, {Name, Value}, ListOfSubValues) -> + {ok, RegSList} = regexp:split(remove_extra_asterisks(Value), "[*]"), + Pattern = case [do_sub(X, ListOfSubValues) || X <- RegSList] of + [Head | Tail] when Tail /= [] -> + {Head, lists:sublist(Tail, length(Tail)-1), lists:last(Tail)}; + R -> + R + end, + case Pattern of + [V] -> + eldap:equalityMatch(Name, V); + {[], [], []} -> + eldap:present(Name); + {"", Any, ""} -> + eldap:substrings(Name, [{any, X} || X<-Any]); + {H, Any, ""} -> + eldap:substrings(Name, [{initial, H}]++[{any, X} || X<-Any]); + {"", Any, T} -> + eldap:substrings(Name, [{any, X} || X<-Any]++[{final, T}]); + {H, Any, T} -> + eldap:substrings(Name, [{initial, H}]++[{any, X} || X<-Any]++[{final, T}]) + end; + +parse_attr(_, _, _) -> + false. + +%%%-------------------- +%%% do_sub/2,3 +%%%-------------------- + +-define(MAX_RECURSION, 100). + +do_sub(S, []) -> + S; + +do_sub([], _) -> + []; + +do_sub(S, [H | T]) -> + Result = do_sub(S, H, 1), + do_sub(Result, T). + +do_sub(S, {RegExp, New}, Iter) -> + case regexp:sub(S, RegExp, New) of + {ok, NewS, 0} -> + NewS; + {ok, NewS, _} when Iter =< ?MAX_RECURSION -> + do_sub(NewS, {RegExp, New}, Iter+1); + {ok, _, _} when Iter > ?MAX_RECURSION -> + throw({regexp, max_substitute_recursion}); + _ -> + throw({regexp, bad_regexp}) + end; + +do_sub(S, {_, _, N}, _) when N<1 -> + S; + +do_sub(S, {RegExp, New, Times}, Iter) -> + case regexp:sub(S, RegExp, New) of + {ok, NewS, 0} -> + NewS; + {ok, NewS, _} when Iter < Times -> + do_sub(NewS, {RegExp, New, Times}, Iter+1); + {ok, NewS, _} -> + NewS; + _ -> + throw({regexp, bad_regexp}) + end. + +remove_extra_asterisks(String) -> + {Res, _} = lists:foldl( + fun(X, {Acc, Last}) -> + case X of + $* when Last==$* -> + {Acc, X}; + _ -> + {Acc ++ [X], X} + end + end, + {"", ""}, String), + Res. + +split_attribute(String) -> + split_attribute(String, "", $0). + +split_attribute([], _, _) -> + {error, "", ""}; + +split_attribute([H|Tail], Acc, Last) -> + case H of + $= when Last==$> -> + {greater, lists:sublist(Acc, 1, length(Acc)-1), Tail}; + $= when Last==$< -> + {less, lists:sublist(Acc, 1, length(Acc)-1), Tail}; + $= when Last==$~ -> + {approx, lists:sublist(Acc, 1, length(Acc)-1), Tail}; + $= when Last==$: -> + {equal, lists:sublist(Acc, 1, length(Acc)-1), Tail}; + $= -> + {equal, Acc, Tail}; + _ -> + split_attribute(Tail, Acc++[H], H) + end. diff --git a/src/mod_vcard_ldap.erl b/src/mod_vcard_ldap.erl index 68e1fc8a2..4389e4bce 100644 --- a/src/mod_vcard_ldap.erl +++ b/src/mod_vcard_ldap.erl @@ -1,8 +1,7 @@ - %%%---------------------------------------------------------------------- %%% File : mod_vcard_ldap.erl %%% Author : Alexey Shchepin <alexey@sevcom.net> -%%% Purpose : +%%% Purpose : Support for VCards from LDAP storage. %%% Created : 2 Jan 2003 by Alexey Shchepin <alexey@sevcom.net> %%% Id : $Id$ %%%---------------------------------------------------------------------- @@ -11,13 +10,26 @@ -author('alexey@sevcom.net'). -vsn('$Revision$ '). +-behaviour(gen_server). -behaviour(gen_mod). --export([start/2, init/3, stop/1, - get_sm_features/5, +%% gen_server callbacks. +-export([init/1, + handle_info/2, + handle_call/3, + handle_cast/2, + terminate/2, + code_change/3 + ]). + +-export([start/2, + start_link/2, + stop/1, + get_sm_features/5, process_local_iq/3, process_sm_iq/3, - remove_user/1]). + remove_user/1 + ]). -include("ejabberd.hrl"). -include("eldap/eldap.hrl"). @@ -25,69 +37,164 @@ -define(PROCNAME, ejabberd_mod_vcard_ldap). +-record(state, {serverhost, + myhost, + eldap_id, + search, + servers, + port, + dn, + base, + password, + uid, + uid_format, + vcard_map, + vcard_map_attrs, + user_filter, + search_filter, + search_fields, + search_reported, + search_reported_attrs + }). + +-define(VCARD_MAP, + [{"NICKNAME", "%u", []}, + {"FN", "%s", ["displayName"]}, + {"FAMILY", "%s", ["sn"]}, + {"GIVEN", "%s", ["givenName"]}, + {"MIDDLE", "%s", ["initials"]}, + {"ORGNAME", "%s", ["o"]}, + {"ORGUNIT", "%s", ["ou"]}, + {"CTRY", "%s", ["c"]}, + {"LOCALITY", "%s", ["l"]}, + {"STREET", "%s", ["street"]}, + {"REGION", "%s", ["st"]}, + {"PCODE", "%s", ["postalCode"]}, + {"TITLE", "%s", ["title"]}, + {"URL", "%s", ["labeleduri"]}, + {"DESC", "%s", ["description"]}, + {"TEL", "%s", ["telephoneNumber"]}, + {"EMAIL", "%s", ["mail"]}, + {"BDAY", "%s", ["birthDay"]}, + {"ROLE", "%s", ["employeeType"]}, + {"PHOTO", "%s", ["jpegPhoto"]} + ]). + +-define(SEARCH_FIELDS, + [{"User", "%u"}, + {"Full Name", "displayName"}, + {"Given Name", "givenName"}, + {"Middle Name", "initials"}, + {"Family Name", "sn"}, + {"Nickname", "%u"}, + {"Birthday", "birthDay"}, + {"Country", "c"}, + {"City", "l"}, + {"Email", "mail"}, + {"Organization Name", "o"}, + {"Organization Unit", "ou"} + ]). + +-define(SEARCH_REPORTED, + [{"Full Name", "FN"}, + {"Given Name", "GIVEN"}, + {"Middle Name", "MIDDLE"}, + {"Family Name", "FAMILY"}, + {"Nickname", "NICKNAME"}, + {"Birthday", "BDAY"}, + {"Country", "CTRY"}, + {"City", "LOCALITY"}, + {"Email", "EMAIL"}, + {"Organization Name", "ORGNAME"}, + {"Organization Unit", "ORGUNIT"} + ]). + +%% Unused callbacks. +handle_cast(_Request, State) -> + {noreply, State}. +code_change(_OldVsn, State, _Extra) -> + {ok, State}. +%% ----- + + start(Host, Opts) -> + Proc = gen_mod:get_module_proc(Host, ?PROCNAME), + ChildSpec = { + Proc, {?MODULE, start_link, [Host, Opts]}, + permanent, 1000, worker, [?MODULE] + }, + supervisor:start_child(ejabberd_sup, ChildSpec). + +stop(Host) -> + Proc = gen_mod:get_module_proc(Host, ?PROCNAME), + gen_server:call(Proc, stop), + supervisor:terminate_child(ejabberd_sup, Proc), + supervisor:delete_child(ejabberd_sup, Proc). + +terminate(_Reason, State) -> + Host = State#state.serverhost, + gen_iq_handler:remove_iq_handler(ejabberd_local, Host, ?NS_VCARD), + gen_iq_handler:remove_iq_handler(ejabberd_sm, Host, ?NS_VCARD), + ejabberd_hooks:delete(disco_sm_features, Host, ?MODULE, get_sm_features, 50), + case State#state.search of + true -> + ejabberd_router:unregister_route(State#state.myhost); + _ -> + ok + end. + +start_link(Host, Opts) -> + Proc = gen_mod:get_module_proc(Host, ?PROCNAME), + gen_server:start_link({local, Proc}, ?MODULE, [Host, Opts], []). + +init([Host, Opts]) -> + State = parse_options(Host, Opts), IQDisc = gen_mod:get_opt(iqdisc, Opts, one_queue), gen_iq_handler:add_iq_handler(ejabberd_local, Host, ?NS_VCARD, ?MODULE, process_local_iq, IQDisc), gen_iq_handler:add_iq_handler(ejabberd_sm, Host, ?NS_VCARD, ?MODULE, process_sm_iq, IQDisc), ejabberd_hooks:add(disco_sm_features, Host, ?MODULE, get_sm_features, 50), - LDAPServers = ejabberd_config:get_local_option({ldap_servers, Host}), - RootDN = ejabberd_config:get_local_option({ldap_rootdn, Host}), - Password = ejabberd_config:get_local_option({ldap_password, Host}), - eldap:start_link("mod_vcard_ldap", LDAPServers, 389, RootDN, Password), - MyHost = gen_mod:get_opt(host, Opts, "vjud." ++ Host), - Search = gen_mod:get_opt(search, Opts, true), - register(gen_mod:get_module_proc(Host, ?PROCNAME), - spawn(?MODULE, init, [MyHost, Host, Search])). - -init(Host, ServerHost, Search) -> - case Search of - false -> - loop(Host, ServerHost); + eldap:start_link(State#state.eldap_id, + State#state.servers, + State#state.port, + State#state.dn, + State#state.password), + case State#state.search of + true -> + ejabberd_router:register_route(State#state.myhost); _ -> - ejabberd_router:register_route(Host), - loop(Host, ServerHost) - end. - -loop(Host, ServerHost) -> - receive - {route, From, To, Packet} -> - case catch do_route(ServerHost, From, To, Packet) of - {'EXIT', Reason} -> - ?ERROR_MSG("~p", [Reason]); - _ -> - ok - end, - loop(Host, ServerHost); - stop -> - ejabberd_router:unregister_route(Host), - ok; + ok + end, + {ok, State}. + +handle_info({route, From, To, Packet}, State) -> + case catch do_route(State, From, To, Packet) of + {'EXIT', Reason} -> + Err = jlib:make_error_reply(Packet, ?ERR_INTERNAL_SERVER_ERROR), + ejabberd_router:route(To, From, Err), + %% Fail-Stop. Let the supervisor restarts us + {stop, Reason, State}; _ -> - loop(Host, ServerHost) - end. + {noreply, State} + end; -stop(Host) -> - gen_iq_handler:remove_iq_handler(ejabberd_local, Host, ?NS_VCARD), - gen_iq_handler:remove_iq_handler(ejabberd_sm, Host, ?NS_VCARD), - ejabberd_hooks:delete(disco_sm_features, Host, ?MODULE, get_sm_features, 50), - Proc = gen_mod:get_module_proc(Host, ?PROCNAME), - Proc ! stop, - {wait, Proc}. +handle_info(_Info, State) -> + {noreply, State}. get_sm_features({error, _Error} = Acc, _From, _To, _Node, _Lang) -> Acc; get_sm_features(Acc, _From, _To, Node, _Lang) -> case Node of - [] -> - case Acc of - {result, Features} -> - {result, [?NS_VCARD | Features]}; - empty -> - {result, [?NS_VCARD]} - end; - _ -> - Acc + [] -> + case Acc of + {result, Features} -> + {result, [?NS_VCARD | Features]}; + empty -> + {result, [?NS_VCARD]} + end; + _ -> + Acc end. process_local_iq(_From, _To, #iq{type = Type, lang = Lang, sub_el = SubEl} = IQ) -> @@ -102,7 +209,7 @@ process_local_iq(_From, _To, #iq{type = Type, lang = Lang, sub_el = SubEl} = IQ) [{xmlcdata, "ejabberd"}]}, {xmlelement, "URL", [], [{xmlcdata, - "http://ejabberd.jabberstudio.org/"}]}, + "http://ejabberd.jabber.ru/"}]}, {xmlelement, "DESC", [], [{xmlcdata, translate:translate( @@ -114,113 +221,165 @@ process_local_iq(_From, _To, #iq{type = Type, lang = Lang, sub_el = SubEl} = IQ) ]}]} end. -find_ldap_user(Host, User) -> - Attr = ejabberd_config:get_local_option({ldap_uidattr, Host}), - Filter = eldap:equalityMatch(Attr, User), - Base = ejabberd_config:get_local_option({ldap_base, Host}), - case eldap:search("mod_vcard_ldap", [{base, Base}, - {filter, Filter}, - {attributes, []}]) of - #eldap_search_result{entries = [E | _]} -> - E; - _ -> - false +-define(SM_IQ_TIMEOUT, 20000). + +process_sm_iq(From, #jid{lserver=LServer} = To, #iq{sub_el = SubEl} = IQ) -> + Proc = gen_mod:get_module_proc(LServer, ?PROCNAME), + case catch gen_server:call(Proc, + {process_sm_iq, From, To, IQ}, ?SM_IQ_TIMEOUT) of + {'EXIT', Reason} -> + case Reason of + {timeout, _} -> + IQ#iq{type = error, + sub_el = [SubEl, ?ERR_REMOTE_SERVER_TIMEOUT]}; + _ -> + IQ#iq{type = error, + sub_el = [SubEl, ?ERR_INTERNAL_SERVER_ERROR]} + end; + Other -> + Other end. -is_attribute_read_allowed(Name,From,To) -> - true. - -ldap_attribute_to_vcard(Prefix,{Name,Values},From,To) -> - case is_attribute_read_allowed(Name,From,To) of - true -> - ldap_lca_to_vcard(Prefix,stringprep:tolower(Name),Values); +handle_call({process_sm_iq, _From, To, IQ}, _FromPid, State) -> + #iq{type = Type, sub_el = SubEl} = IQ, + Reply = case Type of + set -> + IQ#iq{type = error, sub_el = [SubEl, ?ERR_NOT_ALLOWED]}; + get -> + #jid{luser = LUser} = To, + LServer = State#state.serverhost, + case ejabberd_auth:is_user_exists(LUser, LServer) of + true -> + VCardMap = State#state.vcard_map, + case find_ldap_user(LUser, State) of + #eldap_entry{attributes = Attributes} -> + Vcard = ldap_attributes_to_vcard(Attributes, VCardMap, {LUser, LServer}), + IQ#iq{type = result, sub_el = Vcard}; + _ -> + IQ#iq{type = result, sub_el = []} + end; + _ -> + IQ#iq{type = result, sub_el = []} + end + end, + {reply, Reply, State}; + +handle_call(stop, _From, State) -> + {stop, normal, ok, State}; + +handle_call(_Request, _From, State) -> + {reply, bad_request, State}. + +find_ldap_user(User, State) -> + Base = State#state.base, + RFC2254_Filter = State#state.user_filter, + Eldap_ID = State#state.eldap_id, + VCardAttrs = State#state.vcard_map_attrs, + case eldap_filter:parse(RFC2254_Filter, [{"%u", User}]) of + {ok, EldapFilter} -> + case eldap:search(Eldap_ID, [{base, Base}, + {filter, EldapFilter}, + {attributes, VCardAttrs}]) of + #eldap_search_result{entries = [E | _]} -> + E; + _ -> + false + end; _ -> - none + false end. -ldap_lca_to_vcard(vCard,"displayname",[Value|_]) -> +ldap_attributes_to_vcard(Attributes, VCardMap, UD) -> + Attrs = lists:map( + fun({VCardName, _, _}) -> + {stringprep:tolower(VCardName), + map_vcard_attr(VCardName, Attributes, VCardMap, UD)} + end, VCardMap), + Elts = [ldap_attribute_to_vcard(vCard, Attr) || Attr <- Attrs], + NElts = [ldap_attribute_to_vcard(vCardN, Attr) || Attr <- Attrs], + OElts = [ldap_attribute_to_vcard(vCardO, Attr) || Attr <- Attrs], + AElts = [ldap_attribute_to_vcard(vCardA, Attr) || Attr <- Attrs], + [{xmlelement, "vCard", [{"xmlns", ?NS_VCARD}], + lists:append([X || X <- Elts, X /= none], + [{xmlelement,"N",[], [X || X <- NElts, X /= none]}, + {xmlelement,"ORG",[], [X || X <- OElts, X /= none]}, + {xmlelement,"ADR",[], [X || X <- AElts, X /= none]}]) + }]. + +ldap_attribute_to_vcard(vCard, {"fn", Value}) -> {xmlelement,"FN",[],[{xmlcdata,Value}]}; -ldap_lca_to_vcard(vCard,"uid",[Value|_]) -> +ldap_attribute_to_vcard(vCard, {"nickname", Value}) -> {xmlelement,"NICKNAME",[],[{xmlcdata,Value}]}; -ldap_lca_to_vcard(vCard,"title",[Value|_]) -> +ldap_attribute_to_vcard(vCard, {"title", Value}) -> {xmlelement,"TITLE",[],[{xmlcdata,Value}]}; -ldap_lca_to_vcard(vCard,"labeleduri",[Value|_]) -> +ldap_attribute_to_vcard(vCard, {"bday", Value}) -> + {xmlelement,"BDAY",[],[{xmlcdata,Value}]}; + +ldap_attribute_to_vcard(vCard, {"url", Value}) -> {xmlelement,"URL",[],[{xmlcdata,Value}]}; -ldap_lca_to_vcard(vCard,"description",[Value|_]) -> +ldap_attribute_to_vcard(vCard, {"desc", Value}) -> {xmlelement,"DESC",[],[{xmlcdata,Value}]}; -ldap_lca_to_vcard(vCard,"telephonenumber",[Value|_]) -> +ldap_attribute_to_vcard(vCard, {"role", Value}) -> + {xmlelement,"ROLE",[],[{xmlcdata,Value}]}; + +ldap_attribute_to_vcard(vCard, {"tel", Value}) -> {xmlelement,"TEL",[],[{xmlelement,"VOICE",[],[]}, {xmlelement,"WORK",[],[]}, {xmlelement,"NUMBER",[],[{xmlcdata,Value}]}]}; -ldap_lca_to_vcard(vCard,"mail",[Value|_]) -> +ldap_attribute_to_vcard(vCard, {"email", Value}) -> {xmlelement,"EMAIL",[],[{xmlelement,"INTERNET",[],[]}, {xmlelement,"PREF",[],[]}, {xmlelement,"USERID",[],[{xmlcdata,Value}]}]}; -ldap_lca_to_vcard(vCardN,"sn",[Value|_]) -> +ldap_attribute_to_vcard(vCard, {"photo", Value}) -> + {xmlelement,"PHOTO",[],[ + {xmlelement,"BINVAL",[],[{xmlcdata, jlib:encode_base64(Value)}]}]}; + +ldap_attribute_to_vcard(vCardN, {"family", Value}) -> {xmlelement,"FAMILY",[],[{xmlcdata,Value}]}; -ldap_lca_to_vcard(vCardN,"givenname",[Value|_]) -> +ldap_attribute_to_vcard(vCardN, {"given", Value}) -> {xmlelement,"GIVEN",[],[{xmlcdata,Value}]}; -ldap_lca_to_vcard(vCardN,"initials",[Value|_]) -> +ldap_attribute_to_vcard(vCardN, {"middle", Value}) -> {xmlelement,"MIDDLE",[],[{xmlcdata,Value}]}; -ldap_lca_to_vcard(vCardO,"o",[Value|_]) -> +ldap_attribute_to_vcard(vCardO, {"orgname", Value}) -> {xmlelement,"ORGNAME",[],[{xmlcdata,Value}]}; -ldap_lca_to_vcard(vCardO,"ou",[Value|_]) -> +ldap_attribute_to_vcard(vCardO, {"orgunit", Value}) -> {xmlelement,"ORGUNIT",[],[{xmlcdata,Value}]}; -ldap_lca_to_vcard(_,_,_) -> none. - -ldap_attributes_to_vcard(Attributes,From,To) -> - Elts = lists:map(fun(Attr) -> - ldap_attribute_to_vcard(vCard,Attr,From,To) - end,Attributes), - FElts = [ X || X <- Elts, X /= none ], - NElts = lists:map(fun(Attr) -> - ldap_attribute_to_vcard(vCardN,Attr,From,To) - end,Attributes), - FNElts = [ X || X <- NElts, X /= none ], - OElts = lists:map(fun(Attr) -> - ldap_attribute_to_vcard(vCardO,Attr,From,To) - end,Attributes), - FOElts = [ X || X <- OElts, X /= none ], - [{xmlelement, "vCard", [{"xmlns", ?NS_VCARD}], - lists:append(FElts, - [{xmlelement,"N",[],FNElts}, - {xmlelement,"ORG",[],FOElts}]) - }]. +ldap_attribute_to_vcard(vCardA, {"locality", Value}) -> + {xmlelement,"LOCALITY",[],[{xmlcdata,Value}]}; -process_sm_iq(From, To, #iq{type = Type, sub_el = SubEl} = IQ) -> - case Type of - set -> - IQ#iq{type = error, sub_el = [SubEl, ?ERR_NOT_ALLOWED]}; - get -> - #jid{luser = LUser, lserver = LServer} = To, - case find_ldap_user(LServer, LUser) of - #eldap_entry{attributes = Attributes} -> - Vcard = ldap_attributes_to_vcard(Attributes,From,To), - IQ#iq{type = result, sub_el = Vcard}; - _ -> - IQ#iq{type = result, sub_el = []} - end - end. +ldap_attribute_to_vcard(vCardA, {"street", Value}) -> + {xmlelement,"STREET",[],[{xmlcdata,Value}]}; + +ldap_attribute_to_vcard(vCardA, {"ctry", Value}) -> + {xmlelement,"CTRY",[],[{xmlcdata,Value}]}; + +ldap_attribute_to_vcard(vCardA, {"region", Value}) -> + {xmlelement,"REGION",[],[{xmlcdata,Value}]}; + +ldap_attribute_to_vcard(vCardA, {"pcode", Value}) -> + {xmlelement,"PCODE",[],[{xmlcdata,Value}]}; + +ldap_attribute_to_vcard(_, _) -> + none. -define(TLFIELD(Type, Label, Var), {xmlelement, "field", [{"type", Type}, {"label", translate:translate(Lang, Label)}, {"var", Var}], []}). - --define(FORM(JID), +-define(FORM(JID, SearchFields), [{xmlelement, "instructions", [], [{xmlcdata, translate:translate(Lang, "You need an x:data capable client to search")}]}, {xmlelement, "x", [{"xmlns", ?NS_XDATA}, {"type", "form"}], @@ -229,30 +388,15 @@ process_sm_iq(From, To, #iq{type = Type, sub_el = SubEl} = IQ) -> jlib:jid_to_string(JID)}]}, {xmlelement, "instructions", [], [{xmlcdata, translate:translate(Lang, "Fill in fields to search " - "for any matching Jabber User")}]}, - ?TLFIELD("text-single", "User", "user"), - ?TLFIELD("text-single", "Full Name", "fn"), - ?TLFIELD("text-single", "Given Name", "given"), - ?TLFIELD("text-single", "Middle Name", "middle"), - ?TLFIELD("text-single", "Family Name", "family"), - ?TLFIELD("text-single", "Nickname", "nickname"), - ?TLFIELD("text-single", "Birthday", "bday"), - ?TLFIELD("text-single", "Country", "ctry"), - ?TLFIELD("text-single", "City", "locality"), - ?TLFIELD("text-single", "Email", "email"), - ?TLFIELD("text-single", "Organization Name", "orgname"), - ?TLFIELD("text-single", "Organization Unit", "orgunit") - ]}]). - + "for any matching Jabber User")}]} + ] ++ lists:map(fun({X,Y}) -> ?TLFIELD("text-single", X, Y) end, SearchFields)}]). - - -do_route(ServerHost, From, To, Packet) -> +do_route(State, From, To, Packet) -> #jid{user = User, resource = Resource} = To, if (User /= "") or (Resource /= "") -> Err = jlib:make_error_reply(Packet, ?ERR_SERVICE_UNAVAILABLE), - ejabberd_router ! {route, To, From, Err}; + ejabberd_router:route(To, From, Err); true -> IQ = jlib:iq_query_info(Packet), case IQ of @@ -285,24 +429,25 @@ do_route(ServerHost, From, To, Packet) -> [{xmlelement, "x", [{"xmlns", ?NS_XDATA}, {"type", "result"}], - search_result(Lang, To, ServerHost, XData) + search_result(Lang, To, State, XData) }]}]}, ejabberd_router:route( To, From, jlib:iq_to_xml(ResIQ)) end end; get -> + SearchFields = State#state.search_fields, ResIQ = IQ#iq{type = result, sub_el = [{xmlelement, "query", [{"xmlns", ?NS_SEARCH}], - ?FORM(To) + ?FORM(To, SearchFields) }]}, ejabberd_router:route(To, From, jlib:iq_to_xml(ResIQ)) end; - #iq{type = Type, xmlns = ?NS_DISCO_INFO, sub_el = SubEl} -> + #iq{type = Type, xmlns = ?NS_DISCO_INFO} -> case Type of set -> Err = jlib:make_error_reply( @@ -330,7 +475,7 @@ do_route(ServerHost, From, To, Packet) -> From, jlib:iq_to_xml(ResIQ)) end; - #iq{type = Type, xmlns = ?NS_DISCO_ITEMS, sub_el = SubEl} -> + #iq{type = Type, xmlns = ?NS_DISCO_ITEMS} -> case Type of set -> Err = jlib:make_error_reply( @@ -369,223 +514,295 @@ iq_get_vcard(Lang) -> [{xmlcdata, "ejabberd/mod_vcard"}]}, {xmlelement, "URL", [], [{xmlcdata, - "http://ejabberd.jabberstudio.org/"}]}, + "http://ejabberd.jabber.ru/"}]}, {xmlelement, "DESC", [], [{xmlcdata, translate:translate( Lang, "ejabberd vCard module\n" "Copyright (c) 2003-2006 Alexey Shchepin")}]}]. -find_xdata_el({xmlelement, _Name, _Attrs, SubEls}) -> - find_xdata_el1(SubEls). - -find_xdata_el1([]) -> - false; -find_xdata_el1([{xmlelement, Name, Attrs, SubEls} | Els]) -> - case xml:get_attr_s("xmlns", Attrs) of - ?NS_XDATA -> - {xmlelement, Name, Attrs, SubEls}; - _ -> - find_xdata_el1(Els) - end; -find_xdata_el1([_ | Els]) -> - find_xdata_el1(Els). - -define(LFIELD(Label, Var), {xmlelement, "field", [{"label", translate:translate(Lang, Label)}, {"var", Var}], []}). -search_result(Lang, JID, ServerHost, Data) -> - [{xmlelement, "title", [], - [{xmlcdata, translate:translate(Lang, "Search Results for ") ++ - jlib:jid_to_string(JID)}]}, - {xmlelement, "reported", [], - [?LFIELD("Jabber ID", "jid"), - ?LFIELD("Full Name", "fn"), - ?LFIELD("Given Name", "given"), - ?LFIELD("Middle Name", "middle"), - ?LFIELD("Family Name", "family"), - ?LFIELD("Nickname", "nickname"), - ?LFIELD("Birthday", "bday"), - ?LFIELD("Country", "ctry"), - ?LFIELD("City", "locality"), - ?LFIELD("Email", "email"), - ?LFIELD("Organization Name", "orgname"), - ?LFIELD("Organization Unit", "orgunit") - ]}] ++ lists:map(fun(E) -> - record_to_item(E#eldap_entry.attributes) - end, search(ServerHost, Data)). +search_result(Lang, JID, State, Data) -> + SearchReported = State#state.search_reported, + Header = [{xmlelement, "title", [], + [{xmlcdata, translate:translate(Lang, "Search Results for ") ++ + jlib:jid_to_string(JID)}]}, + {xmlelement, "reported", [], + [?LFIELD("Jabber ID", "jid")] ++ + lists:map( + fun({Name, Value}) -> ?LFIELD(Name, Value) end, + SearchReported) + }], + case search(State, Data) of + error -> + Header; + Result -> + Header ++ Result + end. -define(FIELD(Var, Val), {xmlelement, "field", [{"var", Var}], [{xmlelement, "value", [], [{xmlcdata, Val}]}]}). -case_exact_compare(none,_) -> - false; -case_exact_compare(_,none) -> - false; -case_exact_compare(X,Y) -> - X > Y. - -ldap_sort_entries(L) -> - lists:sort(fun(E1,E2) -> - case_exact_compare(ldap_get_value(E1,"cn"),ldap_get_value(E2,"cn")) - end,L). - -ldap_get_value(E,Attribute) -> - #eldap_entry{attributes = Attributes} = E, - case lists:filter(fun({A,_}) -> - string:equal(A,Attribute) - end,Attributes) of - [{Attr,[Value|_]}] -> - Value; - _ -> - none - end. - - -ldap_attribute_to_item("uid",Value) -> - [ - ?FIELD("jid",Value ++ "@" ++ ?MYNAME), - ?FIELD("uid",Value), - ?FIELD("nickname",Value) - ]; - -ldap_attribute_to_item("displayname",Value) -> - [ - ?FIELD("fn",Value) - ]; - -ldap_attribute_to_item("sn",Value) -> - [ - ?FIELD("family",Value) - ]; - -ldap_attribute_to_item("displayname",Value) -> - [ - ?FIELD("fn",Value) - ]; - -ldap_attribute_to_item("givenname",Value) -> - [ - ?FIELD("given",Value) - ]; - -ldap_attribute_to_item("initials",Value) -> - [ - ?FIELD("middle",Value) - ]; - -ldap_attribute_to_item("mail",Value) -> - [ - ?FIELD("email",Value) - ]; - -ldap_attribute_to_item("o",Value) -> - [ - ?FIELD("orgname",Value) - ]; - -ldap_attribute_to_item("ou",Value) -> - [ - ?FIELD("orgunit",Value) - ]; - -ldap_attribute_to_item(_,_) -> - [none]. - -record_to_item(Attributes) -> - List = lists:append(lists:map(fun({Attr,[Value|_]}) -> - ldap_attribute_to_item(stringprep:tolower(Attr),Value) - end,Attributes)), - FList = [X || X <- List, X /= none], - {xmlelement, "item", [],FList}. - -search(LServer, Data) -> - Filter = make_filter(Data), - Base = ejabberd_config:get_local_option({ldap_base, LServer}), - UIDAttr = ejabberd_config:get_local_option({ldap_uidattr, LServer}), - case eldap:search("mod_vcard_ldap",[{base, Base}, - {filter, Filter}, - {attributes, []}]) of +search(State, Data) -> + Base = State#state.base, + SearchFilter = State#state.search_filter, + Eldap_ID = State#state.eldap_id, + UA = State#state.uid, + UAF = State#state.uid_format, + ReportedAttrs = State#state.search_reported_attrs, + Filter = eldap:'and'([SearchFilter, make_filter(Data, UA, UAF)]), + case eldap:search(Eldap_ID, [{base, Base}, + {filter, Filter}, + {attributes, ReportedAttrs}]) of #eldap_search_result{entries = E} -> - [X || X <- E, - ejabberd_auth:is_user_exists( - ldap_get_value(X, UIDAttr), LServer)]; - Err -> - ?ERROR_MSG("Bad search: ~p", [[LServer, {base, Base}, - {filter, Filter}, - {attributes, []}]]) + search_items(E, State); + _ -> + error end. - -make_filter(Data) -> - Filter = [X || X <- lists:map(fun(R) -> - make_assertion(R) - end, Data), - X /= none ], +search_items(Entries, State) -> + LServer = State#state.serverhost, + SearchReported = State#state.search_reported, + VCardMap = State#state.vcard_map, + UIDAttr = State#state.uid, + UIDAttrFormat = State#state.uid_format, + Attributes = lists:map( + fun(E) -> + #eldap_entry{attributes = Attrs} = E, + Attrs + end, Entries), + lists:flatmap( + fun(Attrs) -> + U = get_ldap_attr(UIDAttr, Attrs), + case get_user_part(U, UIDAttrFormat) of + {ok, Username} -> + case ejabberd_auth:is_user_exists(Username, LServer) of + true -> + RFields = lists:map( + fun({_, VCardName}) -> + {VCardName, + map_vcard_attr( + VCardName, + Attrs, + VCardMap, + {Username, ?MYNAME})} + end, SearchReported), + Result = [?FIELD("jid", Username ++ "@" ++ LServer)] ++ + [?FIELD(Name, Value) || {Name, Value} <- RFields], + [{xmlelement, "item", [], Result}]; + _ -> + [] + end; + _ -> + [] + end + end, Attributes). + +make_filter(Data, UAttr, UAttrFormat) -> + Filter = lists:flatmap( + fun({Name, [Value | _]}) -> + case Name of + "%u" when Value /= "" -> + {ok, UAF, _} = regexp:sub(UAttrFormat, "%u", "*%u*"), + case eldap_filter:parse( + "("++UAttr++"="++UAF++")", [{"%u", Value}]) of + {ok, F} -> [F]; + _ -> [] + end; + _ when Value /= "" -> + [eldap:substrings(Name, [{any, Value}])]; + _ -> + [] + end + end, Data), case Filter of - [F] -> + [F] -> F; _ -> eldap:'and'(Filter) end. +remove_user(_User) -> + true. -make_assertion("givenName",Value) -> - eldap:substrings("givenName",[{any,Value}]); - -make_assertion("cn",Value) -> - eldap:substrings("cn",[{any,Value}]); - -make_assertion("sn",Value) -> - eldap:substrings("sn",[{any,Value}]); - -make_assertion(Attr, Value) -> - eldap:equalityMatch(Attr,Value). - -make_assertion({SVar, [Val]}) -> - LAttr = ldap_attribute(SVar), - case LAttr of - none -> - none; - _ -> - if - is_list(Val) and (Val /= "") -> - make_assertion(LAttr,Val); - true -> - none +%%%----------------------- +%%% Auxiliary functions. +%%%----------------------- + +get_user_part(String, Pattern) -> + F = fun(S, P) -> + First = string:str(P, "%u"), + TailLength = length(P) - (First+1), + string:sub_string(S, First, length(S) - TailLength) + end, + case catch F(String, Pattern) of + {'EXIT', _} -> + {error, badmatch}; + Result -> + case regexp:sub(Pattern, "%u", Result) of + {ok, String, _} -> {ok, Result}; + _ -> {error, badmatch} end end. -ldap_attribute("user") -> - "uid"; - -ldap_attribute("fn") -> - "cn"; - -ldap_attribute("family") -> - "sn"; - -ldap_attribute("given") -> - "givenName"; - -ldap_attribute("middle") -> - "initials"; - -ldap_attribute("email") -> - "mail"; +case_insensitive_match(X, Y) -> + X1 = stringprep:tolower(X), + Y1 = stringprep:tolower(Y), + if + X1 == Y1 -> true; + true -> false + end. -ldap_attribute("orgname") -> - "o"; +map_vcard_attr(VCardName, Attributes, Pattern, UD) -> + Res = lists:filter( + fun({Name, _, _}) -> + case_insensitive_match(Name, VCardName) + end, Pattern), + case Res of + [{_, Str, Attrs}] -> + process_pattern(Str, UD, + [get_ldap_attr(X, Attributes) || X<-Attrs]); + _ -> "" + end. -ldap_attribute("orgunit") -> - "ou"; +process_pattern(Str, {User, Domain}, Attrs) -> + Res = lists:foldl( + fun(X, Acc) -> + {ok, NewStr, _} = regexp:sub(Acc, "%s", X), + NewStr + end, + Str, Attrs), + eldap_filter:do_sub(Res, [{"%u", User},{"%d", Domain}]). + +get_ldap_attr(LDAPAttr, Attributes) -> + Res = lists:filter( + fun({Name, _}) -> + case_insensitive_match(Name, LDAPAttr) + end, Attributes), + case Res of + [{_, [Value|_]}] -> Value; + _ -> "" + end. -ldap_attribute(_) -> - none. +find_xdata_el({xmlelement, _Name, _Attrs, SubEls}) -> + find_xdata_el1(SubEls). -remove_user(User) -> - true. +find_xdata_el1([]) -> + false; +find_xdata_el1([{xmlelement, Name, Attrs, SubEls} | Els]) -> + case xml:get_attr_s("xmlns", Attrs) of + ?NS_XDATA -> + {xmlelement, Name, Attrs, SubEls}; + _ -> + find_xdata_el1(Els) + end; +find_xdata_el1([_ | Els]) -> + find_xdata_el1(Els). +parse_options(Host, Opts) -> + MyHost = gen_mod:get_opt(host, Opts, "vjud." ++ Host), + Search = gen_mod:get_opt(search, Opts, true), + Eldap_ID = atom_to_list(gen_mod:get_module_proc(Host, ?PROCNAME)), + LDAPServers = case gen_mod:get_opt(ldap_servers, Opts, undefined) of + undefined -> + ejabberd_config:get_local_option({ldap_servers, Host}); + S -> S + end, + LDAPPort = case gen_mod:get_opt(ldap_port, Opts, undefined) of + undefined -> + case ejabberd_config:get_local_option({ldap_port, Host}) of + undefined -> 389; + P -> P + end; + P -> P + end, + LDAPBase = case gen_mod:get_opt(ldap_base, Opts, undefined) of + undefined -> + ejabberd_config:get_local_option({ldap_base, Host}); + B -> B + end, + UIDAttr = case gen_mod:get_opt(ldap_uidattr, Opts, undefined) of + undefined -> + case ejabberd_config:get_local_option({ldap_uidattr, Host}) of + undefined -> "uid"; + UA -> UA + end; + UA -> UA + end, + UIDAttrFormat = case gen_mod:get_opt(ldap_uidattr_format, Opts, undefined) of + undefined -> + case ejabberd_config:get_local_option({ldap_uidattr_format, Host}) of + undefined -> "%u"; + UAF -> UAF + end; + UAF -> UAF + end, + RootDN = case gen_mod:get_opt(ldap_rootdn, Opts, undefined) of + undefined -> + case ejabberd_config:get_local_option({ldap_rootdn, Host}) of + undefined -> ""; + RDN -> RDN + end; + RDN -> RDN + end, + Password = case gen_mod:get_opt(ldap_password, Opts, undefined) of + undefined -> + case ejabberd_config:get_local_option({ldap_password, Host}) of + undefined -> ""; + Pass -> Pass + end; + Pass -> Pass + end, + SubFilter = "("++UIDAttr++"="++UIDAttrFormat++")", + UserFilter = case gen_mod:get_opt(ldap_filter, Opts, undefined) of + undefined -> + case ejabberd_config:get_local_option({ldap_filter, Host}) of + undefined -> SubFilter; + "" -> SubFilter; + F -> "(&" ++ SubFilter ++ F ++ ")" + end; + "" -> SubFilter; + F -> "(&" ++ SubFilter ++ F ++ ")" + end, + {ok, SearchFilter} = eldap_filter:parse( + eldap_filter:do_sub(UserFilter, [{"%u","*"}])), + VCardMap = gen_mod:get_opt(ldap_vcard_map, Opts, ?VCARD_MAP), + SearchFields = gen_mod:get_opt(ldap_search_fields, Opts, ?SEARCH_FIELDS), + SearchReported = gen_mod:get_opt(ldap_search_reported, Opts, ?SEARCH_REPORTED), + %% In search requests we need to fetch only attributes defined + %% in vcard-map and search-reported. In some cases, + %% this will essentially reduce network traffic from an LDAP server. + VCardMapAttrs = lists:usort( + lists:append([A || {_, _, A} <- VCardMap]) ++ [UIDAttr]), + SearchReportedAttrs = + lists:usort(lists:flatmap( + fun({_, N}) -> + case lists:keysearch(N, 1, VCardMap) of + {value, {_, _, L}} -> L; + _ -> [] + end + end, SearchReported) ++ [UIDAttr]), + #state{serverhost = Host, + myhost = MyHost, + eldap_id = Eldap_ID, + search = Search, + servers = LDAPServers, + port = LDAPPort, + dn = RootDN, + base = LDAPBase, + password = Password, + uid = UIDAttr, + uid_format = UIDAttrFormat, + vcard_map = VCardMap, + vcard_map_attrs = VCardMapAttrs, + user_filter = UserFilter, + search_filter = SearchFilter, + search_fields = SearchFields, + search_reported = SearchReported, + search_reported_attrs = SearchReportedAttrs + }. |