Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mandarinets from "https://raw.githubusercontent.com/mandarineorg/mandarinets/master/security-core/mandarine-security.ns.ts";

§Namespaces

MandarineSecurity

Contains all the essentials for Mandarine's security core to work

MandarineSecurity.Auth
MandarineSecurity.Core
MandarineSecurity.Core.Modules
MandarineSecurity.Crypto
MandarineSecurity.Sessions

§Enums

MandarineSecurity.Auth.AuthExceptions

List of known authentication exceptions

MandarineSecurity.Sessions.MandarineSessionExceptions

Used in callbacks from Mandarine's native Session storage system. This is not necessary to use.

§Functions

MandarineSecurity.getAuthManagerBuilder

Gets the current login builder which contains the information of the endpoints for built-in logins

§Interfaces

MandarineSecurity.Auth.AuthenticationManagerBuilder

Principal interface for the authentication manager builder, which indicates what what service (implementing Mandarine.Security.Auth.UserDetailsService) we will call for built-in authentication

MandarineSecurity.Auth.AuthenticationResult

Contains the state of a built-in authentication process

MandarineSecurity.Auth.Authenticator

Private API to perform authentication (Mandarine's built-in Authentication)

MandarineSecurity.Auth.Handler

Handler for login/logout whether successful or not. This is executed after login/logout was called (from built-in authentication)

MandarineSecurity.Auth.PerformAuthenticationOptions
MandarineSecurity.Auth.PerformHTTPAuthenticationOptions
MandarineSecurity.Auth.RequestAuthObj

Data present in request.authentication AUTH_SES_ID refers to the session id with the data of the user that was logged in through Mandarine's built-in authentication AUTH_EXPIRES refers to the time when the session will expire AUTH_PRINCIPAL refers to all the data that was loaded (following the UserDetails implementation)

MandarineSecurity.Auth.UserDetails

Interface for the minimum of information a user model must have when using Mandarine's built-in authentication.

MandarineSecurity.Auth.UserDetailsService

Interface for a mandarine-powered component (type service) which will be used for built-in authentication

MandarineSecurity.Core.LoginConfigurer

Data to be used for login/logout purposes from built-in authentication

MandarineSecurity.Core.Modules.LoginBuilder

Implementation of Login Builder, used to create the behaviors for built-in authentication

MandarineSecurity.Crypto.PasswordEncoder
MandarineSecurity.Sessions.MandarineSession

Represents the object of a mandarine session. This is not customizable.

MandarineSecurity.Sessions.SessionContainer

Represents the object of the configuration for the Session Container

MandarineSecurity.Sessions.SessionContextObj

Data present in request regarding the current session

MandarineSecurity.Sessions.SessionCookie
MandarineSecurity.Sessions.SessionStore

Represents how a SessionStore implementation should be designed. SessionStore is used to design & use the process of manipulating sessions

§Type Aliases

MandarineSecurity.Auth.AuthenticatorExecutor
MandarineSecurity.Auth.GrantedAuthority
MandarineSecurity.Auth.Permissions
MandarineSecurity.Auth.PermissionValidator

Permission validators are functions executed during the evaluation of a security expression. PermissionValidator is how Mandarine interprets a security expression

MandarineSecurity.Auth.PredefinedExpressions