feat(loopback4-authentication): facebook-oauth2 (#47)

ashutosh-bansal-2136 · web-flow · commit 0691f35f8efb · 2021-07-07T18:47:25.000+05:30
diff --git a/README.md b/README.md
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -56,6 +56,7 @@
     "passport": "^0.4.1",
     "passport-apple": "^2.0.1",
     "passport-azure-ad": "^4.3.0",
+    "passport-facebook": "^3.0.0",
     "passport-google-oauth20": "^2.0.0",
     "passport-http-bearer": "^1.0.1",
     "passport-instagram": "^1.0.0",
@@ -76,6 +77,7 @@
     "@types/passport": "^1.0.3",
     "@types/passport-apple": "^1.1.0",
     "@types/passport-azure-ad": "^4.0.8",
+    "@types/passport-facebook": "^2.1.10",
     "@types/passport-google-oauth20": "^2.0.3",
     "@types/passport-http-bearer": "^1.0.35",
     "@types/passport-instagram": "^1.0.1",
diff --git a/src/component.ts b/src/component.ts
@@ -20,6 +20,8 @@ import {
   GoogleAuthVerifyProvider,
   InstagramAuthStrategyFactoryProvider,
   InstagramAuthVerifyProvider,
+  FacebookAuthStrategyFactoryProvider,
+  FacebookAuthVerifyProvider,
   AppleAuthStrategyFactoryProvider,
   AppleAuthVerifyProvider,
   KeycloakStrategyFactoryProvider,
@@ -55,6 +57,8 @@ export class AuthenticationComponent implements Component {
         .key]: GoogleAuthStrategyFactoryProvider,
       [Strategies.Passport.INSTAGRAM_OAUTH2_STRATEGY_FACTORY
         .key]: InstagramAuthStrategyFactoryProvider,
+      [Strategies.Passport.FACEBOOK_OAUTH2_STRATEGY_FACTORY
+        .key]: FacebookAuthStrategyFactoryProvider,
       [Strategies.Passport.APPLE_OAUTH2_STRATEGY_FACTORY
         .key]: AppleAuthStrategyFactoryProvider,
       [Strategies.Passport.AZURE_AD_STRATEGY_FACTORY
@@ -75,6 +79,8 @@ export class AuthenticationComponent implements Component {
         .key]: GoogleAuthVerifyProvider,
       [Strategies.Passport.INSTAGRAM_OAUTH2_VERIFIER
         .key]: InstagramAuthVerifyProvider,
+      [Strategies.Passport.FACEBOOK_OAUTH2_VERIFIER
+        .key]: FacebookAuthVerifyProvider,
       [Strategies.Passport.APPLE_OAUTH2_VERIFIER.key]: AppleAuthVerifyProvider,
       [Strategies.Passport.AZURE_AD_VERIFIER.key]: AzureADAuthVerifyProvider,
       [Strategies.Passport.KEYCLOAK_VERIFIER.key]: KeycloakVerifyProvider,
diff --git a/src/strategies/keys.ts b/src/strategies/keys.ts
@@ -9,6 +9,7 @@ import {AzureADAuthStrategyFactoryProvider} from './passport/passport-azure-ad';
 import {VerifyFunction} from './types';
 import {InstagramAuthStrategyFactoryProvider} from './passport';
 import {AppleAuthStrategyFactoryProvider} from './passport/passport-apple-oauth2';
+import {FacebookAuthStrategyFactoryProvider} from './passport/passport-facebook-oauth2';
 
 export namespace Strategies {
   export namespace Passport {
@@ -75,6 +76,14 @@ export namespace Strategies {
       'sf.passport.verifier.instagramOauth2',
     );
 
+    // Passport-facebook startegy
+    export const FACEBOOK_OAUTH2_STRATEGY_FACTORY = BindingKey.create<FacebookAuthStrategyFactoryProvider>(
+      'sf.passport.strategyFactory.facebookOauth2',
+    );
+    export const FACEBOOK_OAUTH2_VERIFIER = BindingKey.create<VerifyFunction.FacebookAuthFn>(
+      'sf.passport.verifier.facebookOauth2',
+    );
+
     // Passport-apple-oauth2 strategy
     export const APPLE_OAUTH2_STRATEGY_FACTORY = BindingKey.create<AppleAuthStrategyFactoryProvider>(
       'sf.passport.strategyFactory.appleOauth2',
diff --git a/src/strategies/passport/index.ts b/src/strategies/passport/index.ts
@@ -7,3 +7,4 @@ export * from './passport-google-oauth2';
 export * from './passport-azure-ad';
 export * from './passport-insta-oauth2';
 export * from './passport-apple-oauth2';
+export * from './passport-facebook-oauth2';
diff --git a/src/strategies/passport/passport-facebook-oauth2/facebook-auth-strategy-factory-provider.ts b/src/strategies/passport/passport-facebook-oauth2/facebook-auth-strategy-factory-provider.ts
@@ -0,0 +1,115 @@
+import {inject, Provider} from '@loopback/core';
+import {HttpErrors, Request} from '@loopback/rest';
+import {HttpsProxyAgent} from 'https-proxy-agent';
+import {
+  Profile,
+  Strategy,
+  StrategyOption,
+  StrategyOptionWithRequest,
+} from 'passport-facebook';
+
+import {AuthErrorKeys} from '../../../error-keys';
+import {Strategies} from '../../keys';
+import {VerifyCallback, VerifyFunction} from '../../types';
+
+interface ExtendedStrategyOption extends StrategyOption {
+  passReqToCallback?: false;
+}
+
+export interface FacebookAuthStrategyFactory {
+  (
+    options: ExtendedStrategyOption | StrategyOptionWithRequest,
+    verifierPassed?: VerifyFunction.FacebookAuthFn,
+  ): Strategy;
+}
+
+export class FacebookAuthStrategyFactoryProvider
+  implements Provider<FacebookAuthStrategyFactory> {
+  constructor(
+    @inject(Strategies.Passport.FACEBOOK_OAUTH2_VERIFIER)
+    private readonly verifierFacebookAuth: VerifyFunction.FacebookAuthFn,
+  ) {}
+
+  value(): FacebookAuthStrategyFactory {
+    return (options, verifier) =>
+      this.getFacebookAuthStrategyVerifier(options, verifier);
+  }
+
+  getFacebookAuthStrategyVerifier(
+    options: ExtendedStrategyOption | StrategyOptionWithRequest,
+    verifierPassed?: VerifyFunction.FacebookAuthFn,
+  ): Strategy {
+    const verifyFn = verifierPassed ?? this.verifierFacebookAuth;
+    let strategy;
+    if (options && options.passReqToCallback === true) {
+      strategy = new Strategy(
+        options,
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        async (
+          req: Request,
+          accessToken: string,
+          refreshToken: string,
+          profile: Profile,
+          cb: VerifyCallback,
+        ) => {
+          try {
+            const user = await verifyFn(
+              accessToken,
+              refreshToken,
+              profile,
+              cb,
+              req,
+            );
+            if (!user) {
+              throw new HttpErrors.Unauthorized(
+                AuthErrorKeys.InvalidCredentials,
+              );
+            }
+            cb(undefined, user);
+          } catch (err) {
+            cb(err);
+          }
+        },
+      );
+    } else {
+      strategy = new Strategy(
+        options as ExtendedStrategyOption,
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        async (
+          accessToken: string,
+          refreshToken: string,
+          profile: Profile,
+          cb: VerifyCallback,
+        ) => {
+          try {
+            const user = await verifyFn(accessToken, refreshToken, profile, cb);
+            if (!user) {
+              throw new HttpErrors.Unauthorized(
+                AuthErrorKeys.InvalidCredentials,
+              );
+            }
+            cb(undefined, user);
+          } catch (err) {
+            cb(err);
+          }
+        },
+      );
+    }
+
+    this._setupProxy(strategy);
+    return strategy;
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  private _setupProxy(strategy: any) {
+    // Setup proxy if any
+    let httpsProxyAgent;
+    if (process.env['https_proxy']) {
+      httpsProxyAgent = new HttpsProxyAgent(process.env['https_proxy']);
+      strategy._oauth2.setAgent(httpsProxyAgent);
+    } else if (process.env['HTTPS_PROXY']) {
+      httpsProxyAgent = new HttpsProxyAgent(process.env['HTTPS_PROXY']);
+      strategy._oauth2.setAgent(httpsProxyAgent);
+    }
+  }
+}
diff --git a/src/strategies/passport/passport-facebook-oauth2/facebook-auth-verify.provider.ts b/src/strategies/passport/passport-facebook-oauth2/facebook-auth-verify.provider.ts
@@ -0,0 +1,27 @@
+import {Provider} from '@loopback/context';
+import {HttpErrors, Request} from '@loopback/rest';
+import * as FacebookStrategy from 'passport-facebook';
+import {VerifyCallback, VerifyFunction} from '../../types';
+/**
+ * A provider for default implementation of VerifyFunction.LocalPasswordFn
+ *
+ * It will just throw an error saying Not Implemented
+ */
+export class FacebookAuthVerifyProvider
+  implements Provider<VerifyFunction.FacebookAuthFn> {
+  constructor() {}
+
+  value(): VerifyFunction.FacebookAuthFn {
+    return async (
+      accessToken: string,
+      refreshToken: string,
+      profile: FacebookStrategy.Profile,
+      cb: VerifyCallback,
+      req?: Request,
+    ) => {
+      throw new HttpErrors.NotImplemented(
+        `VerifyFunction.FacebookAuthFn is not implemented`,
+      );
+    };
+  }
+}
diff --git a/src/strategies/passport/passport-facebook-oauth2/index.ts b/src/strategies/passport/passport-facebook-oauth2/index.ts
@@ -0,0 +1,2 @@
+export * from './facebook-auth-strategy-factory-provider';
+export * from './facebook-auth-verify.provider';
diff --git a/src/strategies/types.ts b/src/strategies/types.ts
@@ -2,6 +2,7 @@ import {Request} from '@loopback/rest';
 import * as GoogleStrategy from 'passport-google-oauth20';
 import * as AzureADStrategy from 'passport-azure-ad';
 import * as InstagramStrategy from 'passport-instagram';
+import * as FacebookStrategy from 'passport-facebook';
 import * as AppleStrategy from 'passport-apple';
 import {DecodedIdToken} from 'passport-apple';
 import {IAuthClient, IAuthUser} from '../types';
@@ -75,6 +76,17 @@ export namespace VerifyFunction {
     ): Promise<T | null>;
   }
 
+  export interface FacebookAuthFn<T = IAuthUser>
+    extends VerifyFunction.GenericAuthFn<T> {
+    (
+      accessToken: string,
+      refreshToken: string,
+      profile: FacebookStrategy.Profile,
+      cb: VerifyCallback,
+      req?: Request,
+    ): Promise<T | null>;
+  }
+
   export interface AppleAuthFn<T = IAuthUser> extends GenericAuthFn<T> {
     (
       accessToken: string,
diff --git a/src/strategies/user-auth-strategy.provider.ts b/src/strategies/user-auth-strategy.provider.ts
@@ -5,6 +5,7 @@ import * as AzureADAuthStrategy from 'passport-azure-ad';
 import * as PassportBearer from 'passport-http-bearer';
 import * as PassportLocal from 'passport-local';
 import * as InstagramStrategy from 'passport-instagram';
+import * as FacebookStrategy from 'passport-facebook';
 import * as AppleStrategy from 'passport-apple';
 
 import {AuthenticationBindings} from '../keys';
@@ -23,9 +24,14 @@ import {
   AppleAuthStrategyFactory,
   InstagramAuthStrategyFactory,
   KeycloakStrategyFactory,
+  FacebookAuthStrategyFactory,
 } from './passport';
 import {VerifyFunction} from './types';
 
+interface ExtendedStrategyOption extends FacebookStrategy.StrategyOption {
+  passReqToCallback?: false;
+}
+
 export class AuthStrategyProvider implements Provider<Strategy | undefined> {
   constructor(
     @inject(AuthenticationBindings.USER_METADATA)
@@ -45,6 +51,8 @@ export class AuthStrategyProvider implements Provider<Strategy | undefined> {
     @inject.context() private readonly ctx: Context,
     @inject(Strategies.Passport.INSTAGRAM_OAUTH2_STRATEGY_FACTORY)
     private readonly getInstagramAuthVerifier: InstagramAuthStrategyFactory,
+    @inject(Strategies.Passport.FACEBOOK_OAUTH2_STRATEGY_FACTORY)
+    private readonly getFacebookAuthVerifier: FacebookAuthStrategyFactory,
     @inject(Strategies.Passport.APPLE_OAUTH2_STRATEGY_FACTORY)
     private readonly getAppleAuthVerifier: AppleAuthStrategyFactory,
   ) {}
@@ -114,6 +122,13 @@ export class AuthStrategyProvider implements Provider<Strategy | undefined> {
           | AppleStrategy.AuthenticateOptionsWithRequest,
         verifier as VerifyFunction.AppleAuthFn,
       );
+    } else if (name === STRATEGY.FACEBOOK_OAUTH2) {
+      return this.getFacebookAuthVerifier(
+        this.metadata.options as
+          | FacebookStrategy.StrategyOptionWithRequest
+          | ExtendedStrategyOption,
+        verifier as VerifyFunction.FacebookAuthFn,
+      );
     } else {
       return Promise.reject(`The strategy ${name} is not available.`);
     }
diff --git a/src/strategy-name.enum.ts b/src/strategy-name.enum.ts
@@ -6,6 +6,7 @@ export const enum STRATEGY {
   GOOGLE_OAUTH2 = 'Google Oauth 2.0',
   INSTAGRAM_OAUTH2 = 'Instagram Oauth 2.0',
   APPLE_OAUTH2 = 'Apple Oauth 2.0',
+  FACEBOOK_OAUTH2 = 'Facebook Oauth 2.0',
   AZURE_AD = 'Azure AD',
   KEYCLOAK = 'keycloak',
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from './facebook-auth-strategy-factory-provider';`
	`2`	`+export * from './facebook-auth-verify.provider';`