authAppSelf_handler-function

An Express.js HTTP handler of authentication and authorization services for self-owned LMOS (NodeJS) applications.

Donation

Buy me a coffee via 

Prerequisites

* auth_app_self

Installation

npm install @leismore/authappself_handler

Test

npm test

Examples

``typescript
import express = require('express');
import { LMResponse as Resp, LMResponseData as RespData } from '@leismore/response';
import {
authAppSelf_handler_generator as generator,
authAppSelf_handler_generator_HostApp as GeneratorHostApp,
authAppSelf_handler_generator_Errors as GeneratorErrors,
ExpressRoutingHandler as ExpressHandler
} from '@leismore/authappself_handler';
import { LMError } from '@leismore/lmerror';
import { error_handler_last } from '@leismore/error_handler_last';

const app = express();
const port = 8081;
const API = 'http://AUTH_APP_SELF_AUTHORIZER_URL';

const authError = new LMError( {message: 'authorization failure', code: '1'}, {statusCode: '403'} );
const authAppSelfError = new LMError( {message: 'auth_app_self failure', code: '2'}, {statusCode: '503'} );
const gErrors:GeneratorErrors = {auth:authError, authAppSelf:authAppSelfError};
const gHostApp:GeneratorHostApp = {hostID:'YOUR_HOST_APP_ID', permission:'YOUR_PERMISSION_NAME'};
const get_handler1:ExpressHandler = generator(gHostApp, API, gErrors);

const get_handler2:ExpressHandler = (req:express.Request, res:express.Response, next:express.NextFunction) => {
const resp = new Resp(res);
let data:RespData = { statusCode: '200',
headers: {'Content-Type': 'application/json'}, body: {'result': 'OK'} };
resp.send(data);
};

app.get('/', get_handler1, get_handler2 );
app.use(error_handler_last);

app.listen(port, () => {
console.log(@leismore/authappself_handler testing server, listening at http://localhost:${port});
});
`

API Details

$3

ExpressRoutingHandler

`typescript
import { Request, Response, NextFunction } from 'express';
type ExpressRoutingHandler = (req:Request, res:Response, next:NextFunction) => void;
`

authAppSelf_handler_generator_HostApp

`typescript
type authAppSelf_handler_generator_HostApp = { hostID: string, permission: string };
`

authAppSelf_handler_generator_Errors

`typescript
import { LMError } from '@leismore/lmerror';
type authAppSelf_handler_generator_Errors = { auth:LMError, authAppSelf:LMError };
`

$3

`typescript
/**
* Generate authAppSelf_handler function.
* @param hostApp
* @param authAppSelf_api auth_app_self:authorizer API
* @param errors LMError (or sub-class) instances for authorization failure (HTTP 403) and authAppSelf failure (HTTP 503)
*/
function authAppSelf_handler_generator(
hostApp: authAppSelf_handler_generator_HostApp,
authAppSelf_api: string,
errors: authAppSelf_handler_generator_Errors ): ExpressRoutingHandler
`

* LMError = @leismore/lmerror (NPM)
* authAppSelf = auth_app_self

$3

`typescript
/**
* Test the HTTP credential, if valid, pass to the next handler.
* else
* Pass a LMError object to the next error handler.
*/
function authAppSelf_handler(req:express.Request, res:express.Response, next:express.NextFunction): void
``

* Express.js

Copyright

GNU Affero General Public License v3.0

Authors

* Kyle Chine (Initial Author / Feb 24, 2020)