\n\n## Overview\n\nThis is a loopback-next extension for adding authentication layer to a REST application in loopback 4.\nThis 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.\nIt provides support for seven passport based strategies.\n\n1. [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.\n2. [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.\n3. [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.\n4. [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.\n5. [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.\n6. [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.\n7. [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.\n8. [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.\n9. [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.\n10. [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.\n11. [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\n12. custom-passport-otp - Created a Custom Passport strategy for 2-Factor-Authentication using OTP (One Time Password).\n13. [passport-auth0](https://github.com/auth0/passport-auth0) - Passport strategy for authenticating with auth0. This module lets you authenticate using [Auth0](https://auth0.com/) in your Node.js applications.\n\nYou 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.\n\n## Install\n\n```sh\nnpm install loopback4-authentication\n```\n\n## Quick Starter\n\nFor 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.\n\n## Detailed Usage\n\nThe first and common step for all of the startegies is to add the component to the application. See below\n\n```ts\n// application.ts\nexport class ToDoApplication extends BootMixin(\n ServiceMixin(RepositoryMixin(RestApplication)),\n) {\n constructor(options: ApplicationConfig = {}) {\n super(options);\n\n // Set up the custom sequence\n this.sequence(MySequence);\n\n // Set up default home page\n this.static('/', path.join(__dirname, '../public'));\n\n // Add authentication component\n this.component(AuthenticationComponent);\n\n // .... Rest of the code below\n }\n}\n```\n\nOnce this is done, you are ready to configure any of the available strategy in the application.\n\n### Oauth2-client-password\n\nFirst, 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.\n\n```ts\n@model({\n name: 'auth_clients',\n})\nexport class AuthClient extends Entity implements IAuthClient {\n @property({\n type: 'number',\n id: true,\n })\n id?: number;\n\n @property({\n type: 'string',\n required: true,\n name: 'client_id',\n })\n clientId: string;\n\n @property({\n type: 'string',\n required: true,\n name: 'client_secret',\n })\n clientSecret: string;\n\n @property({\n type: 'array',\n itemType: 'number',\n name: 'user_ids',\n })\n userIds: number[];\n\n constructor(data?: Partial) {\n super(data);\n }\n}\n```\n\nCreate CRUD repository for the above model. Use loopback CLI.\n\n```sh\nlb4 repository\n```\n\nAdd 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.\n\n```ts\nimport {Provider} from '@loopback/context';\nimport {repository} from '@loopback/repository';\nimport {VerifyFunction} from 'loopback4-authentication';\n\nimport {AuthClientRepository} from '../../../repositories';\n\nexport class ClientPasswordVerifyProvider\n implements Provider\n{\n constructor(\n @repository(AuthClientRepository)\n public authClientRepository: AuthClientRepository,\n ) {}\n\n value(): VerifyFunction.OauthClientPasswordFn {\n return async (clientId, clientSecret, req) => {\n return this.authClientRepository.findOne({\n where: {\n clientId,\n clientSecret,\n },\n });\n };\n }\n}\n```\n\nPlease note the Verify function type _VerifyFunction.OauthClientPasswordFn_.\n\nNow bind this provider to the application in application.ts.\n\n```ts\nimport {AuthenticationComponent, Strategies} from 'loopback4-authentication';\n```\n\n```ts\n// Add authentication component\nthis.component(AuthenticationComponent);\n// Customize authentication verify handlers\nthis.bind(Strategies.Passport.OAUTH2_CLIENT_PASSWORD_VERIFIER).toProvider(\n ClientPasswordVerifyProvider,\n);\n```\n\nFinally, add the authenticate function as a sequence action to sequence.ts.\n\n```ts\nexport class MySequence implements SequenceHandler {\n constructor(\n @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,\n @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,\n @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,\n @inject(SequenceActions.SEND) public send: Send,\n @inject(SequenceActions.REJECT) public reject: Reject,\n // Inject CLIENT_AUTH_ACTION sequence action provider\n @inject(AuthenticationBindings.CLIENT_AUTH_ACTION)\n protected authenticateRequestClient: AuthenticateFn,\n ) {}\n\n async handle(context: RequestContext) {\n try {\n const {request, response} = context;\n const route = this.findRoute(request);\n const args = await this.parseParams(request, route);\n request.body = args[args.length - 1];\n\n // Perform client authentication here\n await this.authenticateRequestClient(request);\n\n const result = await this.invoke(route, args);\n this.send(response, result);\n } catch (err) {\n this.reject(context, err);\n }\n }\n}\n```\n\nAfter this, you can use decorator to apply auth to controller functions wherever needed. See below.\n\n```ts\n@authenticateClient(STRATEGY.CLIENT_PASSWORD, {\n passReqToCallback: true\n})\n@post('/auth/login', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Auth Code',\n content: {\n [CONTENT_TYPE.JSON]: Object,\n },\n },\n },\n})\nasync login(\n @requestBody()\n req: LoginRequest,\n): Promise<{\n code: string;\n}> {\n ....\n}\n```\n\nFor 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.\n\n```ts\n @inject.getter(AuthenticationBindings.CURRENT_CLIENT)\n private readonly getCurrentClient: Getter,\n```\n\n### Http-bearer\n\nFirst, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.\n\n```ts\n@model({\n name: 'users',\n})\nexport class User extends Entity implements IAuthUser {\n @property({\n type: 'number',\n id: true,\n })\n id?: number;\n\n @property({\n type: 'string',\n required: true,\n name: 'first_name',\n })\n firstName: string;\n\n @property({\n type: 'string',\n name: 'last_name',\n })\n lastName: string;\n\n @property({\n type: 'string',\n name: 'middle_name',\n })\n middleName?: string;\n\n @property({\n type: 'string',\n required: true,\n })\n username: string;\n\n @property({\n type: 'string',\n })\n email?: string;\n\n @property({\n type: 'string',\n })\n password?: string;\n\n constructor(data?: Partial) {\n super(data);\n }\n}\n```\n\nNow bind this model to USER_MODEL key in application.ts\n\n```ts\nthis.bind(AuthenticationBindings.USER_MODEL).to(User);\n```\n\nCreate CRUD repository for the above model. Use loopback CLI.\n\n```sh\nlb4 repository\n```\n\nAdd 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.\n\n```ts\nimport {Provider} from '@loopback/context';\nimport {repository} from '@loopback/repository';\nimport {verify} from 'jsonwebtoken';\nimport {VerifyFunction} from 'loopback4-authentication';\n\nimport {User} from '../models/user.model';\n\nexport class BearerTokenVerifyProvider\n implements Provider\n{\n constructor(\n @repository(RevokedTokenRepository)\n public revokedTokenRepository: RevokedTokenRepository,\n ) {}\n\n value(): VerifyFunction.BearerFn {\n return async token => {\n if (token && (await this.revokedTokenRepository.get(token))) {\n throw new HttpErrors.Unauthorized('Token Revoked');\n }\n const user = verify(token, process.env.JWT_SECRET as string, {\n issuer: process.env.JWT_ISSUER,\n }) as User;\n return user;\n };\n }\n}\n```\n\nThe 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).\n\nPlease note the Verify function type _VerifyFunction.BearerFn_\n\nNow bind this provider to the application in application.ts.\n\n```ts\nimport {AuthenticationComponent, Strategies} from 'loopback4-authentication';\n```\n\n```ts\n// Add authentication component\nthis.component(AuthenticationComponent);\n// Customize authentication verify handlers\nthis.bind(Strategies.Passport.BEARER_TOKEN_VERIFIER).toProvider(\n BearerTokenVerifyProvider,\n);\n```\n\nFinally, add the authenticate function as a sequence action to sequence.ts.\n\n```ts\nexport class MySequence implements SequenceHandler {\n constructor(\n @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,\n @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,\n @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,\n @inject(SequenceActions.SEND) public send: Send,\n @inject(SequenceActions.REJECT) public reject: Reject,\n @inject(AuthenticationBindings.USER_AUTH_ACTION)\n protected authenticateRequest: AuthenticateFn,\n ) {}\n\n async handle(context: RequestContext) {\n try {\n const {request, response} = context;\n\n const route = this.findRoute(request);\n const args = await this.parseParams(request, route);\n request.body = args[args.length - 1];\n const authUser: AuthUser = await this.authenticateRequest(request);\n const result = await this.invoke(route, args);\n this.send(response, result);\n } catch (err) {\n this.reject(context, err);\n }\n }\n}\n```\n\nAfter this, you can use decorator to apply auth to controller functions wherever needed. See below.\n\n```ts\n@authenticate(STRATEGY.BEARER)\n@get('/users', {\n responses: {\n '200': {\n description: 'Array of User model instances',\n content: {\n 'application/json': {\n schema: {type: 'array', items: {'x-ts-type': User}},\n },\n },\n },\n },\n})\nasync find(\n @param.query.object('filter', getFilterSchemaFor(User)) filter?: Filter,\n): Promise {\n return await this.userRepository.find(filter);\n}\n```\n\nFor 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.\n\n```ts\n @inject.getter(AuthenticationBindings.CURRENT_USER)\n private readonly getCurrentUser: Getter,\n```\n\n### local\n\nIn order to use it, run `npm install passport-local`.\nFirst, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.\n\n```ts\n@model({\n name: 'users',\n})\nexport class User extends Entity implements IAuthUser {\n @property({\n type: 'number',\n id: true,\n })\n id?: number;\n\n @property({\n type: 'string',\n required: true,\n name: 'first_name',\n })\n firstName: string;\n\n @property({\n type: 'string',\n name: 'last_name',\n })\n lastName: string;\n\n @property({\n type: 'string',\n name: 'middle_name',\n })\n middleName?: string;\n\n @property({\n type: 'string',\n required: true,\n })\n username: string;\n\n @property({\n type: 'string',\n })\n email?: string;\n\n @property({\n type: 'string',\n })\n password?: string;\n\n constructor(data?: Partial) {\n super(data);\n }\n}\n```\n\nNow bind this model to USER_MODEL key in application.ts\n\n```ts\nthis.bind(AuthenticationBindings.USER_MODEL).to(User);\n```\n\nCreate CRUD repository for the above model. Use loopback CLI.\n\n```sh\nlb4 repository\n```\n\nAdd 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.\n\n```ts\nexport class LocalPasswordVerifyProvider\n implements Provider\n{\n constructor(\n @repository(UserRepository)\n public userRepository: UserRepository,\n ) {}\n\n value(): VerifyFunction.LocalPasswordFn {\n return async (username: any, password: any) => {\n try {\n const user: AuthUser = new AuthUser(\n await this.userRepository.verifyPassword(username, password),\n );\n return user;\n } catch (error) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials)\n .message;\n }\n };\n }\n}\n```\n\nPlease note the Verify function type _VerifyFunction.LocalPasswordFn_\n\nNow bind this provider to the application in application.ts.\n\n```ts\nimport {AuthenticationComponent, Strategies} from 'loopback4-authentication';\n```\n\n```ts\n// Add authentication component\nthis.component(AuthenticationComponent);\n// Customize authentication verify handlers\nthis.bind(Strategies.Passport.LOCAL_PASSWORD_VERIFIER).toProvider(\n LocalPasswordVerifyProvider,\n);\n```\n\nFinally, add the authenticate function as a sequence action to sequence.ts.\n\n```ts\nexport class MySequence implements SequenceHandler {\n constructor(\n @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,\n @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,\n @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,\n @inject(SequenceActions.SEND) public send: Send,\n @inject(SequenceActions.REJECT) public reject: Reject,\n @inject(AuthenticationBindings.USER_AUTH_ACTION)\n protected authenticateRequest: AuthenticateFn,\n ) {}\n\n async handle(context: RequestContext) {\n try {\n const {request, response} = context;\n\n const route = this.findRoute(request);\n const args = await this.parseParams(request, route);\n request.body = args[args.length - 1];\n const authUser: AuthUser = await this.authenticateRequest(request);\n const result = await this.invoke(route, args);\n this.send(response, result);\n } catch (err) {\n this.reject(context, err);\n }\n }\n}\n```\n\nAfter this, you can use decorator to apply auth to controller functions wherever needed. See below.\n\n```ts\n @authenticate(STRATEGY.LOCAL)\n @post('/auth/login', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Auth Code',\n content: {\n [CONTENT_TYPE.JSON]: Object,\n },\n },\n },\n })\n async login(\n @requestBody()\n req: LoginRequest,\n ): Promise<{\n code: string;\n }> {\n ......\n }\n```\n\nFor 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.\n\n```ts\n @inject.getter(AuthenticationBindings.CURRENT_USER)\n private readonly getCurrentUser: Getter,\n```\n\n### Oauth2-resource-owner-password\n\nIn order to use it, run `npm install passport-oauth2-resource-owner-password`.\nFirst, 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.\n\n```ts\n@model({\n name: 'auth_clients',\n})\nexport class AuthClient extends Entity implements IAuthClient {\n @property({\n type: 'number',\n id: true,\n })\n id?: number;\n\n @property({\n type: 'string',\n required: true,\n name: 'client_id',\n })\n clientId: string;\n\n @property({\n type: 'string',\n required: true,\n name: 'client_secret',\n })\n clientSecret: string;\n\n @property({\n type: 'array',\n itemType: 'number',\n name: 'user_ids',\n })\n userIds: number[];\n\n constructor(data?: Partial) {\n super(data);\n }\n}\n```\n\nNext, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.\n\n```ts\n@model({\n name: 'users',\n})\nexport class User extends Entity implements IAuthUser {\n @property({\n type: 'number',\n id: true,\n })\n id?: number;\n\n @property({\n type: 'string',\n required: true,\n name: 'first_name',\n })\n firstName: string;\n\n @property({\n type: 'string',\n name: 'last_name',\n })\n lastName: string;\n\n @property({\n type: 'string',\n name: 'middle_name',\n })\n middleName?: string;\n\n @property({\n type: 'string',\n required: true,\n })\n username: string;\n\n @property({\n type: 'string',\n })\n email?: string;\n\n @property({\n type: 'string',\n })\n password?: string;\n\n constructor(data?: Partial) {\n super(data);\n }\n}\n```\n\nNow bind this model to USER_MODEL key in application.ts\n\n```ts\nthis.bind(AuthenticationBindings.USER_MODEL).to(User);\n```\n\nCreate CRUD repository for both of the above models. Use loopback CLI.\n\n```sh\nlb4 repository\n```\n\nAdd 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.\n\n```ts\nexport class ResourceOwnerVerifyProvider\n implements Provider\n{\n constructor(\n @repository(UserRepository)\n public userRepository: UserRepository,\n @repository(AuthClientRepository)\n public authClientRepository: AuthClientRepository,\n ) {}\n\n value(): VerifyFunction.ResourceOwnerPasswordFn {\n return async (clientId, clientSecret, username, password) => {\n const user = await this.userRepository.verifyPassword(username, password);\n if (!user) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);\n }\n const client = await this.authClientRepository.findOne({\n where: {\n clientId,\n },\n });\n if (!client || client.userIds.indexOf(user.id || 0) < 0) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);\n } else if (!client.clientSecret || client.clientSecret !== clientSecret) {\n throw new HttpErrors.Unauthorized(\n AuthErrorKeys.ClientVerificationFailed,\n );\n }\n return {\n client,\n user,\n };\n };\n }\n}\n```\n\nPlease note the Verify function type _VerifyFunction.LocalPasswordFn_.\nAlso, in this case, verifier will return AuthClient as well as User model.\n\nNow bind this provider to the application in application.ts.\n\n```ts\nimport {AuthenticationComponent, Strategies} from 'loopback4-authentication';\n```\n\n```ts\n// Add authentication component\nthis.component(AuthenticationComponent);\n// Customize authentication verify handlers\nthis.bind(Strategies.Passport.RESOURCE_OWNER_PASSWORD_VERIFIER).toProvider(\n ResourceOwnerVerifyProvider,\n);\n```\n\nFinally, add the authenticate function as a sequence action to sequence.ts.\n\n```ts\nexport class MySequence implements SequenceHandler {\n constructor(\n @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,\n @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,\n @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,\n @inject(SequenceActions.SEND) public send: Send,\n @inject(SequenceActions.REJECT) public reject: Reject,\n @inject(AuthenticationBindings.USER_AUTH_ACTION)\n protected authenticateRequest: AuthenticateFn,\n ) {}\n\n async handle(context: RequestContext) {\n try {\n const {request, response} = context;\n\n const route = this.findRoute(request);\n const args = await this.parseParams(request, route);\n request.body = args[args.length - 1];\n const authUser: AuthUser = await this.authenticateRequest(request);\n const result = await this.invoke(route, args);\n this.send(response, result);\n } catch (err) {\n this.reject(context, err);\n }\n }\n}\n```\n\nAfter this, you can use decorator to apply auth to controller functions wherever needed. See below.\n\n```ts\n @authenticate(STRATEGY.OAUTH2_RESOURCE_OWNER_GRANT)\n @post('/auth/login-token', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Token Response Model',\n content: {\n [CONTENT_TYPE.JSON]: {\n schema: {'x-ts-type': TokenResponse},\n },\n },\n },\n },\n })\n async loginWithClientUser(\n @requestBody() req: LoginRequest,\n ): Promise {\n ......\n }\n```\n\nFor 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.\n\n```ts\n @inject.getter(AuthenticationBindings.CURRENT_USER)\n private readonly getCurrentUser: Getter,\n @inject.getter(AuthenticationBindings.CURRENT_CLIENT)\n private readonly getCurrentClient: Getter,\n```\n\n### OTP\n\nFirst, 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.\n\n```ts\n@model()\nexport class OtpCache extends Entity {\n @property({\n type: 'string',\n })\n otp: string;\n\n @property({\n type: 'string',\n })\n userId: string;\n\n @property({\n type: 'string',\n })\n clientId: string;\n\n @property({\n type: 'string',\n })\n clientSecret: string;\n\n constructor(data?: Partial) {\n super(data);\n }\n}\n```\n\nCreate [redis-repository](https://loopback.io/doc/en/lb4/Repository.html#define-a-keyvaluerepository) for the above model. Use loopback CLI.\n\n```sh\nlb4 repository\n```\n\nHere is a simple example.\n\n```ts\nimport {OtpCache} from '../models';\nimport {AuthCacheSourceName} from 'loopback4-authentication';\n\nexport class OtpCacheRepository extends DefaultKeyValueRepository {\n constructor(\n @inject(`datasources.${AuthCacheSourceName}`)\n dataSource: juggler.DataSource,\n ) {\n super(OtpCache, dataSource);\n }\n}\n```\n\nAdd 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.\n\n```ts\nexport class OtpVerifyProvider implements Provider {\n constructor(\n @repository(UserRepository)\n public userRepository: UserRepository,\n @repository(OtpCacheRepository)\n public otpCacheRepo: OtpCacheRepository,\n ) {}\n\n value(): VerifyFunction.OtpAuthFn {\n return async (key: string, otp: string) => {\n const otpCache = await this.otpCacheRepo.get(key);\n if (!otpCache) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);\n }\n if (otpCache.otp.toString() !== otp) {\n throw new HttpErrors.Unauthorized('Invalid OTP');\n }\n return this.userRepository.findById(otpCache.userId);\n };\n }\n}\n```\n\nPlease note the Verify function type _VerifyFunction.OtpAuthFn_\n\nNow bind this provider to the application in application.ts.\n\n```ts\nimport {AuthenticationComponent, Strategies} from 'loopback4-authentication';\n```\n\n```ts\n// Add authentication component\nthis.component(AuthenticationComponent);\n// Customize authentication verify handlers\nthis.bind(Strategies.Passport.OTP_VERIFIER).toProvider(OtpVerifyProvider);\n```\n\nFinally, add the authenticate function as a sequence action to sequence.ts.\n\n```ts\nexport class MySequence implements SequenceHandler {\n constructor(\n @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,\n @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,\n @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,\n @inject(SequenceActions.SEND) public send: Send,\n @inject(SequenceActions.REJECT) public reject: Reject,\n @inject(AuthenticationBindings.USER_AUTH_ACTION)\n protected authenticateRequest: AuthenticateFn,\n ) {}\n\n async handle(context: RequestContext) {\n try {\n const {request, response} = context;\n\n const route = this.findRoute(request);\n const args = await this.parseParams(request, route);\n request.body = args[args.length - 1];\n const authUser: AuthUser = await this.authenticateRequest(request);\n const result = await this.invoke(route, args);\n this.send(response, result);\n } catch (err) {\n this.reject(context, err);\n }\n }\n}\n```\n\nThen, you need to create APIs, where you will first authenticate the user, and then send the OTP to user's email/phone. See below.\n\n```ts\n //You can use your other strategies also\n @authenticate(STRATEGY.LOCAL)\n @post('/auth/send-otp', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Send Otp',\n content: {\n [CONTENT_TYPE.JSON]: Object,\n },\n },\n },\n })\n async login(\n @requestBody()\n req: LoginRequest,\n ): Promise<{\n key: string;\n }> {\n\n // User is authenticated before this step.\n // Now follow these steps:\n // 1. Create a unique key.\n // 2. Generate and send OTP to user's email/phone.\n // 3. Store the details in redis-cache using key created in step-1. (Refer OtpCache model mentioned above)\n // 4. Response will be the key created in step-1\n }\n```\n\nAfter this, create an API with @@authenticate(STRATEGY.OTP) decorator. See below.\n\n```ts\n @authenticate(STRATEGY.OTP)\n @post('/auth/login-otp', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Auth Code',\n content: {\n [CONTENT_TYPE.JSON]: Object,\n },\n },\n },\n })\n async login(\n @requestBody()\n req: {\n key: 'string';\n otp: 'string';\n },\n ): Promise<{\n code: string;\n }> {\n ......\n }\n```\n\nFor 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.\n\n```ts\n @inject.getter(AuthenticationBindings.CURRENT_USER)\n private readonly getCurrentUser: Getter,\n```\n\n### Google Oauth 2\n\nIn order to use it, run `npm install passport-google-oauth20` and `npm install @types/passport-google-oauth20`.\nFirst, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.\n\n```ts\n@model({\n name: 'users',\n})\nexport class User extends Entity implements IAuthUser {\n @property({\n type: 'number',\n id: true,\n })\n id?: number;\n\n @property({\n type: 'string',\n required: true,\n name: 'first_name',\n })\n firstName: string;\n\n @property({\n type: 'string',\n name: 'last_name',\n })\n lastName: string;\n\n @property({\n type: 'string',\n name: 'middle_name',\n })\n middleName?: string;\n\n @property({\n type: 'string',\n required: true,\n })\n username: string;\n\n @property({\n type: 'string',\n })\n email?: string;\n\n // Auth provider - 'google'\n @property({\n type: 'string',\n required: true,\n name: 'auth_provider',\n })\n authProvider: string;\n\n // Id from external provider\n @property({\n type: 'string',\n name: 'auth_id',\n })\n authId?: string;\n\n @property({\n type: 'string',\n name: 'auth_token',\n })\n authToken?: string;\n\n @property({\n type: 'string',\n })\n password?: string;\n\n constructor(data?: Partial) {\n super(data);\n }\n}\n```\n\nNow bind this model to USER_MODEL key in application.ts\n\n```ts\nthis.bind(AuthenticationBindings.USER_MODEL).to(User);\n```\n\nCreate CRUD repository for the above model. Use loopback CLI.\n\n```sh\nlb4 repository\n```\n\nAdd 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.\n\n```ts\nimport {Provider} from '@loopback/context';\nimport {repository} from '@loopback/repository';\nimport {HttpErrors} from '@loopback/rest';\nimport {AuthErrorKeys, VerifyFunction} from 'loopback4-authentication';\n\nimport {Tenant} from '../../../models';\nimport {UserCredentialsRepository, UserRepository} from '../../../repositories';\nimport {AuthUser} from '../models/auth-user.model';\n\nexport class GoogleOauth2VerifyProvider\n implements Provider\n{\n constructor(\n @repository(UserRepository)\n public userRepository: UserRepository,\n @repository(UserCredentialsRepository)\n public userCredsRepository: UserCredentialsRepository,\n ) {}\n\n value(): VerifyFunction.GoogleAuthFn {\n return async (accessToken, refreshToken, profile) => {\n const user = await this.userRepository.findOne({\n where: {\n /* eslint-disable-next-line @typescript-eslint/no-explicit-any */\n email: (profile as any)._json.email,\n },\n });\n if (!user) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);\n }\n if (\n !user ||\n user.authProvider !== 'google' ||\n user.authId !== profile.id\n ) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);\n }\n\n const authUser: AuthUser = new AuthUser(user);\n authUser.permissions = [];\n authUser.externalAuthToken = accessToken;\n authUser.externalRefreshToken = refreshToken;\n authUser.tenant = new Tenant({id: user.defaultTenant});\n return authUser;\n };\n }\n}\n```\n\nPlease note the Verify function type _VerifyFunction.LocalPasswordFn_\n\nNow bind this provider to the application in application.ts.\n\n```ts\nimport {AuthenticationComponent, Strategies} from 'loopback4-authentication';\n```\n\n```ts\n// Add authentication component\nthis.component(AuthenticationComponent);\n// Customize authentication verify handlers\nthis.bind(Strategies.Passport.GOOGLE_OAUTH2_VERIFIER).toProvider(\n GoogleOauth2VerifyProvider,\n);\n```\n\nNow, bind this provider to the application in application.ts.\n\n```ts\nimport {GoogleAuthStrategyFactoryProvider} from 'loopback4-authentication/passport-google-oauth2';\n```\n\n```ts\nthis.bind(Strategies.Passport.GOOGLE_OAUTH2_STRATEGY_FACTORY.key).toProvider(\n GoogleAuthStrategyFactoryProvider,\n);\n```\n\nFinally, add the authenticate function as a sequence action to sequence.ts.\n\n```ts\nexport class MySequence implements SequenceHandler {\n constructor(\n @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,\n @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,\n @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,\n @inject(SequenceActions.SEND) public send: Send,\n @inject(SequenceActions.REJECT) public reject: Reject,\n @inject(AuthenticationBindings.USER_AUTH_ACTION)\n protected authenticateRequest: AuthenticateFn,\n ) {}\n\n async handle(context: RequestContext) {\n try {\n const {request, response} = context;\n\n const route = this.findRoute(request);\n const args = await this.parseParams(request, route);\n request.body = args[args.length - 1];\n const authUser: AuthUser = await this.authenticateRequest(\n request,\n response,\n );\n const result = await this.invoke(route, args);\n this.send(response, result);\n } catch (err) {\n this.reject(context, err);\n }\n }\n}\n```\n\nAfter this, you can use decorator to apply auth to controller functions wherever needed. See below.\n\n```ts\n@authenticateClient(STRATEGY.CLIENT_PASSWORD)\n @authenticate(\n STRATEGY.GOOGLE_OAUTH2,\n {\n accessType: 'offline',\n scope: ['profile', 'email'],\n authorizationURL: process.env.GOOGLE_AUTH_URL,\n callbackURL: process.env.GOOGLE_AUTH_CALLBACK_URL,\n clientID: process.env.GOOGLE_AUTH_CLIENT_ID,\n clientSecret: process.env.GOOGLE_AUTH_CLIENT_SECRET,\n tokenURL: process.env.GOOGLE_AUTH_TOKEN_URL,\n },\n (req: Request) => {\n return {\n accessType: 'offline',\n state: Object.keys(req.query)\n .map(key => key + '=' + req.query[key])\n .join('&'),\n };\n },\n )\n @authorize(['*'])\n @get('/auth/google', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Token Response',\n content: {\n [CONTENT_TYPE.JSON]: {\n schema: {'x-ts-type': TokenResponse},\n },\n },\n },\n },\n })\n async loginViaGoogle(\n @param.query.string('client_id')\n clientId?: string,\n @param.query.string('client_secret')\n clientSecret?: string,\n ): Promise {}\n\n @authenticate(\n STRATEGY.GOOGLE_OAUTH2,\n {\n accessType: 'offline',\n scope: ['profile', 'email'],\n authorizationURL: process.env.GOOGLE_AUTH_URL,\n callbackURL: process.env.GOOGLE_AUTH_CALLBACK_URL,\n clientID: process.env.GOOGLE_AUTH_CLIENT_ID,\n clientSecret: process.env.GOOGLE_AUTH_CLIENT_SECRET,\n tokenURL: process.env.GOOGLE_AUTH_TOKEN_URL,\n },\n (req: Request) => {\n return {\n accessType: 'offline',\n state: Object.keys(req.query)\n .map(key => `${key}=${req.query[key]}`)\n .join('&'),\n };\n },\n )\n @authorize(['*'])\n @get('/auth/google-auth-redirect', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Token Response',\n content: {\n [CONTENT_TYPE.JSON]: {\n schema: {'x-ts-type': TokenResponse},\n },\n },\n },\n },\n })\n async googleCallback(\n @param.query.string('code') code: string,\n @param.query.string('state') state: string,\n @inject(RestBindings.Http.RESPONSE) response: Response,\n ): Promise {\n const clientId = new URLSearchParams(state).get('client_id');\n if (!clientId || !this.user) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);\n }\n const client = await this.authClientRepository.findOne({\n where: {\n clientId: clientId,\n },\n });\n if (!client || !client.redirectUrl) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);\n }\n try {\n const codePayload: ClientAuthCode = {\n clientId,\n user: this.user,\n };\n const token = jwt.sign(codePayload, client.secret, {\n expiresIn: client.authCodeExpiration,\n audience: clientId,\n subject: this.user.username,\n issuer: process.env.JWT_ISSUER,\n });\n response.redirect(`${client.redirectUrl}?code=${token}`);\n } catch (error) {\n throw new HttpErrors.InternalServerError(AuthErrorKeys.UnknownError);\n }\n }\n```\n\nPlease 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.\n\nFor 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.\n\n```ts\n @inject.getter(AuthenticationBindings.CURRENT_USER)\n private readonly getCurrentUser: Getter,\n```\n\n### Instagram Oauth 2\n\nIn order to use it, run `npm install passport-instagram`.\nFirst, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.\n\n```ts\n@model({\n name: 'users',\n})\nexport class User extends Entity implements IAuthUser {\n @property({\n type: 'number',\n id: true,\n })\n id?: number;\n\n @property({\n type: 'string',\n required: true,\n name: 'first_name',\n })\n firstName: string;\n\n @property({\n type: 'string',\n name: 'last_name',\n })\n lastName: string;\n\n @property({\n type: 'string',\n name: 'middle_name',\n })\n middleName?: string;\n\n @property({\n type: 'string',\n required: true,\n })\n username: string;\n\n @property({\n type: 'string',\n })\n email?: string;\n\n // Auth provider - 'instagram'\n @property({\n type: 'string',\n required: true,\n name: 'auth_provider',\n })\n authProvider: string;\n\n // Id from external provider\n @property({\n type: 'string',\n name: 'auth_id',\n })\n authId?: string;\n\n @property({\n type: 'string',\n name: 'auth_token',\n })\n authToken?: string;\n\n @property({\n type: 'string',\n })\n password?: string;\n\n constructor(data?: Partial) {\n super(data);\n }\n}\n```\n\nNow bind this model to USER_MODEL key in application.ts\n\n```ts\nthis.bind(AuthenticationBindings.USER_MODEL).to(User);\n```\n\nCreate CRUD repository for the above model. Use loopback CLI.\n\n```sh\nlb4 repository\n```\n\nAdd 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.\n\n```ts\nimport {Provider} from '@loopback/context';\nimport {repository} from '@loopback/repository';\nimport {HttpErrors} from '@loopback/rest';\nimport {AuthErrorKeys, VerifyFunction} from 'loopback4-authentication';\n\nimport {Tenant} from '../../../models';\nimport {UserCredentialsRepository, UserRepository} from '../../../repositories';\nimport {AuthUser} from '../models/auth-user.model';\n\nexport class InstagramOauth2VerifyProvider\n implements Provider\n{\n constructor(\n @repository(UserRepository)\n public userRepository: UserRepository,\n @repository(UserCredentialsRepository)\n public userCredsRepository: UserCredentialsRepository,\n ) {}\n\n value(): VerifyFunction.InstagramAuthFn {\n return async (accessToken, refreshToken, profile) => {\n const user = await this.userRepository.findOne({\n where: {\n /* eslint-disable-next-line @typescript-eslint/no-explicit-any */\n email: (profile as any)._json.email,\n },\n });\n if (!user) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);\n }\n if (\n !user ||\n user.authProvider !== 'instagram' ||\n user.authId !== profile.id\n ) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);\n }\n\n const authUser: AuthUser = new AuthUser(user);\n authUser.permissions = [];\n authUser.externalAuthToken = accessToken;\n authUser.externalRefreshToken = refreshToken;\n authUser.tenant = new Tenant({id: user.defaultTenant});\n return authUser;\n };\n }\n}\n```\n\nPlease note the Verify function type _VerifyFunction.LocalPasswordFn_\n\nNow bind this provider to the application in application.ts.\n\n```ts\nimport {AuthenticationComponent, Strategies} from 'loopback4-authentication';\n```\n\n```ts\n// Add authentication component\nthis.component(AuthenticationComponent);\n// Customize authentication verify handlers\nthis.bind(Strategies.Passport.INSTAGRAM_OAUTH2_VERIFIER).toProvider(\n InstagramOauth2VerifyProvider,\n);\n```\n\nFinally, add the authenticate function as a sequence action to sequence.ts.\n\n```ts\nexport class MySequence implements SequenceHandler {\n constructor(\n @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,\n @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,\n @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,\n @inject(SequenceActions.SEND) public send: Send,\n @inject(SequenceActions.REJECT) public reject: Reject,\n @inject(AuthenticationBindings.USER_AUTH_ACTION)\n protected authenticateRequest: AuthenticateFn,\n ) {}\n\n async handle(context: RequestContext) {\n try {\n const {request, response} = context;\n\n const route = this.findRoute(request);\n const args = await this.parseParams(request, route);\n request.body = args[args.length - 1];\n const authUser: AuthUser = await this.authenticateRequest(\n request,\n response,\n );\n const result = await this.invoke(route, args);\n this.send(response, result);\n } catch (err) {\n this.reject(context, err);\n }\n }\n}\n```\n\nAfter this, you can use decorator to apply auth to controller functions wherever needed. See below.\n\n```ts\n@authenticateClient(STRATEGY.CLIENT_PASSWORD)\n @authenticate(\n STRATEGY.INSTAGRAM_OAUTH2,\n {\n accessType: 'offline',\n authorizationURL: process.env.INSTAGRAM_AUTH_URL,\n callbackURL: process.env.INSTAGRAM_AUTH_CALLBACK_URL,\n clientID: process.env.INSTAGRAM_AUTH_CLIENT_ID,\n clientSecret: process.env.INSTAGRAM_AUTH_CLIENT_SECRET,\n tokenURL: process.env.INSTAGRAM_AUTH_TOKEN_URL,\n },\n (req: Request) => {\n return {\n accessType: 'offline',\n state: Object.keys(req.query)\n .map(key => key + '=' + req.query[key])\n .join('&'),\n };\n },\n )\n @authorize(['*'])\n @get('/auth/instagram', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Token Response',\n content: {\n [CONTENT_TYPE.JSON]: {\n schema: {'x-ts-type': TokenResponse},\n },\n },\n },\n },\n })\n async loginViaInstagram(\n @param.query.string('client_id')\n clientId?: string,\n @param.query.string('client_secret')\n clientSecret?: string,\n ): Promise {}\n\n @authenticate(\n STRATEGY.INSTAGRAM_OAUTH2,\n {\n accessType: 'offline',\n authorizationURL: process.env.INSTAGRAM_AUTH_URL,\n callbackURL: process.env.INSTAGRAM_AUTH_CALLBACK_URL,\n clientID: process.env.INSTAGRAM_AUTH_CLIENT_ID,\n clientSecret: process.env.INSTAGRAM_AUTH_CLIENT_SECRET,\n tokenURL: process.env.INSTAGRAM_AUTH_TOKEN_URL,\n },\n (req: Request) => {\n return {\n accessType: 'offline',\n state: Object.keys(req.query)\n .map(key => `${key}=${req.query[key]}`)\n .join('&'),\n };\n },\n )\n @authorize(['*'])\n @get('/auth/instagram-auth-redirect', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Token Response',\n content: {\n [CONTENT_TYPE.JSON]: {\n schema: {'x-ts-type': TokenResponse},\n },\n },\n },\n },\n })\n async instagramCallback(\n @param.query.string('code') code: string,\n @param.query.string('state') state: string,\n @inject(RestBindings.Http.RESPONSE) response: Response,\n ): Promise {\n const clientId = new URLSearchParams(state).get('client_id');\n if (!clientId || !this.user) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);\n }\n const client = await this.authClientRepository.findOne({\n where: {\n clientId: clientId,\n },\n });\n if (!client || !client.redirectUrl) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);\n }\n try {\n const codePayload: ClientAuthCode = {\n clientId,\n user: this.user,\n };\n const token = jwt.sign(codePayload, client.secret, {\n expiresIn: client.authCodeExpiration,\n audience: clientId,\n subject: this.user.username,\n issuer: process.env.JWT_ISSUER,\n });\n response.redirect(`${client.redirectUrl}?code=${token}`);\n } catch (error) {\n throw new HttpErrors.InternalServerError(AuthErrorKeys.UnknownError);\n }\n }\n```\n\nPlease 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.\n\nFor 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.\n\n```ts\n @inject.getter(AuthenticationBindings.CURRENT_USER)\n private readonly getCurrentUser: Getter,\n```\n\n### Apple Oauth 2\n\nIn order to use it, run `npm install --save passport-apple`.\nFirst, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.\n\n```ts\n@model({\n name: 'users',\n})\nexport class User extends Entity implements IAuthUser {\n @property({\n type: 'number',\n id: true,\n })\n id?: number;\n\n @property({\n type: 'string',\n required: true,\n name: 'first_name',\n })\n firstName: string;\n\n @property({\n type: 'string',\n name: 'last_name',\n })\n lastName: string;\n\n @property({\n type: 'string',\n name: 'middle_name',\n })\n middleName?: string;\n\n @property({\n type: 'string',\n required: true,\n })\n username: string;\n\n @property({\n type: 'string',\n })\n email?: string;\n\n // Auth provider - 'apple'\n @property({\n type: 'string',\n required: true,\n name: 'auth_provider',\n })\n authProvider: string;\n\n // Id from external provider\n @property({\n type: 'string',\n name: 'auth_id',\n })\n authId?: string;\n\n @property({\n type: 'string',\n name: 'auth_token',\n })\n authToken?: string;\n\n @property({\n type: 'string',\n })\n password?: string;\n\n constructor(data?: Partial) {\n super(data);\n }\n}\n```\n\nNow bind this model to USER_MODEL key in application.ts\n\n```ts\nthis.bind(AuthenticationBindings.USER_MODEL).to(User);\n```\n\nCreate CRUD repository for the above model. Use loopback CLI.\n\n```sh\nlb4 repository\n```\n\nAdd 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.\n\n```ts\nimport {Provider} from '@loopback/context';\nimport {repository} from '@loopback/repository';\nimport {HttpErrors} from '@loopback/rest';\nimport {AuthErrorKeys, VerifyFunction} from 'loopback4-authentication';\n\nimport {Tenant} from '../../../models';\nimport {UserCredentialsRepository, UserRepository} from '../../../repositories';\nimport {AuthUser} from '../models/auth-user.model';\n\nexport class AppleOauth2VerifyProvider\n implements Provider\n{\n constructor(\n @repository(UserRepository)\n public userRepository: UserRepository,\n @repository(UserCredentialsRepository)\n public userCredsRepository: UserCredentialsRepository,\n ) {}\n\n value(): VerifyFunction.AppleAuthFn {\n return async (accessToken, refreshToken, profile) => {\n const user = await this.userRepository.findOne({\n where: {\n /* eslint-disable-next-line @typescript-eslint/no-explicit-any */\n email: (profile as any)._json.email,\n },\n });\n if (!user) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);\n }\n if (\n !user ||\n user.authProvider !== 'apple' ||\n user.authId !== profile.id\n ) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);\n }\n\n const authUser: AuthUser = new AuthUser(user);\n authUser.permissions = [];\n authUser.externalAuthToken = accessToken;\n authUser.externalRefreshToken = refreshToken;\n authUser.tenant = new Tenant({id: user.defaultTenant});\n return authUser;\n };\n }\n}\n```\n\nPlease note the Verify function type _VerifyFunction.LocalPasswordFn_\n\nNow bind this provider to the application in application.ts.\n\n```ts\nimport {AuthenticationComponent, Strategies} from 'loopback4-authentication';\n```\n\n```ts\n// Add authentication component\nthis.component(AuthenticationComponent);\n// Customize authentication verify handlers\nthis.bind(Strategies.Passport.APPLE_OAUTH2_VERIFIER).toProvider(\n AppleOauth2VerifyProvider,\n);\n```\n\nFinally, add the authenticate function as a sequence action to sequence.ts.\n\n```ts\nexport class MySequence implements SequenceHandler {\n constructor(\n @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,\n @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,\n @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,\n @inject(SequenceActions.SEND) public send: Send,\n @inject(SequenceActions.REJECT) public reject: Reject,\n @inject(AuthenticationBindings.USER_AUTH_ACTION)\n protected authenticateRequest: AuthenticateFn,\n ) {}\n\n async handle(context: RequestContext) {\n try {\n const {request, response} = context;\n\n const route = this.findRoute(request);\n const args = await this.parseParams(request, route);\n request.body = args[args.length - 1];\n const authUser: AuthUser = await this.authenticateRequest(\n request,\n response,\n );\n const result = await this.invoke(route, args);\n this.send(response, result);\n } catch (err) {\n this.reject(context, err);\n }\n }\n}\n```\n\nAfter this, you can use decorator to apply auth to controller functions wherever needed. See below.\n\n```ts\n@authenticateClient(STRATEGY.CLIENT_PASSWORD)\n @authenticate(\n STRATEGY.APPLE_OAUTH2,\n {\n accessType: 'offline',\n scope: ['name', 'email'],\n callbackURL: process.env.APPLE_AUTH_CALLBACK_URL,\n clientID: process.env.APPLE_AUTH_CLIENT_ID,\n teamID: process.env.APPLE_AUTH_TEAM_ID,\n keyID: process.env.APPLE_AUTH_KEY_ID,\n privateKeyLocation: process.env.APPLE_AUTH_PRIVATE_KEY_LOCATION,\n },\n (req: Request) => {\n return {\n accessType: 'offline',\n state: Object.keys(req.query)\n .map(key => key + '=' + req.query[key])\n .join('&'),\n };\n },\n )\n @authorize(['*'])\n @get('/auth/oauth-apple', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Token Response',\n content: {\n [CONTENT_TYPE.JSON]: {\n schema: {'x-ts-type': TokenResponse},\n },\n },\n },\n },\n })\n async loginViaApple(\n @param.query.string('client_id')\n clientId?: string,\n @param.query.string('client_secret')\n clientSecret?: string,\n ): Promise {}\n\n @authenticate(\n STRATEGY.APPLE_OAUTH2,\n {\n accessType: 'offline',\n scope: ['name', 'email'],\n callbackURL: process.env.APPLE_AUTH_CALLBACK_URL,\n clientID: process.env.APPLE_AUTH_CLIENT_ID,\n teamID: process.env.APPLE_AUTH_TEAM_ID,\n keyID: process.env.APPLE_AUTH_KEY_ID,\n privateKeyLocation: process.env.APPLE_AUTH_PRIVATE_KEY_LOCATION,\n },\n (req: Request) => {\n return {\n accessType: 'offline',\n state: Object.keys(req.query)\n .map(key => `${key}=${req.query[key]}`)\n .join('&'),\n };\n },\n )\n @authorize(['*'])\n @get('/auth/apple-oauth-redirect', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Token Response',\n content: {\n [CONTENT_TYPE.JSON]: {\n schema: {'x-ts-type': TokenResponse},\n },\n },\n },\n },\n })\n async appleCallback(\n @param.query.string('code') code: string,\n @param.query.string('state') state: string,\n @inject(RestBindings.Http.RESPONSE) response: Response,\n ): Promise {\n const clientId = new URLSearchParams(state).get('client_id');\n if (!clientId || !this.user) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);\n }\n const client = await this.authClientRepository.findOne({\n where: {\n clientId: clientId,\n },\n });\n if (!client || !client.redirectUrl) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);\n }\n try {\n const codePayload: ClientAuthCode = {\n clientId,\n user: this.user,\n };\n const token = jwt.sign(codePayload, client.secret, {\n expiresIn: client.authCodeExpiration,\n audience: clientId,\n subject: this.user.username,\n issuer: process.env.JWT_ISSUER,\n });\n response.redirect(`${client.redirectUrl}?code=${token}`);\n } catch (error) {\n throw new HttpErrors.InternalServerError(AuthErrorKeys.UnknownError);\n }\n }\n```\n\nPlease 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.\n\nFor 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.\n\n```ts\n @inject.getter(AuthenticationBindings.CURRENT_USER)\n private readonly getCurrentUser: Getter,\n```\n\n### Facebook Oauth 2\n\nIn order to use it, run `npm install passport-facebook`.\nFirst, create a AuthUser model implementing the IAuthUser interface. You can implement the interface in the user model itself. See sample below.\n\n```ts\n@model({\n name: 'users',\n})\nexport class User extends Entity implements IAuthUser {\n @property({\n type: 'number',\n id: true,\n })\n id?: number;\n\n @property({\n type: 'string',\n required: true,\n name: 'first_name',\n })\n firstName: string;\n\n @property({\n type: 'string',\n name: 'last_name',\n })\n lastName: string;\n\n @property({\n type: 'string',\n name: 'middle_name',\n })\n middleName?: string;\n\n @property({\n type: 'string',\n required: true,\n })\n username: string;\n\n @property({\n type: 'string',\n })\n email?: string;\n\n // Auth provider - 'facebook'\n @property({\n type: 'string',\n required: true,\n name: 'auth_provider',\n })\n authProvider: string;\n\n // Id from external provider\n @property({\n type: 'string',\n name: 'auth_id',\n })\n authId?: string;\n\n @property({\n type: 'string',\n name: 'auth_token',\n })\n authToken?: string;\n\n @property({\n type: 'string',\n })\n password?: string;\n\n constructor(data?: Partial) {\n super(data);\n }\n}\n```\n\nNow bind this model to USER_MODEL key in application.ts\n\n```ts\nthis.bind(AuthenticationBindings.USER_MODEL).to(User);\n```\n\nCreate CRUD repository for the above model. Use loopback CLI.\n\n```sh\nlb4 repository\n```\n\nAdd 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.\n\n```ts\nimport {Provider} from '@loopback/context';\nimport {repository} from '@loopback/repository';\nimport {HttpErrors} from '@loopback/rest';\nimport {AuthErrorKeys, VerifyFunction} from 'loopback4-authentication';\n\nimport {Tenant} from '../../../models';\nimport {UserCredentialsRepository, UserRepository} from '../../../repositories';\nimport {AuthUser} from '../models/auth-user.model';\n\nexport class FacebookOauth2VerifyProvider\n implements Provider\n{\n constructor(\n @repository(UserRepository)\n public userRepository: UserRepository,\n @repository(UserCredentialsRepository)\n public userCredsRepository: UserCredentialsRepository,\n ) {}\n\n value(): VerifyFunction.FacebookAuthFn {\n return async (accessToken, refreshToken, profile) => {\n const user = await this.userRepository.findOne({\n where: {\n /* eslint-disable-next-line @typescript-eslint/no-explicit-any */\n email: (profile as any)._json.email,\n },\n });\n if (!user) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);\n }\n if (\n !user ||\n user.authProvider !== 'facebook' ||\n user.authId !== profile.id\n ) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.InvalidCredentials);\n }\n\n const authUser: AuthUser = new AuthUser(user);\n authUser.permissions = [];\n authUser.externalAuthToken = accessToken;\n authUser.externalRefreshToken = refreshToken;\n authUser.tenant = new Tenant({id: user.defaultTenant});\n return authUser;\n };\n }\n}\n```\n\nPlease note the Verify function type _VerifyFunction.LocalPasswordFn_\n\nNow bind this provider to the application in application.ts.\n\n```ts\nimport {AuthenticationComponent, Strategies} from 'loopback4-authentication';\n```\n\n```ts\n// Add authentication component\nthis.component(AuthenticationComponent);\n// Customize authentication verify handlers\nthis.bind(Strategies.Passport.FACEBOOK_OAUTH2_VERIFIER).toProvider(\n FacebookOauth2VerifyProvider,\n);\n```\n\nFinally, add the authenticate function as a sequence action to sequence.ts.\n\n```ts\nexport class MySequence implements SequenceHandler {\n constructor(\n @inject(SequenceActions.FIND_ROUTE) protected findRoute: FindRoute,\n @inject(SequenceActions.PARSE_PARAMS) protected parseParams: ParseParams,\n @inject(SequenceActions.INVOKE_METHOD) protected invoke: InvokeMethod,\n @inject(SequenceActions.SEND) public send: Send,\n @inject(SequenceActions.REJECT) public reject: Reject,\n @inject(AuthenticationBindings.USER_AUTH_ACTION)\n protected authenticateRequest: AuthenticateFn,\n ) {}\n\n async handle(context: RequestContext) {\n try {\n const {request, response} = context;\n\n const route = this.findRoute(request);\n const args = await this.parseParams(request, route);\n request.body = args[args.length - 1];\n const authUser: AuthUser = await this.authenticateRequest(\n request,\n response,\n );\n const result = await this.invoke(route, args);\n this.send(response, result);\n } catch (err) {\n this.reject(context, err);\n }\n }\n}\n```\n\nAfter this, you can use decorator to apply auth to controller functions wherever needed. See below.\n\n```ts\n@authenticateClient(STRATEGY.CLIENT_PASSWORD)\n @authenticate(\n STRATEGY.FACEBOOK_OAUTH2,\n {\n accessType: 'offline',\n authorizationURL: process.env.FACEBOOK_AUTH_URL,\n callbackURL: process.env.FACEBOOK_AUTH_CALLBACK_URL,\n clientID: process.env.FACEBOOK_AUTH_CLIENT_ID,\n clientSecret: process.env.FACEBOOK_AUTH_CLIENT_SECRET,\n tokenURL: process.env.FACEBOOK_AUTH_TOKEN_URL,\n },\n (req: Request) => {\n return {\n accessType: 'offline',\n state: Object.keys(req.query)\n .map(key => key + '=' + req.query[key])\n .join('&'),\n };\n },\n )\n @authorize(['*'])\n @get('/auth/facebook', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Token Response',\n content: {\n [CONTENT_TYPE.JSON]: {\n schema: {'x-ts-type': TokenResponse},\n },\n },\n },\n },\n })\n async loginViaFacebook(\n @param.query.string('client_id')\n clientId?: string,\n @param.query.string('client_secret')\n clientSecret?: string,\n ): Promise {}\n\n @authenticate(\n STRATEGY.FACEBOOK_OAUTH2,\n {\n accessType: 'offline',\n authorizationURL: process.env.FACEBOOK_AUTH_URL,\n callbackURL: process.env.FACEBOOK_AUTH_CALLBACK_URL,\n clientID: process.env.FACEBOOK_AUTH_CLIENT_ID,\n clientSecret: process.env.FACEBOOK_AUTH_CLIENT_SECRET,\n tokenURL: process.env.FACEBOOK_AUTH_TOKEN_URL,\n },\n (req: Request) => {\n return {\n accessType: 'offline',\n state: Object.keys(req.query)\n .map(key => `${key}=${req.query[key]}`)\n .join('&'),\n };\n },\n )\n @authorize(['*'])\n @get('/auth/facebook-auth-redirect', {\n responses: {\n [STATUS_CODE.OK]: {\n description: 'Token Response',\n content: {\n [CONTENT_TYPE.JSON]: {\n schema: {'x-ts-type': TokenResponse},\n },\n },\n },\n },\n })\n async facebookCallback(\n @param.query.string('code') code: string,\n @param.query.string('state') state: string,\n @inject(RestBindings.Http.RESPONSE) response: Response,\n ): Promise {\n const clientId = new URLSearchParams(state).get('client_id');\n if (!clientId || !this.user) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);\n }\n const client = await this.authClientRepository.findOne({\n where: {\n clientId: clientId,\n },\n });\n if (!client || !client.redirectUrl) {\n throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);\n }\n try {\n const codePayload: ClientAuthCode = {\n clientId,\n user: this.user,\n };\n const token = jwt.sign(codePayload, client.secret, {\n expiresIn: client.authCodeExpiration,\n audience: clientId,\n subject: this.user.username,\n issuer: process.env.JWT_ISSUER,\n });\n response.redirect(`${client.redirectUrl}?code=${token}`","readmeFilename":"README.md"}
![\"ARC](\"https://github.com/sourcefuse/loopback4-microservice-catalog/blob/master/docs/assets/logo-dark-bg.png?raw=true\" "\\"ARC"){kind=logo}
![\"npm](\"https://img.shields.io/npm/v/loopback4-authentication.svg\")
\n\n\n![\"Sonar](\"https://img.shields.io/sonar/quality_gate/sourcefuse_loopback4-authentication?server=https%3A%2F%2Fsonarcloud.io\")
![\"GitHub](\"https://img.shields.io/github/contributors/sourcefuse/loopback4-authentication?\")
![\"downloads\"](\"https://img.shields.io/npm/dw/loopback4-authentication.svg\")
\n\n\n![\"License\"](\"https://img.shields.io/github/license/sourcefuse/loopback4-authentication.svg\")
\n\n\n![\"Powered](\"https://img.shields.io/badge/Powered%20by-LoopBack){kind=icon}