typescript.auth.auth.mustache Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openapi-generator Show documentation
There is a newer version: 7.7.0
import { RequestContext } from "../http/http{{importFileExtension}}";
{{#useInversify}}
import { injectable, inject, named } from "inversify";
import { AbstractTokenProvider } from "../services/configuration";
{{/useInversify}}

/**
 * Interface authentication schemes.
 */
export interface SecurityAuthentication {
    /*
     * @return returns the name of the security authentication as specified in OAI
     */
    getName(): string;

    /**
     * Applies the authentication scheme to the request context
     *
     * @params context the request context which should use this authentication scheme
     */
    applySecurityAuthentication(context: RequestContext): void | Promise;
}

{{#useInversify}}
export const AuthApiKey = Symbol("auth.api_key");
export const AuthUsername = Symbol("auth.username");
export const AuthPassword = Symbol("auth.password");

{{/useInversify}}
export interface TokenProvider {
  getToken(): Promise | string;
}

{{#authMethods}}
/**
 * Applies {{type}} authentication to the request context.
 */
{{#useInversify}}
@injectable()
{{/useInversify}}
export class {{#lambda.pascalcase}}{{name}}{{/lambda.pascalcase}}Authentication implements SecurityAuthentication {
    {{#isApiKey}}
    /**
     * Configures this api key authentication with the necessary properties
     *
     * @param apiKey: The api key to be used for every request
     */
    public constructor({{#useInversify}}@inject(AuthApiKey) @named("{{name}}") {{/useInversify}}private apiKey: string) {}
    {{/isApiKey}}
    {{#isBasicBasic}}
    /**
     * Configures the http authentication with the required details.
     *
     * @param username username for http basic authentication
     * @param password password for http basic authentication
     */
    public constructor(
        {{#useInversify}}@inject(AuthUsername) @named("{{name}}") {{/useInversify}}private username: string,
        {{#useInversify}}@inject(AuthPassword) @named("{{name}}") {{/useInversify}}private password: string
    ) {}
    {{/isBasicBasic}}
    {{#isBasicBearer}}
    /**
     * Configures the http authentication with the required details.
     *
     * @param tokenProvider service that can provide the up-to-date token when needed
     */
    public constructor({{#useInversify}}@inject(AbstractTokenProvider) @named("{{name}}") {{/useInversify}}private tokenProvider: TokenProvider) {}
    {{/isBasicBearer}}
    {{#isOAuth}}
    /**
     * Configures OAuth2 with the necessary properties
     *
     * @param accessToken: The access token to be used for every request
     */
    public constructor(private accessToken: string) {}
    {{/isOAuth}}

    public getName(): string {
        return "{{name}}";
    }

    public {{#isBasicBearer}}async {{/isBasicBearer}}applySecurityAuthentication(context: RequestContext) {
        {{#isApiKey}}
        context.{{#isKeyInHeader}}setHeaderParam{{/isKeyInHeader}}{{#isKeyInQuery}}setQueryParam{{/isKeyInQuery}}{{#isKeyInCookie}}addCookie{{/isKeyInCookie}}("{{keyParamName}}", this.apiKey);
        {{/isApiKey}}
        {{#isBasicBasic}}
        let comb = Buffer.from(this.username + ":" + this.password, 'binary').toString('base64');
        context.setHeaderParam("Authorization", "Basic " + comb);
        {{/isBasicBasic}}
        {{#isBasicBearer}}
        context.setHeaderParam("Authorization", "Bearer " + await this.tokenProvider.getToken());
        {{/isBasicBearer}}
        {{#isOAuth}}
        context.setHeaderParam("Authorization", "Bearer " + this.accessToken);
        {{/isOAuth}}
    }
}

{{/authMethods}}

export type AuthMethods = {
    {{^useInversify}}
    "default"?: SecurityAuthentication,
    {{/useInversify}}
    {{#authMethods}}
    "{{name}}"?: SecurityAuthentication{{^-last}},{{/-last}}
    {{/authMethods}}
}
{{#useInversify}}

export const authMethodServices = {
    {{^useInversify}}
    "default"?: SecurityAuthentication,
    {{/useInversify}}
    {{#authMethods}}
    "{{name}}": {{#lambda.pascalcase}}{{name}}{{/lambda.pascalcase}}Authentication{{^-last}},{{/-last}}
    {{/authMethods}}
}
{{/useInversify}}

export type ApiKeyConfiguration = string;
export type HttpBasicConfiguration = { "username": string, "password": string };
export type HttpBearerConfiguration = { tokenProvider: TokenProvider };
export type OAuth2Configuration = { accessToken: string };

export type AuthMethodsConfiguration = {
    {{^useInversify}}
    "default"?: SecurityAuthentication,
    {{/useInversify}}
    {{#authMethods}}
    "{{name}}"?: {{#isApiKey}}ApiKeyConfiguration{{/isApiKey}}{{#isBasicBasic}}HttpBasicConfiguration{{/isBasicBasic}}{{#isBasicBearer}}HttpBearerConfiguration{{/isBasicBearer}}{{#isOAuth}}OAuth2Configuration{{/isOAuth}}{{^-last}},{{/-last}}
    {{/authMethods}}
}

/**
 * Creates the authentication methods from a swagger description.
 *
 */
export function configureAuthMethods(config: AuthMethodsConfiguration | undefined): AuthMethods {
    let authMethods: AuthMethods = {}

    if (!config) {
        return authMethods;
    }
    {{^useInversify}}
    authMethods["default"] = config["default"]
    {{/useInversify}}

    {{#authMethods}}
    if (config["{{name}}"]) {
        authMethods["{{name}}"] = new {{#lambda.pascalcase}}{{name}}{{/lambda.pascalcase}}Authentication(
            {{#isApiKey}}
            config["{{name}}"]
            {{/isApiKey}}
            {{#isBasicBasic}}
            config["{{name}}"]["username"],
            config["{{name}}"]["password"]
            {{/isBasicBasic}}
            {{#isBasicBearer}}
            config["{{name}}"]["tokenProvider"]
            {{/isBasicBearer}}
            {{#isOAuth}}
            config["{{name}}"]["accessToken"]
            {{/isOAuth}}
        );
    }

    {{/authMethods}}
    return authMethods;
}