Variable verify

Type Declaration

• • (
        opts: any,
    ): Promise<
        | { description: any; error: string; errorCode: any; ok: boolean }
        | {
            address: any;
            application: any;
            attributes: any;
            audience: any;
            authnStatements: any;
            canonicalization: any;
            certificateChain: { anchor: any; path: any };
            certificateRevocation: { policy: any; status: any; why: any };
            certificateSource: any;
            certificateThumbprint: any;
            declared: boolean;
            directlyAuthenticated: boolean;
            discardedConfirmations: number;
            encrypted: boolean;
            encryption: { algorithm: any; keyTransport: any };
            expiresAt: number;
            id: any;
            issuer: any;
            issuerKind: string;
            matchedAudience: any;
            nameIdFormat: any;
            ok: boolean;
            person: any;
            recipient: any;
            scope: string[];
            scopeNarrowed: any[];
            signatureMethod: any;
            subject: any;
            subjectWasEncrypted: any;
        },
    >

  • Verifies a SAML assertion as an authorization grant (RFC 7522 section 3), or as client authentication (section 2.2) where clientId is set; the signature first, then section 3's checks in order.

    Parameters

    • opts: any

      assertion, audiences, requestingClientId, scope and request, and for client authentication clientId, registeredCertificate, issuedCertificate and issuedCertificateChain

    Returns Promise<
        | { description: any; error: string; errorCode: any; ok: boolean }
        | {
            address: any;
            application: any;
            attributes: any;
            audience: any;
            authnStatements: any;
            canonicalization: any;
            certificateChain: { anchor: any; path: any };
            certificateRevocation: { policy: any; status: any; why: any };
            certificateSource: any;
            certificateThumbprint: any;
            declared: boolean;
            directlyAuthenticated: boolean;
            discardedConfirmations: number;
            encrypted: boolean;
            encryption: { algorithm: any; keyTransport: any };
            expiresAt: number;
            id: any;
            issuer: any;
            issuerKind: string;
            matchedAudience: any;
            nameIdFormat: any;
            ok: boolean;
            person: any;
            recipient: any;
            scope: string[];
            scopeNarrowed: any[];
            signatureMethod: any;
            subject: any;
            subjectWasEncrypted: any;
        },
    >

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