auth-backend: refactor provider factories to accept options

plugins/auth-backend/src/providers/auth0/index.ts

@@ -15,3 +15,4 @@
  */
 
 export { createAuth0Provider } from './provider';
+export type { Auth0ProviderOptions } from './provider';

plugins/auth-backend/src/providers/auth0/provider.ts

@@ -148,28 +148,29 @@ export class Auth0AuthProvider implements OAuthHandlers {
   }
 }
 
-export const createAuth0Provider: AuthProviderFactory = ({
-  providerId,
-  globalConfig,
-  config,
-  tokenIssuer,
-}) =>
-  OAuthEnvironmentHandler.mapConfig(config, envConfig => {
-    const clientId = envConfig.getString('clientId');
-    const clientSecret = envConfig.getString('clientSecret');
-    const domain = envConfig.getString('domain');
-    const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
+export type Auth0ProviderOptions = {};
 
-    const provider = new Auth0AuthProvider({
-      clientId,
-      clientSecret,
-      callbackUrl,
-      domain,
-    });
+export const createAuth0Provider = (
+  _options?: Auth0ProviderOptions,
+): AuthProviderFactory => {
+  return ({ providerId, globalConfig, config, tokenIssuer }) =>
+    OAuthEnvironmentHandler.mapConfig(config, envConfig => {
+      const clientId = envConfig.getString('clientId');
+      const clientSecret = envConfig.getString('clientSecret');
+      const domain = envConfig.getString('domain');
+      const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
 
-    return OAuthAdapter.fromConfig(globalConfig, provider, {
-      disableRefresh: true,
-      providerId,
-      tokenIssuer,
+      const provider = new Auth0AuthProvider({
+        clientId,
+        clientSecret,
+        callbackUrl,
+        domain,
+      });
+
+      return OAuthAdapter.fromConfig(globalConfig, provider, {
+        disableRefresh: true,
+        providerId,
+        tokenIssuer,
+      });
     });
-  });
+};

plugins/auth-backend/src/providers/aws-alb/index.ts

@@ -14,3 +14,4 @@
  * limitations under the License.
  */
 export { createAwsAlbProvider } from './provider';
+export type { AwsAlbProviderOptions } from './provider';

plugins/auth-backend/src/providers/aws-alb/provider.ts

@@ -106,22 +106,26 @@ export class AwsAlbAuthProvider implements AuthProviderRouteHandlers {
   }
 }
 
-export const createAwsAlbProvider = ({
-  logger,
-  catalogApi,
-  config,
-  identityResolver,
-}: AuthProviderFactoryOptions) => {
-  const region = config.getString('region');
-  const issuer = config.getOptionalString('iss');
-  if (identityResolver !== undefined) {
-    return new AwsAlbAuthProvider(logger, catalogApi, {
-      region,
-      issuer,
-      identityResolutionCallback: identityResolver,
-    });
-  }
-  throw new Error(
-    'Identity resolver is required to use this authentication provider',
-  );
+export type AwsAlbProviderOptions = {};
+
+export const createAwsAlbProvider = (_options?: AwsAlbProviderOptions) => {
+  return ({
+    logger,
+    catalogApi,
+    config,
+    identityResolver,
+  }: AuthProviderFactoryOptions) => {
+    const region = config.getString('region');
+    const issuer = config.getOptionalString('iss');
+    if (identityResolver !== undefined) {
+      return new AwsAlbAuthProvider(logger, catalogApi, {
+        region,
+        issuer,
+        identityResolutionCallback: identityResolver,
+      });
+    }
+    throw new Error(
+      'Identity resolver is required to use this authentication provider',
+    );
+  };
 };

plugins/auth-backend/src/providers/factories.ts

@@ -28,15 +28,15 @@ import { AuthProviderFactory } from './types';
 import { createAwsAlbProvider } from './aws-alb';
 
 export const factories: { [providerId: string]: AuthProviderFactory } = {
-  google: createGoogleProvider,
-  github: createGithubProvider,
-  gitlab: createGitlabProvider,
-  saml: createSamlProvider,
-  okta: createOktaProvider,
-  auth0: createAuth0Provider,
-  microsoft: createMicrosoftProvider,
-  oauth2: createOAuth2Provider,
-  oidc: createOidcProvider,
-  onelogin: createOneLoginProvider,
-  awsalb: createAwsAlbProvider,
+  google: createGoogleProvider(),
+  github: createGithubProvider(),
+  gitlab: createGitlabProvider(),
+  saml: createSamlProvider(),
+  okta: createOktaProvider(),
+  auth0: createAuth0Provider(),
+  microsoft: createMicrosoftProvider(),
+  oauth2: createOAuth2Provider(),
+  oidc: createOidcProvider(),
+  onelogin: createOneLoginProvider(),
+  awsalb: createAwsAlbProvider(),
 };

plugins/auth-backend/src/providers/github/index.ts

@@ -15,3 +15,4 @@
  */
 
 export { createGithubProvider } from './provider';
+export type { GithubProviderOptions } from './provider';

plugins/auth-backend/src/providers/github/provider.ts

@@ -136,42 +136,43 @@ export class GithubAuthProvider implements OAuthHandlers {
   }
 }
 
-export const createGithubProvider: AuthProviderFactory = ({
-  providerId,
-  globalConfig,
-  config,
-  tokenIssuer,
-}) =>
-  OAuthEnvironmentHandler.mapConfig(config, envConfig => {
-    const clientId = envConfig.getString('clientId');
-    const clientSecret = envConfig.getString('clientSecret');
-    const enterpriseInstanceUrl = envConfig.getOptionalString(
-      'enterpriseInstanceUrl',
-    );
-    const authorizationUrl = enterpriseInstanceUrl
-      ? `${enterpriseInstanceUrl}/login/oauth/authorize`
-      : undefined;
-    const tokenUrl = enterpriseInstanceUrl
-      ? `${enterpriseInstanceUrl}/login/oauth/access_token`
-      : undefined;
-    const userProfileUrl = enterpriseInstanceUrl
-      ? `${enterpriseInstanceUrl}/api/v3/user`
-      : undefined;
-    const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
+export type GithubProviderOptions = {};
 
-    const provider = new GithubAuthProvider({
-      clientId,
-      clientSecret,
-      callbackUrl,
-      tokenUrl,
-      userProfileUrl,
-      authorizationUrl,
-    });
+export const createGithubProvider = (
+  _options?: GithubProviderOptions,
+): AuthProviderFactory => {
+  return ({ providerId, globalConfig, config, tokenIssuer }) =>
+    OAuthEnvironmentHandler.mapConfig(config, envConfig => {
+      const clientId = envConfig.getString('clientId');
+      const clientSecret = envConfig.getString('clientSecret');
+      const enterpriseInstanceUrl = envConfig.getOptionalString(
+        'enterpriseInstanceUrl',
+      );
+      const authorizationUrl = enterpriseInstanceUrl
+        ? `${enterpriseInstanceUrl}/login/oauth/authorize`
+        : undefined;
+      const tokenUrl = enterpriseInstanceUrl
+        ? `${enterpriseInstanceUrl}/login/oauth/access_token`
+        : undefined;
+      const userProfileUrl = enterpriseInstanceUrl
+        ? `${enterpriseInstanceUrl}/api/v3/user`
+        : undefined;
+      const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
 
-    return OAuthAdapter.fromConfig(globalConfig, provider, {
-      disableRefresh: true,
-      persistScopes: true,
-      providerId,
-      tokenIssuer,
+      const provider = new GithubAuthProvider({
+        clientId,
+        clientSecret,
+        callbackUrl,
+        tokenUrl,
+        userProfileUrl,
+        authorizationUrl,
+      });
+
+      return OAuthAdapter.fromConfig(globalConfig, provider, {
+        disableRefresh: true,
+        persistScopes: true,
+        providerId,
+        tokenIssuer,
+      });
     });
-  });
+};

plugins/auth-backend/src/providers/gitlab/index.ts

@@ -15,3 +15,4 @@
  */
 
 export { createGitlabProvider } from './provider';
+export type { GitlabProviderOptions } from './provider';

plugins/auth-backend/src/providers/gitlab/provider.ts

@@ -139,29 +139,30 @@ export class GitlabAuthProvider implements OAuthHandlers {
   }
 }
 
-export const createGitlabProvider: AuthProviderFactory = ({
-  providerId,
-  globalConfig,
-  config,
-  tokenIssuer,
-}) =>
-  OAuthEnvironmentHandler.mapConfig(config, envConfig => {
-    const clientId = envConfig.getString('clientId');
-    const clientSecret = envConfig.getString('clientSecret');
-    const audience = envConfig.getString('audience');
-    const baseUrl = audience || 'https://gitlab.com';
-    const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
+export type GitlabProviderOptions = {};
 
-    const provider = new GitlabAuthProvider({
-      clientId,
-      clientSecret,
-      callbackUrl,
-      baseUrl,
-    });
+export const createGitlabProvider = (
+  _options?: GitlabProviderOptions,
+): AuthProviderFactory => {
+  return ({ providerId, globalConfig, config, tokenIssuer }) =>
+    OAuthEnvironmentHandler.mapConfig(config, envConfig => {
+      const clientId = envConfig.getString('clientId');
+      const clientSecret = envConfig.getString('clientSecret');
+      const audience = envConfig.getString('audience');
+      const baseUrl = audience || 'https://gitlab.com';
+      const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
 
-    return OAuthAdapter.fromConfig(globalConfig, provider, {
-      disableRefresh: true,
-      providerId,
-      tokenIssuer,
+      const provider = new GitlabAuthProvider({
+        clientId,
+        clientSecret,
+        callbackUrl,
+        baseUrl,
+      });
+
+      return OAuthAdapter.fromConfig(globalConfig, provider, {
+        disableRefresh: true,
+        providerId,
+        tokenIssuer,
+      });
     });
-  });
+};

plugins/auth-backend/src/providers/google/index.ts

@@ -15,3 +15,4 @@
  */
 
 export { createGoogleProvider } from './provider';
+export type { GoogleProviderOptions } from './provider';

plugins/auth-backend/src/providers/google/provider.ts

@@ -44,7 +44,7 @@ type PrivateInfo = {
   refreshToken: string;
 };
 
-export type GoogleAuthProviderOptions = OAuthProviderOptions & {
+type Options = OAuthProviderOptions & {
   logger: Logger;
   identityClient: CatalogIdentityClient;
   tokenIssuer: TokenIssuer;
@@ -56,7 +56,7 @@ export class GoogleAuthProvider implements OAuthHandlers {
   private readonly identityClient: CatalogIdentityClient;
   private readonly tokenIssuer: TokenIssuer;
 
-  constructor(options: GoogleAuthProviderOptions) {
+  constructor(options: Options) {
     this.logger = options.logger;
     this.identityClient = options.identityClient;
     this.tokenIssuer = options.tokenIssuer;
@@ -184,31 +184,37 @@ export class GoogleAuthProvider implements OAuthHandlers {
   }
 }
 
-export const createGoogleProvider: AuthProviderFactory = ({
-  providerId,
-  globalConfig,
-  config,
-  logger,
-  tokenIssuer,
-  catalogApi,
-}) =>
-  OAuthEnvironmentHandler.mapConfig(config, envConfig => {
-    const clientId = envConfig.getString('clientId');
-    const clientSecret = envConfig.getString('clientSecret');
-    const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
+export type GoogleProviderOptions = {};
 
-    const provider = new GoogleAuthProvider({
-      clientId,
-      clientSecret,
-      callbackUrl,
-      logger,
-      tokenIssuer,
-      identityClient: new CatalogIdentityClient({ catalogApi }),
-    });
+export const createGoogleProvider = (
+  _options?: GoogleProviderOptions,
+): AuthProviderFactory => {
+  return ({
+    providerId,
+    globalConfig,
+    config,
+    logger,
+    tokenIssuer,
+    catalogApi,
+  }) =>
+    OAuthEnvironmentHandler.mapConfig(config, envConfig => {
+      const clientId = envConfig.getString('clientId');
+      const clientSecret = envConfig.getString('clientSecret');
+      const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
 
-    return OAuthAdapter.fromConfig(globalConfig, provider, {
-      disableRefresh: false,
-      providerId,
-      tokenIssuer,
+      const provider = new GoogleAuthProvider({
+        clientId,
+        clientSecret,
+        callbackUrl,
+        logger,
+        tokenIssuer,
+        identityClient: new CatalogIdentityClient({ catalogApi }),
+      });
+
+      return OAuthAdapter.fromConfig(globalConfig, provider, {
+        disableRefresh: false,
+        providerId,
+        tokenIssuer,
+      });
     });
-  });
+};

plugins/auth-backend/src/providers/microsoft/index.ts

@@ -15,3 +15,4 @@
  */
 
 export { createMicrosoftProvider } from './provider';
+export type { MicrosoftProviderOptions } from './provider';

plugins/auth-backend/src/providers/microsoft/provider.ts

@@ -205,32 +205,33 @@ export class MicrosoftAuthProvider implements OAuthHandlers {
   }
 }
 
-export const createMicrosoftProvider: AuthProviderFactory = ({
-  providerId,
-  globalConfig,
-  config,
-  tokenIssuer,
-}) =>
-  OAuthEnvironmentHandler.mapConfig(config, envConfig => {
-    const clientId = envConfig.getString('clientId');
-    const clientSecret = envConfig.getString('clientSecret');
-    const tenantID = envConfig.getString('tenantId');
+export type MicrosoftProviderOptions = {};
 
-    const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
-    const authorizationUrl = `https://login.microsoftonline.com/${tenantID}/oauth2/v2.0/authorize`;
-    const tokenUrl = `https://login.microsoftonline.com/${tenantID}/oauth2/v2.0/token`;
+export const createMicrosoftProvider = (
+  _options?: MicrosoftProviderOptions,
+): AuthProviderFactory => {
+  return ({ providerId, globalConfig, config, tokenIssuer }) =>
+    OAuthEnvironmentHandler.mapConfig(config, envConfig => {
+      const clientId = envConfig.getString('clientId');
+      const clientSecret = envConfig.getString('clientSecret');
+      const tenantID = envConfig.getString('tenantId');
 
-    const provider = new MicrosoftAuthProvider({
-      clientId,
-      clientSecret,
-      callbackUrl,
-      authorizationUrl,
-      tokenUrl,
+      const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
+      const authorizationUrl = `https://login.microsoftonline.com/${tenantID}/oauth2/v2.0/authorize`;
+      const tokenUrl = `https://login.microsoftonline.com/${tenantID}/oauth2/v2.0/token`;
+
+      const provider = new MicrosoftAuthProvider({
+        clientId,
+        clientSecret,
+        callbackUrl,
+        authorizationUrl,
+        tokenUrl,
+      });
+
+      return OAuthAdapter.fromConfig(globalConfig, provider, {
+        disableRefresh: false,
+        providerId,
+        tokenIssuer,
+      });
     });
-
-    return OAuthAdapter.fromConfig(globalConfig, provider, {
-      disableRefresh: false,
-      providerId,
-      tokenIssuer,
-    });
-  });
+};

plugins/auth-backend/src/providers/oauth2/index.ts

@@ -15,3 +15,4 @@
  */
 
 export { createOAuth2Provider } from './provider';
+export type { OAuth2ProviderOptions } from './provider';

plugins/auth-backend/src/providers/oauth2/provider.ts

@@ -158,32 +158,33 @@ export class OAuth2AuthProvider implements OAuthHandlers {
   }
 }
 
-export const createOAuth2Provider: AuthProviderFactory = ({
-  providerId,
-  globalConfig,
-  config,
-  tokenIssuer,
-}) =>
-  OAuthEnvironmentHandler.mapConfig(config, envConfig => {
-    const clientId = envConfig.getString('clientId');
-    const clientSecret = envConfig.getString('clientSecret');
-    const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
-    const authorizationUrl = envConfig.getString('authorizationUrl');
-    const tokenUrl = envConfig.getString('tokenUrl');
-    const scope = envConfig.getOptionalString('scope');
+export type OAuth2ProviderOptions = {};
 
-    const provider = new OAuth2AuthProvider({
-      clientId,
-      clientSecret,
-      callbackUrl,
-      authorizationUrl,
-      tokenUrl,
-      scope,
-    });
+export const createOAuth2Provider = (
+  _options?: OAuth2ProviderOptions,
+): AuthProviderFactory => {
+  return ({ providerId, globalConfig, config, tokenIssuer }) =>
+    OAuthEnvironmentHandler.mapConfig(config, envConfig => {
+      const clientId = envConfig.getString('clientId');
+      const clientSecret = envConfig.getString('clientSecret');
+      const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
+      const authorizationUrl = envConfig.getString('authorizationUrl');
+      const tokenUrl = envConfig.getString('tokenUrl');
+      const scope = envConfig.getOptionalString('scope');
 
-    return OAuthAdapter.fromConfig(globalConfig, provider, {
-      disableRefresh: false,
-      providerId,
-      tokenIssuer,
+      const provider = new OAuth2AuthProvider({
+        clientId,
+        clientSecret,
+        callbackUrl,
+        authorizationUrl,
+        tokenUrl,
+        scope,
+      });
+
+      return OAuthAdapter.fromConfig(globalConfig, provider, {
+        disableRefresh: false,
+        providerId,
+        tokenIssuer,
+      });
     });
-  });
+};

plugins/auth-backend/src/providers/oidc/index.ts

@@ -15,3 +15,4 @@
  */
 
 export { createOidcProvider } from './provider';
+export type { OidcProviderOptions } from './provider';

plugins/auth-backend/src/providers/oidc/provider.test.ts

@@ -121,7 +121,7 @@ describe('OidcAuthProvider', () => {
         })),
       } as any) as Config,
     } as AuthProviderFactoryOptions;
-    const provider = createOidcProvider(options) as OAuthAdapter;
+    const provider = createOidcProvider()(options) as OAuthAdapter;
     expect(provider.start).toBeDefined();
     await new Promise(resolve => process.nextTick(resolve)); // advance a tick to give nock a chance to intercept the request
     expect(scope.isDone()).toBeTruthy();

plugins/auth-backend/src/providers/oidc/provider.ts

@@ -48,7 +48,7 @@ type OidcImpl = {
   client: Client;
 };
 
-export type OidcAuthProviderOptions = OAuthProviderOptions & {
+export type Options = OAuthProviderOptions & {
   metadataUrl: string;
   tokenSignedResponseAlg?: string;
 };
@@ -56,7 +56,7 @@ export type OidcAuthProviderOptions = OAuthProviderOptions & {
 export class OidcAuthProvider implements OAuthHandlers {
   private readonly implementation: Promise<OidcImpl>;
 
-  constructor(options: OidcAuthProviderOptions) {
+  constructor(options: Options) {
     this.implementation = this.setupStrategy(options);
   }
 
@@ -105,9 +105,7 @@ export class OidcAuthProvider implements OAuthHandlers {
     });
   }
 
-  private async setupStrategy(
-    options: OidcAuthProviderOptions,
-  ): Promise<OidcImpl> {
+  private async setupStrategy(options: Options): Promise<OidcImpl> {
     const issuer = await Issuer.discover(options.metadataUrl);
     const client = new issuer.Client({
       client_id: options.clientId,
@@ -170,32 +168,33 @@ export class OidcAuthProvider implements OAuthHandlers {
   }
 }
 
-export const createOidcProvider: AuthProviderFactory = ({
-  providerId,
-  globalConfig,
-  config,
-  tokenIssuer,
-}) =>
-  OAuthEnvironmentHandler.mapConfig(config, envConfig => {
-    const clientId = envConfig.getString('clientId');
-    const clientSecret = envConfig.getString('clientSecret');
-    const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
-    const metadataUrl = envConfig.getString('metadataUrl');
-    const tokenSignedResponseAlg = envConfig.getString(
-      'tokenSignedResponseAlg',
-    );
+export type OidcProviderOptions = {};
 
-    const provider = new OidcAuthProvider({
-      clientId,
-      clientSecret,
-      callbackUrl,
-      tokenSignedResponseAlg,
-      metadataUrl,
-    });
+export const createOidcProvider = (
+  _options?: OidcProviderOptions,
+): AuthProviderFactory => {
+  return ({ providerId, globalConfig, config, tokenIssuer }) =>
+    OAuthEnvironmentHandler.mapConfig(config, envConfig => {
+      const clientId = envConfig.getString('clientId');
+      const clientSecret = envConfig.getString('clientSecret');
+      const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
+      const metadataUrl = envConfig.getString('metadataUrl');
+      const tokenSignedResponseAlg = envConfig.getString(
+        'tokenSignedResponseAlg',
+      );
 
-    return OAuthAdapter.fromConfig(globalConfig, provider, {
-      disableRefresh: false,
-      providerId,
-      tokenIssuer,
+      const provider = new OidcAuthProvider({
+        clientId,
+        clientSecret,
+        callbackUrl,
+        tokenSignedResponseAlg,
+        metadataUrl,
+      });
+
+      return OAuthAdapter.fromConfig(globalConfig, provider, {
+        disableRefresh: false,
+        providerId,
+        tokenIssuer,
+      });
     });
-  });
+};

plugins/auth-backend/src/providers/okta/index.ts

@@ -13,4 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 export { createOktaProvider } from './provider';
+export type { OktaProviderOptions } from './provider';

plugins/auth-backend/src/providers/okta/provider.ts

@@ -167,28 +167,29 @@ export class OktaAuthProvider implements OAuthHandlers {
   }
 }
 
-export const createOktaProvider: AuthProviderFactory = ({
-  providerId,
-  globalConfig,
-  config,
-  tokenIssuer,
-}) =>
-  OAuthEnvironmentHandler.mapConfig(config, envConfig => {
-    const clientId = envConfig.getString('clientId');
-    const clientSecret = envConfig.getString('clientSecret');
-    const audience = envConfig.getString('audience');
-    const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
+export type OktaProviderOptions = {};
 
-    const provider = new OktaAuthProvider({
-      audience,
-      clientId,
-      clientSecret,
-      callbackUrl,
-    });
+export const createOktaProvider = (
+  _options?: OktaProviderOptions,
+): AuthProviderFactory => {
+  return ({ providerId, globalConfig, config, tokenIssuer }) =>
+    OAuthEnvironmentHandler.mapConfig(config, envConfig => {
+      const clientId = envConfig.getString('clientId');
+      const clientSecret = envConfig.getString('clientSecret');
+      const audience = envConfig.getString('audience');
+      const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
 
-    return OAuthAdapter.fromConfig(globalConfig, provider, {
-      disableRefresh: false,
-      providerId,
-      tokenIssuer,
+      const provider = new OktaAuthProvider({
+        audience,
+        clientId,
+        clientSecret,
+        callbackUrl,
+      });
+
+      return OAuthAdapter.fromConfig(globalConfig, provider, {
+        disableRefresh: false,
+        providerId,
+        tokenIssuer,
+      });
     });
-  });
+};

plugins/auth-backend/src/providers/onelogin/index.ts

@@ -15,3 +15,4 @@
  */
 
 export { createOneLoginProvider } from './provider';
+export type { OneLoginProviderOptions } from './provider';

plugins/auth-backend/src/providers/onelogin/provider.ts

@@ -41,14 +41,14 @@ type PrivateInfo = {
   refreshToken: string;
 };
 
-export type OneLoginProviderOptions = OAuthProviderOptions & {
+export type Options = OAuthProviderOptions & {
   issuer: string;
 };
 
 export class OneLoginProvider implements OAuthHandlers {
   private readonly _strategy: any;
 
-  constructor(options: OneLoginProviderOptions) {
+  constructor(options: Options) {
     this._strategy = new OneLoginStrategy(
       {
         issuer: options.issuer,
@@ -146,28 +146,29 @@ export class OneLoginProvider implements OAuthHandlers {
   }
 }
 
-export const createOneLoginProvider: AuthProviderFactory = ({
-  providerId,
-  globalConfig,
-  config,
-  tokenIssuer,
-}) =>
-  OAuthEnvironmentHandler.mapConfig(config, envConfig => {
-    const clientId = envConfig.getString('clientId');
-    const clientSecret = envConfig.getString('clientSecret');
-    const issuer = envConfig.getString('issuer');
-    const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
+export type OneLoginProviderOptions = {};
 
-    const provider = new OneLoginProvider({
-      clientId,
-      clientSecret,
-      callbackUrl,
-      issuer,
-    });
+export const createOneLoginProvider = (
+  _options?: OneLoginProviderOptions,
+): AuthProviderFactory => {
+  return ({ providerId, globalConfig, config, tokenIssuer }) =>
+    OAuthEnvironmentHandler.mapConfig(config, envConfig => {
+      const clientId = envConfig.getString('clientId');
+      const clientSecret = envConfig.getString('clientSecret');
+      const issuer = envConfig.getString('issuer');
+      const callbackUrl = `${globalConfig.baseUrl}/${providerId}/handler/frame`;
 
-    return OAuthAdapter.fromConfig(globalConfig, provider, {
-      disableRefresh: false,
-      providerId,
-      tokenIssuer,
+      const provider = new OneLoginProvider({
+        clientId,
+        clientSecret,
+        callbackUrl,
+        issuer,
+      });
+
+      return OAuthAdapter.fromConfig(globalConfig, provider, {
+        disableRefresh: false,
+        providerId,
+        tokenIssuer,
+      });
     });
-  });
+};

plugins/auth-backend/src/providers/saml/index.ts

@@ -15,3 +15,4 @@
  */
 
 export { createSamlProvider } from './provider';
+export type { SamlProviderOptions } from './provider';

plugins/auth-backend/src/providers/saml/provider.ts

@@ -39,12 +39,17 @@ type SamlInfo = {
   profile: ProfileInfo;
 };
 
+type Options = SamlConfig & {
+  tokenIssuer: TokenIssuer;
+  appUrl: string;
+};
+
 export class SamlAuthProvider implements AuthProviderRouteHandlers {
   private readonly strategy: SamlStrategy;
   private readonly tokenIssuer: TokenIssuer;
   private readonly appUrl: string;
 
-  constructor(options: SAMLProviderOptions) {
+  constructor(options: Options) {
     this.appUrl = options.appUrl;
     this.tokenIssuer = options.tokenIssuer;
     this.strategy = new SamlStrategy({ ...options }, ((
@@ -113,40 +118,36 @@ export class SamlAuthProvider implements AuthProviderRouteHandlers {
   }
 }
 
-type SAMLProviderOptions = SamlConfig & {
-  tokenIssuer: TokenIssuer;
-  appUrl: string;
-};
-
 type SignatureAlgorithm = 'sha1' | 'sha256' | 'sha512';
 
-export const createSamlProvider: AuthProviderFactory = ({
-  providerId,
-  globalConfig,
-  config,
-  tokenIssuer,
-}) => {
-  const opts = {
-    callbackUrl: `${globalConfig.baseUrl}/${providerId}/handler/frame`,
-    entryPoint: config.getString('entryPoint'),
-    logoutUrl: config.getOptionalString('logoutUrl'),
-    issuer: config.getString('issuer'),
-    cert: config.getOptionalString('cert'),
-    privateCert: config.getOptionalString('privateKey'),
-    decryptionPvk: config.getOptionalString('decryptionPvk'),
-    signatureAlgorithm: config.getOptionalString('signatureAlgorithm') as
-      | SignatureAlgorithm
-      | undefined,
-    digestAlgorithm: config.getOptionalString('digestAlgorithm'),
+export type SamlProviderOptions = {};
 
-    tokenIssuer,
-    appUrl: globalConfig.appUrl,
+export const createSamlProvider = (
+  _options?: SamlProviderOptions,
+): AuthProviderFactory => {
+  return ({ providerId, globalConfig, config, tokenIssuer }) => {
+    const opts = {
+      callbackUrl: `${globalConfig.baseUrl}/${providerId}/handler/frame`,
+      entryPoint: config.getString('entryPoint'),
+      logoutUrl: config.getOptionalString('logoutUrl'),
+      issuer: config.getString('issuer'),
+      cert: config.getOptionalString('cert'),
+      privateCert: config.getOptionalString('privateKey'),
+      decryptionPvk: config.getOptionalString('decryptionPvk'),
+      signatureAlgorithm: config.getOptionalString('signatureAlgorithm') as
+        | SignatureAlgorithm
+        | undefined,
+      digestAlgorithm: config.getOptionalString('digestAlgorithm'),
+
+      tokenIssuer,
+      appUrl: globalConfig.appUrl,
+    };
+
+    // passport-saml will return an error if the `cert` key is set, and the value is empty.
+    // Since we read from config (such as environment variables) an empty string should be equal to being unset.
+    if (!opts.cert) {
+      delete opts.cert;
+    }
+    return new SamlAuthProvider(opts);
   };
-
-  // passport-saml will return an error if the `cert` key is set, and the value is empty.
-  // Since we read from config (such as environment variables) an empty string should be equal to being unset.
-  if (!opts.cert) {
-    delete opts.cert;
-  }
-  return new SamlAuthProvider(opts);
 };