iya-sts
    Preparing search index...

    The FAPI client profiles an inbound OpenID Connect relationship can use. A static utility class.

    Index
    CLIENT_ASSERTION_TYPE: "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" = CLIENT_ASSERTION_TYPE
    • Whether an answer asks for a DPoP nonce. An authorization server says so in the JSON body (RFC 9449 section 8); a resource server, UserInfo among them, says so in WWW-Authenticate (section 9), whose scheme and parameter name are case-insensitive (RFC 9110 section 11.1). The conformance suite's UserInfo answers the second way, the scheme spelt dPoP in one module (#931's first run, 2026-11-13).

      Parameters

      • answer: any

        { ok, json, headers }, headers lower-cased

      Returns boolean

      whether the answer is a use_dpop_nonce refusal

    • Signs the private_key_jwt for a token, refresh or pushed-authorization request. aud is the partner's issuer. Lives 60 seconds.

      Parameters

      • record: any

        the relationship, its fedPeer the issuer

      Returns string

      the assertion

    • Says why a verified JARM payload has no usable lifetime, or '' when it has one. JARM section 4.4 has the client check exp, and jwt.verify checks it only when it is there: a response JWT with no exp would otherwise be good for ever, so a captured one could be replayed at any later sign-in that reused its state (#931's review).

      Parameters

      • payload: any

        the verified response JWT's claims

      Returns string

      the problem, or ''

    • Says why a verified JARM payload cannot be used, or '' when it can. state is how the flow is found. An error is the partner's refusal and is returned to the caller; a success carries a code.

      Parameters

      • payload: any

        the verified response JWT's claims

      Returns string

      the problem, or ''

    • Whether the profile cannot start without the partner's discovery document. The pushed-authorization endpoint is read from it.

      Parameters

      • profile: string

        profileOf()

      Returns boolean

      whether it does

    • Makes the key one sign-in's DPoP proofs are signed with.

      Returns any

      { pem, jwk }, jwk the public half alone

    • The profile fedFapi names, or '' when this relationship is not a FAPI client. An unknown value, a protocol other than OpenID Connect, and an OpenID Federation OP are ''.

      Parameters

      • record: any

        the relationship

      Returns string

      1-advanced, 2-security, 2-message-signing, or ''

    • Signs a DPoP proof (RFC 9449 section 4.2) for one request.

      Parameters

      • key: any

        what newKey() made

      • method: string

        the HTTP method

      • url: string

        the address the proof is for

      • nonce: string

        the server's nonce, when it has given one

      • OptionalaccessToken: string

        the access token a resource request presents; its hash is ath

      Returns string

      the proof

    • Signs the authorization request as a request object (RFC 9101), PS256, living 60 seconds. The parameters already on params are the claims.

      Parameters

      • record: any

        the relationship

      • params: URLSearchParams

        the authorization parameters

      Returns string

      the request object

    • Whether the authorization response must name its issuer (RFC 9207). FAPI 2.0 Security Profile section 5.3.2.2 has the client verify iss, so a 2.x response without one is refused rather than accepted as a plain relationship accepts it. Under JARM the iss is the response JWT's own, verified against fedPeer before it is read. 1-advanced is left as it was: its front-channel ID Token is the detached signature that names the issuer.

      Parameters

      • profile: string

        profileOf()

      Returns boolean

      whether it must

    • Whether a front-channel ID Token must carry s_hash over the state. FAPI 1.0 Advanced (Part 2, section 5.1.1 and 5.2.2.1) uses the ID Token from the authorization endpoint as a detached signature over the response, and state is one of the values it signs: without s_hash a state swapped on the way back is accepted.

      Parameters

      • profile: string

        profileOf()

      Returns boolean

      whether it must

    • Whether the profile puts a request object on the browser's authorization URL. Message signing puts one in the push instead.

      Parameters

      • profile: string

        profileOf()

      Returns boolean

      whether it does

    • A copy of the relationship with the profile's response type, response mode and scope applied. No profile returns the same record.

      Parameters

      • record: any

        the relationship

      Returns any

      the record the authorization request is built from

    • Says why a token response cannot be used by a profile that binds its access token with DPoP, or '' when it can. RFC 9449 section 5: an access token bound to the proof key comes back as token_type DPoP (compared without case). A Bearer answer is a token the partner did not bind, and FAPI 2.0 requires a sender-constrained one, so it is not presented anywhere.

      Parameters

      • profile: string

        profileOf()

      • tokens: any

        the token endpoint's JSON

      Returns string

      the problem, or ''

    • Whether the profile sender-constrains the access token with DPoP.

      Parameters

      • profile: string

        profileOf()

      Returns boolean

      whether it does

    • Whether the profile requires a signed authorization response.

      Parameters

      • profile: string

        profileOf()

      Returns boolean

      whether it does

    • Whether the profile sender-constrains the access token with mutual TLS (RFC 8705 section 3): FAPI 1.0 Advanced (#931, rcbj's decision of 2026-11-13). The token request, the refresh and UserInfo present the relationship's TLS client certificate.

      Parameters

      • profile: string

        profileOf()

      Returns boolean

      whether it does

    • Whether the profile pushes the authorization request.

      Parameters

      • profile: string

        profileOf()

      Returns boolean

      whether it does

    • Whether the profile authenticates at the token endpoint with its TLS client certificate rather than private_key_jwt: 1-advanced with fedTokenAuth tls_client_auth (RFC 8705 section 2.1). The 2.x profiles always use private_key_jwt.

      Parameters

      • record: any

        the relationship

      Returns boolean

      whether it does

    • Sends once, and again when the partner answers use_dpop_nonce with a nonce other than the one just sent. A repeat of the same nonce is not retried: that would loop. send is called once per attempt, and signs everything it sends on that attempt: a client assertion or a request object sent twice is a replay the partner refuses (RFC 7523 section 3, the jti; #931's first run, the suite's CheckForClientAssertionJtiReuse).

      Parameters

      • send: (nonce: string) => Promise<any>

        posts with the nonce it is given and answers { ok, json, headers }

      • firstNonce: string

        the nonce already held, or ''

      Returns Promise<any>

      the answer kept