<chapter id="user">
<title>User</title>
<para>
This chapter will show you more details about the system users (agents).
</para>

<sect1 id="user-howto">
<title>How it works</title>
<para>
You need system users (agents) to deal with all the tickets.
</para>
<sect2>
<title>Admin-Interface</title>
<para>
Edit your system user via the Admin-Interface.
</para>
</sect2>
</sect1>

<sect1 id="user-backend">
<title>User Backend</title>
<para>
There is no existing user backend. At the moment the OTRS user need to 
be in the otrs database.
</para>
<para>
User backends (for DB and LDAP) are planned for OTRS 2.0.
</para>
</sect1>

<sect1 id="user-auth-backend">
<title>User Auth Backend</title>

<sect2>
<title>Database (default)</title>
<para>
The default user auth backend is the otrs database. 
<programlisting>
    [Kernel/Config.pm]
    # This is the auth. module againt the otrs db
    $Self->{'AuthModule'} = 'Kernel::System::Auth::DB';
    [...]
</programlisting>
</para>
</sect2>

<sect2>
<title>LDAP</title>
<para>
If there is a LDAP tree available with your users then you can
use the user LDAP auth backend. This module is just read only (
means it can't write to your LDAP tree - this should just be possibe for 
your tree manager) so you can't create or update user via the Admin-Interface.
<programlisting>
    [Kernel/Config.pm]
    # This is an example configuration for an LDAP auth. backend.
    # (take care that Net::LDAP is installed!)
    $Self->{'AuthModule'} = 'Kernel::System::Auth::LDAP';
    $Self->{'AuthModule::LDAP::Host'} = 'ldap.example.com';
    $Self->{'AuthModule::LDAP::BaseDN'} = 'dc=example,dc=com';
    $Self->{'AuthModule::LDAP::UID'} = 'uid';

    # Check if the user is allowed to auth in a posixGroup
    # (e. g. user needs to be in a group xyz to use otrs)
#    $Self->{'AuthModule::LDAP::GroupDN'} = 'cn=otrsallow,ou=posixGroups,dc=example,dc=com';
#    $Self->{'AuthModule::LDAP::AccessAttr'} = 'memberUid';

    # The following is valid but would only be necessary if the
    # anonymous user do NOT have permission to read from the LDAP tree 
    $Self->{'AuthModule::LDAP::SearchUserDN'} = '';
    $Self->{'AuthModule::LDAP::SearchUserPw'} = '';

    # in case you want to add always one filter to each ldap query, use
    # this option. e. g. AlwaysFilter => '(mail=*)' or AlwaysFilter => '(objectclass=user)'
#   $Self->{'AuthModule::LDAP::AlwaysFilter'} = '';

    # Net::LDAP new params (if needed - for more info see perldoc Net::LDAP)
#    $Self->{'AuthModule::LDAP::Params'} = {
#        port => 389,
#        version => 3,
#    };
    [...]
</programlisting>
LDAP entries shall conform to the PosixAccount and inetOrgPerson schema. An example entry might look like:
<programlisting>
    dn: uid=lester,ou=user,dc=example,dc=com
    objectClass: top
    objectClass: account
    objectClass: posixAccount
    objectClass: organizationalPerson
    objectClass: inetOrgPerson
    objectClass: officePerson
    uid: lester
    cn: Lester Adamas
    userPassword: {crypt}X5/DBrWPOQQaI
    gecos: Lester
    loginShell: /bin/csh
    uidNumber: 10
    gidNumber: 10
    homeDirectory: /home/lester
    sn: Adams
    givenName: Lester
    mail: lester@example.com
    preferredLanguage: fr
    comment: technical support
</programlisting>
Please note, that in version 1.x you have to create a db entry for the ldap user. 
This is done automatically on first login in versions < 1.1.x.
</para>
<para>
This will be the config option to map the LDAP attributes to database. Default is:
<programlisting>
    # UserSyncLDAPMap 
    # (map if agent should create/synced from LDAP to DB after login)
    $Self->{UserSyncLDAPMap} = {
        # DB -> LDAP
        Firstname => 'givenName',
        Lastname => 'sn',
        Email => 'mail',
    };
</programlisting>
</para>
</sect2>

<sect2>
<title>HTTPBasicAuth</title>
<para>
If you a "single sign on" solution, use http basic authentication (for all
your systems) and use the HTTPBasicAuth module (no otrs login is required!).
<programlisting>
    [Kernel/Config.pm]
    # This is the auth. module againt $ENV{REMOTE_USER} (apache
    # http-basic-auth)
    $Self->{'AuthModule'} = 'Kernel::System::Auth::HTTPBasicAuth';
    # Note:
    # If you use this module, you should use as fallback the following
    # config settings if user isn't login through apache ($ENV{REMOTE_USER})
    $Self->{LoginURL} = 'http://host.example.com/not-authorised-for-otrs.html';
    $Self->{LogoutURL} = 'http://host.example.com/thanks-for-using-otrs.html';
    [...]
</programlisting>
</para>
</sect2>

</sect1>

</chapter>
