api

package
v1.12.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 1, 2025 License: Apache-2.0 Imports: 25 Imported by: 16

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AttestedNodeToProto added in v0.11.0 

func AttestedNodeToProto(node *common.AttestedNode, selectors []*types.Selector) (*types.Agent, error)

AttestedNodeToProto converts an agent from the given *common.AttestedNode with the provided selectors to *types.Agent

func BundleToProto 

func BundleToProto(b *common.Bundle) (*types.Bundle, error)

func CertificatesToProto 

func CertificatesToProto(rootCas []*common.Certificate) []*types.X509Certificate

func CreateStatus 

func CreateStatus(code codes.Code, msg string) *types.Status

CreateStatus creates a proto Status

func CreateStatusf added in v1.10.2 

func CreateStatusf(code codes.Code, format string, a ...any) *types.Status

CreateStatus creates a proto Status

func FederationRelationshipToProto added in v1.1.0 

func FederationRelationshipToProto(f *datastore.FederationRelationship, mask *types.FederationRelationshipMask) (*types.FederationRelationship, error)

FederationRelationshipToProto converts datastore federation relationship to types proto

func FieldsFromBundleProto added in v1.1.0 

func FieldsFromBundleProto(proto *types.Bundle, inputMask *types.BundleMask) logrus.Fields

func FieldsFromJwtAuthoritiesProto added in v1.1.0 

func FieldsFromJwtAuthoritiesProto(jwtAuthorities []*types.JWTKey) logrus.Fields

func FieldsFromX509AuthoritiesProto added in v1.1.0 

func FieldsFromX509AuthoritiesProto(x509Authorities []*types.X509Certificate) logrus.Fields

func HashByte added in v1.0.1 

func HashByte(b []byte) string

func IDFromProto 

func IDFromProto(_ context.Context, protoID *types.SPIFFEID) (spiffeid.ID, error)

IDFromProto converts a SPIFFEID message into an ID type

func MakeErr added in v0.11.0 

func MakeErr(log logrus.FieldLogger, code codes.Code, msg string, err error) error

MakeErr logs and returns an error composed of: msg, err and code. Errors are treated differently according to its gRPC code.

func MakeStatus added in v0.11.0 

func MakeStatus(log logrus.FieldLogger, code codes.Code, msg string, err error) *types.Status

MakeStatus logs and returns a status composed of: msg, err and code. Errors are treated differently according to its gRPC code.

func OK 

func OK() *types.Status

OK creates a success proto status

func ParseJWTAuthorities 

func ParseJWTAuthorities(keys []*types.JWTKey) ([]*common.PublicKey, error)

func ParseX509Authorities added in v0.11.0 

func ParseX509Authorities(certs []*types.X509Certificate) ([]*common.Certificate, error)

func ProtoFromAttestedNode added in v0.11.0 

func ProtoFromAttestedNode(n *common.AttestedNode) (*types.Agent, error)

func ProtoFromID 

func ProtoFromID(id spiffeid.ID) *types.SPIFFEID

ProtoFromID converts a SPIFFE ID from the given spiffeid.ID to types.SPIFFEID

func ProtoFromSelectors added in v0.11.0 

func ProtoFromSelectors(in []*common.Selector) []*types.Selector

func ProtoToBundle 

func ProtoToBundle(b *types.Bundle) (*common.Bundle, error)

func ProtoToBundleMask added in v0.11.0 

func ProtoToBundleMask(mask *types.BundleMask) *common.BundleMask

func ProtoToFederationRelationship added in v1.1.0 

func ProtoToFederationRelationship(f *types.FederationRelationship) (*datastore.FederationRelationship, error)

ProtoToFederationRelationship convert and validate proto to datastore federated relationship

func ProtoToFederationRelationshipWithMask added in v1.1.0 

func ProtoToFederationRelationshipWithMask(f *types.FederationRelationship, mask *types.FederationRelationshipMask) (*datastore.FederationRelationship, error)

ProtoToFederationRelationshipWithMask convert and validate proto to datastore federated relationship, and apply mask

func ProtoToRegistrationEntry 

func ProtoToRegistrationEntry(ctx context.Context, td spiffeid.TrustDomain, e *types.Entry) (*common.RegistrationEntry, error)

ProtoToRegistrationEntry converts and validate entry into common registration entry

func ProtoToRegistrationEntryWithMask added in v0.11.0 

func ProtoToRegistrationEntryWithMask(ctx context.Context, td spiffeid.TrustDomain, e *types.Entry, mask *types.EntryMask) (_ *common.RegistrationEntry, err error)

ProtoToRegistrationEntryWithMask converts and validate entry into common registration entry, while allowing empty values for SpiffeId, ParentId, and Selectors IF their corresponding values in the mask are false. This allows the user to not specify these fields while updating using a mask. All other fields are allowed to be empty (with or without a mask).

func PublicKeysToProto 

func PublicKeysToProto(keys []*common.PublicKey) []*types.JWTKey

func RegistrationEntriesToProto added in v0.11.0 

func RegistrationEntriesToProto(es []*common.RegistrationEntry) ([]*types.Entry, error)

RegistrationEntriesToProto converts RegistrationEntry's into Entry's

func RegistrationEntryToProto 

func RegistrationEntryToProto(e *common.RegistrationEntry) (*types.Entry, error)

RegistrationEntryToProto converts RegistrationEntry into types Entry

func SelectorFieldFromProto added in v1.0.1 

func SelectorFieldFromProto(proto []*types.Selector) string

func SelectorsFromProto added in v0.11.0 

func SelectorsFromProto(proto []*types.Selector) ([]*common.Selector, error)

SelectorsFromProto converts a slice of types.Selector to a slice of common.Selector

func TrustDomainAgentIDFromProto added in v0.11.0 

func TrustDomainAgentIDFromProto(ctx context.Context, td spiffeid.TrustDomain, protoID *types.SPIFFEID) (spiffeid.ID, error)

func TrustDomainMemberIDFromProto added in v0.11.0 

func TrustDomainMemberIDFromProto(ctx context.Context, td spiffeid.TrustDomain, protoID *types.SPIFFEID) (spiffeid.ID, error)

func TrustDomainWorkloadIDFromProto added in v0.11.0 

func TrustDomainWorkloadIDFromProto(ctx context.Context, td spiffeid.TrustDomain, protoID *types.SPIFFEID) (spiffeid.ID, error)

func VerifyTrustDomainAgentID added in v0.11.0 

func VerifyTrustDomainAgentID(td spiffeid.TrustDomain, id spiffeid.ID) error

func VerifyTrustDomainAgentIDForNodeAttestor added in v1.2.1 

func VerifyTrustDomainAgentIDForNodeAttestor(td spiffeid.TrustDomain, id spiffeid.ID, nodeAttestorName string) error

func VerifyTrustDomainMemberID added in v0.11.0 

func VerifyTrustDomainMemberID(td spiffeid.TrustDomain, id spiffeid.ID) error

func VerifyTrustDomainWorkloadID added in v0.11.0 

func VerifyTrustDomainWorkloadID(td spiffeid.TrustDomain, id spiffeid.ID) error

Types

type AuthorizedEntryFetcher added in v0.11.0 

type AuthorizedEntryFetcher interface {
	// LookupAuthorizedEntries fetches the entries in entryIDs that the
	// specified SPIFFE ID is authorized for
	LookupAuthorizedEntries(ctx context.Context, id spiffeid.ID, entryIDs map[string]struct{}) (map[string]ReadOnlyEntry, error)
	// FetchAuthorizedEntries fetches the entries that the specified
	// SPIFFE ID is authorized for
	FetchAuthorizedEntries(ctx context.Context, id spiffeid.ID) ([]ReadOnlyEntry, error)
}

AuthorizedEntryFetcher is the interface to fetch authorized entries

type RateLimiter 

type RateLimiter = api.RateLimiter

type RateLimiterFunc 

type RateLimiterFunc = api.RateLimiterFunc

type ReadOnlyEntry added in v1.12.4 

type ReadOnlyEntry struct {
	// contains filtered or unexported fields
}

func NewReadOnlyEntry added in v1.12.4 

func NewReadOnlyEntry(entry *types.Entry) ReadOnlyEntry

func (*ReadOnlyEntry) Clone added in v1.12.4 

func (e *ReadOnlyEntry) Clone(mask *types.EntryMask) *types.Entry

Manually clone the entry instead of using the protobuf helpers since those are two times slower.

func (*ReadOnlyEntry) GetCreatedAt added in v1.12.4 

func (e *ReadOnlyEntry) GetCreatedAt() int64

func (*ReadOnlyEntry) GetDnsNames added in v1.12.4 

func (e *ReadOnlyEntry) GetDnsNames() []string

func (ReadOnlyEntry) GetId added in v1.12.4 

func (e ReadOnlyEntry) GetId() string

func (*ReadOnlyEntry) GetJwtSvidTtl added in v1.12.4 

func (e *ReadOnlyEntry) GetJwtSvidTtl() int32

func (*ReadOnlyEntry) GetRevisionNumber added in v1.12.4 

func (e *ReadOnlyEntry) GetRevisionNumber() int64

func (*ReadOnlyEntry) GetSpiffeId added in v1.12.4 

func (e *ReadOnlyEntry) GetSpiffeId() *types.SPIFFEID

func (*ReadOnlyEntry) GetX509SvidTtl added in v1.12.4 

func (e *ReadOnlyEntry) GetX509SvidTtl() int32

Source Files

View all Source files

Directories

Path Synopsis
agent
v1
bundle
v1
debug
v1
entry
v1
health
v1
localauthority
v1
logger
v1
svid
v1
trustdomain
v1

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.