Variable verify

Type Declaration

• • (
        opts: any,
    ): Promise<
        | {
            alg?: undefined;
            application?: undefined;
            audience?: undefined;
            claims?: undefined;
            confirmation?: undefined;
            declared?: undefined;
            description: string;
            encrypted?: undefined;
            encryption?: undefined;
            error: string;
            errorCode: any;
            expiresAt?: undefined;
            issuer?: undefined;
            issuerKind?: undefined;
            jti?: undefined;
            keyChain?: undefined;
            keyRevocation?: undefined;
            keySource?: undefined;
            ok: boolean;
            person?: undefined;
            scope?: undefined;
            scopeNarrowed?: undefined;
            subject?: undefined;
        }
        | {
            alg: string;
            application: any;
            audience: any;
            claims: any;
            confirmation: any;
            declared: boolean;
            description?: undefined;
            encrypted: boolean;
            encryption: { alg: string; cty: string; enc: string; kid: string };
            error?: undefined;
            errorCode?: undefined;
            expiresAt: number;
            issuer: string;
            issuerKind: string;
            jti: string;
            keyChain: { anchor: any; path: any };
            keyRevocation: { bare: boolean; policy: any; status: any; why: any };
            keySource: string;
            ok: boolean;
            person: any;
            scope: string[];
            scopeNarrowed: any[];
            subject: string;
        },
    >

  • Verifies a JWT assertion as an authorization grant (RFC 7523 section 3), its signature before any claim is believed, and claims its jti in the used-assertion history as the last check.

    Parameters

    • opts: any

      assertion, audiences, clientSecret, requestingClientId, scope and request; for an RFC 8693 token exchange (#114) use: 'token-exchange' and audienceCheck(auds), which decides the audience in place of audiences and answers the one it accepted, or ''

    Returns Promise<
        | {
            alg?: undefined;
            application?: undefined;
            audience?: undefined;
            claims?: undefined;
            confirmation?: undefined;
            declared?: undefined;
            description: string;
            encrypted?: undefined;
            encryption?: undefined;
            error: string;
            errorCode: any;
            expiresAt?: undefined;
            issuer?: undefined;
            issuerKind?: undefined;
            jti?: undefined;
            keyChain?: undefined;
            keyRevocation?: undefined;
            keySource?: undefined;
            ok: boolean;
            person?: undefined;
            scope?: undefined;
            scopeNarrowed?: undefined;
            subject?: undefined;
        }
        | {
            alg: string;
            application: any;
            audience: any;
            claims: any;
            confirmation: any;
            declared: boolean;
            description?: undefined;
            encrypted: boolean;
            encryption: { alg: string; cty: string; enc: string; kid: string };
            error?: undefined;
            errorCode?: undefined;
            expiresAt: number;
            issuer: string;
            issuerKind: string;
            jti: string;
            keyChain: { anchor: any; path: any };
            keyRevocation: { bare: boolean; policy: any; status: any; why: any };
            keySource: string;
            ok: boolean;
            person: any;
            scope: string[];
            scopeNarrowed: any[];
            subject: string;
        },
    >

    a promise of { ok: true, issuer, subject, claims, ... }, or { ok: false, errorCode, error, description }