@ghentcdh/authentication-api 0.0.0 → 0.0.2-10

package/README.md

@@ -1,7 +1,86 @@
-# authentication-api
+GhentCdh Keycloak libraries for authentication
 
-This library was generated with [Nx](https://nx.dev).
 
-## Building
+# Backend nestjs
 
-Run `nx build authentication-api` to build the library.
+## Install the libraries
+
+```ssh
+pnpm add @ghentcdh/auth/vue @ghentcdh/auth/backend
+```
+
+Add following environment variables to the `.env` file.
+
+```
+      - KEYCLOAK_HOST=$KEYCLOAK_HOST
+      - KEYCLOAK_REALM=$KEYCLOAK_REALM
+```
+
+### Secure requests
+
+Add the module to your module.ts imports
+
+```typescript
+
+import {AuthenticationApiModule} from "@ghentcdh/authentication-api";
+
+@Module({
+    imports: [AuthenticationApiModule],
+})
+export class MyModule {
+}
+
+```
+
+Extend the `GhentCdhGuard` decorator to secure your routes
+
+
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { GhentCdhGuard } from '@ghentcdh/authentication-api';
+import { HttpService } from '@nestjs/axios';
+import { ConfigService } from '@nestjs/config';
+
+@Injectable()
+export class MyGuard extends GhentCdhGuard {
+  constructor(_httpService: HttpService, _configService: ConfigService) {
+    super(_httpService, _configService);
+  }
+}
+
+```
+
+Use the guard in your controller
+
+```typescript
+import {MyGuard} from "./my.guard";
+
+@Controller()
+export class MyController {
+    @UseGuards(MyGuard)
+    @Post('/secure')
+    async securePath(@User() user: any, @Request() req: any) {
+        return user;
+    }
+}
+```
+
+The `@User()` decorator will give you the user object from the keycloak token.
+
+
+> TODO list
+> - [ ] Add roles decorator and implement logic `@GhentCdhRoles(['admin'])`
+
+## Development environment
+
+Make sure the following is added to your hosts file, if you are running a local keycloak instance. Internally the docker
+containers cannot connect to the localhost:8080 port, so a hook is needed in terms of host rewrite.
+
+```sh
+echo "127.0.0.1 authentication\n" | sudo tee -a /etc/hosts
+```
+
+## Setup docker
+
+> TODO describe me

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@ghentcdh/authentication-api",
-  "version": "0.0.0",
+  "license": "MIT",
+  "version": "0.0.2-10",
   "type": "commonjs",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -14,7 +15,6 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/GhentCDH/ghentcdh-monorepo.git",
-    "directory": "libs/authentication/api"
+    "url": "https://github.com/GhentCDH/ghentcdh-monorepo.git"
   }
 }

package/src/lib/auth.guard.d.ts

@@ -2,7 +2,6 @@ import { HttpService } from '@nestjs/axios';
 import type { CanActivate, ExecutionContext } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import type { Observable } from 'rxjs';
-export declare const AUTH_NAME = "keycloack";
 export declare class GhentCdhGuard implements CanActivate {
     private readonly httpService;
     private readonly configService;

package/src/lib/auth.guard.js

@@ -1,14 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GhentCdhGuard = exports.AUTH_NAME = void 0;
-const tslib_1 = require("tslib");
-const axios_1 = require("@nestjs/axios");
+exports.GhentCdhGuard = void 0;
 const common_1 = require("@nestjs/common");
-const config_1 = require("@nestjs/config");
 const rxjs_1 = require("rxjs");
 const auth_const_1 = require("./auth.const");
-exports.AUTH_NAME = 'keycloack';
-let GhentCdhGuard = class GhentCdhGuard {
+class GhentCdhGuard {
     constructor(httpService, configService) {
         this.httpService = httpService;
         this.configService = configService;
@@ -42,11 +38,6 @@ let GhentCdhGuard = class GhentCdhGuard {
         }
         throw new common_1.UnauthorizedException();
     }
-};
+}
 exports.GhentCdhGuard = GhentCdhGuard;
-exports.GhentCdhGuard = GhentCdhGuard = tslib_1.__decorate([
-    (0, common_1.Injectable)(),
-    tslib_1.__metadata("design:paramtypes", [axios_1.HttpService,
-        config_1.ConfigService])
-], GhentCdhGuard);
 //# sourceMappingURL=auth.guard.js.map

package/src/lib/auth.guard.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.guard.js","sourceRoot":"","sources":["../../../../../../libs/authentication/api/src/lib/auth.guard.ts"],"names":[],"mappings":";;;;AACA,yCAA6C;AAE7C,2CAAmE;AACnE,2CAAgD;AAEhD,+BAAsC;AAGtC,6CAAyC;AAE5B,QAAA,SAAS,GAAG,WAAW,CAAC;AAG9B,IAAM,aAAa,GAAnB,MAAM,aAAa;IACxB,YACmB,WAAwB,EACxB,aAA4B;QAD5B,gBAAW,GAAX,WAAW,CAAa;QACxB,kBAAa,GAAb,aAAa,CAAe;IAC5C,CAAC;IAEJ,WAAW,CACT,OAAyB;QAEzB,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QAEpD,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;QAEpD,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,sBAAS,CAAC,IAAI,CAAC,CAAC;YAC5D,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,sBAAS,CAAC,KAAK,CAAC,CAAC;YAG1D,MAAM,GAAG,GAAG,GAAG,YAAY,UAAU,SAAS,mCAAmC,CAAC;YAElF,OAAO,IAAA,qBAAc,EACnB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE;gBACxB,OAAO,EAAE;oBACP,uEAAuE;oBACvE,aAAa,EAAE,aAAa;oBAC5B,mBAAmB,EAAE,gBAAgB;iBACtC;aACF,CAAC,CACH;iBACE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,yDAAyD;gBACzD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBAC5B,MAAM,IAAI,8BAAqB,EAAE,CAAC;gBACpC,CAAC;gBAED,0DAA0D;gBAC1D,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAE7B,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,MAAM,IAAI,8BAAqB,EAAE,CAAC;YACpC,CAAC,CAAC,CAAC;QACP,CAAC;QAED,MAAM,IAAI,8BAAqB,EAAE,CAAC;IACpC,CAAC;CACF,CAAA;AA/CY,sCAAa;wBAAb,aAAa;IADzB,IAAA,mBAAU,GAAE;6CAGqB,mBAAW;QACT,sBAAa;GAHpC,aAAa,CA+CzB"}
+{"version":3,"file":"auth.guard.js","sourceRoot":"","sources":["../../../../../../libs/authentication/api/src/lib/auth.guard.ts"],"names":[],"mappings":";;;AAGA,2CAAmE;AAGnE,+BAAsC;AAGtC,6CAAyC;AAEzC,MAAa,aAAa;IACxB,YACmB,WAAwB,EACxB,aAA4B;QAD5B,gBAAW,GAAX,WAAW,CAAa;QACxB,kBAAa,GAAb,aAAa,CAAe;IAC5C,CAAC;IAEJ,WAAW,CACT,OAAyB;QAEzB,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QAEpD,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;QAEpD,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,sBAAS,CAAC,IAAI,CAAC,CAAC;YAC5D,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,sBAAS,CAAC,KAAK,CAAC,CAAC;YAG1D,MAAM,GAAG,GAAG,GAAG,YAAY,UAAU,SAAS,mCAAmC,CAAC;YAElF,OAAO,IAAA,qBAAc,EACnB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE;gBACxB,OAAO,EAAE;oBACP,uEAAuE;oBACvE,aAAa,EAAE,aAAa;oBAC5B,mBAAmB,EAAE,gBAAgB;iBACtC;aACF,CAAC,CACH;iBACE,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjB,yDAAyD;gBACzD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBAC5B,MAAM,IAAI,8BAAqB,EAAE,CAAC;gBACpC,CAAC;gBAED,0DAA0D;gBAC1D,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;gBAE7B,OAAO,IAAI,CAAC;YACd,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,MAAM,IAAI,8BAAqB,EAAE,CAAC;YACpC,CAAC,CAAC,CAAC;QACP,CAAC;QAED,MAAM,IAAI,8BAAqB,EAAE,CAAC;IACpC,CAAC;CACF;AA/CD,sCA+CC"}

package/src/lib/authentication-api.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"authentication-api.module.js","sourceRoot":"","sources":["../../../../../../libs/authentication/api/src/lib/authentication-api.module.ts"],"names":[],"mappings":";;;;AAAA,yCAA2C;AAC3C,2CAAwC;AACxC,2CAA8C;AAE9C,yDAAqD;AAQ9C,IAAM,uBAAuB,GAA7B,MAAM,uBAAuB;CAAG,CAAA;AAA1B,0DAAuB;kCAAvB,uBAAuB;IANnC,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,kBAAU,EAAE,qBAAY,CAAC;QACnC,WAAW,EAAE,CAAC,kCAAe,CAAC;QAC9B,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,EAAE;KACZ,CAAC;GACW,uBAAuB,CAAG"}
+{"version":3,"file":"authentication-api.module.js","sourceRoot":"","sources":["../../../../../../libs/authentication/api/src/lib/authentication-api.module.ts"],"names":[],"mappings":";;;;AAAA,yCAA2C;AAC3C,2CAAwC;AACxC,2CAA8C;AAG9C,yDAAqD;AAQ9C,IAAM,uBAAuB,GAA7B,MAAM,uBAAuB;CAAG,CAAA;AAA1B,0DAAuB;kCAAvB,uBAAuB;IANnC,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,kBAAU,EAAE,qBAAY,CAAC;QACnC,WAAW,EAAE,CAAC,kCAAe,CAAC;QAC9B,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,EAAE;KACZ,CAAC;GACW,uBAAuB,CAAG"}