Authentication IMAP Plugin description: Difference between revisions

From Open-Xchange
No edit summary
Line 2: Line 2:


== Introduction ==
== Introduction ==
The Open-Xchange Server offers the ability to replace the standard database login mechanism with a custom Java login plugin. That means that this plugin is able to check the username and password entered on the login screen against any storage (in this case IMAP). In general the Open-Xchange Server hands over every information that the user has entered during the login procedure (Username@domain and Password) to this plugin, so that the plugin can use these information to verify if the user should get a valid session or if he should get a login error. To create a valid session, the plugin has to return a user id and a context id.
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 ===
=== Imap Authentication Matrix ===

Revision as of 16:20, 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 offers some main properties which influence the string which is used for authentication against an IMAP server:

com.openexchange.mail.loginSource
USE_FULL_LOGIN_INFO
USE_MULTIPLE

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

Property/Property USE_FULL_LOGIN_INFO
true false
USE_MULTIPLE true maxdb maxdb
false max.muster@firma.de max.muster

com.openexchange.mail.loginSource=mail

Property/Property USE_FULL_LOGIN_INFO
true false
USE_MULTIPLE true mm@1337.to mm@1337.to
false max.muster@firma.de max.muster

com.openexchange.mail.loginSource=name

Property/Property USE_FULL_LOGIN_INFO
true false
USE_MULTIPLE true max.muster@firma.de max.muster
false max.muster@firma.de max.muster

Install on OX AppSuite

Debian GNU/Linux 11.0

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

deb https://software.open-xchange.com/products/stable/DebianBullseye/ /
# 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/products/stable/updates/DebianBullseye/ /

and run 

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

Debian GNU/Linux 12.0

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

deb https://software.open-xchange.com/products/stable/DebianBookworm/ /
# 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/products/stable/updates/DebianBookworm/ /

and run 

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


Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=Authentication_IMAP_Plugin_description&oldid=6222"