import AuthenticationLowDbPlugin from 'devapt-core-server/js/security/authentication_plugin_lowdb.js'

public class | source

AuthenticationLowDbPlugin

devapt-core-common/dist/js/plugins/plugin~Plugin → AuthenticationPlugin → AuthenticationLowDbPlugin

Authentication class with a LowDb user/login database.

Constructor Summary

Public Constructor
public	constructor(arg_manager: AuhtenticationManager, arg_name: string, arg_log_context: string \| undefined): nothing Create an Authentication plugin class based on query parameters.

Public Members
public	failure_redirect: *
public	file_db: *
public	file_name: *
public	id_fieldname: *
public	is_authentication_lowdb_plugin: boolean
public	password_fieldname: *
public	success_redirect: *
public	use_session: *
public	username_fieldname: *

Public Methods
public	authenticate(arg_credentials: Credentials \| undefined): object Authenticate a user with a file giving request credentials.
public	create_middleware(arg_should_401: boolean, arg_next_auth_mw: Function): Function Get a authentication middleware to use on servers (see Connect/Express middleware signature).
public	disable(arg_settings: object \| undefined): object Disable authentication plugin with contextual informations.
public	enable(arg_settings: object \| undefined): object Enable authentication plugin with contextual informations.
public	get_user_by_id(arg_user_id: string): string Get user record by its id.
public	get_user_id(arg_user_record: object): string Get user id from a user record.

From class AuthenticationPlugin
public	is_authentication_plugin: boolean
public abstract	apply_on_server(arg_server: object): nothing Apply authentication plugin io given server.
public abstract	authenticate(arg_credentials: Credentials \| undefined): object Authenticate a user with request credentials.
public abstract	check_token(): boolean Check a credentials token.
public abstract	create_middleware(arg_should_401: boolean, arg_next_auth_mw: Function): Function Get a authentication middleware to use on servers (see Connect/Express middleware signature).
public abstract	disable(arg_settings: object \| undefined): object Disable authentication plugin with contextual informations.
public abstract	enable(arg_settings: object \| undefined): object Enable authentication plugin with contextual informations.
public abstract	get_token(): string Get credentials token of authenticated user.
public abstract	login(): object Login current request (alias of authenticate).
public abstract	logout(): object Logout current authenticated user.
public abstract	renew_token(): string Create a new credentials token for authenticated user.

Create an Authentication plugin class based on query parameters.

Name	Type	Attribute	Description
arg_manager	AuhtenticationManager		authentication plugins manager.
arg_name	string		plugin name.
arg_log_context	string \| undefined		optional.

nothing

Authenticate a user with a file giving request credentials.

Name	Type	Attribute	Description
arg_credentials	Credentials \| undefined		request credentials object.

a promise of boolean.

Get a authentication middleware to use on servers (see Connect/Express middleware signature).

Name	Type	Attribute	Description
arg_should_401	boolean		should send an 401 error on authentication failure.
arg_next_auth_mw	Function		next authentication middleware.