Authentication basics (#35)

.github/labeler.yml

@@ -9,10 +9,9 @@ PACKAGE: packages/**
 "Hiker's Book UI": ui/hikers-book/**
 '@hikers-book/cli-tools': packages/cli-tools/**
 '@hikers-book/config': packages/config/**
-'@hikers-book/cryptography': packages/cryptography/**
 '@hikers-book/eslint-config': packages/eslint/**
 '@hikers-book/jest': packages/jest/**
-'@hikers-book/tsed-swagger': packages/tsed-swagger/**
+'@hikers-book/tsed-common': packages/tsed-common/**
 
 ci: .github/**
 deps: '**/package.json'

api/authentication/.barrelsby.json

@@ -2,8 +2,12 @@
   "directory": [
     "./src/docs/controllers/pages",
     "./src/v1/controllers",
+    "./src/v1/handlers/auth",
+    "./src/v1/models",
     "./src/v1/types",
-    "./src/v1/types/enum"
+    "./src/v1/types/enum",
+    "./src/services",
+    "./src/utils"
   ],
   "exclude": [
     "__mock__",

api/authentication/.gitignore

@@ -0,0 +1,2 @@
+keys/jwt.pem
+keys/jwt.pem.pub

api/authentication/package.json

@@ -5,6 +5,7 @@
   "author": "radoslav.irha@gmail.com",
   "license": "MIT",
   "scripts": {
+    "bootstrap": "pnpm run config:all && pnpm run keys",
     "build": "pnpm run barrels && tsc --project tsconfig.compile.json",
     "barrels": "barrelsby --config .barrelsby.json",
     "start": "pnpm run barrels && tsnd --inspect --exit-child --cls --ignore-watch node_modules --respawn --transpile-only -r tsconfig-paths/register src/index.ts",
@@ -18,11 +19,11 @@
     "config:clear": "find ./config -name '*.json' -type f -delete",
     "config:all": "pnpm run config:env && pnpm run config && pnpm run config:test",
     "postinstall": "pnpm run config:all",
-    "cleanup": "rm -rf coverage dist"
+    "cleanup": "rm -rf coverage dist",
+    "keys": "openssl genrsa -out keys/jwt.pem 2048 && openssl rsa -in keys/jwt.pem -outform PEM -pubout -out keys/jwt.pem.pub"
   },
   "dependencies": {
-    "@hikers-book/cryptography": "workspace:*",
-    "@hikers-book/tsed-swagger": "workspace:*",
+    "@hikers-book/tsed-common": "workspace:*",
     "@tsed/ajv": "^7.36.8",
     "@tsed/common": "^7.36.8",
     "@tsed/core": "^7.36.8",
@@ -43,7 +44,7 @@
     "@tsed/platform-views": "^7.36.8",
     "@tsed/schema": "^7.36.8",
     "@tsed/swagger": "^7.36.8",
-    "ajv": "^8.12.0",
+    "argon2": "^0.31.1",
     "barrelsby": "^2.8.1",
     "body-parser": "^1.20.2",
     "class-validator": "^0.13.2",
@@ -57,6 +58,7 @@
     "dotenv-flow": "^3.3.0",
     "express": "^4.18.2",
     "helmet": "^7.0.0",
+    "jsonwebtoken": "^9.0.2",
     "method-override": "^3.0.0",
     "mongoose": "^7.5.0"
   },
@@ -76,6 +78,7 @@
     "@types/cors": "^2.8.14",
     "@types/express": "^4.17.18",
     "@types/jest": "^29.5.5",
+    "@types/jsonwebtoken": "^9.0.3",
     "@types/method-override": "^0.0.33",
     "@types/multer": "^1.4.8",
     "@types/node": "^20.5.7",

api/authentication/src/Server.ts

@@ -1,66 +1,41 @@
-import { getHelmetDirectives, getSwaggerConfig } from '@hikers-book/tsed-swagger';
+import { BaseServer } from '@hikers-book/tsed-common/server';
+import { ConfigServiceBase } from '@hikers-book/tsed-common/services';
+import { getHelmetDirectives, getSwaggerConfig } from '@hikers-book/tsed-common/swagger';
 import '@tsed/ajv';
-import { $log, PlatformApplication } from '@tsed/common';
-import { Configuration, Inject } from '@tsed/di';
+import { Configuration } from '@tsed/di';
 import '@tsed/mongoose';
 import '@tsed/platform-express'; // /!\ keep this import
-import bodyParser from 'body-parser';
-import compress from 'compression';
-import cookieParser from 'cookie-parser';
-import cors from 'cors';
 import helmet from 'helmet';
-import methodOverride from 'method-override';
 import { join } from 'path';
-import { config } from './config/index';
 import * as docs from './docs/controllers/pages/index';
+import './providers/ConfigProvider';
 import * as v1 from './v1/controllers/index';
 
 @Configuration({
-  ...config,
-  acceptMimes: ['application/json'],
-  disableComponentsScan: true,
+  // @Configuration decorator from base class is not working
+  ...ConfigServiceBase.getServerDefaults(),
   mount: {
     '/v1': [...Object.values(v1)],
     '/': [...Object.values(docs)]
   },
-  swagger: getSwaggerConfig(join(__dirname, '../package.json')),
+  swagger: getSwaggerConfig(),
   views: {
     root: join(process.cwd(), '../views'),
     extensions: {
       ejs: 'ejs'
     }
-  },
-  exclude: ['**/*.spec.ts']
+  }
 })
-export class Server {
-  @Inject()
-  protected app!: PlatformApplication;
-
-  @Configuration()
-  protected settings!: Configuration;
-
+export class Server extends BaseServer {
   $beforeRoutesInit(): void {
-    this.app
-      .use(
-        helmet({
-          contentSecurityPolicy: {
-            directives: getHelmetDirectives()
-          }
-        })
-      )
-      .use(cors())
-      .use(cookieParser())
-      .use(compress({}))
-      .use(methodOverride())
-      .use(bodyParser.json())
-      .use(
-        bodyParser.urlencoded({
-          extended: true
-        })
-      );
-  }
+    this.registerMiddlewares();
 
-  $onReady(): void {
-    $log.info(`${this.settings.api} ${this.settings.version} is ready!`);
+    this.app.use(
+      helmet({
+        contentSecurityPolicy: {
+          directives: getHelmetDirectives()
+        }
+      })
+    );
   }
 }

api/authentication/src/index.ts

@@ -1,10 +1,12 @@
 import { $log } from '@tsed/common';
 import { PlatformExpress } from '@tsed/platform-express';
 import { Server } from './Server';
+import { ConfigService } from './services/ConfigService';
 
 async function bootstrap() {
   try {
-    const platform = await PlatformExpress.bootstrap(Server);
+    const config = ConfigService.getServerConfig();
+    const platform = await PlatformExpress.bootstrap(Server, config);
     await platform.listen();
 
     process.on('SIGINT', () => {

api/authentication/src/models/ConfigJWTModel.ts

@@ -0,0 +1,28 @@
+import { Enum, Required } from '@tsed/schema';
+import { Algorithm } from 'jsonwebtoken';
+
+export class ConfigJWTModel {
+  @Required()
+  @Enum(
+    'HS256',
+    'HS384',
+    'HS512',
+    'RS256',
+    'RS384',
+    'RS512',
+    'ES256',
+    'ES384',
+    'ES512',
+    'PS256',
+    'PS384',
+    'PS512',
+    'none'
+  )
+  algorithm!: Algorithm;
+
+  @Required()
+  expiresIn!: string;
+
+  @Required()
+  expiresInRefresh!: string;
+}

api/authentication/src/models/ConfigModel.ts

@@ -0,0 +1,11 @@
+import { MongoDBConfigModel } from '@hikers-book/tsed-common/models';
+import { Required } from '@tsed/schema';
+import { ConfigJWTModel } from './ConfigJWTModel';
+
+export class ConfigModel {
+  @Required()
+  jwt!: ConfigJWTModel;
+
+  @Required()
+  mongodb!: MongoDBConfigModel;
+}

api/authentication/src/providers/ConfigProvider.ts

@@ -0,0 +1,7 @@
+import { registerProvider } from '@tsed/di';
+import { ConfigService } from '../services/ConfigService';
+
+registerProvider({
+  provide: ConfigService,
+  useClass: ConfigService
+});

api/authentication/src/services/ConfigService.ts

@@ -0,0 +1,28 @@
+import { ConfigServiceBase } from '@hikers-book/tsed-common/services';
+import { Injectable } from '@tsed/di';
+import { ConfigModel } from '../models/ConfigModel';
+
+@Injectable()
+export class ConfigService extends ConfigServiceBase<ConfigModel> {
+  static api = "Hiker's Book Authentication API";
+  static port = 5501;
+
+  constructor() {
+    super(ConfigService.api, ConfigService.port, ConfigModel);
+  }
+
+  static getServerConfig(): Partial<TsED.Configuration> {
+    const config = ConfigServiceBase.load(ConfigService.api, ConfigService.port, ConfigModel);
+
+    return {
+      ...config.base,
+      mongoose: [
+        {
+          id: 'authentication',
+          url: config.file.mongodb.url,
+          connectionOptions: config.file.mongodb.connectionOptions
+        }
+      ]
+    };
+  }
+}