Difference between revisions of "Authentication IMAP Plugin description"

(Imap Authentication Matrix)
Line 8: Line 8:
 
=== Imap Authentication Matrix ===
 
=== Imap Authentication Matrix ===
  
The IMAP authentication module offers some main properties which influence the string which is used for authentication against an IMAP server:
+
The IMAP authentication module has configuration parameters which do influence the username which is used for the IMAP connect during log in.  The parameters are:
  
com.openexchange.mail.loginSource<br/>
+
com.openexchange.mail.loginSource
USE_FULL_LOGIN_INFO<br/>
+
USE_FULL_LOGIN_INFO
USE_MULTIPLE<br/>
+
USE_MULTIPLE
 +
 
 +
The following examples make the behaviour of that parameters visible. The log in string, passed as example to the Open-Xchange log in mask is
 +
 
 +
user@domain.tld
 +
 
 +
during user provisioning, following attributes are set for the context via the createcontext call:
 +
 
 +
{|
 +
| attribute
 +
| value
 +
|-
 +
| contextname
 +
| domain.tld
 +
|}
 +
 
 +
and following parameters via the creatuser call:
 +
 
 +
{|
 +
| attribute
 +
| value
 +
|-
 +
| imaplogin
 +
| user1337
 +
|-
 +
| username
 +
| user
 +
|-
 +
| email
 +
| exampleuser@otherdomain.tld
 +
|}
  
The following will show how they influence the results. In this example we have a user who types max.muster@firma.de to the login form,
 
his imaplogin at the database is "maxdb", his email address at the database is mm@1337.to
 
  
 
com.openexchange.mail.loginSource=login<br />
 
com.openexchange.mail.loginSource=login<br />
Line 29: Line 57:
 
!rowspan="2" | '''USE_MULTIPLE'''  
 
!rowspan="2" | '''USE_MULTIPLE'''  
 
! '''true'''  
 
! '''true'''  
| maxdb
+
| user1337
| maxdb
+
| user1337
 
|-
 
|-
 
! | '''false'''  
 
! | '''false'''  
| max.muster@firma.de
+
| user@domain.tld
| max.muster
+
| user
 
|}
 
|}
  
Line 49: Line 77:
 
!rowspan="2" | '''USE_MULTIPLE'''  
 
!rowspan="2" | '''USE_MULTIPLE'''  
 
! '''true'''  
 
! '''true'''  
| mm@1337.to
+
| exampleuser@otherdomain.tld
| mm@1337.to
+
| exampleuser@otherdomain.tld
 
|-
 
|-
 
! | '''false'''  
 
! | '''false'''  
| max.muster@firma.de
+
| user@domain.tld
| max.muster
+
| user
 
|}
 
|}
  
Line 69: Line 97:
 
!rowspan="2" | '''USE_MULTIPLE'''  
 
!rowspan="2" | '''USE_MULTIPLE'''  
 
! '''true'''  
 
! '''true'''  
| max.muster@firma.de
+
| user@domain.tld
| max.muster
+
| user
 
|-
 
|-
 
! | '''false'''  
 
! | '''false'''  
| max.muster@firma.de
+
| user@domain.tld
| max.muster
+
| user
 
|}
 
|}
  
 
{{InstallPlugin|pluginname=open-xchange-authentication-imap|sopath=stable}}
 
{{InstallPlugin|pluginname=open-xchange-authentication-imap|sopath=stable}}

Revision as of 16:40, 25 June 2010

Open-Xchange imap authentication module

Introduction

The Open-Xchange imap authentication module is used to perform the Open-Xchange authentication against a IMAP server. During log in, a imap connection is opened with the users credentials given through the Open-Xchange login mask. If that IMAP connect succeeds, the users is authenticated and finally logged in to Open-Xchange.

The module does replace the database authentication module installed by default.

Imap Authentication Matrix

The IMAP authentication module has configuration parameters which do influence the username which is used for the IMAP connect during log in. The parameters are:

com.openexchange.mail.loginSource
USE_FULL_LOGIN_INFO
USE_MULTIPLE

The following examples make the behaviour of that parameters visible. The log in string, passed as example to the Open-Xchange log in mask is

user@domain.tld

during user provisioning, following attributes are set for the context via the createcontext call:

attribute value
contextname domain.tld

and following parameters via the creatuser call:

attribute value
imaplogin user1337
username user
email exampleuser@otherdomain.tld


com.openexchange.mail.loginSource=login

Property/Property USE_FULL_LOGIN_INFO
true false
USE_MULTIPLE true user1337 user1337
false user@domain.tld user

com.openexchange.mail.loginSource=mail

Property/Property USE_FULL_LOGIN_INFO
true false
USE_MULTIPLE true exampleuser@otherdomain.tld exampleuser@otherdomain.tld
false user@domain.tld user

com.openexchange.mail.loginSource=name

Property/Property USE_FULL_LOGIN_INFO
true false
USE_MULTIPLE true user@domain.tld user
false user@domain.tld user

Install on OX AppSuite

Debian GNU/Linux 8.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb https://software.open-xchange.com/OX6/stable/DebianJessie/ /
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/DebianJessie/ /

and run

$ apt-get update
$ apt-get install open-xchange-authentication-imap

Debian GNU/Linux 9.0

Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:

deb https://software.open-xchange.com/OX6/stable/DebianStretch/ /
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/DebianStretch/ /

and run

$ apt-get update
$ apt-get install open-xchange-authentication-imap

SUSE Linux Enterprise Server 12

Add the package repository using zypper if not already present:

$ zypper ar https://software.open-xchange.com/OX6/stable/SLE_12 ox

If you have a valid maintenance subscription, please run the following command and add the ldb account data to the url so that the most recent packages get installed:

$ zypper ar https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/SLES11 ox-updates

and run

$ zypper ref
$ zypper in open-xchange-authentication-imap

RedHat Enterprise Linux 6

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/stable/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-authentication-imap

RedHat Enterprise Linux 7

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/stable/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-authentication-imap

CentOS 6

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/stable/RHEL6/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/RHEL6/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-authentication-imap

CentOS 7

Start a console and create a software repository file if not already present:

$ vim /etc/yum.repos.d/ox.repo

[ox]
name=Open-Xchange
baseurl=https://software.open-xchange.com/OX6/stable/RHEL7/
gpgkey=https://software.open-xchange.com/oxbuildkey.pub
enabled=1
gpgcheck=1
metadata_expire=0m
# if you have a valid maintenance subscription, please uncomment the 
# following and add the ldb account data to the url so that the most recent
# packages get installed
# [ox-updates]
# name=Open-Xchange Updates
# baseurl=https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/OX6/stable/updates/RHEL7/
# gpgkey=https://software.open-xchange.com/oxbuildkey.pub
# enabled=1
# gpgcheck=1
# metadata_expire=0m

and run

$ yum update
$ yum install open-xchange-authentication-imap