Open-Xchange servlet for external login masks

From Open-Xchange
Revision as of 17:11, 30 March 2009 by Holgi (talk | contribs) (→‎Example)

Open-Xchange servlet for external login masks

who should read this document

This document is mend for web developers who would like to create a custom login mask for the Open-Xchange server which also can reside on an external server (not directly located on the Open-Xchange machines) or administrators who install and maintain Open-Xchange machines.

Description

The package open-xchange-easylogin provides a servlet which expects a user name and password via GET or POST. For security reasons, GET is disabled by default and can be turned on via configuration.

Installation

The package open-xchange-easylogin, available in the Open-Xchange community version, needs to be installed using the os package maintaining tools (e.g. dpkg, rpm). After installation, the groupware process has to be restarted: 

/etc/init.d/open-xchange restart

Configuration

Configuration file is: 

/opt/open-xchange/etc/groupware/easylogin.properties

following configuration options are available (the groupware must be restarted to make changes effective): 

# easylogin configuration field

# GET/POST variable name for the password
com.openexchange.easylogin.passwordPara = password 

# GET/POST variable name for the login name
com.openexchange.easylogin.loginPara = login 

# AJAX root path on the Open-Xchange server 
# do not change unless you know what you are doing
com.openexchange.easylogin.AJAX_ROOT = /ajax

# the relative path to the Open-Xchange GUI
com.openexchange.easylogin.OX_PATH_RELATIVE = ../

# enable GET for the servlet 
# possible parameters: true/false
com.openexchange.easylogin.doGetEnabled = true

Example

html form examples for a custom login mask (for security reasons POST should be used): 

 <html>
 <body>

 <h1>Login via POST:</h1>
 <form action="http://ox-server/servlet/easylogin" method="POST">
     <p>
     <label for="login">Username: </label>
               <input type="text" name="login" id="login"><br>
     <label for="password">Password:  </label>
               <input type="password" name="password" id="password"><br><br>
     <input type="submit" value="POST login">
     </p>
  </form>
 
  <h1>Login via GET:</h1>
  <form action="http://ox-server/servlet/easylogin" method="GET">
     <p>
     <label for="login">Username: </label>
               <input type="text" name="login" id="login"><br>
     <label for="password">Password:  </label>
               <input type="password" name="password" id="password"><br><br>
     <input type="submit" value="GET login">
     </p>
  </form>
 
  </body>
 </html>
Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=Open-Xchange_servlet_for_external_login_masks&oldid=3441"