====== Options "avancées" pour Ejabberd ======

<note warning>cette page est obsolète pour ceux qui utilisent le paquet **ipasserelle-im**</note>
===== HTTP bind et HTTP poll =====


Ejabberd supporte les méthodes HTTP Bind et HTTP Poll (souvent utilisé par les clients web). Pour l'activer sur SME, il faut créer quelques templates-custom pour ejabberd (pour activer la fonction uniquement sur le loopback), et pour apache, pour permettre d'accéder à l'HTTP Bind ou l'HTTP Poll à travers une directive ProxyPass

<code bash>
mkdir -p /etc/e-smith/templates-custom/etc/ejabberd/ejabberd.cfg/
cat <<'EOF' > /etc/e-smith/templates-custom/etc/ejabberd/ejabberd.cfg/80Ports30http

{
$OUT .= "\n".'       % http_bind interface, restrict it to 127.0.0.1, external access is handled by'."\n".
        '       % ProxyPass directives in apache'."\n";

$OUT .= '       ';
$OUT .= '%' unless (((${'ejabberd'}{'HTTPBind'} || 'disabled') || 
                    (${'ejabberd'}{'HTTPPoll'} || 'disabled')) ||
                    (${'ejabberd'}{'WebAdmin'} || 'disabled')
                   eq 'enabled');
$OUT .= ',{5280, ejabberd_http,    [ ';
$OUT .= 'http_bind, ' if ((${'ejabberd'}{'HTTPBind'} || 'disabled') eq 'enabled');
$OUT .= 'http_poll, ' if ((${'ejabberd'}{'HTTPPoll'} || 'disabled') eq 'enabled');
$OUT .= 'web_admin, ' if ((${'ejabberd'}{'WebAdmin'} || 'disabled') eq 'enabled');
$OUT .= '{ip, {127, 0, 0, 1}} ]}'."\n";
}

EOF
</code>
<code bash>
cat <<'EOF' > /etc/e-smith/templates-custom/etc/ejabberd/ejabberd.cfg/85Modules

{
    $OUT =<<'HERE';
% Used modules:
{modules,
 [
  {mod_register,   [{access, register}]},
  {mod_roster,     []},
  {mod_privacy,    []},
  {mod_adhoc,      []},
  {mod_configure,  []}, % Depends on mod_adhoc
  {mod_configure2, []},
  {mod_disco,      []},
  {mod_stats,      []},
  {mod_vcard,      []},
  {mod_caps,       []},
  {mod_offline,    []},
  {mod_announce,   [{access, announce}]}, % Depends on mod_adhoc
  {mod_private,    []},
  {mod_irc,        []},
% Default options for mod_muc:
%   host: "conference." ++ ?MYNAME
%   access: all
%   access_create: all
%   access_admin: none (only room creator has owner privileges)
  {mod_muc,        [{access, muc}, {access_create, muc}, {access_admin, muc_admin}]},
  {mod_muc_log,    []},
  {mod_shared_roster, []},
  {mod_pubsub,     [
    {access_createnode, pubsub_createnode},
    {plugins, ["flat", "hometree", "pep"]}
  ]},
  {mod_time,       []},
  {mod_last,       []},
%  {mod_xmlrpc,[{port, 4560},{timeout, 5000}]},
  {mod_version,    []},
  {mod_admin_extra,    []},
HERE
    $OUT .= '  {mod_http_bind, []},'."\n" if (${'ejabberd'}{'HTTPBind'} || 'disabled') eq 'enabled';
    $OUT .= '  {mod_echo,       [{host, "echo.';
    $OUT .= ${DomainName};
    $OUT .= '"}]}';
    $OUT .= "\n";
    $OUT .= ' ]}.';
    $OUT .= "\n\n";
}

EOF
</code>
<code bash>
mkdir -p /etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf/
cat <<'EOF' > /etc/e-smith/templates-custom/etc/httpd/conf/httpd.conf/98ejabberd

{
$OUT .= '';

if ((${'ejabberd'}{'WebAdmin'} || 'disabled') eq 'enabled'){
$OUT .=<<'HERE';

# ProxyPass requests for /xmpp-admin to ejabberd web_admin interface
ProxyPass /xmpp-admin/ http://127.0.0.1:5280/admin/
ProxyPassReverse /xmpp-admin/ http://127.0.0.1:5280/admin/

<Location /xmpp-admin/>
    SSLRequireSSL on
    order deny, allow
    deny from all
    allow from $localAccess $externalSSLAccess
</Location>

HERE

}

if ((${'ejabberd'}{'HTTPBind'} || 'disabled') eq 'enabled'){
$OUT .=<<'HERE';

# ProxyPass requests for /http-bind to ejabberd http-bind interface
ProxyPass /http-bind/ http://127.0.0.1:5280/http-bind/
ProxyPassReverse /http-bind/ http://127.0.0.1:5280/http-bind/

<Location /http-bind/>
    SSLRequireSSL on
</Location>

HERE

}

if ((${'ejabberd'}{'HTTPPoll'}) || 'disabled' eq 'enabled'){
$OUT .=<<'HERE';

# ProxyPass requests for /http-poll to ejabberd http-poll interface
ProxyPass /http-poll/ http://127.0.0.1:5280/http-poll/
ProxyPassReverse /http-poll/ http://127.0.0.1:5280/http-poll/


<Location /http-poll/>
    SSLRequireSSL on
</Location>

HERE
}
}

EOF
</code>

Maintenant, les deux fonctions peuvent être contrôlé via une clef dans la DB
<code bash>
db configuration setprop ejabberd HTTPBind enabled
expand-template /etc/httpd/conf/httpd.conf
sv t /service/httpd-e-smith
signal-event ejabberd-update
</code>
<code bash>
db configuration setprop ejabberd HTTPPoll enabled
expand-template /etc/httpd/conf/httpd.conf
sv t /service/httpd-e-smith
signal-event ejabberd-update
</code>

===== Authentification pam =====
Ejabberd supporte l'authentification basée sur PAM, pour l'activer, il faut créer un petit templates-custom:
<code bash>
mkdir -p /etc/e-smith/templates-custom/etc/ejabberd/ejabberd.cfg/
cat <<'EOF' > /etc/e-smith/templates-custom/etc/ejabberd/ejabberd.cfg/55AuthConf
{
    $OUT =<<'HERE';
% Authentication method.  If you want to use internal user base, then use
% this line:
{auth_method, [internal,pam]}.
HERE
}
EOF
</code>

Suivit d'un petit
<code bash>
signal-event ejabberd-update
</code>

===== Authentification LDAP =====
Sur SME8, on peut activer l'authentification LDAP (et on évite d'utiliser un binaire en SUID)

<code bash>
mkdir -p /etc/e-smith/templates-custom/etc/ejabberd/ejabberd.cfg/
cat <<'EOF' > /etc/e-smith/templates-custom/etc/ejabberd/ejabberd.cfg/55AuthConf
{

use esmith::util;

our $base = esmith::util::ldapBase ($DomainName);

    $OUT =<<"HERE";
% LDAP Auth
{auth_method, ldap}.

% LDAP conf
{ldap_servers, ["localhost"]}.
{ldap_base, "ou=Users,$base"}.


HERE
}
EOF
</code>

Puis:

<code bash>
signal-event ejabberd-update
</code>

===== Configurer mod_vcard_ldap =====
Allons-y gaiment, on a un serveur LDAP maintenant, on peut donc configurer le module mod_vcard_ldap, qui permettra (via vjud) de faire des recherches sur nos utilisateurs déclarés dans SME
, il suffit d'éditer le template 85Modules, et de remplacer la ligne
<code>
  {mod_vcard,      []},
</code>
Par:
<code>
{mod_vcard_ldap,
   [
    {ldap_base, "ou=Users,$base"},
    {ldap_filter, "(objectClass=inetOrgPerson)"},
    {ldap_vcard_map,
    %% vcard patterns
     [{"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"]},
      {"ORGNAME", "%s", ["o"]},
      {"ORGUNIT", "%s", ["ou"]},
      {"LOCALITY", "%s", ["l"]},
      {"STREET", "%s", ["Street"]},
      {"TEL", "%s", ["Phone"]}
     ]},
    %% Search form
    {ldap_search_fields,
     [{"User", "%u"},
      {"Name", "givenName"},
      {"Family Name", "sn"},
      {"Email", "mail"}]},
    %% vCard fields to be reported
    %% Note that JID is always returned with search results
    {ldap_search_reported,
     [{"Full Name", "FN"},
      {"Nickname", "NICKNAME"}]}
  ]},
</code>

===== Configurer mod_shared_roster_ldap =====

FIXME: configuration de mod_shared_roster_ldap à revoir. Semble poser des problèmes de groupes

mod_shared_roster_ldap permet de créer automatiquement un roster pour les nouveaux utilisateurs, basé sur un annuaire LDAP. Pour le configurer, il faut rajouter une section comme ceci dans la partie modules du ficheir ejabberd.cfg:

<code>
  {mod_shared_roster_ldap,[
    {ldap_base, "dc=firewall-services,dc=com"},
    {ldap_rfilter, "(objectClass=mailboxRelatedObject)"},
    {ldap_groupattr, "cn"},
    {ldap_groupdesc, "description"},
    {ldap_memberattr, "memberUid"},
    {ldap_useruid, "uid"},
    {ldap_userdesc, "cn"}
  ]},
</code>

Si on veut limiter à un nombre précis de groupe, il suffit de l'ajouter dans le filtre, comme ceci:
<code>
{mod_shared_roster_ldap,[
    {ldap_base, "dc=firewall-services,dc=com"},
    {ldap_rfilter, "(objectClass=mailboxRelatedObject)"},
    {ldap_gfilter, "(|(cn=techniciens)(cn=ventes)(cn=equipe))"},
    {ldap_groupattr, "cn"},
    {ldap_groupdesc, "description"},
    {ldap_memberattr, "memberUid"},
    {ldap_useruid, "uid"},
    {ldap_userdesc, "cn"}
  ]},
</code>

Seuls les groupes **techniciens**, **ventes** et **equipe** seront recherchés

===== Configurer mod_archive =====
On va utiliser pour ceci le module mod_archive_odbc (voir http://www.ndl.kiev.ua/content/mod_archive_odbc-release).
Pour cela, on va devoir installer des modules supplémentaires pour ejabberd:

<code bash>
yum --enablerepo=fws install ejabberd-modules
</code>

Puis, il faut créer une base de donnée mysql et y ajouter le schéma nécessaire. Il faut également modifier mysql pour qu'il écoute sur un socket réseau, et activer InnoDB
<code bash>
db configuration setprop mysqld LocalNetworkingOnly no InnoDB enabled
expand-template /etc/my.cnf
sv t /service/mysqld
openssl rand -base64 40 > ejabberd.pw
chmod 600 ejabberd.pw
PW=$(cat ./ejabberd.pw)
db configuration setprop ejabberd DbName ejabberd DbUser ejabberd DbPassword $PW
mysql -e "create database ejabberd"
mysql -e "grant all privileges on ejabberd.* to 'ejabberd'@'localhost' identified by '$PW'"
mysql -e "flush privileges"
mysql ejabberd < /usr/share/doc/ejabberd-modules-0.1/mod_archive_odbc_mysql.sql
</code>

Puis, on rajoute la configuration nécessaire dans le fichier ejabberd.cfg:

  * Dans la section modules
<code>
{mod_archive_odbc, [{database_type, "mysql"},
                      {default_auto_save, true},
                      {enforce_default_auto_save, false},
                      {default_expire, infinity},
                      {enforce_min_expire, 0},
                      {enforce_max_expire, infinity},
                      {replication_expire, 31536000},
                      {session_duration, 1800},
                      {wipeout_interval, 86400}]}
</code>

  * Au niveau global (format templates SME)
<code>
cat <<EOF > /etc/e-smith/templates-custom/etc/ejabberd/ejabberd.cfg/10database

% mysql database access
\{odbc_server, \{mysql, "localhost", "{"\$ejabberd{DbName}"}", "{"\$ejabberd{DbUser}"}", "{"\$ejabberd{DbPassword}"}"\}\}.

EOF
</code>

===== Utiliser MySQL comme backend (à la place de mnesia) =====
La base de donnée par défaut utilisée par ejabberd est mnesia. MySQL a quelques avantages, en terme de performances, de facilité d'administration, de sauvegarde etc... On va donc modifier la configuration d'ejabberd pour utiliser une base mysql comme backend

==== Créer la base de donnée ====
Si ce n'est pas déjà fait, il faut créer la base de donnée (voir section mod_archive)

==== Import du schéma dans la base ====
On va maintenant insérer le schéma mysql dans la base:
<code bash>
mysql ejabberd < /usr/share/doc/ejabberd-modules-0.1/mysql.sql
</code>

==== Migrer les données depuis la base mnesia ====
Si le serveur ejabberd a déjà utilisé (pas une nouvelle installation), il faut migrer les données depuis la base mnesia vers mysql.

<code bash>
mkdir /tmp/mnesia
chown root:ejabberd /tmp/mnesia
chmod 770 /tmp/mnesia
ejabberdctl export2odbc $(db configuration get DomainName) /tmp/mnesia
for FILE in /tmp/mnesia/*.txt; do
  mysql ejabberd < $FILE
done
</code>
==== Configurer ejabberd ====

Il ne reste qu'à remplacer les modules suivants par leur équivalent, en ajoutant le préfixe _odbc

  * mod_archive_odbc
  * mod_last_odbc
  * mod_offline_odbc
  * mod_privacy_odbc
  * mod_private_odbc
  * mod_pubsub_odbc (semble avoir des problème pour l'instant, avec ejabberd 2.1.6, donc, on laisse en mnesia)
  * mod_roster_odbc
  * mod_vcard_odbc