lfk/backend
2
0
Fork 0
Code Issues 1 Pull Requests Actions Projects Releases 40 Activity

Fixed some typos and extended comments for the middlewares

Browse Source 
ref #76
This commit is contained in:
Nicolai Ort 2021-01-10 16:03:56 +01:00
parent f2c50e929e
commit f96b256ad3
4 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/middlewares/RawBody.ts
View File

@ -1,8 +1,8 @@
import { Request, Response } from 'express'; import { Request, Response } from 'express';
/** /**
* Custom express middleware that appends the raw body to the request obeject. * Custom express middleware that appends the raw body to the request object.
* Mainly used for parsing csvs from boddies. * Mainly used for parsing csvs from bodies.
*/ */
const RawBodyMiddleware = (req: Request, res: Response, next: () => void) => { const RawBodyMiddleware = (req: Request, res: Response, next: () => void) => {

9
src/middlewares/ScanAuth.ts
View File

@ -5,8 +5,9 @@ import { ScanStation } from '../models/entities/ScanStation';
import authchecker from './authchecker'; import authchecker from './authchecker';
/** /**
* This middleware handels the authentification of scan station api tokens. * This middleware handles the authentication of scan station api tokens.
* The tokens have to be provided via Bearer auth header. * The tokens have to be provided via Bearer authorization header.
* You have to manually use this middleware via @UseBefore(ScanAuth) instead of using @Authorized().
* @param req Express request object. * @param req Express request object.
* @param res Express response object. * @param res Express response object.
* @param next Next function to call on success. * @param next Next function to call on success.
@ -31,7 +32,7 @@ const ScanAuth = async (req: Request, res: Response, next: () => void) => {
} }
finally { finally {
if (prefix == "" || prefix == undefined || prefix == null) { if (prefix == "" || prefix == undefined || prefix == null) {
res.status(401).send("Api token non-existant or invalid syntax."); res.status(401).send("Api token non-existent or invalid syntax.");
return; return;
} }
} }
@ -45,7 +46,7 @@ const ScanAuth = async (req: Request, res: Response, next: () => void) => {
} }
finally { finally {
if (user_authorized == false) { if (user_authorized == false) {
res.status(401).send("Api token non-existant or invalid syntax."); res.status(401).send("Api token non-existent or invalid syntax.");
return; return;
} }
else { else {

5
src/middlewares/StatsAuth.ts
View File

@ -5,8 +5,9 @@ import { StatsClient } from '../models/entities/StatsClient';
import authchecker from './authchecker'; import authchecker from './authchecker';
/** /**
* This middleware handels the authentification of stats client api tokens. * This middleware handles the authentication of stats client api tokens.
* The tokens have to be provided via Bearer auth header. * The tokens have to be provided via Bearer authorization header.
* You have to manually use this middleware via @UseBefore(StatsAuth) instead of using @Authorized().
* @param req Express request object. * @param req Express request object.
* @param res Express response object. * @param res Express response object.
* @param next Next function to call on success. * @param next Next function to call on success.

4
src/middlewares/authchecker.ts
View File

@ -8,7 +8,7 @@ import { JwtCreator, JwtUser } from '../jwtcreator';
import { User } from '../models/entities/User'; import { User } from '../models/entities/User';
/** /**
* Handels authorisation verification via jwt's for all api endpoints using the @Authorized decorator. * Handles authentication via jwt's (Bearer authorization header) for all api endpoints using the @Authorized decorator.
* @param action Routing-Controllers action object that provides request and response objects among other stuff. * @param action Routing-Controllers action object that provides request and response objects among other stuff.
* @param permissions The permissions that the endpoint using @Authorized requires. * @param permissions The permissions that the endpoint using @Authorized requires.
*/ */
@ -43,7 +43,7 @@ const authchecker = async (action: Action, permissions: string[] | string) => {
} }
/** /**
* Handels soft-refreshing of access-tokens. * Handles soft-refreshing of access-tokens.
* @param action Routing-Controllers action object that provides request and response objects among other stuff. * @param action Routing-Controllers action object that provides request and response objects among other stuff.
*/ */
const refresh = async (action: Action) => { const refresh = async (action: Action) => {