Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 3 Next »

Description

AlisonGUI is a javascript client library to access Alison-Desktop and AlisonServer certificates functionalities from any browser. AlisonGUI embed AkisonJS into it.  

Browser compatibility

Chrome

Firefox

Safari

Opera

Brave

Edge

IExplorer

Latest ✔Latest ✔Latest ✔Latest ✔Latest ✔Latest ✔

11 ✔

Download

You can [download latest stable release] of AlisonGUI.

Integration

You must include the following line in your HTML page.

<script type="text/javascript" src="alisonGUI.umd.js"></script>

Future Releases

It is possible to access future releases of the library to test new features to be implemented.

Disclaimer

Disclaimer

This is a work in progress.

It may be subject to changes in the future.


Related Product

Alison Desktop

Go to the Alison Desktop documentation.

AlisoJS sdk

Go to the AlisosJS sdk documentation.

Methods

List of available methods.


Version

Use the attribute libVersion to determine current version of the library.

Library Version
const version = alisonGUI.libVersion;

.


Mount

This method initialize the defined providers, set filters and display features and show a dialog windows to perform the selected operation.


Initialize
AlisonGUI.mount( parameter );
ArgumentRequiredDescription
parameter✔

A JSon string defining all the components and operations.

A description of each field can be found below.

.


Parameters

Following fields can be present into the parameters.

Fields
{
	gui?: {...},
	filters?: [...],
	select?: {...},

	providers: {...},
	operation?: {...},
	signature?: {...},
	onConfirm: (result) {...},
	onCancel: (result) {...}
}

.

gui:

These values define some graphics features of the library.

gui:
gui: {
	logoUrl: logoUrl?,
	theme: themeId?,
	header: header?,
	language: language?,
	viewSignature: boolean?
}
ArgumentRequiredDescription
logoUrl✘

URL to the logo image to be included into the header of the dialog window.

theme✘

Name of the graphic theme to be used. Default value: "theme1".

Currently only "theme1" and "theme2" are defined.

header✘

String to describe the operation.

language✘Language. It none is defined, library uses browser language, or "en" if the language is not supported by the library.
viewSignature✘If "true", the text to be signed is displayed on frame of the same window.


Language is a more complex structure since it allows to select the language of the message and also to extend default message definitions or to add new ones. Following example shows how to define a new language and its values.


Language Definition
"language": {
	"key": "jp",
	"resources": [
		{
			"key": "jp",
			"resource": "translations/jp.json"
		}
	]
}


ArgumentRequiredDescription
key✔

Language. It must be a 2 letter definition.

resources✘

Array of resources where new languages are defined. Follow previous example.


Themes

Color and styles can be overwrite.

Theme1

Theme2

.



filters:

It's possible to define a filter to be applied on the certificate list. A filter can define several conditions.

gui:
filters: [
	{
		subject: subject?,
		issuer: issuer?,
		keysore: keystoreArray?,
		expirationWindow: expirationWindow?
	} , ...
}
ArgumentRequiredDescription
subject✘

A string that is included into the Distinguished Name (DN) of the subject's certificate.

issuer✘A string that is included into the Distinguished Name (DN) of the issuer's certificate.
keystore✘

An array of valid keystores. Ex: "CSK", "MACOS"].

expirationWindow✘

A certificate can be filtered by its expiration date.

This field must define 2 integer values: "<past-days>,<previous-days>", and these values allows to create a range around the expiration date of the certificate.

A wildcard (*) can be used to disable one of the values. Some examples:

0 , * : all valid certificates.

* , 0 : all expired certificates.

0 , 60 : valid certificates with less than 60 days of validity.

-30 , 90 : certificates close to expire (less than 90 days), or expired (less than 30 expired days).

60 , * : certificates with more than 60 days of validity.


Example: valid certificates issued by "Banco Saraza SA".

Filter Example
filters: [
	{
		"windowValidity": "0,*",
		"issuer": "Banco Saraza"
	}
]

.



select:

This parameter allows selection of a certificate from all the certificates found.

gui:
selector: {
	thumbPrint: thumbPrint,
	profileName: profileName?,
	keyStoreId: keyStoreId?
}
ArgumentRequiredDescription
thumbPrint✔

ThumbPrint of the certificate. This value is required. If more than one certificate is present, then profileName and keyStoreId is used to select the right certificate.

profileName✘ProfileName that contains the selected certificate.
keyStoreId✘

KeyStoreId that contains the selected certificate, ie: "MACOS", "ETOKEN".

.


Example

Select a certificate


Select a Certificate
<script src="./alisonGUI.umd.js"></script>

AlisonGUI.mount({
	gui: {
		logoUrl: company.logo,
		language: "en"
	},
	providers: {
		desktop: {
			url: 
			accessToken: "ewogICJ2MiI..."
		},
		tad: {
			requestUrl: 'https://localhost:3000/requestSignature',
			responseUrl: 'https://localhost:3000/responseSignature'
		}
	},
	filters: [
		{
            expirationWindow: '0,*',
            issuer: 'CN=Bank*'
		}
	],
	onConfirm: (result) => {
		console.log("onConfirm"); 
		console.log(result);
	},
	onCancel: (result) => {
		console.log("onCancel"); 
		console.log(result);
	}
});


  • No labels