OAuth2.Login is the base class for login pages which use OAuth 2.0 or OpenID Connect. More...

Inheritance diagram for Login:

Collaboration diagram for Login:

Static Public Member Functions
	DefineParameters (_.Library.String application, _.Library.String scope, _.Library.String responseMode)
	Callback to allow the overriding login subclass to define the class parameter values at run-time More...

	DefineProperties (_.Library.String properties)
	Callback to allow the overriding login subclass to define the properties list for the GetAccessTokenAuthorizationCode call. More...

Static Public Member Functions inherited from Login
	DrawCSS3STYLE ()
	Draw the style definitions for the login page. More...

	DrawHEAD (pTitle)
	Draw the HEAD section of the login page. More...

	DrawSTHEAD ()
	Draw the HEAD section of the security token page. More...

	DrawSTTitle (_.Library.String pTitle)
	Draw the title section of the security token page. More...

	DrawSTYLE ()
	Draw the style definitions for the login page. More...

	DrawTitle (_.Library.String pTitle)
	Draw the title section of the login page. More...

	DrawTitleSection (_.Library.String msgs)
	Draw the title section of the page. More...

_.Library.Status	OnHandleCorsRequest (_.Library.String url)
	This is the CORS request handler. More...

_.Library.Status	OnHandleOptionsRequest (_.Library.String url)
	This methods provides handling of the options request for this CSP application. More...

_.Library.Status	OnPage ()
	Output the default login page as HTML.

_.Library.Boolean	OnPreHTTP ()
	Determine if we need login CSRF tokens and if so add them. More...

_.Library.Status	SupportedVerbs (url, _.Library.String verbs)
	By default all methods are supported.

Static Public Member Functions inherited from Page
_.Library.Status	ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
	You pass this the <parameter>url</parameter> of the page you are going to and a. More...

_.Library.Binary	Decrypt (_.Library.String data)
	Decrypts the input string using the session.Key value that is unique to. More...

_.Library.String	Encrypt (_.Library.Binary data)
	Encrypts the input string using the session.Key value that is unique to this. More...

_.Library.String	EscapeHTML (in)
	This method converts input HTML text into Escaped HTML text.

_.Library.String	EscapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in input URL string into Escaped URL string. More...

_.Library.String	HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
	This method returns the string that needs to be written to the current. More...

_.Library.String	HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
	This method returns the string that needs to be written to the current. More...

	Include (_.Library.String url)
	Include another csp page or file in the output at this point. More...

_.Library.String	InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
	Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...

_.Library.String	InsertHiddenFields (_.Library.String url, _.Library.String query)
	Return the string containing the hidden form tags. More...

_.Library.Boolean	IsPrivate ()
	Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).

_.Library.String	Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ)
	Tranforms the link specified by link into a URL and returns it as a string. More...

_.Library.Status	OnHTTPHeader (_.Library.Boolean OutputBody)
	Event handler for PAGE event: this is invoked in order to More...

	OnPageError (_.Library.Status sc)
	Event handler for any error that occurs on the page. More...

	OnPostHTTP ()
	Event handler for POSTPAGE event: this is invoked after the data. More...

_.Library.Status	OnPostHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked after a hyperevent method is called on this page.

_.Library.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on this page. More...

_.Library.Status	Page (_.Library.Boolean skipheader)
	Process a request to serve a CSPPage. More...

_.Library.String	QuoteJS (in)
	This method converts input string into quoted JavaScript literal.

_.Library.String	RewriteURL (_.Library.String url)
	This method will rewrite a URL to use #url()# if needed.

	ShowError (_.Library.Status sc)
	Display a <class>Status</class> error code to the CSP Page.

	StartTimer (_.Library.String name)
	Used to get performance information on your CSP pages. More...

	StopTimer (_.Library.String name)
	Used to time performance information on your CSP pages. More...

	ThrowError (_.Library.Status sc)
	Passed a <class>Status</class> code this goes to the error page passing this status code.

_.Library.String	UnescapeHTML (in)
	This method converts Escaped HTML text into normal HTML text.

_.Library.String	UnescapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in Escaped URL string back to its original form. More...

Static Public Attributes
	APPLICATION = None
	OAuth2.Login is the base class for login pages which use OAuth 2.0 or OpenID Connect. More...

	RESPONSEMODE = None
	The RESPONSEMODE parameter specifies the mode of the response as either query, fragment or form_post. More...

	SCOPE = None
	The blank separated scope list to be used for the access token request. More...

Static Public Attributes inherited from Login
	DOMAIN = None
	Provide a default login and security-token pages for CSP applications. More...

	FAVORITEICON = None
	Home favorite icon.

	HandleCorsRequest = None
	This parameter influences the CORS support for the CSP application that has this login page assigned. More...

	LOGINTITLE = None
	Title displayed for login page. More...

	STYLESHEET = None
	Name of stylesheet used for login page. More...

Static Public Attributes inherited from Page
	CHARSET = None
	The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...

	CONTENTTYPE = None
	Specifies the default content type for the page. More...

	CONVERTINPUTSTREAM = None
	Specifies if input request.Content or request.MimeData values are converted from their. More...

	CSPFILE = None
	If this page was compiled from a .csp file, then this parameter contains the. More...

	CSPSTRICT = None
	The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...

	CSPURL = None
	This parameter is used to make sure that if multiple. More...

	CSPXHTML = None
	The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...

	DOMAIN = None
	The default domain for csp:text, span and div tags. More...

	ENCODED = None
	Controls how the query parameters for this page are passed, it can. More...

	ERRORPAGE = None
	Specify a custom error page to call if there are any problems with generating this page. More...

	EXPIRES = None
	Specified the default value for the response.Expires. More...

	NOCHARSETCONVERT = None
	Specifies if we wish to turn off charset conversion for this page. More...

	PAGETIMING = None
	If this parameter is true then we automatically record timing statistics of how long it takes to. More...

	PRIVATE = None
	Controls the access to the page, it can be set to one of the following: More...

	SECURITYRESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...

	TIMINGSLOTS = None
	Used by the timing to decide how many slots a day should be divided up into. More...

	UseSession = None
	This parameter controls the CSP session support. More...

Detailed Description

OAuth2.Login is the base class for login pages which use OAuth 2.0 or OpenID Connect.

The usual login class will only override the APPLICATION and SCOPE parameters. Additional customization may be done by overriding the RESPONSEMODE parameter and DefineProperties method.

The login page will directly log in the session using delegated authentication. For an example ZAUTHENTICATE routine, see the Samples-Security repo in GitHub.

Member Function Documentation

◆ DefineParameters()

DefineParameters	(	_.Library.String	application,
		_.Library.String	scope,
		_.Library.String	responseMode
	)

static

Callback to allow the overriding login subclass to define the class parameter values at run-time

The default to use the class parameter values.

◆ DefineProperties()

DefineProperties ( _.Library.String properties )

static

Callback to allow the overriding login subclass to define the properties list for the GetAccessTokenAuthorizationCode call.

properties is a local array specifying additional properties to be included in a token request in the form properties(name)=value. To add a request parameter which is a JSON object, you may either create a properties element which is a DynamicObject or is a string that is the UTF-8 encoded serialized object. For example the claims parameter that is defined by OpenID Connect. If the request or request_uri request parameters are to be used, then the SYS.OAuth2.Request class is used to create the JWT. The the JWT is assigned to properties("request") or the URL for the JWT is assigned to properties("request_uri")

Member Data Documentation

◆ APPLICATION

APPLICATION = None

static

OAuth2.Login is the base class for login pages which use OAuth 2.0 or OpenID Connect.

The usual login class will only override the APPLICATION and SCOPE parameters. Additional customization may be done by overriding the RESPONSEMODE parameter and DefineProperties method.

The login page will directly log in the session using delegated authentication. For an example ZAUTHENTICATE routine, see the Samples-Security repo in GitHub.

The application name for the application being logged into.

The actual login page will need to override this parameter.

◆ RESPONSEMODE

RESPONSEMODE = None

static

The RESPONSEMODE parameter specifies the mode of the response as either query, fragment or form_post.

The default is query.

◆ SCOPE

SCOPE = None

static

The blank separated scope list to be used for the access token request.

The actual login page will need to override this parameter.

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ DefineParameters()

◆ DefineProperties()

Member Data Documentation

◆ APPLICATION

◆ RESPONSEMODE

◆ SCOPE