IF Commons GitHub

models/identity-machine/mod

Written to: 3 requirements: 3 proved, 0 partly, 0 failing, 0 with no test recorded. 0037-identity-machine FR-001, 0037-identity-machine FR-002, 0037-identity-machine FR-003

Machine identities as a module (commons data 0037-identity-machine): services, workloads, pipelines and integrations, each a principal with an accountable owner; the workload identity that a platform vouches for (a SPIFFE ID, a Kubernetes service account, an OIDC subject, a certificate), API keys that are never wider than their owner, and public keys.

Source: commons/data/models/identity-machine/mod.ts

1 of 8 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

machineKindconstno test imports it
const machineKind: CodeList<string, string>

What kind of program a machine is.

environmentconstno test imports it
const environment: CodeList<string, string>

A program that acts for itself, with a person or a group accountable for it.

issuerKindconstno test imports it
const issuerKind: CodeList<string, string>

A program that acts for itself, with a person or a group accountable for it.

machineconstno test imports it
const machine: Concept<"machine", { readonly machineKind: Attribute<Datatype, Multiplicity>; readonly purpose: Attribute… (472 characters)
const machine: Concept<"machine", { readonly machineKind: Attribute<Datatype, Multiplicity>; readonly purpose: Attribute<Datatype, Multiplicity>; readonly environment: Attribute<Datatype, Multiplicity>; readonly isBreakGlass: Attribute<Datatype, Multiplicity>; readonly maxCredentialDays: Attribute<Datatype, Multiplicity>; readonly reviewBy: Attribute<Datatype, Multiplicity>; }, { readonly principal: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "principal">

A machine: a program that acts for itself, with a person or a group accountable for it. Its identity is its principal's.

workloadIdentityconstno test imports it
const workloadIdentity: Concept<"workloadIdentity", { readonly workloadIdentityId: Attribute<Datatype, Multiplicity>; re… (654 characters)
const workloadIdentity: Concept<"workloadIdentity", { readonly workloadIdentityId: Attribute<Datatype, Multiplicity>; readonly issuerKind: Attribute<Datatype, Multiplicity>; readonly issuer: Attribute<Datatype, Multiplicity>; readonly subject: Attribute<Datatype, Multiplicity>; readonly trustDomain: Attribute<Datatype, Multiplicity>; readonly audience: Attribute<Datatype, Multiplicity>; readonly selectors: Attribute<Datatype, Multiplicity>; readonly status: Attribute<Datatype, Multiplicity>; readonly bindingKey: Attribute<Datatype, Multiplicity>; }, { readonly machine: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "workloadIdentityId">

What a platform vouches for about a workload: a machine proves itself by this instead of by a secret.

apiKeyconstno test imports it
const apiKey: AnyConcept

An API key: a random secret kept as a keyed hash, never wider in authority than its owner. Its identity is its credential's.

keyCredentialconstno test imports it
const keyCredential: Concept<"keyCredential", { readonly publicJwk: Attribute<Datatype, Multiplicity>; readonly thumbprint: Attribute<Datatype, Multiplicity>; readonly algorithm: Attribute<Datatype, Multiplicity>; }, { readonly credential: Relationship<"one", AnyConcept | (() => AnyConcept)>; }, "credential">

A public key that a principal proves itself with by signing; the private half is never kept.

identityMachineModuleconst
const identityMachineModule: Module

Machine identities: services, workloads, pipelines and integrations.

Imported by 10 tests of the run (10 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.