FormLogin - Revision history

Choeger: Redirected page to OXSessionFormLogin

2013-08-07T08:55:00Z

← Older revision		Revision as of 08:55, 7 August 2013
Line 1:		Line 1:
	~~= FormLogin =~~		#REDIRECT [[OXSessionFormLogin]]

	The goal here is to authenticate a user for the Open-Xchange system from an external system and to safely pass on the received session data to the user´s browser. To do so the external system has to know the user data (username, password) for Open-Xchange in plain text.
	~~There are three participants in this process: User, Open-Xchange system ("OX") and External system ("3rd-party").~~

	~~== Prerequisites ==~~

	~~1. A ReverseProxy-directive has to be set in the OX-/Loadbalancer-Apache~~

	~~Example:~~

	#~~ReverseProxy to 3rd-party to enable the form-login~~
	~~ProxyPass /forwardname http://3rdpartydomain.tld~~
	~~ProxyPassReverse /forwardname http://3rdpartydomain.tld~~
	~~#enable sslProxy~~
	~~SSLProxyEngine on~~

	~~please note that "forwardname" is just an example, this could be anything~~

	~~2. The necessary apache-module needs to be installed for this directive to work~~

	~~Typically that is done like this:~~
	~~a2enmod proxy_http~~

	~~3. The 3rd-party system accesses the OX-system via the same domainname as the user (e.g. oxdomain.TLD)~~

	~~4. the 3rd-party system is on the ip-check-whitelist of the OX-system as described here (in "10.2.20. noipcheck.cnf"):~~
	~~http://software.open-xchange.com/OX6/doc/OX6-Installation-and-Administration.pdf~~

	~~Also the exact parameter-names for the FormLogin can be found here:~~
	~~http://oxpedia.org/wiki/index.php?title=HTTP_API#Form_Login_.28since_6.20.29~~

	~~== Diagram ==~~

	~~This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological order things need to happen in.~~

	[[~~File:formLoginDiagram3.png]]~~

	~~== Example for the login-form ==~~

	~~<syntaxhighlight lang="html4strict">~~
	~~<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">~~
	~~<html>~~
	~~<head>~~
	~~<meta http-equiv="content-type" content="text/html; charset=UTF-8">~~
	~~<meta http-equiv="cache-control" content="no-cache">~~
	~~<title>Login</title>~~
	~~<script type="text/javascript">~~
	~~function uuid() {~~
	~~function hex(len, x) {~~
	~~if (x === undefined) x = Math.random();~~
	~~var s = new Array(len);~~
	~~for (var i = 0; i < len; i++) {~~
	~~x *= 16;~~
	~~var digit = x & 15;~~
	s[i] ~~= digit + (digit < 10 ? 48 : 87); // '0' and 'a' - 10~~
	}
	~~return String.fromCharCode.apply(String, s);~~
	}
	~~return [hex(8), "-", hex(4), "-4", hex(3), "-", hex(4, 0.5 + Math.random() / 4), "-", hex(12)~~]~~.join("");~~
	}
	~~</script>~~
	~~</head>~~
	~~<body>~~
	~~<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();">~~
	~~<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>~~
	~~<input type="submit" value="Login">~~
	~~<input type="hidden" name="version" value="Form Login">~~
	~~<input type="hidden" name="autologin" value="true">~~

	~~<!-- When using OX App Suite -->~~
	~~<input type="hidden" name="client" value="open-xchange-appsuite">~~
	~~<!-- Important: value of uiWebPath MUST be terminated by a trailing slash "/" -->~~
	~~<input type="hidden" name="uiWebPath" value="/appsuite/">~~

	~~<!-- When using OX6 -->~~
	~~<!-- <input type="hidden" name="client" value="com.openexchange.ox.gui.dhtml"> -->~~
	~~<!-- <input type="hidden" name="uiWebPath" value="/ox6/index.html"> -->~~

	~~</p>~~
	~~</form>~~
	~~</body>~~
	~~</html>~~
	~~</syntaxhighlight>~~

Choeger: /* Example for the login-form */

2013-05-08T06:18:16Z

Example for the login-form

← Older revision		Revision as of 06:18, 8 May 2013
Line 39:		Line 39:
	== Example for the login-form ==		== Example for the login-form ==

	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">		<syntaxhighlight lang="html4strict">
			<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
	<html>		<html>
	<head>		<head>
Line 47:		Line 48:
	<script type="text/javascript">		<script type="text/javascript">
	function uuid() {		function uuid() {
	function hex(len, x) {		function hex(len, x) {
	if (x === undefined) x = Math.random();		if (x === undefined) x = Math.random();
	var s = new Array(len);		var s = new Array(len);
	for (var i = 0; i < len; i++) {		for (var i = 0; i < len; i++) {
	x *= 16;		x *= 16;
	var digit = x & 15;		var digit = x & 15;
	s[i] = digit + (digit < 10 ? 48 : 87); // '0' and 'a' - 10		s[i] = digit + (digit < 10 ? 48 : 87); // '0' and 'a' - 10
	}		}
	return String.fromCharCode.apply(String, s);		return String.fromCharCode.apply(String, s);
	}		}
	return [hex(8), "-", hex(4), "-4", hex(3), "-", hex(4, 0.5 + Math.random() / 4), "-", hex(12)].join("");		return [hex(8), "-", hex(4), "-4", hex(3), "-", hex(4, 0.5 + Math.random() / 4), "-", hex(12)].join("");
	}		}
	</script>		</script>
	</head>		</head>
	<body>		<body>
	<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();">		<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();">
			<p>
	<label for="login">Username: </label>		<label for="login">Username: </label>
	<input type="text" name="login" id="login"><br>		<input type="text" name="login" id="login"><br>
Line 68:		Line 70:
	<input type="password" name="password" id="password"><br>		<input type="password" name="password" id="password"><br>
	<input type="submit" value="Login">		<input type="submit" value="Login">
	~~<input type="hidden" name="client" value="com.openexchange.ox.gui.dhtml">~~
	<input type="hidden" name="version" value="Form Login">		<input type="hidden" name="version" value="Form Login">
	<input type="hidden" name="autologin" value="true">		<input type="hidden" name="autologin" value="true">
	<input type="hidden" name="uiWebPath" value="/ox6/index.html">
			<!-- When using OX App Suite -->
			<input type="hidden" name="client" value="open-xchange-appsuite">
			<!-- Important: value of uiWebPath MUST be terminated by a trailing slash "/" -->
			<input type="hidden" name="uiWebPath" value="/appsuite/">

			<!-- When using OX6 -->
			<!-- <input type="hidden" name="client" value="com.openexchange.ox.gui.dhtml"> -->
			<!-- <input type="hidden" name="uiWebPath" value="/ox6/index.html"> -->

			</p>
	</form>		</form>
	</body>		</body>
	</html>		</html>
			</syntaxhighlight>

Karsten.will: /* Diagram */

2011-10-14T06:41:15Z

Diagram

← Older revision		Revision as of 06:41, 14 October 2011
Line 35:		Line 35:
	This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological order things need to happen in.		This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological order things need to happen in.

	[[File:~~formLoginDiagram2~~.png]]		[[File:formLoginDiagram3.png]]

	== Example for the login-form ==		== Example for the login-form ==

Karsten.will: /* Diagram */

2011-10-14T06:38:55Z

Diagram

← Older revision		Revision as of 06:38, 14 October 2011
Line 35:		Line 35:
	This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological order things need to happen in.		This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological order things need to happen in.

	[[File:~~formLoginDiagram~~.png]]		[[File:formLoginDiagram2.png]]

	== Example for the login-form ==		== Example for the login-form ==

Karsten.will: /* Prerequisites */

2011-10-14T06:21:57Z

Prerequisites

← Older revision		Revision as of 06:21, 14 October 2011
Line 21:		Line 21:

	Typically that is done like this:		Typically that is done like this:
	~~ln -s /etc/apache2/mods-available/~~proxy_http~~.load /etc/apache2/mods-enabled/proxy_http.load~~		a2enmod proxy_http

	3. The 3rd-party system accesses the OX-system via the same domainname as the user (e.g. oxdomain.TLD)		3. The 3rd-party system accesses the OX-system via the same domainname as the user (e.g. oxdomain.TLD)

188.99.88.25: /* Diagram */

2011-10-14T05:11:00Z

Diagram

← Older revision		Revision as of 05:11, 14 October 2011
Line 33:		Line 33:
	== Diagram ==		== Diagram ==

	This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological ~~oder~~ things need to happen in.		This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological order things need to happen in.

	[[File:formLoginDiagram.png]]		[[File:formLoginDiagram.png]]

217.6.212.138: /* Diagram */

2011-10-13T14:26:05Z

Diagram

← Older revision		Revision as of 14:26, 13 October 2011
Line 35:		Line 35:
	This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological oder things need to happen in.		This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological oder things need to happen in.

	[[File:formLoginDiagram.~~svg~~]]		[[File:formLoginDiagram.png]]

	== Example for the login-form ==		== Example for the login-form ==

217.6.212.138: /* Diagram */

2011-10-13T14:11:18Z

Diagram

← Older revision		Revision as of 14:11, 13 October 2011
Line 35:		Line 35:
	This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological oder things need to happen in.		This diagram shows the complete process. Just read it naturally from top to bottom and you have the chronological oder things need to happen in.

	[[File:formLoginDiagram.~~jpg~~]]		[[File:formLoginDiagram.svg]]

	== Example for the login-form ==		== Example for the login-form ==

Tierlieb: /* Example for the login-form */

2011-10-13T14:10:42Z

Example for the login-form

← Older revision		Revision as of 14:10, 13 October 2011
Line 63:		Line 63:
	<body>		<body>
	<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();">		<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();">
	~~<p>~~
	<label for="login">Username: </label>		<label for="login">Username: </label>
	<input type="text" name="login" id="login"><br>		<input type="text" name="login" id="login"><br>
Line 73:		Line 72:
	<input type="hidden" name="autologin" value="true">		<input type="hidden" name="autologin" value="true">
	<input type="hidden" name="uiWebPath" value="/ox6/index.html">		<input type="hidden" name="uiWebPath" value="/ox6/index.html">
	~~</p>~~
	</form>		</form>
	</body>		</body>
	</html>		</html>

217.6.212.138: /* Example for the login-form */

2011-10-13T14:08:38Z

Example for the login-form

← Older revision		Revision as of 14:08, 13 October 2011
Line 64:		Line 64:
	<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();">		<form action="/ajax/login?action=formlogin&authId=" method="post" onSubmit="this.action += uuid();">
	<p>		<p>
	<label for="login">Username: </label>		<label for="login">Username: </label>
	<input type="text" name="login" id="login"><br>		<input type="text" name="login" id="login"><br>
	<label for="password">Password: </label>		<label for="password">Password: </label>
	<input type="password" name="password" id="password"><br>		<input type="password" name="password" id="password"><br>
	<input type="submit" value="Login">		<input type="submit" value="Login">
	<input type="hidden" name="client" value="com.openexchange.ox.gui.dhtml">		<input type="hidden" name="client" value="com.openexchange.ox.gui.dhtml">
	<input type="hidden" name="version" value="Form Login">		<input type="hidden" name="version" value="Form Login">
	<input type="hidden" name="autologin" value="true">		<input type="hidden" name="autologin" value="true">
	<input type="hidden" name="uiWebPath" value="/ox6/index.html">		<input type="hidden" name="uiWebPath" value="/ox6/index.html">
	</p>		</p>
	</form>		</form>
	</body>		</body>
	</html>		</html>