import Credentials from 'devapt-core-common/js/base/credentials.js'

public class | source

Credentials

Authentication informations, used on server and on browser.

Example:

	API:
		->set_credentials(arg_datas):nothing - check and set crendtials datas.
		
		->dump():string - dump credentials to a readable string without sensitive datas.
		->digest_password(arg_string):string - hash credentials password (static).
		
		->serialize(arg_app_secret):string - transform credentials to a string.
		->deserialize(string, arg_app_secret):boolean - load credentials from a string.string

		->encrypt(arg_app_key):string - encrypted string.
		->decrypt(arg_string, arg_app_key):boolean - success or failure.

		->extract(arg_string):object - extract a record with credentials values from a formatted string.

Static Method Summary

Static Public Methods
public static	digest_password(arg_password: string): string Transform credentials password with a hash method.
public static	get_empty_credentials(): object Get empty credentials record.

Constructor Summary

Public Constructor
public	constructor(arg_datas: object): nothing Create a Credentials instance.

Member Summary

Public Members
public	is_credentials: boolean Class type flag.
public	update_handler: function Update handler.

Private Members
private	_credentials: Immutable.Map Credentials settings.

Method Summary

Public Methods
public	decrypt(arg_string: string, arg_app_key: string): string Decrypt credentials encrypted string.
public	deserialize(arg_string: string): boolean Deserialize credentials from a string without encryption.
public	dump(): string Dump credentials datas to a readable string without sensitive datas.
public	encrypt(arg_app_key: string): string Transform credentials to a string with encryption.
public	extract(arg_string: string): object Extract credentials fields from a string (password should be hashed and encoded, only [a-zA-Z0-9_] chars).
public	get_application(): string \| undefined Get credentials application.
public	get_credentials(): object Get credentials datas.
public	get_credentials_for_template(): object Get credentials datas.
public	get_env(): string \| undefined Get credentials environment.
public	get_pass_digest(): string \| undefined Get credentials user.
public	get_tenant(): string \| undefined Get credentials tenant.
public	get_token(): string \| undefined Get credentials token.
public	get_url_part(): string Get credentials url part.
public	get_user(): string \| undefined Get credentials user.
public	is_valid(): boolean Credentials are valid for access.
public	serialize(): string Transform credentials to a string without encryption which could be sent over a network.
public	set_credentials(arg_datas: object): boolean Check and set credentials datas.