IO Wallet SDK
    Preparing search index...

    Interface KeyAttestationOptions

    KeyAttestationOptions Defines the options required to create a key attestation JWT. This attestation conveys information about the cryptographic keys managed by the wallet, their storage characteristics, user authentication level, and revocation status.

    interface KeyAttestationOptions {
        attestedKeys: [
            {
                alg?: string;
                crv?: string;
                d?: string;
                dp?: string;
                dq?: string;
                e?: string;
                ext?: boolean;
                k?: string;
                key_ops?: string[];
                kid?: string;
                kty: string;
                n?: string;
                oth?: { d?: string; r?: string; t?: string; [key: string]: unknown }[];
                p?: string;
                q?: string;
                qi?: string;
                use?: string;
                x?: string;
                x5c?: string[];
                x5t?: string;
                "x5t#S256"?: string;
                x5u?: string;
                y?: string;
                [key: string]: unknown;
            },
            ...{
                alg?: string;
                crv?: string;
                d?: string;
                dp?: string;
                dq?: string;
                e?: string;
                ext?: boolean;
                k?: string;
                key_ops?: string[];
                kid?: string;
                kty: string;
                n?: string;
                oth?: { d?: string; r?: string; t?: string; [key: string]: unknown }[];
                p?: string;
                q?: string;
                qi?: string;
                use?: string;
                x?: string;
                x5c?: string[];
                x5t?: string;
                "x5t#S256"?: string;
                x5u?: string;
                y?: string;
                [key: string]: unknown;
            }[],
        ];
        callbacks: Pick<CallbackContext, "signJwt">;
        certification?: string;
        expiresAt?: Date;
        issuedAt?: Date;
        issuer: string;
        keyStorage: [
            | "iso_18045_high"
            | "iso_18045_moderate"
            | "iso_18045_enhanced-basic"
            | "iso_18045_basic",
            ...(
                | "iso_18045_high"
                | "iso_18045_moderate"
                | "iso_18045_enhanced-basic"
                | "iso_18045_basic"
            )[],
        ];
        signer: JwtSignerX5c;
        status: { status_list: { idx: number; uri: string } };
        trustChain?: [string, ...string[]];
        userAuthentication: [
            | "iso_18045_high"
            | "iso_18045_moderate"
            | "iso_18045_enhanced-basic"
            | "iso_18045_basic",
            ...(
                | "iso_18045_high"
                | "iso_18045_moderate"
                | "iso_18045_enhanced-basic"
                | "iso_18045_basic"
            )[],
        ];
    }
    Index

    Properties

    attestedKeys callbacks certification? expiresAt? issuedAt? issuer keyStorage signer status trustChain? userAuthentication

    Properties

    attestedKeys: [
        {
            alg?: string;
            crv?: string;
            d?: string;
            dp?: string;
            dq?: string;
            e?: string;
            ext?: boolean;
            k?: string;
            key_ops?: string[];
            kid?: string;
            kty: string;
            n?: string;
            oth?: { d?: string; r?: string; t?: string; [key: string]: unknown }[];
            p?: string;
            q?: string;
            qi?: string;
            use?: string;
            x?: string;
            x5c?: string[];
            x5t?: string;
            "x5t#S256"?: string;
            x5u?: string;
            y?: string;
            [key: string]: unknown;
        },
        ...{
            alg?: string;
            crv?: string;
            d?: string;
            dp?: string;
            dq?: string;
            e?: string;
            ext?: boolean;
            k?: string;
            key_ops?: string[];
            kid?: string;
            kty: string;
            n?: string;
            oth?: { d?: string; r?: string; t?: string; [key: string]: unknown }[];
            p?: string;
            q?: string;
            qi?: string;
            use?: string;
            x?: string;
            x5c?: string[];
            x5t?: string;
            "x5t#S256"?: string;
            x5u?: string;
            y?: string;
            [key: string]: unknown;
        }[],
    ]

    The array of JWKs representing the attested keys.

    callbacks: Pick<CallbackContext, "signJwt">
    certification?: string

    Optional URL to the key storage component certification.

    expiresAt?: Date

    The optional expiration date for the attestation JWT. If not provided, a default lifetime will be used.

    issuedAt?: Date

    The issuance date of the key attestation. Defaults to the current date and time if not provided.

    issuer: string
    keyStorage: [
        | "iso_18045_high"
        | "iso_18045_moderate"
        | "iso_18045_enhanced-basic"
        | "iso_18045_basic",
        ...(
            | "iso_18045_high"
            | "iso_18045_moderate"
            | "iso_18045_enhanced-basic"
            | "iso_18045_basic"
        )[],
    ]

    The levels of security for key storage as per ISO 18045 standards.

    signer: JwtSignerX5c

    The signer information containing the Key ID and the X.509 certificate chain.

    status: { status_list: { idx: number; uri: string } }

    The status information related to the key attestation.

    trustChain?: [string, ...string[]]

    An array of JWTs representing the chain of trust from the federation's trust anchor

    userAuthentication: [
        | "iso_18045_high"
        | "iso_18045_moderate"
        | "iso_18045_enhanced-basic"
        | "iso_18045_basic",
        ...(
            | "iso_18045_high"
            | "iso_18045_moderate"
            | "iso_18045_enhanced-basic"
            | "iso_18045_basic"
        )[],
    ]

    The levels of user authentication as per ISO 18045 standards.

    Settings

    Member Visibility

    On This Page

    Properties