Static ReadonlyRENEW_The id of the scheduler job that issues and renews the certificates.
Static ReadonlyROW_The row format version; a row of any other is not used.
Static ReadonlySEAL_The keystore label the sealed private keys are counted under.
StaticcurrentThe relationship's usable row: this format, a certificate, and not
past its notAfter. Null otherwise.
the relationship
OptionalnowMs: number
the time to judge against; now by default
the row, or null
StaticdueWhether a row is due a renewal: none, unusable, or within
federation.clientCertificateRenewDays of its notAfter.
the relationship
OptionalnowMs: number
the time to judge against; now by default
whether it is due
StaticissueIssues a new certificate for a relationship and writes it, sealed. The one it replaces is overwritten: a token already bound to the old certificate stops working at the partner, which is a renewal's ordinary cost and why the job renews well before the end.
the relationship id
Optionalwhy: string
the audit sentence
a promise of { ok, row, message } or { ok: false, errors }
marked STS-FED-0252
Staticissueissue(), but one at a time per relationship in this process: two
sign-ins that both find no certificate share one issue rather than each
minting one, the second overwriting the certificate the first one's
token was just bound to. (Two PROCESSES can still race; the loser's
sign-in is refused at UserInfo by the partner, and the next one works.)
the relationship id
the audit sentence
a promise of issue()'s answer
StaticmaterialThe PEMs node's TLS client presents for a relationship: the leaf with its chain, and the private key, opened. Issues one first where the relationship holds none that is usable (a relationship that became 1-advanced before this existed, or one whose job has not run).
the relationship
a promise of { ok: true, cert, key, x5tS256 } or
{ ok: false, errorCode: 'STS-FED-0252', why }; never rejects
StaticneededWhether a relationship presents a client certificate: an OpenID Connect one held to FAPI 1.0 Advanced, and nothing else.
the relationship
whether it does
StaticregisterRegisters the renewal scheduler job, once; it runs per realm every hour
while federation.enabled is on.
StaticrenewIssues or renews, in the current realm, every certificate a 1-advanced relationship lacks or is due to renew; the scheduler job's body.
OptionalnowMs: number
the time to judge against; now by default
a promise of { issued, failed }
StaticviewWhat the relationship page and GET /admin-api/federation show of the
client certificate: the certificate and its chain as PEM, the subject
DN a partner registers as tls_client_auth_subject_dn, the
x5t#S256 a bound token carries, the validity and when it renews.
Never the private key.
the relationship
the view, or null for a relationship that presents none
A FAPI 1.0 Advanced federation relationship's TLS client certificate: issued from the realm's TLS Client Issuing CA, sealed, renewed by a scheduler job, presented to the partner's token and UserInfo endpoints, and published for the partner to register. A static utility class.