import IdentityModule from 'runtime-core/src/identity/IdentityModule.js'

public class | source

IdentityModule

The Identity Module (Id Module) is the component responsible for handling the user identity and the association of this identity with the Hyperty instances, in order to make Hyperty instances identifiable. The identity in the reTHINK project is not fixed to a unique Identity Service Provider, but obtained through several different Identity sources. With this approach, the Id Module provides to the user the option to choose the preferred method for authentication. This module will thus able to support multiple Identity acquisition methods, such as OpenID connect 1.0, Kerberos System, or authentication through smart cards. For example, a user with a Google account can use the Google as an Identity Provider to provide Identity Tokens, which can be used by the Identity Module to associate it with a Hyperty instance.

The Identity Module uses a node package, the HelloJS, which is a client-side JavaScript API for authentication that facilitates the requests for the OpenID connect protocol. This method allows for some abstraction when making requests for different Identity Providers, such as OpenID connect used by Google, Facebook, Microsoft, for example.

When a request for a user identity is made using the method loginWithRP(identifier, scope), this method will analyse the Identity Provider chosen to obtain an identity and will use the HelloJS node package with the selected Identity Provider and identity scope. After the HelloJS request for an Access Token to the Identity Providers, the user will be prompted to authenticate towards the Identity Provider. Upon receiving the Access Token, this token is validated with a RESTful web service request to an endpoint on the Identity Provider Authorization Server, and after the validation is done, an ID token is obtained with the information according to the scope required. This ID token is then preserved in this module that can obtained through the getIdentities() and is passed as return value of the loginWithRP function. The methods generateAssertion and validateAssertion have not yet been developed.

Constructor Summary

Public Constructor
public	constructor(runtimeURL: , runtimeCapabilities: , storageManager: , dataObjectsStorage: ) This is the constructor to initialise the Identity Module it does not require any input.

Member Summary

Public Members
public get	messageBus(messageBus: MessageBus): * return the messageBus in this Registry
public set	messageBus(messageBus: MessageBus): * Set the messageBus in this Registry
public get	registry(registry: registry): * return the registry in this idModule
public set	registry(reg: registry): * Set the registry in this idModule

Method Summary

Public Methods
public	addGUIListeners()
public	callGenerateMethods(idp: , origin: ): *
public	callIdentityModuleFunc(methodName: , parameters: ): *
public	decryptDataObject(dataObject: , sender: ): *
public	decryptMessage(message: ):
public	deleteIdentity(userURL: String) Function to remove an identity from the Identities array
public	deployGUI()
public	doMutualAuthentication(sender: , receiver: ): *
public	encryptDataObject(dataObject: , sender: ): *
public	encryptMessage(message: ):
public	generateAssertion(contents: DOMString, origin: DOMString, usernameHint: DOMString, keyPair: JSON): IdAssertion Requests the IdpProxy from a given Domain for an identityAssertion
public	generateSelectedIdentity(publicKey: , origin: , idp: , keyPair: ): *
public	getAccessToken(legacyURL: String): JSON get an Access Token for a legacyURL
public	getCurrentIdentity(): Identity Function to return the selected Identity within a session
public	getIdToken(hypertyURL: String): JSON get an Id Token for a HypertyURL
public	getIdentities(): Array<Identities> Function to return all the identities registered within a session by a user.
public	getIdentitiesToChoose(): {"identities": , "idps": }
public	getIdentity(userURL: String): JSON gets all the information from a given userURL
public	getIdentityAssertion(identityBundle: *): IdAssertion Function that fetch an identityAssertion from a user.
public	getToken(fromURL: String, toURL: String): JSON get a Token to be added to a message
public	getUsersIDs(emailFormat: Boolean): Array<String> Function to return all the users URLs registered within a session These users URLs are returned in an array of strings.
public	loginSelectedIdentity(publicKey: , origin: , idp: , keyPair: , loginUrl: ):
public	requestIdentityToGUI(identities: Array<identity>, idps: Array<String>): Promise Function that sends a request to the GUI using messages.
public	selectIdentityForHyperty(origin: , idp: , idHint: ):
public	selectIdentityFromGUI(origin: ):
public	sendGenerateMessage(contents: , origin: , usernameHint: , idpDomain: ): *
public	setCurrentIdentity(identity: Identity) Function to set the current Identity with a given Identity
public	storeIdentity(result: , keyPair: ): *
public	unregisterIdentity(email: String) Function to unregister an identity from the emailsList array and not show in to the GUI
public	validateAssertion(assertion: DOMString, origin: DOMString): Promise Requests the IdpProxy from a given Domain to validate an IdentityAssertion Returns a promise with the result from the validation.

Public Constructors

public constructor(runtimeURL: , runtimeCapabilities: , storageManager: , dataObjectsStorage: ) source

This is the constructor to initialise the Identity Module it does not require any input.

Params:

Name	Type	Attribute	Description
runtimeURL	*
runtimeCapabilities	*
storageManager	*
dataObjectsStorage	*

Public Members

public get messageBus(messageBus: MessageBus): * source

return the messageBus in this Registry

public set messageBus(messageBus: MessageBus): * source

Set the messageBus in this Registry

public get registry(registry: registry): * source

return the registry in this idModule

public set registry(reg: registry): * source

Set the registry in this idModule

Public Methods

public addGUIListeners() source

public callGenerateMethods(idp: , origin: ): * source

Params:

Name	Type	Attribute	Description
idp	*
origin	*

Return:

public callIdentityModuleFunc(methodName: , parameters: ): * source

Params:

Name	Type	Attribute	Description
methodName	*
parameters	*

Return:

public decryptDataObject(dataObject: , sender: ): * source

Params:

Name	Type	Attribute	Description
dataObject	*
sender	*

Return:

public decryptMessage(message: ): source

Params:

Name	Type	Attribute	Description
message	*

Return:

public deleteIdentity(userURL: String) source

Function to remove an identity from the Identities array

Params:

Name	Type	Attribute	Description
userURL	String		userURL

public deployGUI() source

public doMutualAuthentication(sender: , receiver: ): * source

Params:

Name	Type	Attribute	Description
sender	*
receiver	*

Return:

public encryptDataObject(dataObject: , sender: ): * source

Params:

Name	Type	Attribute	Description
dataObject	*
sender	*

Return:

public encryptMessage(message: ): source

Params:

Name	Type	Attribute	Description
message	*

Return:

public generateAssertion(contents: DOMString, origin: DOMString, usernameHint: DOMString, keyPair: JSON): IdAssertion source

Requests the IdpProxy from a given Domain for an identityAssertion

Params:

Name	Type	Attribute	Description
contents	DOMString		contents
origin	DOMString		origin
usernameHint	DOMString		usernameHint
keyPair	JSON		user keyPair

Return:

IdAssertion

public generateSelectedIdentity(publicKey: , origin: , idp: , keyPair: ): * source

Params:

Name	Type	Attribute	Description
publicKey	*
origin	*
idp	*
keyPair	*

Return:

public getAccessToken(legacyURL: String): JSON source

get an Access Token for a legacyURL

Params:

Name	Type	Attribute	Description
legacyURL	String		the legacy address

Return:

JSON	token Access token to be added to the message

public getCurrentIdentity(): Identity source

Function to return the selected Identity within a session

Return:

Identity

identity identity

public getIdToken(hypertyURL: String): JSON source

get an Id Token for a HypertyURL

Params:

Name	Type	Attribute	Description
hypertyURL	String		the Hyperty address

Return:

JSON	token Id token to be added to the message

public getIdentities(): Array<Identities> source

Function to return all the identities registered within a session by a user. These identities are returned in an array containing a JSON package for each user identity.

Return:

Array<Identities>

Identities

public getIdentitiesToChoose(): {"identities": , "idps": } source

Return:

{"identities": *, "idps": *}

public getIdentity(userURL: String): JSON source

gets all the information from a given userURL

Params:

Name	Type	Attribute	Description
userURL	String		user url

Return:

JSON	identity identity bundle from the userURL

public getIdentityAssertion(identityBundle: *): IdAssertion source

Function that fetch an identityAssertion from a user.

Params:

Name	Type	Attribute	Description
identityBundle	*

Return:

IdAssertion

public getToken(fromURL: String, toURL: String): JSON source

get a Token to be added to a message

Params:

Name	Type	Attribute	Description
fromURL	String		origin of the message
toURL	String		target of the message

Return:

JSON	token token to be added to the message

public getUsersIDs(emailFormat: Boolean): Array<String> source

Function to return all the users URLs registered within a session These users URLs are returned in an array of strings.

Params:

Name	Type	Attribute	Description
emailFormat	Boolean		(Optional) boolean to indicate to return in email format

Return:

Array<String>

users

public loginSelectedIdentity(publicKey: , origin: , idp: , keyPair: , loginUrl: ): source

Params:

Name	Type	Attribute	Description
publicKey	*
origin	*
idp	*
keyPair	*
loginUrl	*

Return:

public requestIdentityToGUI(identities: Array<identity>, idps: Array<String>): Promise source

Function that sends a request to the GUI using messages. Sends all identities registered and the Idps supported, and return the identity/idp received by the GUI

Params:

Name	Type	Attribute	Description
identities	Array<identity>		list of identitiies
idps	Array<String>		list of idps to authenticate

Return:

Promise

returns a chosen identity or idp

public selectIdentityForHyperty(origin: , idp: , idHint: ): source

Params:

Name	Type	Attribute	Description
origin	*
idp	*
idHint	*

Return:

public selectIdentityFromGUI(origin: ): source

Params:

Name	Type	Attribute	Description
origin	*

Return:

public sendGenerateMessage(contents: , origin: , usernameHint: , idpDomain: ): * source

Params:

Name	Type	Attribute	Description
contents	*
origin	*
usernameHint	*
idpDomain	*

Return:

public setCurrentIdentity(identity: Identity) source

Function to set the current Identity with a given Identity

Params:

Name	Type	Attribute	Description
identity	Identity		identity

public storeIdentity(result: , keyPair: ): * source

Params:

Name	Type	Attribute	Description
result	*
keyPair	*

Return:

public unregisterIdentity(email: String) source

Function to unregister an identity from the emailsList array and not show in to the GUI

Params:

Name	Type	Attribute	Description
email	String		email

public validateAssertion(assertion: DOMString, origin: DOMString): Promise source

Requests the IdpProxy from a given Domain to validate an IdentityAssertion Returns a promise with the result from the validation.

Params:

Name	Type	Attribute	Description
assertion	DOMString
origin	DOMString		origin

Return:

Promise

Promise promise with the result from the validation

IdentityModule

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(runtimeURL: *, runtimeCapabilities: *, storageManager: *, dataObjectsStorage: *) source

Params:

Public Members

public get messageBus(messageBus: MessageBus): * source

public set messageBus(messageBus: MessageBus): * source

public get registry(registry: registry): * source

public set registry(reg: registry): * source

Public Methods

public addGUIListeners() source

public callGenerateMethods(idp: *, origin: *): * source

Params:

Return:

public callIdentityModuleFunc(methodName: *, parameters: *): * source

Params:

Return:

public decryptDataObject(dataObject: *, sender: *): * source

Params:

Return:

public decryptMessage(message: *): * source

Params:

Return:

public deleteIdentity(userURL: String) source

Params:

public deployGUI() source

public doMutualAuthentication(sender: *, receiver: *): * source

Params:

Return:

public encryptDataObject(dataObject: *, sender: *): * source

Params:

Return:

public encryptMessage(message: *): * source

Params:

Return:

public generateAssertion(contents: DOMString, origin: DOMString, usernameHint: DOMString, keyPair: JSON): IdAssertion source

Params:

Return:

public generateSelectedIdentity(publicKey: *, origin: *, idp: *, keyPair: *): * source

Params:

Return:

public getAccessToken(legacyURL: String): JSON source

Params:

Return:

public getCurrentIdentity(): Identity source

Return:

public getIdToken(hypertyURL: String): JSON source

Params:

Return:

public getIdentities(): Array<Identities> source

Return:

public getIdentitiesToChoose(): {"identities": *, "idps": *} source

Return:

public getIdentity(userURL: String): JSON source

Params:

Return:

public getIdentityAssertion(identityBundle: *): IdAssertion source

Params:

Return:

public getToken(fromURL: String, toURL: String): JSON source

Params:

Return:

public getUsersIDs(emailFormat: Boolean): Array<String> source

Params:

Return:

public loginSelectedIdentity(publicKey: *, origin: *, idp: *, keyPair: *, loginUrl: *): * source

Params:

Return:

public requestIdentityToGUI(identities: Array<identity>, idps: Array<String>): Promise source

Params:

Return:

public selectIdentityForHyperty(origin: *, idp: *, idHint: *): * source

Params:

Return:

public selectIdentityFromGUI(origin: *): * source

Params:

Return:

public constructor(runtimeURL: , runtimeCapabilities: , storageManager: , dataObjectsStorage: ) source

public callGenerateMethods(idp: , origin: ): * source

public callIdentityModuleFunc(methodName: , parameters: ): * source

public decryptDataObject(dataObject: , sender: ): * source

public decryptMessage(message: ): source

public doMutualAuthentication(sender: , receiver: ): * source

public encryptDataObject(dataObject: , sender: ): * source

public encryptMessage(message: ): source

public generateSelectedIdentity(publicKey: , origin: , idp: , keyPair: ): * source

public getIdentitiesToChoose(): {"identities": , "idps": } source

public loginSelectedIdentity(publicKey: , origin: , idp: , keyPair: , loginUrl: ): source

public selectIdentityForHyperty(origin: , idp: , idHint: ): source

public selectIdentityFromGUI(origin: ): source

public sendGenerateMessage(contents: , origin: , usernameHint: , idpDomain: ): * source

public storeIdentity(result: , keyPair: ): * source