OXSessionFormLogin - Revision history

Sonja.krause-harder: /* Parameters */

2014-07-18T09:03:32Z

Parameters

← Older revision		Revision as of 09:03, 18 July 2014
Line 13:		Line 13:
	: The users password. This will usually be a password input field.		: The users password. This will usually be a password input field.
	; client		; client
	: The client parameter used to distinguish between programs using the same cookie store. Since we want the new session to be used by the AJAX frontend, we'll set this to '''com.openexchange.ox.gui.dhtml''' for the OX6 frontend, to '''open-xchange-appsuite''' for App Suite and '''com.openexchange.mobileapp''' for the Mobile UI. This is a hidden field. See also [[OXSessionHandlingGlossary ]]. This parameter can be given to the [[AppSuite:Logincounter\|logincounter]] tool to retrieve statistics about how end users are ~~using~~ the system.		: The client parameter used to distinguish between programs using the same cookie store. Since we want the new session to be used by the AJAX frontend, we'll set this to '''com.openexchange.ox.gui.dhtml''' for the OX6 frontend, to '''open-xchange-appsuite''' for App Suite and '''com.openexchange.mobileapp''' for the Mobile UI. This is a hidden field. See also [[OXSessionHandlingGlossary ]]. This parameter can be given to the [[AppSuite:Logincounter\|logincounter]] tool to retrieve statistics about how (and how often) end users are logging in to the system.
	; version		; version
	: A version string. The content is not really relevant, but it will be logged, so we can later find out, where a login request came from. The UI will usually send its version, we'll send '''Form Login''' so we can see in the logfile when our spiffy new form was used to log in. This will also be a hidden field.		: A version string. The content is not really relevant, but it will be logged, so we can later find out, where a login request came from. The UI will usually send its version, we'll send '''Form Login''' so we can see in the logfile when our spiffy new form was used to log in. This will also be a hidden field.

Sonja.krause-harder: /* Parameters */

2014-07-18T09:03:01Z

Parameters

← Older revision		Revision as of 09:03, 18 July 2014
Line 13:		Line 13:
	: The users password. This will usually be a password input field.		: The users password. This will usually be a password input field.
	; client		; client
	: The client parameter used to distinguish between programs using the same cookie store. Since we want the new session to be used by the AJAX frontend, we'll set this to '''com.openexchange.ox.gui.dhtml''' for the OX6 frontend, to '''open-xchange-appsuite''' for App Suite and '''com.openexchange.mobileapp''' for the Mobile UI. This is a hidden field. See also [[OXSessionHandlingGlossary ]]		: The client parameter used to distinguish between programs using the same cookie store. Since we want the new session to be used by the AJAX frontend, we'll set this to '''com.openexchange.ox.gui.dhtml''' for the OX6 frontend, to '''open-xchange-appsuite''' for App Suite and '''com.openexchange.mobileapp''' for the Mobile UI. This is a hidden field. See also [[OXSessionHandlingGlossary ]]. This parameter can be given to the [[AppSuite:Logincounter\|logincounter]] tool to retrieve statistics about how end users are using the system.
	; version		; version
	: A version string. The content is not really relevant, but it will be logged, so we can later find out, where a login request came from. The UI will usually send its version, we'll send '''Form Login''' so we can see in the logfile when our spiffy new form was used to log in. This will also be a hidden field.		: A version string. The content is not really relevant, but it will be logged, so we can later find out, where a login request came from. The UI will usually send its version, we'll send '''Form Login''' so we can see in the logfile when our spiffy new form was used to log in. This will also be a hidden field.

Sonja.krause-harder: /* Parameters */

2014-05-20T08:01:16Z

Parameters

← Older revision		Revision as of 08:01, 20 May 2014
Line 13:		Line 13:
	: The users password. This will usually be a password input field.		: The users password. This will usually be a password input field.
	; client		; client
	: The client parameter used to distinguish between programs using the same cookie store. Since we want the new session to be used by the AJAX frontend, we'll set this to '''com.openexchange.ox.gui.dhtml''' for the OX6 frontend, to '''open-xchange-appsuite''' for App Suite and '''com.openexchange.mobileapp''' for the Mobile UI. This is a hidden field. See also [[~~OXSessionGlossary~~]]		: The client parameter used to distinguish between programs using the same cookie store. Since we want the new session to be used by the AJAX frontend, we'll set this to '''com.openexchange.ox.gui.dhtml''' for the OX6 frontend, to '''open-xchange-appsuite''' for App Suite and '''com.openexchange.mobileapp''' for the Mobile UI. This is a hidden field. See also [[OXSessionHandlingGlossary ]]
	; version		; version
	: A version string. The content is not really relevant, but it will be logged, so we can later find out, where a login request came from. The UI will usually send its version, we'll send '''Form Login''' so we can see in the logfile when our spiffy new form was used to log in. This will also be a hidden field.		: A version string. The content is not really relevant, but it will be logged, so we can later find out, where a login request came from. The UI will usually send its version, we'll send '''Form Login''' so we can see in the logfile when our spiffy new form was used to log in. This will also be a hidden field.
Line 22:		Line 22:
	; authId		; authId
	: A random string used for tracking a login requests way through your apache / OX setup.		: A random string used for tracking a login requests way through your apache / OX setup.


	== Example ==		== Example ==

Tierlieb: /* Login Errors */

2014-04-25T11:08:10Z

← Older revision		Revision as of 11:08, 25 April 2014
Line 131:		Line 131:

	[[Category: OX6]]		[[Category: OX6]]
			[[Category: AppSuite]]
	[[Category: v6.22]]		[[Category: v6.22]]
	[[Category: HTTP API]]		[[Category: HTTP API]]
	[[Category: Details]]		[[Category: Details]]
			[[Category: Frontend]]
			[[Category: Adminstrator]]

WolfgangRosenauer at 08:15, 2 December 2013

2013-12-02T08:15:39Z

← Older revision		Revision as of 08:15, 2 December 2013
Line 121:		Line 121:
	</syntaxhighlight>		</syntaxhighlight>

	What does it do? It displays the error message for 5 seconds and the redirects back to the referrer, meaning: Your form. It adds a login=failed parameter to the URL, so your form may react when something went wrong. If you think (like myself) this form lacks the, ah well, je-ne-sais-quoi of a nice error page, then fret not! You can provide your own custom template. To do that, open up the file '''/opt/openexchange/etc~~/groupware~~/login.properties''' and set the '''com.openexchange.ajax.login.errorPageTemplate''' to point to a file on the OX system that contains your template. For example:		What does it do? It displays the error message for 5 seconds and the redirects back to the referrer, meaning: Your form. It adds a login=failed parameter to the URL, so your form may react when something went wrong. If you think (like myself) this form lacks the, ah well, je-ne-sais-quoi of a nice error page, then fret not! You can provide your own custom template. To do that, open up the file '''/opt/openexchange/etc/login.properties''' and set the '''com.openexchange.ajax.login.errorPageTemplate''' to point to a file on the OX system that contains your template. For example:

	com.openexchange.ajax.login.errorPageTemplate=/opt/openexchange/local/loginErrors.html		com.openexchange.ajax.login.errorPageTemplate=/opt/openexchange/local/loginErrors.html
Line 131:		Line 131:

	[[Category: OX6]]		[[Category: OX6]]
	[[Category: v6.20]]		[[Category: v6.22]]
	[[Category: HTTP API]]		[[Category: HTTP API]]
	[[Category: Details]]		[[Category: Details]]

Choeger at 11:07, 19 August 2013

2013-08-19T11:07:09Z

← Older revision		Revision as of 11:07, 19 August 2013
Line 13:		Line 13:
	: The users password. This will usually be a password input field.		: The users password. This will usually be a password input field.
	; client		; client
	: The client parameter used to distinguish between programs using the same cookie store. Since we want the new session to be used by the AJAX frontend, we'll set this to '''com.openexchange.ox.gui.dhtml''' for the OX6 frontend ~~and~~ to '''open-xchange-appsuite''' for App Suite. This is a hidden field. See also [[OXSessionGlossary]]		: The client parameter used to distinguish between programs using the same cookie store. Since we want the new session to be used by the AJAX frontend, we'll set this to '''com.openexchange.ox.gui.dhtml''' for the OX6 frontend, to '''open-xchange-appsuite''' for App Suite and '''com.openexchange.mobileapp''' for the Mobile UI. This is a hidden field. See also [[OXSessionGlossary]]
	; version		; version
	: A version string. The content is not really relevant, but it will be logged, so we can later find out, where a login request came from. The UI will usually send its version, we'll send '''Form Login''' so we can see in the logfile when our spiffy new form was used to log in. This will also be a hidden field.		: A version string. The content is not really relevant, but it will be logged, so we can later find out, where a login request came from. The UI will usually send its version, we'll send '''Form Login''' so we can see in the logfile when our spiffy new form was used to log in. This will also be a hidden field.

Alexander.quast: added example for mobile web interface

2013-08-19T10:11:39Z

added example for mobile web interface

← Older revision		Revision as of 10:11, 19 August 2013
Line 70:		Line 70:
	<!-- <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="uiWebPath" value="/ox6/index.html"> -->		<!-- <input type="hidden" name="uiWebPath" value="/ox6/index.html"> -->

			<!-- When using Mobile Web Interface -->
			<!-- <input type="hidden" name="client" value="com.openexchange.mobileapp"> -->
			<!-- <input type="hidden" name="uiWebPath" value="/mobile/index.html"> -->
	</p>		</p>
	</form>		</form>
Line 83:		Line 87:

	If you're uncomfortable using javascript for this, you might opt for having the form page generated by a server side script and just include the random UUID in the form definition. The only thing to remember about this is: You need the '''authId''' parameter, it must be part of the URL, so it shows up in logfiles and it must be unique so that it makes sense when later tracking what happens to a login request. In total our form page looks like this:		If you're uncomfortable using javascript for this, you might opt for having the form page generated by a server side script and just include the random UUID in the form definition. The only thing to remember about this is: You need the '''authId''' parameter, it must be part of the URL, so it shows up in logfiles and it must be unique so that it makes sense when later tracking what happens to a login request. In total our form page looks like this:


	== Login Errors ==		== Login Errors ==

Choeger at 07:09, 18 July 2013

2013-07-18T07:09:56Z

← Older revision		Revision as of 07:09, 18 July 2013
Line 1:		Line 1:
	~~This article explains the optional OXSessionFormLogin servlet in detail. For a quick-start guide on using it, see [[Open-Xchange servlet for external login masks]]~~

	= Form Login =		= Form Login =

WolfgangRosenauer: Reverted edits by Choeger (talk) to last revision by WolfgangRosenauer

2013-07-18T07:09:07Z

Reverted edits by Choeger (talk) to last revision by WolfgangRosenauer

← Older revision		Revision as of 07:09, 18 July 2013
Line 1:		Line 1:
			This article explains the optional OXSessionFormLogin servlet in detail. For a quick-start guide on using it, see [[Open-Xchange servlet for external login masks]]

	= Form Login =		= Form Login =

	The form login is a mechanism, that allows you to create a custom login form, by which way a user may enter the OX frontend. All you need to do, is have the form POST the necessary login information and the location of the OX frontend. The OX server will create a session, set all necessary cookies and forward the browser to the frontend.		The form login is a mechanism, that allows you to create a custom login form, by which way a user may enter the OX frontend. All you need to do, is have the form POST the necessary login information and the location of the OX frontend. The OX server will create a session, set all necessary cookies and forward the browser to the frontend.

	~~== Requirements ==~~

	~~The Open-Xchange [[HTTP_API#Form_Login_.28since_6.20.29\|HTTP API]] has a function to~~
	~~create a session from external.~~

	~~In order for this mechanism to work, you need to set <tt>com.openexchange.sessiond.autologin=true</tt> in <tt>/opt/open-xchange/etc/sessiond.properties</tt>~~

Choeger at 06:17, 18 July 2013

2013-07-18T06:17:08Z

← Older revision		Revision as of 06:17, 18 July 2013
Line 1:		Line 1:
	~~This article explains the optional OXSessionFormLogin servlet in detail. For a quick-start guide on using it, see [[Open-Xchange servlet for external login masks]]~~

	= Form Login =		= Form Login =

	The form login is a mechanism, that allows you to create a custom login form, by which way a user may enter the OX frontend. All you need to do, is have the form POST the necessary login information and the location of the OX frontend. The OX server will create a session, set all necessary cookies and forward the browser to the frontend.		The form login is a mechanism, that allows you to create a custom login form, by which way a user may enter the OX frontend. All you need to do, is have the form POST the necessary login information and the location of the OX frontend. The OX server will create a session, set all necessary cookies and forward the browser to the frontend.

			== Requirements ==

			The Open-Xchange [[HTTP_API#Form_Login_.28since_6.20.29\|HTTP API]] has a function to
			create a session from external.

			In order for this mechanism to work, you need to set <tt>com.openexchange.sessiond.autologin=true</tt> in <tt>/opt/open-xchange/etc/sessiond.properties</tt>