From 69212bcb5b399d1bada303d6cd8eaa459c3cd977 Mon Sep 17 00:00:00 2001
From: Sunny Tyagi <107617248+Tyagi-Sunny@users.noreply.github.com>
Date: Wed, 3 Jan 2024 11:25:56 +0530
Subject: [PATCH] techdocs updated (#197)
---
README.md => docs/README.md | 0
docs/index.md | 2993 -----------------------------------
mkdocs.yml | 3 -
3 files changed, 2996 deletions(-)
rename README.md => docs/README.md (100%)
delete mode 100644 docs/index.md
diff --git a/README.md b/docs/README.md
similarity index 100%
rename from README.md
rename to docs/README.md
diff --git a/docs/index.md b/docs/index.md
deleted file mode 100644
index 4157840..0000000
--- a/docs/index.md
+++ /dev/null
@@ -1,2993 +0,0 @@
-
-
-# [loopback4-authentication](https://github.com/sourcefuse/loopback4-authentication)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-## Overview
-
-This is a loopback-next extension for adding authentication layer to a REST application in loopback 4.
-This extension is based on the implementation guidelines provided on official [@loopback/authentication](https://github.com/strongloop/loopback-next/blob/master/packages/authentication/README.md) page.
-It provides support for seven passport based strategies.
-
-1. [passport-oauth2-client-password](https://github.com/jaredhanson/passport-oauth2-client-password) - OAuth 2.0 client password authentication strategy for Passport. This module lets you authenticate requests containing client credentials in the request body, as [defined](http://tools.ietf.org/html/draft-ietf-oauth-v2-27#section-2.3.1) by the OAuth 2.0 specification.
-2. [passport-http-bearer](https://github.com/jaredhanson/passport-http-bearer) - HTTP Bearer authentication strategy for Passport. This module lets you authenticate HTTP requests using bearer tokens, as specified by [RFC 6750](https://tools.ietf.org/html/rfc6750), in your Node.js applications.
-3. [passport-local](https://github.com/jaredhanson/passport-local) - Passport strategy for authenticating with a username and password. This module lets you authenticate using a username and password in your Node.js applications.
-4. [passport-oauth2-resource-owner-password](https://www.npmjs.com/package/passport-oauth2-resource-owner-password) - OAuth 2.0 resource owner password authentication strategy for Passport. This module lets you authenticate requests containing resource owner credentials in the request body, as [defined](http://tools.ietf.org/html/draft-ietf-oauth-v2-27#section-1.3.3) by the OAuth 2.0 specification.
-5. [passport-google-oauth2](https://github.com/jaredhanson/passport-google-oauth2) - Passport strategy for authenticating with Google using the Google OAuth 2.0 API. This module lets you authenticate using Google in your Node.js applications.
-6. [keycloak-passport](https://github.com/exlinc/keycloak-passport) - Passport strategy for authenticating with Keycloak. This library offers a production-ready and maintained Keycloak Passport connector.
-7. [passport-instagram](https://github.com/jaredhanson/passport-instagram) - Passport strategy for authenticating with Instagram using the Instagram OAuth 2.0 API. This module lets you authenticate using Instagram in your Node.js applications.
-8. [passport-apple](https://github.com/ananay/passport-apple) - Passport strategy for authenticating with Apple using the Apple OAuth 2.0 API. This module lets you authenticate using Apple in your Node.js applications.
-9. [passport-facebook](https://github.com/jaredhanson/passport-facebook) - Passport strategy for authenticating with Facebook using the Facebook OAuth 2.0 API. This module lets you authenticate using Facebook in your Node.js applications.
-10. [passport-cognito-oauth2](https://github.com/ebuychance/passport-cognito-oauth2) - Passport strategy for authenticating with Cognito using the Cognito OAuth 2.0 API. This module lets you authenticate using Cognito in your Node.js applications.
-11. [passport-SAML](https://github.com/node-saml/passport-saml) - Passport strategy for authenticating with SAML using the SAML 2.0 API. This module lets you authenticate using SAML in your Node.js applications
-12. custom-passport-otp - Created a Custom Passport strategy for 2-Factor-Authentication using OTP (One Time Password).
-
-You can use one or more strategies of the above in your application. For each of the strategy (only which you use), you just need to provide your own verifier function, making it easily configurable. Rest of the strategy implementation intricacies is handled by extension.
-
-## Install
-
-```sh
-npm install loopback4-authentication
-```
-
-## Quick Starter
-
-For a quick starter guide, you can refer to our [loopback 4 starter](https://github.com/sourcefuse/loopback4-starter) application which utilizes all of the above auth strategies from the extension in a simple multi-tenant application. Refer to the auth module [there](https://github.com/sourcefuse/loopback4-starter/tree/master/src/modules/auth) for specific details on authentication.
-
-## Detailed Usage
-
-The first and common step for all of the startegies is to add the component to the application. See below
-
-```ts
-// application.ts
-export class ToDoApplication extends BootMixin(
- ServiceMixin(RepositoryMixin(RestApplication)),
-) {
- constructor(options: ApplicationConfig = {}) {
- super(options);
-
- // Set up the custom sequence
- this.sequence(MySequence);
-
- // Set up default home page
- this.static('/', path.join(__dirname, '../public'));
-
- // Add authentication component
- this.component(AuthenticationComponent);
-
- // .... Rest of the code below
- }
-}
-```
-
-Once this is done, you are ready to configure any of the available strategy in the application.
-
-### Oauth2-client-password
-
-In order to use it, run `npm install passport-oauth2-client-password`.
-First, create an AuthClient model implementing the IAuthClient interface. The purpose of this model is to store oauth registered clients for the app in the DB. See sample below.
-
-```ts
-@model({
- name: 'auth_clients',
-})
-export class AuthClient extends Entity implements IAuthClient {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
-
- @property({
- type: 'string',
- required: true,
- name: 'client_id',
- })
- clientId: string;
-
- @property({
- type: 'string',
- required: true,
- name: 'client_secret',
- })
- clientSecret: string;
-
- @property({
- type: 'array',
- itemType: 'number',
- name: 'user_ids',
- })
- userIds: number[];
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Create CRUD repository for the above model. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same strategy. You can add your application specific business logic for client auth here. Here is simple example.
-
-```ts
-import {Provider} from '@loopback/context';
-import {repository} from '@loopback/repository';
-import {VerifyFunction} from 'loopback4-authentication';
-
-import {AuthClientRepository} from '../../../repositories';
-
-export class ClientPasswordVerifyProvider
- implements Provider
-{
- constructor(
- @repository(AuthClientRepository)
- public authClientRepository: AuthClientRepository,
- ) {}
-
- value(): VerifyFunction.OauthClientPasswordFn {
- return async (clientId, clientSecret, req) => {
- return this.authClientRepository.findOne({
- where: {
- clientId,
- clientSecret,
- },
- });
- };
- }
-}
-```
-
-Please note the Verify function type _VerifyFunction.OauthClientPasswordFn_.
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.OAUTH2_CLIENT_PASSWORD_VERIFIER).toProvider(
- ClientPasswordVerifyProvider,
-);
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- // Inject CLIENT_AUTH_ACTION sequence action provider
- @inject(AuthenticationBindings.CLIENT_AUTH_ACTION)
- protected authenticateRequestClient: AuthenticateFn,
- ) {}
-
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
-
- // Perform client authentication here
- await this.authenticateRequestClient(request);
-
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-After this, you can use decorator to apply auth to controller functions wherever needed. See below.
-
-```ts
-@authenticateClient(STRATEGY.CLIENT_PASSWORD, {
- passReqToCallback: true
-})
-@post('/auth/login', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Auth Code',
- content: {
- [CONTENT_TYPE.JSON]: Object,
- },
- },
- },
-})
-async login(
- @requestBody()
- req: LoginRequest,
-): Promise<{
- code: string;
-}> {
- ....
-}
-```
-
-For accessing the authenticated AuthClient model reference, you can inject the CURRENT_CLIENT provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_CLIENT)
- private readonly getCurrentClient: Getter,
-```
-
-### Http-bearer
-
-In order to use it, run `npm install passport-http-bearer`.
-First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
-
-```ts
-@model({
- name: 'users',
-})
-export class User extends Entity implements IAuthUser {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
-
- @property({
- type: 'string',
- required: true,
- name: 'first_name',
- })
- firstName: string;
-
- @property({
- type: 'string',
- name: 'last_name',
- })
- lastName: string;
-
- @property({
- type: 'string',
- name: 'middle_name',
- })
- middleName?: string;
-
- @property({
- type: 'string',
- required: true,
- })
- username: string;
-
- @property({
- type: 'string',
- })
- email?: string;
-
- @property({
- type: 'string',
- })
- password?: string;
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Now bind this model to USER_MODEL key in application.ts
-
-```ts
-this.bind(AuthenticationBindings.USER_MODEL).to(User);
-```
-
-Create CRUD repository for the above model. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same. You can add your application specific business logic for client auth here. Here is simple example for JWT tokens.
-
-```ts
-import {Provider} from '@loopback/context';
-import {repository} from '@loopback/repository';
-import {verify} from 'jsonwebtoken';
-import {VerifyFunction} from 'loopback4-authentication';
-
-import {User} from '../models/user.model';
-
-export class BearerTokenVerifyProvider
- implements Provider
-{
- constructor(
- @repository(RevokedTokenRepository)
- public revokedTokenRepository: RevokedTokenRepository,
- ) {}
-
- value(): VerifyFunction.BearerFn {
- return async (token) => {
- if (token && (await this.revokedTokenRepository.get(token))) {
- throw new HttpErrors.Unauthorized('Token Revoked');
- }
- const user = verify(token, process.env.JWT_SECRET as string, {
- issuer: process.env.JWT_ISSUER,
- }) as User;
- return user;
- };
- }
-}
-```
-
-The above example has an import and injection of a RevokedTokenRepository, which could be used to keep track of revoked tokens in a datasource like Redis. You can find an implementation of this repository [here](https://github.com/sourcefuse/loopback4-starter/blob/master/src/repositories/revoked-token.repository.ts) and the Redis datasource [here](https://github.com/sourcefuse/loopback4-starter/blob/master/src/datasources/redis.datasource.ts).
-
-Please note the Verify function type _VerifyFunction.BearerFn_
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.BEARER_TOKEN_VERIFIER).toProvider(
- BearerTokenVerifyProvider,
-);
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- @inject(AuthenticationBindings.USER_AUTH_ACTION)
- protected authenticateRequest: AuthenticateFn,
- ) {}
-
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
-
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
- const authUser: AuthUser = await this.authenticateRequest(request);
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-After this, you can use decorator to apply auth to controller functions wherever needed. See below.
-
-```ts
-@authenticate(STRATEGY.BEARER)
-@get('/users', {
- responses: {
- '200': {
- description: 'Array of User model instances',
- content: {
- 'application/json': {
- schema: {type: 'array', items: {'x-ts-type': User}},
- },
- },
- },
- },
-})
-async find(
- @param.query.object('filter', getFilterSchemaFor(User)) filter?: Filter,
-): Promise {
- return await this.userRepository.find(filter);
-}
-```
-
-For accessing the authenticated AuthUser model reference, you can inject the CURRENT_USER provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_USER)
- private readonly getCurrentUser: Getter,
-```
-
-### local
-
-In order to use it, run `npm install passport-local`.
-First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
-
-```ts
-@model({
- name: 'users',
-})
-export class User extends Entity implements IAuthUser {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
-
- @property({
- type: 'string',
- required: true,
- name: 'first_name',
- })
- firstName: string;
-
- @property({
- type: 'string',
- name: 'last_name',
- })
- lastName: string;
-
- @property({
- type: 'string',
- name: 'middle_name',
- })
- middleName?: string;
-
- @property({
- type: 'string',
- required: true,
- })
- username: string;
-
- @property({
- type: 'string',
- })
- email?: string;
-
- @property({
- type: 'string',
- })
- password?: string;
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Now bind this model to USER_MODEL key in application.ts
-
-```ts
-this.bind(AuthenticationBindings.USER_MODEL).to(User);
-```
-
-Create CRUD repository for the above model. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same. You can add your application specific business logic for client auth here. Here is a simple example.
-
-```ts
-export class LocalPasswordVerifyProvider
- implements Provider
-{
- constructor(
- @repository(UserRepository)
- public userRepository: UserRepository,
- ) {}
-
- value(): VerifyFunction.LocalPasswordFn {
- return async (username: any, password: any) => {
- try {
- const user: AuthUser = new AuthUser(
- await this.userRepository.verifyPassword(username, password),
- );
- return user;
- } catch (error) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials)
- .message;
- }
- };
- }
-}
-```
-
-Please note the Verify function type _VerifyFunction.LocalPasswordFn_
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.LOCAL_PASSWORD_VERIFIER).toProvider(
- LocalPasswordVerifyProvider,
-);
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- @inject(AuthenticationBindings.USER_AUTH_ACTION)
- protected authenticateRequest: AuthenticateFn,
- ) {}
-
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
-
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
- const authUser: AuthUser = await this.authenticateRequest(request);
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-After this, you can use decorator to apply auth to controller functions wherever needed. See below.
-
-```ts
- @authenticate(STRATEGY.LOCAL)
- @post('/auth/login', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Auth Code',
- content: {
- [CONTENT_TYPE.JSON]: Object,
- },
- },
- },
- })
- async login(
- @requestBody()
- req: LoginRequest,
- ): Promise<{
- code: string;
- }> {
- ......
- }
-```
-
-For accessing the authenticated AuthUser model reference, you can inject the CURRENT_USER provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_USER)
- private readonly getCurrentUser: Getter,
-```
-
-### Oauth2-resource-owner-password
-
-In order to use it, run `npm install passport-oauth2-resource-owner-password`.
-First, create an AuthClient model implementing the IAuthClient interface. The purpose of this model is to store oauth registered clients for the app in the DB. See sample below.
-
-```ts
-@model({
- name: 'auth_clients',
-})
-export class AuthClient extends Entity implements IAuthClient {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
-
- @property({
- type: 'string',
- required: true,
- name: 'client_id',
- })
- clientId: string;
-
- @property({
- type: 'string',
- required: true,
- name: 'client_secret',
- })
- clientSecret: string;
-
- @property({
- type: 'array',
- itemType: 'number',
- name: 'user_ids',
- })
- userIds: number[];
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Next, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
-
-```ts
-@model({
- name: 'users',
-})
-export class User extends Entity implements IAuthUser {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
-
- @property({
- type: 'string',
- required: true,
- name: 'first_name',
- })
- firstName: string;
-
- @property({
- type: 'string',
- name: 'last_name',
- })
- lastName: string;
-
- @property({
- type: 'string',
- name: 'middle_name',
- })
- middleName?: string;
-
- @property({
- type: 'string',
- required: true,
- })
- username: string;
-
- @property({
- type: 'string',
- })
- email?: string;
-
- @property({
- type: 'string',
- })
- password?: string;
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Now bind this model to USER_MODEL key in application.ts
-
-```ts
-this.bind(AuthenticationBindings.USER_MODEL).to(User);
-```
-
-Create CRUD repository for both of the above models. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same. You can add your application specific business logic for client auth here. Here is a simple example.
-
-```ts
-export class ResourceOwnerVerifyProvider
- implements Provider
-{
- constructor(
- @repository(UserRepository)
- public userRepository: UserRepository,
- @repository(AuthClientRepository)
- public authClientRepository: AuthClientRepository,
- ) {}
-
- value(): VerifyFunction.ResourceOwnerPasswordFn {
- return async (clientId, clientSecret, username, password) => {
- const user = await this.userRepository.verifyPassword(username, password);
- if (!user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- const client = await this.authClientRepository.findOne({
- where: {
- clientId,
- },
- });
- if (!client || client.userIds.indexOf(user.id || 0) < 0) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- } else if (!client.clientSecret || client.clientSecret !== clientSecret) {
- throw new HttpErrors.Unauthorized(
- AuthErrorKeys.ClientVerificationFailed,
- );
- }
- return {
- client,
- user,
- };
- };
- }
-}
-```
-
-Please note the Verify function type _VerifyFunction.LocalPasswordFn_.
-Also, in this case, verifier will return AuthClient as well as User model.
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.RESOURCE_OWNER_PASSWORD_VERIFIER).toProvider(
- ResourceOwnerVerifyProvider,
-);
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- @inject(AuthenticationBindings.USER_AUTH_ACTION)
- protected authenticateRequest: AuthenticateFn,
- ) {}
-
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
-
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
- const authUser: AuthUser = await this.authenticateRequest(request);
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-After this, you can use decorator to apply auth to controller functions wherever needed. See below.
-
-```ts
- @authenticate(STRATEGY.OAUTH2_RESOURCE_OWNER_GRANT)
- @post('/auth/login-token', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Token Response Model',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async loginWithClientUser(
- @requestBody() req: LoginRequest,
- ): Promise {
- ......
- }
-```
-
-For accessing the authenticated AuthUser and AuthClient model reference, you can inject the CURRENT_USER and CURRENT_CLIENT provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_USER)
- private readonly getCurrentUser: Getter,
- @inject.getter(AuthenticationBindings.CURRENT_CLIENT)
- private readonly getCurrentClient: Getter,
-```
-
-### OTP
-
-First, create a OtpCache model. This model should have OTP and few details of user and client (which will be used to retrieve them from database), it will be used to verify otp and get user, client. See sample below.
-
-```ts
-@model()
-export class OtpCache extends Entity {
- @property({
- type: 'string',
- })
- otp: string;
-
- @property({
- type: 'string',
- })
- userId: string;
-
- @property({
- type: 'string',
- })
- clientId: string;
-
- @property({
- type: 'string',
- })
- clientSecret: string;
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Create [redis-repository](https://loopback.io/doc/en/lb4/Repository.html#define-a-keyvaluerepository) for the above model. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Here is a simple example.
-
-```ts
-import {OtpCache} from '../models';
-import {AuthCacheSourceName} from 'loopback4-authentication';
-
-export class OtpCacheRepository extends DefaultKeyValueRepository {
- constructor(
- @inject(`datasources.${AuthCacheSourceName}`)
- dataSource: juggler.DataSource,
- ) {
- super(OtpCache, dataSource);
- }
-}
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same. You can add your application specific business logic for auth here. Here is a simple example.
-
-```ts
-export class OtpVerifyProvider implements Provider {
- constructor(
- @repository(UserRepository)
- public userRepository: UserRepository,
- @repository(OtpCacheRepository)
- public otpCacheRepo: OtpCacheRepository,
- ) {}
-
- value(): VerifyFunction.OtpAuthFn {
- return async (key: string, otp: string) => {
- const otpCache = await this.otpCacheRepo.get(key);
- if (!otpCache) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- if (otpCache.otp.toString() !== otp) {
- throw new HttpErrors.Unauthorized('Invalid OTP');
- }
- return this.userRepository.findById(otpCache.userId);
- };
- }
-}
-```
-
-Please note the Verify function type _VerifyFunction.OtpAuthFn_
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.OTP_VERIFIER).toProvider(OtpVerifyProvider);
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- @inject(AuthenticationBindings.USER_AUTH_ACTION)
- protected authenticateRequest: AuthenticateFn,
- ) {}
-
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
-
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
- const authUser: AuthUser = await this.authenticateRequest(request);
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-Then, you need to create APIs, where you will first authenticate the user, and then send the OTP to user's email/phone. See below.
-
-```ts
- //You can use your other strategies also
- @authenticate(STRATEGY.LOCAL)
- @post('/auth/send-otp', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Send Otp',
- content: {
- [CONTENT_TYPE.JSON]: Object,
- },
- },
- },
- })
- async login(
- @requestBody()
- req: LoginRequest,
- ): Promise<{
- key: string;
- }> {
-
- // User is authenticated before this step.
- // Now follow these steps:
- // 1. Create a unique key.
- // 2. Generate and send OTP to user's email/phone.
- // 3. Store the details in redis-cache using key created in step-1. (Refer OtpCache model mentioned above)
- // 4. Response will be the key created in step-1
- }
-```
-
-After this, create an API with @@authenticate(STRATEGY.OTP) decorator. See below.
-
-```ts
- @authenticate(STRATEGY.OTP)
- @post('/auth/login-otp', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Auth Code',
- content: {
- [CONTENT_TYPE.JSON]: Object,
- },
- },
- },
- })
- async login(
- @requestBody()
- req: {
- key: 'string';
- otp: 'string';
- },
- ): Promise<{
- code: string;
- }> {
- ......
- }
-```
-
-For accessing the authenticated AuthUser model reference, you can inject the CURRENT_USER provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_USER)
- private readonly getCurrentUser: Getter,
-```
-
-### Google Oauth 2
-
-In order to use it, run `npm install passport-google-oauth20` and `npm install @types/passport-google-oauth20`.
-First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
-
-```ts
-@model({
- name: 'users',
-})
-export class User extends Entity implements IAuthUser {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
-
- @property({
- type: 'string',
- required: true,
- name: 'first_name',
- })
- firstName: string;
-
- @property({
- type: 'string',
- name: 'last_name',
- })
- lastName: string;
-
- @property({
- type: 'string',
- name: 'middle_name',
- })
- middleName?: string;
-
- @property({
- type: 'string',
- required: true,
- })
- username: string;
-
- @property({
- type: 'string',
- })
- email?: string;
-
- // Auth provider - 'google'
- @property({
- type: 'string',
- required: true,
- name: 'auth_provider',
- })
- authProvider: string;
-
- // Id from external provider
- @property({
- type: 'string',
- name: 'auth_id',
- })
- authId?: string;
-
- @property({
- type: 'string',
- name: 'auth_token',
- })
- authToken?: string;
-
- @property({
- type: 'string',
- })
- password?: string;
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Now bind this model to USER_MODEL key in application.ts
-
-```ts
-this.bind(AuthenticationBindings.USER_MODEL).to(User);
-```
-
-Create CRUD repository for the above model. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same. You can add your application specific business logic for client auth here. Here is a simple example.
-
-```ts
-import {Provider} from '@loopback/context';
-import {repository} from '@loopback/repository';
-import {HttpErrors} from '@loopback/rest';
-import {AuthErrorKeys, VerifyFunction} from 'loopback4-authentication';
-
-import {Tenant} from '../../../models';
-import {UserCredentialsRepository, UserRepository} from '../../../repositories';
-import {AuthUser} from '../models/auth-user.model';
-
-export class GoogleOauth2VerifyProvider
- implements Provider
-{
- constructor(
- @repository(UserRepository)
- public userRepository: UserRepository,
- @repository(UserCredentialsRepository)
- public userCredsRepository: UserCredentialsRepository,
- ) {}
-
- value(): VerifyFunction.GoogleAuthFn {
- return async (accessToken, refreshToken, profile) => {
- const user = await this.userRepository.findOne({
- where: {
- /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
- email: (profile as any)._json.email,
- },
- });
- if (!user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- if (
- !user ||
- user.authProvider !== 'google' ||
- user.authId !== profile.id
- ) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
-
- const authUser: AuthUser = new AuthUser(user);
- authUser.permissions = [];
- authUser.externalAuthToken = accessToken;
- authUser.externalRefreshToken = refreshToken;
- authUser.tenant = new Tenant({id: user.defaultTenant});
- return authUser;
- };
- }
-}
-```
-
-Please note the Verify function type _VerifyFunction.LocalPasswordFn_
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.GOOGLE_OAUTH2_VERIFIER).toProvider(
- GoogleOauth2VerifyProvider,
-);
-```
-
-Now, bind this provider to the application in application.ts.
-
-```ts
-import { GoogleAuthStrategyFactoryProvider } from 'loopback4-authentication/passport-google-oauth2';
-```
-
-```ts
-this.bind(Strategies.Passport.GOOGLE_OAUTH2_STRATEGY_FACTORY.key).toProvider(
- GoogleAuthStrategyFactoryProvider
- );
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- @inject(AuthenticationBindings.USER_AUTH_ACTION)
- protected authenticateRequest: AuthenticateFn,
- ) {}
-
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
-
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
- const authUser: AuthUser = await this.authenticateRequest(
- request,
- response,
- );
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-After this, you can use decorator to apply auth to controller functions wherever needed. See below.
-
-```ts
-@authenticateClient(STRATEGY.CLIENT_PASSWORD)
- @authenticate(
- STRATEGY.GOOGLE_OAUTH2,
- {
- accessType: 'offline',
- scope: ['profile', 'email'],
- authorizationURL: process.env.GOOGLE_AUTH_URL,
- callbackURL: process.env.GOOGLE_AUTH_CALLBACK_URL,
- clientID: process.env.GOOGLE_AUTH_CLIENT_ID,
- clientSecret: process.env.GOOGLE_AUTH_CLIENT_SECRET,
- tokenURL: process.env.GOOGLE_AUTH_TOKEN_URL,
- },
- (req: Request) => {
- return {
- accessType: 'offline',
- state: Object.keys(req.query)
- .map(key => key + '=' + req.query[key])
- .join('&'),
- };
- },
- )
- @authorize(['*'])
- @get('/auth/google', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async loginViaGoogle(
- @param.query.string('client_id')
- clientId?: string,
- @param.query.string('client_secret')
- clientSecret?: string,
- ): Promise {}
-
- @authenticate(
- STRATEGY.GOOGLE_OAUTH2,
- {
- accessType: 'offline',
- scope: ['profile', 'email'],
- authorizationURL: process.env.GOOGLE_AUTH_URL,
- callbackURL: process.env.GOOGLE_AUTH_CALLBACK_URL,
- clientID: process.env.GOOGLE_AUTH_CLIENT_ID,
- clientSecret: process.env.GOOGLE_AUTH_CLIENT_SECRET,
- tokenURL: process.env.GOOGLE_AUTH_TOKEN_URL,
- },
- (req: Request) => {
- return {
- accessType: 'offline',
- state: Object.keys(req.query)
- .map(key => `${key}=${req.query[key]}`)
- .join('&'),
- };
- },
- )
- @authorize(['*'])
- @get('/auth/google-auth-redirect', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async googleCallback(
- @param.query.string('code') code: string,
- @param.query.string('state') state: string,
- @inject(RestBindings.Http.RESPONSE) response: Response,
- ): Promise {
- const clientId = new URLSearchParams(state).get('client_id');
- if (!clientId || !this.user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- const client = await this.authClientRepository.findOne({
- where: {
- clientId: clientId,
- },
- });
- if (!client || !client.redirectUrl) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- try {
- const codePayload: ClientAuthCode = {
- clientId,
- user: this.user,
- };
- const token = jwt.sign(codePayload, client.secret, {
- expiresIn: client.authCodeExpiration,
- audience: clientId,
- subject: this.user.username,
- issuer: process.env.JWT_ISSUER,
- });
- response.redirect(`${client.redirectUrl}?code=${token}`);
- } catch (error) {
- throw new HttpErrors.InternalServerError(AuthErrorKeys.UnknownError);
- }
- }
-```
-
-Please note above that we are creating two new APIs for google auth. The first one is for UI clients to hit. We are authenticating client as well, then passing the details to the google auth. Then, the actual authentication is done by google authorization url, which redirects to the second API we created after success. The first API method body is empty as we do not need to handle its response. The google auth provider in this package will do the redirection for you automatically.
-
-For accessing the authenticated AuthUser model reference, you can inject the CURRENT_USER provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_USER)
- private readonly getCurrentUser: Getter,
-```
-
-### Instagram Oauth 2
-
-In order to use it, run `npm install passport-instagram`.
-First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
-
-```ts
-@model({
- name: 'users',
-})
-export class User extends Entity implements IAuthUser {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
-
- @property({
- type: 'string',
- required: true,
- name: 'first_name',
- })
- firstName: string;
-
- @property({
- type: 'string',
- name: 'last_name',
- })
- lastName: string;
-
- @property({
- type: 'string',
- name: 'middle_name',
- })
- middleName?: string;
-
- @property({
- type: 'string',
- required: true,
- })
- username: string;
-
- @property({
- type: 'string',
- })
- email?: string;
-
- // Auth provider - 'instagram'
- @property({
- type: 'string',
- required: true,
- name: 'auth_provider',
- })
- authProvider: string;
-
- // Id from external provider
- @property({
- type: 'string',
- name: 'auth_id',
- })
- authId?: string;
-
- @property({
- type: 'string',
- name: 'auth_token',
- })
- authToken?: string;
-
- @property({
- type: 'string',
- })
- password?: string;
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Now bind this model to USER_MODEL key in application.ts
-
-```ts
-this.bind(AuthenticationBindings.USER_MODEL).to(User);
-```
-
-Create CRUD repository for the above model. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same. You can add your application specific business logic for client auth here. Here is a simple example.
-
-```ts
-import {Provider} from '@loopback/context';
-import {repository} from '@loopback/repository';
-import {HttpErrors} from '@loopback/rest';
-import {AuthErrorKeys, VerifyFunction} from 'loopback4-authentication';
-
-import {Tenant} from '../../../models';
-import {UserCredentialsRepository, UserRepository} from '../../../repositories';
-import {AuthUser} from '../models/auth-user.model';
-
-export class InstagramOauth2VerifyProvider
- implements Provider
-{
- constructor(
- @repository(UserRepository)
- public userRepository: UserRepository,
- @repository(UserCredentialsRepository)
- public userCredsRepository: UserCredentialsRepository,
- ) {}
-
- value(): VerifyFunction.InstagramAuthFn {
- return async (accessToken, refreshToken, profile) => {
- const user = await this.userRepository.findOne({
- where: {
- /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
- email: (profile as any)._json.email,
- },
- });
- if (!user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- if (
- !user ||
- user.authProvider !== 'instagram' ||
- user.authId !== profile.id
- ) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
-
- const authUser: AuthUser = new AuthUser(user);
- authUser.permissions = [];
- authUser.externalAuthToken = accessToken;
- authUser.externalRefreshToken = refreshToken;
- authUser.tenant = new Tenant({id: user.defaultTenant});
- return authUser;
- };
- }
-}
-```
-
-Please note the Verify function type _VerifyFunction.LocalPasswordFn_
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.INSTAGRAM_OAUTH2_VERIFIER).toProvider(
- InstagramOauth2VerifyProvider,
-);
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- @inject(AuthenticationBindings.USER_AUTH_ACTION)
- protected authenticateRequest: AuthenticateFn,
- ) {}
-
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
-
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
- const authUser: AuthUser = await this.authenticateRequest(
- request,
- response,
- );
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-After this, you can use decorator to apply auth to controller functions wherever needed. See below.
-
-```ts
-@authenticateClient(STRATEGY.CLIENT_PASSWORD)
- @authenticate(
- STRATEGY.INSTAGRAM_OAUTH2,
- {
- accessType: 'offline',
- authorizationURL: process.env.INSTAGRAM_AUTH_URL,
- callbackURL: process.env.INSTAGRAM_AUTH_CALLBACK_URL,
- clientID: process.env.INSTAGRAM_AUTH_CLIENT_ID,
- clientSecret: process.env.INSTAGRAM_AUTH_CLIENT_SECRET,
- tokenURL: process.env.INSTAGRAM_AUTH_TOKEN_URL,
- },
- (req: Request) => {
- return {
- accessType: 'offline',
- state: Object.keys(req.query)
- .map(key => key + '=' + req.query[key])
- .join('&'),
- };
- },
- )
- @authorize(['*'])
- @get('/auth/instagram', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async loginViaInstagram(
- @param.query.string('client_id')
- clientId?: string,
- @param.query.string('client_secret')
- clientSecret?: string,
- ): Promise {}
-
- @authenticate(
- STRATEGY.INSTAGRAM_OAUTH2,
- {
- accessType: 'offline',
- authorizationURL: process.env.INSTAGRAM_AUTH_URL,
- callbackURL: process.env.INSTAGRAM_AUTH_CALLBACK_URL,
- clientID: process.env.INSTAGRAM_AUTH_CLIENT_ID,
- clientSecret: process.env.INSTAGRAM_AUTH_CLIENT_SECRET,
- tokenURL: process.env.INSTAGRAM_AUTH_TOKEN_URL,
- },
- (req: Request) => {
- return {
- accessType: 'offline',
- state: Object.keys(req.query)
- .map(key => `${key}=${req.query[key]}`)
- .join('&'),
- };
- },
- )
- @authorize(['*'])
- @get('/auth/instagram-auth-redirect', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async instagramCallback(
- @param.query.string('code') code: string,
- @param.query.string('state') state: string,
- @inject(RestBindings.Http.RESPONSE) response: Response,
- ): Promise {
- const clientId = new URLSearchParams(state).get('client_id');
- if (!clientId || !this.user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- const client = await this.authClientRepository.findOne({
- where: {
- clientId: clientId,
- },
- });
- if (!client || !client.redirectUrl) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- try {
- const codePayload: ClientAuthCode = {
- clientId,
- user: this.user,
- };
- const token = jwt.sign(codePayload, client.secret, {
- expiresIn: client.authCodeExpiration,
- audience: clientId,
- subject: this.user.username,
- issuer: process.env.JWT_ISSUER,
- });
- response.redirect(`${client.redirectUrl}?code=${token}`);
- } catch (error) {
- throw new HttpErrors.InternalServerError(AuthErrorKeys.UnknownError);
- }
- }
-```
-
-Please note above that we are creating two new APIs for instagram auth. The first one is for UI clients to hit. We are authenticating client as well, then passing the details to the instagram auth. Then, the actual authentication is done by instagram authorization url, which redirects to the second API we created after success. The first API method body is empty as we do not need to handle its response. The instagram auth provider in this package will do the redirection for you automatically.
-
-For accessing the authenticated AuthUser model reference, you can inject the CURRENT_USER provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_USER)
- private readonly getCurrentUser: Getter,
-```
-
-### Apple Oauth 2
-
-In order to use it, run `npm install --save passport-apple`.
-First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
-
-```ts
-@model({
- name: 'users',
-})
-export class User extends Entity implements IAuthUser {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
-
- @property({
- type: 'string',
- required: true,
- name: 'first_name',
- })
- firstName: string;
-
- @property({
- type: 'string',
- name: 'last_name',
- })
- lastName: string;
-
- @property({
- type: 'string',
- name: 'middle_name',
- })
- middleName?: string;
-
- @property({
- type: 'string',
- required: true,
- })
- username: string;
-
- @property({
- type: 'string',
- })
- email?: string;
-
- // Auth provider - 'apple'
- @property({
- type: 'string',
- required: true,
- name: 'auth_provider',
- })
- authProvider: string;
-
- // Id from external provider
- @property({
- type: 'string',
- name: 'auth_id',
- })
- authId?: string;
-
- @property({
- type: 'string',
- name: 'auth_token',
- })
- authToken?: string;
-
- @property({
- type: 'string',
- })
- password?: string;
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Now bind this model to USER_MODEL key in application.ts
-
-```ts
-this.bind(AuthenticationBindings.USER_MODEL).to(User);
-```
-
-Create CRUD repository for the above model. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same. You can add your application specific business logic for client auth here. Here is a simple example.
-
-```ts
-import {Provider} from '@loopback/context';
-import {repository} from '@loopback/repository';
-import {HttpErrors} from '@loopback/rest';
-import {AuthErrorKeys, VerifyFunction} from 'loopback4-authentication';
-
-import {Tenant} from '../../../models';
-import {UserCredentialsRepository, UserRepository} from '../../../repositories';
-import {AuthUser} from '../models/auth-user.model';
-
-export class AppleOauth2VerifyProvider
- implements Provider
-{
- constructor(
- @repository(UserRepository)
- public userRepository: UserRepository,
- @repository(UserCredentialsRepository)
- public userCredsRepository: UserCredentialsRepository,
- ) {}
-
- value(): VerifyFunction.AppleAuthFn {
- return async (accessToken, refreshToken, profile) => {
- const user = await this.userRepository.findOne({
- where: {
- /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
- email: (profile as any)._json.email,
- },
- });
- if (!user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- if (
- !user ||
- user.authProvider !== 'apple' ||
- user.authId !== profile.id
- ) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
-
- const authUser: AuthUser = new AuthUser(user);
- authUser.permissions = [];
- authUser.externalAuthToken = accessToken;
- authUser.externalRefreshToken = refreshToken;
- authUser.tenant = new Tenant({id: user.defaultTenant});
- return authUser;
- };
- }
-}
-```
-
-Please note the Verify function type _VerifyFunction.LocalPasswordFn_
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.APPLE_OAUTH2_VERIFIER).toProvider(
- AppleOauth2VerifyProvider,
-);
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- @inject(AuthenticationBindings.USER_AUTH_ACTION)
- protected authenticateRequest: AuthenticateFn,
- ) {}
-
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
-
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
- const authUser: AuthUser = await this.authenticateRequest(
- request,
- response,
- );
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-After this, you can use decorator to apply auth to controller functions wherever needed. See below.
-
-```ts
-@authenticateClient(STRATEGY.CLIENT_PASSWORD)
- @authenticate(
- STRATEGY.APPLE_OAUTH2,
- {
- accessType: 'offline',
- scope: ['name', 'email'],
- callbackURL: process.env.APPLE_AUTH_CALLBACK_URL,
- clientID: process.env.APPLE_AUTH_CLIENT_ID,
- teamID: process.env.APPLE_AUTH_TEAM_ID,
- keyID: process.env.APPLE_AUTH_KEY_ID,
- privateKeyLocation: process.env.APPLE_AUTH_PRIVATE_KEY_LOCATION,
- },
- (req: Request) => {
- return {
- accessType: 'offline',
- state: Object.keys(req.query)
- .map(key => key + '=' + req.query[key])
- .join('&'),
- };
- },
- )
- @authorize(['*'])
- @get('/auth/oauth-apple', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async loginViaApple(
- @param.query.string('client_id')
- clientId?: string,
- @param.query.string('client_secret')
- clientSecret?: string,
- ): Promise {}
-
- @authenticate(
- STRATEGY.APPLE_OAUTH2,
- {
- accessType: 'offline',
- scope: ['name', 'email'],
- callbackURL: process.env.APPLE_AUTH_CALLBACK_URL,
- clientID: process.env.APPLE_AUTH_CLIENT_ID,
- teamID: process.env.APPLE_AUTH_TEAM_ID,
- keyID: process.env.APPLE_AUTH_KEY_ID,
- privateKeyLocation: process.env.APPLE_AUTH_PRIVATE_KEY_LOCATION,
- },
- (req: Request) => {
- return {
- accessType: 'offline',
- state: Object.keys(req.query)
- .map(key => `${key}=${req.query[key]}`)
- .join('&'),
- };
- },
- )
- @authorize(['*'])
- @get('/auth/apple-oauth-redirect', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async appleCallback(
- @param.query.string('code') code: string,
- @param.query.string('state') state: string,
- @inject(RestBindings.Http.RESPONSE) response: Response,
- ): Promise {
- const clientId = new URLSearchParams(state).get('client_id');
- if (!clientId || !this.user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- const client = await this.authClientRepository.findOne({
- where: {
- clientId: clientId,
- },
- });
- if (!client || !client.redirectUrl) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- try {
- const codePayload: ClientAuthCode = {
- clientId,
- user: this.user,
- };
- const token = jwt.sign(codePayload, client.secret, {
- expiresIn: client.authCodeExpiration,
- audience: clientId,
- subject: this.user.username,
- issuer: process.env.JWT_ISSUER,
- });
- response.redirect(`${client.redirectUrl}?code=${token}`);
- } catch (error) {
- throw new HttpErrors.InternalServerError(AuthErrorKeys.UnknownError);
- }
- }
-```
-
-Please note above that we are creating two new APIs for apple auth. The first one is for UI clients to hit. We are authenticating client as well, then passing the details to the apple auth. Then, the actual authentication is done by apple authorization url, which redirects to the second API we created after success. The first API method body is empty as we do not need to handle its response. The apple auth provider in this package will do the redirection for you automatically.
-
-For accessing the authenticated AuthUser model reference, you can inject the CURRENT_USER provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_USER)
- private readonly getCurrentUser: Getter,
-```
-
-### Facebook Oauth 2
-
-In order to use it, run `npm install passport-facebook`.
-First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
-
-```ts
-@model({
- name: 'users',
-})
-export class User extends Entity implements IAuthUser {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
-
- @property({
- type: 'string',
- required: true,
- name: 'first_name',
- })
- firstName: string;
-
- @property({
- type: 'string',
- name: 'last_name',
- })
- lastName: string;
-
- @property({
- type: 'string',
- name: 'middle_name',
- })
- middleName?: string;
-
- @property({
- type: 'string',
- required: true,
- })
- username: string;
-
- @property({
- type: 'string',
- })
- email?: string;
-
- // Auth provider - 'facebook'
- @property({
- type: 'string',
- required: true,
- name: 'auth_provider',
- })
- authProvider: string;
-
- // Id from external provider
- @property({
- type: 'string',
- name: 'auth_id',
- })
- authId?: string;
-
- @property({
- type: 'string',
- name: 'auth_token',
- })
- authToken?: string;
-
- @property({
- type: 'string',
- })
- password?: string;
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Now bind this model to USER_MODEL key in application.ts
-
-```ts
-this.bind(AuthenticationBindings.USER_MODEL).to(User);
-```
-
-Create CRUD repository for the above model. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same. You can add your application specific business logic for client auth here. Here is a simple example.
-
-```ts
-import {Provider} from '@loopback/context';
-import {repository} from '@loopback/repository';
-import {HttpErrors} from '@loopback/rest';
-import {AuthErrorKeys, VerifyFunction} from 'loopback4-authentication';
-
-import {Tenant} from '../../../models';
-import {UserCredentialsRepository, UserRepository} from '../../../repositories';
-import {AuthUser} from '../models/auth-user.model';
-
-export class FacebookOauth2VerifyProvider
- implements Provider
-{
- constructor(
- @repository(UserRepository)
- public userRepository: UserRepository,
- @repository(UserCredentialsRepository)
- public userCredsRepository: UserCredentialsRepository,
- ) {}
-
- value(): VerifyFunction.FacebookAuthFn {
- return async (accessToken, refreshToken, profile) => {
- const user = await this.userRepository.findOne({
- where: {
- /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
- email: (profile as any)._json.email,
- },
- });
- if (!user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- if (
- !user ||
- user.authProvider !== 'facebook' ||
- user.authId !== profile.id
- ) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
-
- const authUser: AuthUser = new AuthUser(user);
- authUser.permissions = [];
- authUser.externalAuthToken = accessToken;
- authUser.externalRefreshToken = refreshToken;
- authUser.tenant = new Tenant({id: user.defaultTenant});
- return authUser;
- };
- }
-}
-```
-
-Please note the Verify function type _VerifyFunction.LocalPasswordFn_
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.FACEBOOK_OAUTH2_VERIFIER).toProvider(
- FacebookOauth2VerifyProvider,
-);
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- @inject(AuthenticationBindings.USER_AUTH_ACTION)
- protected authenticateRequest: AuthenticateFn,
- ) {}
-
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
-
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
- const authUser: AuthUser = await this.authenticateRequest(
- request,
- response,
- );
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-After this, you can use decorator to apply auth to controller functions wherever needed. See below.
-
-```ts
-@authenticateClient(STRATEGY.CLIENT_PASSWORD)
- @authenticate(
- STRATEGY.FACEBOOK_OAUTH2,
- {
- accessType: 'offline',
- authorizationURL: process.env.FACEBOOK_AUTH_URL,
- callbackURL: process.env.FACEBOOK_AUTH_CALLBACK_URL,
- clientID: process.env.FACEBOOK_AUTH_CLIENT_ID,
- clientSecret: process.env.FACEBOOK_AUTH_CLIENT_SECRET,
- tokenURL: process.env.FACEBOOK_AUTH_TOKEN_URL,
- },
- (req: Request) => {
- return {
- accessType: 'offline',
- state: Object.keys(req.query)
- .map(key => key + '=' + req.query[key])
- .join('&'),
- };
- },
- )
- @authorize(['*'])
- @get('/auth/facebook', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async loginViaFacebook(
- @param.query.string('client_id')
- clientId?: string,
- @param.query.string('client_secret')
- clientSecret?: string,
- ): Promise {}
-
- @authenticate(
- STRATEGY.FACEBOOK_OAUTH2,
- {
- accessType: 'offline',
- authorizationURL: process.env.FACEBOOK_AUTH_URL,
- callbackURL: process.env.FACEBOOK_AUTH_CALLBACK_URL,
- clientID: process.env.FACEBOOK_AUTH_CLIENT_ID,
- clientSecret: process.env.FACEBOOK_AUTH_CLIENT_SECRET,
- tokenURL: process.env.FACEBOOK_AUTH_TOKEN_URL,
- },
- (req: Request) => {
- return {
- accessType: 'offline',
- state: Object.keys(req.query)
- .map(key => `${key}=${req.query[key]}`)
- .join('&'),
- };
- },
- )
- @authorize(['*'])
- @get('/auth/facebook-auth-redirect', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async facebookCallback(
- @param.query.string('code') code: string,
- @param.query.string('state') state: string,
- @inject(RestBindings.Http.RESPONSE) response: Response,
- ): Promise {
- const clientId = new URLSearchParams(state).get('client_id');
- if (!clientId || !this.user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- const client = await this.authClientRepository.findOne({
- where: {
- clientId: clientId,
- },
- });
- if (!client || !client.redirectUrl) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- try {
- const codePayload: ClientAuthCode = {
- clientId,
- user: this.user,
- };
- const token = jwt.sign(codePayload, client.secret, {
- expiresIn: client.authCodeExpiration,
- audience: clientId,
- subject: this.user.username,
- issuer: process.env.JWT_ISSUER,
- });
- response.redirect(`${client.redirectUrl}?code=${token}`);
- } catch (error) {
- throw new HttpErrors.InternalServerError(AuthErrorKeys.UnknownError);
- }
- }
-```
-
-Please note above that we are creating two new APIs for facebook auth. The first one is for UI clients to hit. We are authenticating client as well, then passing the details to the facebook auth. Then, the actual authentication is done by facebook authorization url, which redirects to the second API we created after success. The first API method body is empty as we do not need to handle its response. The facebook auth provider in this package will do the redirection for you automatically.
-
-For accessing the authenticated AuthUser model reference, you can inject the CURRENT_USER provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_USER)
- private readonly getCurrentUser: Getter,
-```
-
-### Keycloak
-
-In order to use it, run `npm install @exlinc/keycloak-passport`.
-First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
-
-```ts
-@model({
- name: 'users',
-})
-export class User extends Entity implements IAuthUser {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
-
- @property({
- type: 'string',
- required: true,
- name: 'first_name',
- })
- firstName: string;
-
- @property({
- type: 'string',
- name: 'last_name',
- })
- lastName: string;
-
- @property({
- type: 'string',
- name: 'middle_name',
- })
- middleName?: string;
-
- @property({
- type: 'string',
- required: true,
- })
- username: string;
-
- @property({
- type: 'string',
- })
- email?: string;
-
- // Auth provider - 'keycloak'
- @property({
- type: 'string',
- required: true,
- name: 'auth_provider',
- })
- authProvider: string;
-
- // Id from external provider
- @property({
- type: 'string',
- name: 'auth_id',
- })
- authId?: string;
-
- @property({
- type: 'string',
- name: 'auth_token',
- })
- authToken?: string;
-
- @property({
- type: 'string',
- })
- password?: string;
-
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Now bind this model to USER_MODEL key in application.ts
-
-```ts
-this.bind(AuthenticationBindings.USER_MODEL).to(User);
-```
-
-Create CRUD repository for the above model. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same. You can add your application specific business logic for client auth here. Here is a simple example.
-
-```ts
-import {Provider, inject} from '@loopback/context';
-import {repository} from '@loopback/repository';
-import {HttpErrors} from '@loopback/rest';
-import {
- AuthErrorKeys,
- IAuthUser,
- VerifyFunction,
-} from 'loopback4-authentication';
-
-import {UserCredentialsRepository, UserRepository} from '../../../repositories';
-import {AuthUser} from '../models/auth-user.model';
-
-export class KeycloakVerifyProvider
- implements Provider
-{
- constructor(
- @repository(UserRepository)
- public userRepository: UserRepository,
- @repository(UserCredentialsRepository)
- public userCredsRepository: UserCredentialsRepository,
- ) {}
-
- value(): VerifyFunction.KeycloakAuthFn {
- return async (accessToken, refreshToken, profile) => {
- let user: IAuthUser | null = await this.userRepository.findOne({
- where: {
- email: profile.email,
- },
- });
- if (!user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- const creds = await this.userCredsRepository.findOne({
- where: {
- userId: user.id as string,
- },
- });
- if (
- !creds ||
- creds.authProvider !== 'keycloak' ||
- creds.authId !== profile.keycloakId
- ) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
-
- const authUser: AuthUser = new AuthUser({
- ...user,
- id: user.id as string,
- });
- authUser.permissions = [];
- authUser.externalAuthToken = accessToken;
- authUser.externalRefreshToken = refreshToken;
- return authUser;
- };
- }
-}
-```
-
-Please note the Verify function type _VerifyFunction.KeycloakAuthFn_
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.KEYCLOAK_VERIFIER).toProvider(
- KeycloakVerifyProvider,
-);
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- /**
- * Optional invoker for registered middleware in a chain.
- * To be injected via SequenceActions.INVOKE_MIDDLEWARE.
- */
- @inject(SequenceActions.INVOKE_MIDDLEWARE, {optional: true})
- protected invokeMiddleware: InvokeMiddleware = () => false;
-
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- @inject(AuthenticationBindings.USER_AUTH_ACTION)
- protected authenticateRequest: AuthenticateFn,
- ) {}
-
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
-
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
- const authUser: AuthUser = await this.authenticateRequest(
- request,
- response,
- );
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-After this, you can use decorator to apply auth to controller functions wherever needed. See below.
-
-```ts
-@authenticateClient(STRATEGY.CLIENT_PASSWORD)
- @authenticate(
- STRATEGY.KEYCLOAK,
- {
- host: process.env.KEYCLOAK_HOST,
- realm: process.env.KEYCLOAK_REALM, //'Tenant1',
- clientID: process.env.KEYCLOAK_CLIENT_ID, //'onboarding',
- clientSecret: process.env.KEYCLOAK_CLIENT_SECRET, //'e607fd75-adc8-4af7-9f03-c9e79a4b8b72',
- callbackURL: process.env.KEYCLOAK_CALLBACK_URL, //'http://localhost:3001/auth/keycloak-auth-redirect',
- authorizationURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/auth`,
- tokenURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/token`,
- userInfoURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/userinfo`,
- },
- keycloakQueryGen,
- )
- @authorize({permissions: ['*']})
- @get('/auth/keycloak', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Keycloak Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async loginViaKeycloak(
- @param.query.string('client_id')
- clientId?: string,
- @param.query.string('client_secret')
- clientSecret?: string,
- ): Promise {}
-
- @authenticate(
- STRATEGY.KEYCLOAK,
- {
- host: process.env.KEYCLOAK_HOST,
- realm: process.env.KEYCLOAK_REALM,
- clientID: process.env.KEYCLOAK_CLIENT_ID,
- clientSecret: process.env.KEYCLOAK_CLIENT_SECRET,
- callbackURL: process.env.KEYCLOAK_CALLBACK_URL,
- authorizationURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/auth`,
- tokenURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/token`,
- userInfoURL: `${process.env.KEYCLOAK_HOST}/auth/realms/${process.env.KEYCLOAK_REALM}/protocol/openid-connect/userinfo`,
- },
- keycloakQueryGen,
- )
- @authorize({permissions: ['*']})
- @get('/auth/keycloak-auth-redirect', {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Keycloak Redirect Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {'x-ts-type': TokenResponse},
- },
- },
- },
- },
- })
- async keycloakCallback(
- @param.query.string('code') code: string,
- @param.query.string('state') state: string,
- @inject(RestBindings.Http.RESPONSE) response: Response,
- ): Promise {
- const clientId = new URLSearchParams(state).get('client_id');
- if (!clientId || !this.user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- const client = await this.authClientRepository.findOne({
- where: {
- clientId,
- },
- });
- if (!client || !client.redirectUrl) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- try {
- const codePayload: ClientAuthCode = {
- clientId,
- user: this.user,
- };
- const token = jwt.sign(codePayload, client.secret, {
- expiresIn: client.authCodeExpiration,
- audience: clientId,
- subject: this.user.username,
- issuer: process.env.JWT_ISSUER,
- });
- response.redirect(
- `${client.redirectUrl}?code=${token}&user=${this.user.username}`,
- );
- } catch (error) {
- this.logger.error(error);
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- }
-```
-
-Please note above that we are creating two new APIs for keycloak auth. The first one is for UI clients to hit. We are authenticating client as well, then passing the details to the keycloak auth. Then, the actual authentication is done by keycloak authorization url, which redirects to the second API we created after success. The first API method body is empty as we do not need to handle its response. The keycloak auth provider in this package will do the redirection for you automatically.
-
-For accessing the authenticated AuthUser model reference, you can inject the CURRENT_USER provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_USER)
- private readonly getCurrentUser: Getter,
-```
-
-### Custom Verifier for Individual Routes
-
-For providing a custom verifier for a particular route, you can pass a binding key for a verifier provider as the fourth parameter of the authenticate decorator.
-Note - The key VerifyBindings.BEARER_SIGNUP_VERIFY_PROVIDER can be any custom key, it just be bound to a verify function provider.
-
-```ts
- @authenticate(
- STRATEGY.BEARER,
- undefined, //options
- undefined, //authOptions
- VerifyBindings.BEARER_SIGNUP_VERIFY_PROVIDER,
- )
-```
-
-And binding this key to a verifier in the application.ts
-
-```ts
-this.bind(VerifyBindings.BEARER_SIGNUP_VERIFY_PROVIDER).toProvider(
- LocalPreSignupProvider as Constructor>,
-);
-```
-
-### SAML
-
-In order to use it, run `npm install @node-saml/passport-saml`.
-SAML (Security Assertion Markup Language) is an XML-based standard for exchanging authentication and authorization data between parties, in particular, between an identity provider (IdP) and a service provider (SP).
-
-First, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.
-
-```ts
-@model({
- name: 'users',
-})
-export class User extends Entity implements IAuthUser {
- @property({
- type: 'number',
- id: true,
- })
- id?: number;
- @property({
- type: 'string',
- required: true,
- name: 'first_name',
- })
- firstName: string;
- @property({
- type: 'string',
- name: 'last_name',
- })
- lastName: string;
- @property({
- type: 'string',
- name: 'middle_name',
- })
- middleName?: string;
- @property({
- type: 'string',
- required: true,
- })
- username: string;
- @property({
- type: 'string',
- })
- email?: string;
- // Auth provider - 'SAML'
- @property({
- type: 'string',
- required: true,
- name: 'auth_provider',
- })
- authProvider: string;
- // Id from external provider
- @property({
- type: 'string',
- name: 'auth_id',
- })
- authId?: string;
- @property({
- type: 'string',
- name: 'auth_token',
- })
- authToken?: string;
- @property({
- type: 'string',
- })
- password?: string;
- constructor(data?: Partial) {
- super(data);
- }
-}
-```
-
-Now bind this model to USER_MODEL key in application.ts
-
-```ts
-this.bind(AuthenticationBindings.USER_MODEL).to(User);
-```
-
-Create CRUD repository for the above model. Use loopback CLI.
-
-```sh
-lb4 repository
-```
-
-Add the verifier function for the strategy. You need to create a provider for the same. You can add your application specific business logic for client auth here. Here is a simple example.
-
-```ts
-import {Provider} from '@loopback/context';
-import {repository} from '@loopback/repository';
-import {HttpErrors} from '@loopback/rest';
-import {AuthErrorKeys, VerifyFunction} from 'loopback4-authentication';
-import {Tenant} from '../../../models';
-import {UserCredentialsRepository, UserRepository} from '../../../repositories';
-import {AuthUser} from '../models/auth-user.model';
-export class SamlVerifyProvider implements Provider {
- constructor(
- @repository(UserRepository)
- public userRepository: UserRepository,
- @repository(UserCredentialsRepository)
- public userCredsRepository: UserCredentialsRepository,
- ) {}
- value(): VerifyFunction.SamlFn {
- return async (profile) => {
- const user = await this.userRepository.findOne({
- where: {
- /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
- email: (profile as any)._json.email,
- },
- });
- if (!user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- if (!user || user.authProvider !== 'saml' || user.authId !== profile.id) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- const authUser: AuthUser = new AuthUser({
- ...user,
- id: user.id as string,
- });
- authUser.permissions = [];
- return this.postVerifyProvider(profile, authUser);
- };
- }
-}
-```
-
-Please note the Verify function type _VerifyFunction.LocalPasswordFn_
-
-Now bind this provider to the application in application.ts.
-
-```ts
-import {AuthenticationComponent, Strategies} from 'loopback4-authentication';
-```
-
-```ts
-// Add authentication component
-this.component(AuthenticationComponent);
-// Customize authentication verify handlers
-this.bind(Strategies.Passport.SAML_VERIFIER).toProvider(SamlVerifyProvider);
-```
-
-Finally, add the authenticate function as a sequence action to sequence.ts.
-
-```ts
-export class MySequence implements SequenceHandler {
- constructor(
- @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,
- @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,
- @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,
- @inject(SequenceActions.SEND) public send: Send,
- @inject(SequenceActions.REJECT) public reject: Reject,
- @inject(AuthenticationBindings.USER_AUTH_ACTION)
- protected authenticateRequest: AuthenticateFn,
- ) {}
- async handle(context: RequestContext) {
- try {
- const {request, response} = context;
- const route = this.findRoute(request);
- const args = await this.parseParams(request, route);
- request.body = args[args.length - 1];
- const authUser: AuthUser = await this.authenticateRequest(
- request,
- response,
- );
- const result = await this.invoke(route, args);
- this.send(response, result);
- } catch (err) {
- this.reject(context, err);
- }
- }
-}
-```
-
-After this, you can use decorator to apply auth to controller functions wherever needed. See below.
-
-```ts
- @authenticateClient(STRATEGY.CLIENT_PASSWORD)
- @authenticate(
- STRATEGY.SAML,
- {
- accessType: 'offline',
- scope: ['profile', 'email'],
- callbackURL: process.env.SAML_CALLBACK_URL,
- issuer: process.env.SAML_ISSUER,
- cert: process.env.SAML_CERT,
- entryPoint: process.env.SAML_ENTRY_POINT,
- audience: process.env.SAML_AUDIENCE,
- logoutUrl: process.env.SAML_LOGOUT_URL,
- passReqToCallback: !!+(process.env.SAML_AUTH_PASS_REQ_CALLBACK ?? 0),
- validateInResponseTo: !!+(process.env.VALIDATE_RESPONSE ?? 1),
- idpIssuer: process.env.IDP_ISSUER,
- logoutCallbackUrl: process.env.SAML_LOGOUT_CALLBACK_URL,
- }
- )
- @authorize({permissions: ['*']})
- @post('/auth/saml', {
- description: 'POST Call for saml based login',
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Saml Token Response',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {[X_TS_TYPE]: TokenResponse},
- },
- },
- },
- },
- })
- async postLoginViaSaml(
- @requestBody({
- content: {
- [CONTENT_TYPE.FORM_URLENCODED]: {
- schema: getModelSchemaRef(ClientAuthRequest),
- },
- },
- })
- clientCreds?: ClientAuthRequest, //NOSONAR
- ): Promise {
- //do nothing
- }
- @authenticate(
- STRATEGY.SAML,
- {
- accessType: 'offline',
- scope: ['profile', 'email'],
- callbackURL: process.env.SAML_CALLBACK_URL,
- issuer: process.env.SAML_ISSUER,
- cert: process.env.SAML_CERT,
- entryPoint: process.env.SAML_ENTRY_POINT,
- audience: process.env.SAML_AUDIENCE,
- logoutUrl: process.env.SAML_LOGOUT_URL,
- passReqToCallback: !!+(process.env.SAML_AUTH_PASS_REQ_CALLBACK ?? 0),
- validateInResponseTo: !!+(process.env.VALIDATE_RESPONSE ?? 1),
- idpIssuer: process.env.IDP_ISSUER,
- logoutCallbackUrl: process.env.SAML_LOGOUT_CALLBACK_URL,
- }
- )
- @authorize({permissions: ['*']})
- @post(`/auth/saml-redirect`, {
- responses: {
- [STATUS_CODE.OK]: {
- description: 'Okta SAML callback',
- content: {
- [CONTENT_TYPE.JSON]: {
- schema: {[X_TS_TYPE]: TokenResponse},
- },
- },
- },
- },
- })
- async oktaSamlCallback(
- @inject(AuthenticationBindings.CURRENT_USER)
- user: AuthUser | undefined,
- @inject(RestBindings.Http.REQUEST) request: Request,
- @param.query.string('client') clientId: string,
- @inject(RestBindings.Http.RESPONSE) response: Response,
- @requestBody({
- content: {
- [CONTENT_TYPE.FORM_URLENCODED]: {},
- },
- })
- oktaData: AnyObject,
- ): Promise {
- if (!clientId || !user) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- const client = await this.authClientRepository.findOne({
- where: {
- clientId,
- },
- });
- if (!client?.redirectUrl) {
- throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
- }
- try {
- const token = await this.getAuthCode(client, user);
- response.redirect(`${client.redirectUrl}?code=${token}`);
- } catch (error) {
- this.logger.error(error);
- throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);
- }
- }
-```
-
-Please note above that we are creating two new APIs for SAML. The first one is for UI clients to hit. We are authenticating client as well, then passing the details to the SAML. Then, the actual authentication is done by SAML authorization url, which redirects to the second API we created after success. The first API method body is empty as we do not need to handle its response. The SAML provider in this package will do the redirection for you automatically.
-
-Note: For `auth/saml-redirect` one needs to configure the SSO path by incorporating the client ID as a query parameter in existing application set up within your Okta environment for which you intend to enable SSO as follows:
-
-```
-http://localhost:3000/auth/saml-redirect?client=YOUR_CLIENT_ID
-
-```
-
-For accessing the authenticated AuthUser model reference, you can inject the CURRENT_USER provider, provided by the extension, which is populated by the auth action sequence above.
-
-```ts
- @inject.getter(AuthenticationBindings.CURRENT_USER)
- private readonly getCurrentUser: Getter,
-```
-
-The `logoutVerify` function is used in the node-saml library as a part of the Passport SAML authentication process. This function is used to verify the authenticity of a SAML logout request.
-The logout process in SAML is used to end the user's session on the service provider, and the logoutVerify function is used to verify that the logout request is coming from a trusted IdP.
-The implementation of the logoutVerify function may vary depending on the specific requirements and the security constraints of the application. It is typically used to verify the signature on the logout request, to ensure that the request has not been tampered with, and to extract the user's identity information from the request.
-
-```ts
-function logoutVerify(
- req: Request,
- profile: Profile | null,
- done: VerifiedCallback,
-): void {
- // Check if a user is currently authenticated
- if (req.isAuthenticated()) {
- // Log the user out by removing their session data
- req.logout(done);
- // Call the "done" callback to indicate success
- done(null, {message: 'User successfully logged out'});
- } else {
- // Call the "done" callback with an error to indicate that the user is not logged in
- done(new Error('User is not currently logged in'));
- }
-}
-```
-
-This function is called when a user logs out of the application.Once this function is implemented,it will be called when the user logs out of the application,allowing the application to perform any necessary tasks before ending the user's session.
-@param req - The request object.
-@param {Profile | null} profile - The user's profile, as returned by the provider.
-@param {VerifiedCallback} done - A callback to be called when the verificationis complete.
-
-### Https proxy support for keycloak and google auth
-
-If a https proxy agent is needed for keycloak and google auth, just add an environment variable named `HTTPS_PROXY` or `https_proxy` with proxy url as value. It will add that proxy agent to the request.
-
-## Middleware Sequence Support
-
-As action based sequence will be deprecated soon, we have provided support for middleware based sequences. If you are using middleware sequence you can add authentication to your application by enabling client or user authentication middleware. This can be done by binding the AuthenticationBindings.CONFIG :
-
-```ts
-this.bind(AuthenticationBindings.CONFIG).to({
- useClientAuthenticationMiddleware: true,
- useUserAuthenticationMiddleware: true,
-});
-
-this.component(AuthenticationComponent);
-```
-
-This binding needs to be done before adding the Authentication component to your application.
-Apart from this all other steps for authentication for all strategies remain the same.
-
-## Feedback
-
-If you've noticed a bug or have a question or have a feature request, [search the issue tracker](https://github.com/sourcefuse/loopback4-authentication/issues) to see if someone else in the community has already created a ticket.
-If not, go ahead and [make one](https://github.com/sourcefuse/loopback4-authentication/issues/new/choose)!
-All feature requests are welcome. Implementation time may vary. Feel free to contribute the same, if you can.
-If you think this extension is useful, please [star](https://help.github.com/en/articles/about-stars) it. Appreciation really helps in keeping this project alive.
-
-## Contributing
-
-Please read [CONTRIBUTING.md](https://github.com/sourcefuse/loopback4-authentication/blob/master/.github/CONTRIBUTING.md) for details on the process for submitting pull requests to us.
-
-## Code of conduct
-
-Code of conduct guidelines [here](https://github.com/sourcefuse/loopback4-authentication/blob/master/.github/CODE_OF_CONDUCT.md).
-
-## License
-
-[MIT](https://github.com/sourcefuse/loopback4-authentication/blob/master/LICENSE)
diff --git a/mkdocs.yml b/mkdocs.yml
index 8c26ac5..0b9b72d 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,8 +1,5 @@
site_name: loopback4-authentication
site_description: loopback4-authentication
-nav:
- - Introduction: index.md
-
plugins:
- techdocs-core