import Auth from '@osjs/server/src/auth.js'

public class | source

Auth

Authentication Handler

Constructor Summary

Public Constructor
public	constructor(core: Core, options: AuthOptions) Creates a new instance

Member Summary

Public Members
public	adapter: AuthAdapter
public	core: Core
public	options: AuthOptions

Method Summary

Public Methods
public	checkLoginPermissions(profile: AuthUserProfile): boolean Checks if login is allowed for this user
public	async createHomeDirectory(profile: AuthUserProfile): Promise<undefined> Tries to create home directory for a user
public	async createHomeDirectoryFromArray(template: Object[], vfs: VFSServiceProvider, profile: AuthUserProfile) If the template is an array, it is a list of files that should be copied to the user's home directory
public	createUserProfile(fields: object, result: object): AuthUserProfile \| boolean Creates user profile object
public	destroy() Destroys instance
public	async init(): Promise<boolean> Initializes adapter
public	async login(req: Request, res: Response): Promise<undefined> Performs a login request
public	async logout(req: Request, res: Response): Promise<undefined> Performs a logout request
public	async register(req: Request, res: Response): Promise<undefined> Performs a register request

Public Constructors

public constructor(core: Core, options: AuthOptions) source

Creates a new instance

Params:

Name	Type	Attribute	Description
core	Core		Core instance reference
options	AuthOptions	optional default: {}	Service Provider arguments

Public Members

public adapter: AuthAdapter source

public core: Core source

public options: AuthOptions source

Public Methods

public checkLoginPermissions(profile: AuthUserProfile): boolean source

Checks if login is allowed for this user

Params:

Name	Type	Attribute	Description
profile	AuthUserProfile		User profile

Return:

boolean

public async createHomeDirectory(profile: AuthUserProfile): Promise<undefined> source

Tries to create home directory for a user

Params:

Name	Type	Attribute	Description
profile	AuthUserProfile		User profile

Return:

Promise<undefined>

public async createHomeDirectoryFromArray(template: Object[], vfs: VFSServiceProvider, profile: AuthUserProfile) source

If the template is an array, it is a list of files that should be copied to the user's home directory

Params:

Name	Type	Attribute	Description
template	Object[]		Array of objects with a specified path, optionally with specified content but defaulting to an empty string
vfs	VFSServiceProvider		An instance of the virtual file system
profile	AuthUserProfile		User profile

public createUserProfile(fields: object, result: object): AuthUserProfile | boolean source

Creates user profile object

Params:

Name	Type	Attribute	Description
fields	object		Input fields
result	object		Login result

Return:

AuthUserProfile | boolean

public destroy() source

Destroys instance

public async init(): Promise<boolean> source

Initializes adapter

Return:

Promise<boolean>

Performs a login request

Params:

Name	Type	Attribute	Description
req	Request		HTTP request
res	Response		HTTP response

Return:

Promise<undefined>

public async logout(req: Request, res: Response): Promise<undefined> source

Performs a logout request

Params:

Name	Type	Attribute	Description
req	Request		HTTP request
res	Response		HTTP response

Return:

Promise<undefined>

public async register(req: Request, res: Response): Promise<undefined> source

Performs a register request

Params:

Name	Type	Attribute	Description
req	Request		HTTP request
res	Response		HTTP response

Return:

Promise<undefined>

Auth

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(core: Core, options: AuthOptions) source

Params:

Public Members

public adapter: AuthAdapter source

public core: Core source

public options: AuthOptions source

Public Methods

public checkLoginPermissions(profile: AuthUserProfile): boolean source

Params:

Return:

public async createHomeDirectory(profile: AuthUserProfile): Promise<undefined> source

Params:

Return:

public async createHomeDirectoryFromArray(template: Object[], vfs: VFSServiceProvider, profile: AuthUserProfile) source

Params:

public createUserProfile(fields: object, result: object): AuthUserProfile | boolean source

Params:

Return:

public destroy() source

public async init(): Promise<boolean> source

Return:

public async login(req: Request, res: Response): Promise<undefined> source

Params:

Return:

public async logout(req: Request, res: Response): Promise<undefined> source

Params:

Return:

public async register(req: Request, res: Response): Promise<undefined> source

Params:

Return: