Variable unwrapAssertion

Type Declaration

• • (
        presented: any,
        opts: any,
    ):
        | {
            description?: undefined;
            encrypted: boolean;
            encryption?: undefined;
            errorCode?: undefined;
            jws: string;
            ok: boolean;
        }
        | {
            description: string;
            encrypted?: undefined;
            encryption?: undefined;
            errorCode: string;
            jws?: undefined;
            ok: boolean;
        }
        | {
            description?: undefined;
            encrypted: boolean;
            encryption: { alg: string; cty: string; enc: string; kid: string };
            errorCode?: undefined;
            jws: string;
            ok: boolean;
        }

  • Decrypts an assertion that arrived as a JWE to the JWS inside it, with its cty checked; a JWS passes through.

    Parameters

    • presented: any

      the assertion as presented

    • opts: any

      secret, a client secret for a symmetric JWE

    Returns
        | {
            description?: undefined;
            encrypted: boolean;
            encryption?: undefined;
            errorCode?: undefined;
            jws: string;
            ok: boolean;
        }
        | {
            description: string;
            encrypted?: undefined;
            encryption?: undefined;
            errorCode: string;
            jws?: undefined;
            ok: boolean;
        }
        | {
            description?: undefined;
            encrypted: boolean;
            encryption: { alg: string; cty: string; enc: string; kid: string };
            errorCode?: undefined;
            jws: string;
            ok: boolean;
        }

    { ok: true, jws, encrypted, ... }, or { ok: false, errorCode, description }