iya-sts
    Preparing search index...

    The SPIFFE model: the facts the surfaces decide with, the refusals of a request's fields, and the holding of what they answer.

    Index
    • Whether a JSON value is one of the types a member may take.

      Parameters

      • value: unknown

        the value

      • types: string[]

        from the model

      Returns boolean

      true when it is

    • The gaps this process recorded, newest last, at most a hundred.

      Returns string[]

      a copy

    • The SPIFFE ID grammar.

      Returns Json

      { scheme, maxBytes, maxTrustDomainBytes, trustDomainPattern, pathSegmentPattern, reservedPrefix, cite }

    • Holds a document — a bundle, a JWT-SVID's header or claims — to its member set, and records what does not fit under STS-SPIFFE-0154. The document is not touched.

      Parameters

      • id: string

        the member set's id

      • value: unknown

        the document

      • where: string

        what it is, for the log line

      Returns string[]

      the problems, empty when it is the model's

    • Holds what a handler answers to its method's response message, and records what does not fit under STS-SPIFFE-0154. The answer is not touched.

      Parameters

      • surface: string

        the surface

      • name: string

        the method, as the surface names it

      • reply: unknown

        the message about to be written

      Returns string[]

      the problems, empty when the answer is the model's

    • Holds the status a call ends with to the statuses its service and method declare, and records one they do not under STS-SPIFFE-0155. The status is not touched.

      Parameters

      • surface: string

        the surface

      • name: string

        the method, as the surface names it

      • code: number

        the numeric gRPC status

      Returns boolean

      true when the model does not declare it

    • Whether a request field's value, as the handler has read it, is empty: absent, an empty string, list or byte string.

      Parameters

      • value: unknown

        the value

      Returns boolean

      true when it is

    • What a document carries that its member set does not allow — a member a closed set does not name, a type or value the set does not allow, a required member missing — and the same of every set it nests.

      Parameters

      • id: string

        the member set's id

      • value: unknown

        the document

      • Optionalwhere: string

        its path, for the sentence

      Returns string[]

      one sentence per problem

    • The method a surface registers under a name, from the model.

      Parameters

      • surface: string

        workload, server or broker

      • name: string

        the method, <Service>.<Method> on the SPIRE Server API

      Returns Json

      { service, method, name }, or undefined

    • The SPIRE Server API methods this service does not implement, each with its reason, by <Service>.<Method>.

      Returns Record<string, string>

      the table

    • One request field's refusal.

      Parameters

      • message: string

        the message's full name in the protos

      • field: string

        the field

      • when: string

        empty, malformed or unexpected

      • Optionalmethod: string

        the method, where the message is shared and each method refuses it in its own words

      • Optionalreason: string

        a malformed SPIFFE ID's sentence, for {reason}

      Returns Json

      { status, statusName, code, message, errorInfo? }

    • One registry's values.

      Parameters

      • id: string

        bundle-key-use or jwt-svid-typ

      Returns string[]

      a copy of its values

    • Whether one value is what a field of its proto type accepts, as protobufjs's fromObject() reads it.

      Parameters

      • type: Json

        the field's type, from the model

      • value: unknown

        the value

      Returns boolean

      true when it is

    • An X509-SVID leaf's rules, in the order they are asked.

      Returns Json[]

      [{ fact, equals | includes | excludes, problem }]

    • What a message object carries that its message does not take: a member that is no field (protobufjs drops it), a value of the wrong type, and the same of every message it nests. Empty when it is the model's.

      Parameters

      • name: string

        the message's full name

      • value: unknown

        the object

      • where: string

        its path, for the sentence

      Returns string[]

      one sentence per problem