gnap-caep-risc-nodejs
    Preparing search index...

    Interface GnapConfigFile

    A configuration file, or the object resolveConfig accepts.

    interface GnapConfigFile {
        access?: unknown[];
        allowInsecure?: boolean;
        application?: string;
        assertionFormats?: string[];
        certificate?: string;
        classId?: string;
        clockToleranceSec?: number;
        display?: { name?: string; uri?: string };
        finishMethod?: string;
        finishUri?: string;
        grantEndpoint?: string;
        hashMethod?: string;
        idTokenIssuer?: string;
        interactionStart?: string[];
        keyProof?: string;
        maxWaitSec?: number;
        privateKey?: string;
        requireBoundTokens?: boolean;
        signals?: boolean;
        ssf?: { pollIntervalMs?: number; transmitter?: string };
        subIdFormats?: string[];
        tlsCa?: string;
        transactionTtlSec?: number;
        transmitterIssuer?: string;
        useInstanceId?: boolean;
    }
    Index
    access?: unknown[]

    Access rights, as strings or objects. Default ssf.read and ssf.manage. signals: false removes those two.

    allowInsecure?: boolean

    Allow an http grant endpoint, and a non-loopback http finish URI. Default false.

    application?: string

    The registered application's identifier. Not sent as class_id. Used as an ID token audience and as what the setup script registers.

    assertionFormats?: string[]
    certificate?: string

    PEM certificate. Required for mtls.

    classId?: string

    Sent as client.class_id only when set. The demo does not set it. An unregistered instance's identifier.

    clockToleranceSec?: number
    display?: { name?: string; uri?: string }
    finishMethod?: string

    redirect (default) or push.

    finishUri?: string

    Where the authorization server redirects the browser, or pushes the finish.

    grantEndpoint?: string

    The grant endpoint, https://idp.example/gnap. Required.

    hashMethod?: string

    Interaction hash. Only sha-256, the default, and it is omitted from the request.

    idTokenIssuer?: string

    The issuer of subject ID tokens. Defaults to the grant endpoint's origin.

    interactionStart?: string[]

    Interaction start modes. Default ["redirect"].

    keyProof?: string

    mtls, httpsig, or jwsd. Default mtls when certificate is set, otherwise httpsig.

    maxWaitSec?: number

    The longest a continue.wait or a too_fast retry may delay one continuation. Default 30.

    privateKey?: string

    PEM PKCS#8, file:path, env:NAME, or a path. Required.

    requireBoundTokens?: boolean

    Refuse a token whose flags include bearer. Default true.

    signals?: boolean

    Receive CAEP and RISC. Omitted is the same as true. false removes ssf.read and ssf.manage, does not fill ssf, and does not contact a transmitter.

    ssf?: { pollIntervalMs?: number; transmitter?: string }
    subIdFormats?: string[]
    tlsCa?: string

    The authorization server's listener CA chain: PEM, file:path, env:NAME, or a path. A missing file is ignored, so a demo can name a chain the setup script has not written yet. iya-sts publishes the bundle at GET /tls/server-certificate. configure-iya-sts and the demo container write that file from it.

    transactionTtlSec?: number

    How long a pending interaction may sit. Default 600.

    transmitterIssuer?: string

    gnap-caep-js's name for the Shared Signals transmitter. ssf.transmitter wins when both are set.

    useInstanceId?: boolean

    After the first response, send client as the instance_id string. Default true.