idutil

Documentation

Index

• Constants
• func AgentID(td spiffeid.TrustDomain, suffix string) (spiffeid.ID, error)
• func IDFromProto(id *types.SPIFFEID) (spiffeid.ID, error)
• func IDProtoFromString(s string) (*types.SPIFFEID, error)
• func IDProtoString(id *types.SPIFFEID) (string, error)
• func IsAgentPath(path string) bool
• func IsAgentPathForNodeAttestor(path string, nodeAttestor string) bool
• func IsReservedPath(path string) bool
• func MemberFromString(td spiffeid.TrustDomain, s string) (spiffeid.ID, error)
• func RequireAgentID(td spiffeid.TrustDomain, suffix string) spiffeid.ID
• func RequireIDFromProto(id *types.SPIFFEID) spiffeid.ID
• func RequireIDProtoString(id *types.SPIFFEID) string
• func RequireServerID(td spiffeid.TrustDomain) spiffeid.ID
• func ServerID(td spiffeid.TrustDomain) (spiffeid.ID, error)

Constants

const (
	ServerIDPath = "/spire/server"
)

Functions

func AgentID

func AgentID(td spiffeid.TrustDomain, suffix string) (spiffeid.ID, error)

AgentID creates an agent SPIFFE ID given a trust domain and a path suffix. The path suffix must be an absolute path. The /spire/agent prefix is prefixed to the suffix to form the path.

func IDFromProto

func IDFromProto(id *types.SPIFFEID) (spiffeid.ID, error)

IDFromProto returns SPIFFE ID from the proto representation

func IDProtoFromString

func IDProtoFromString(s string) (*types.SPIFFEID, error)

IDProtoFromString parses a SPIFFE ID string into the raw ID proto components. It does not attempt to escape/unescape any portion of the ID.

func IDProtoString

func IDProtoString(id *types.SPIFFEID) (string, error)

IDProtoString constructs a SPIFFE ID string for the given ID protobuf.

func IsAgentPath

func IsAgentPath(path string) bool

IsAgentPath returns true if the given string is an SPIRE agent ID path. SPIRE agent IDs are prefixed with "/spire/agent/".

func IsAgentPathForNodeAttestor

func IsAgentPathForNodeAttestor(path string, nodeAttestor string) bool

IsAgentPathForNodeAttestor returns if the path lives under the agent namesepace for the given node attestor

func IsReservedPath

func IsReservedPath(path string) bool

func MemberFromString

func MemberFromString(td spiffeid.TrustDomain, s string) (spiffeid.ID, error)

func RequireAgentID

func RequireAgentID(td spiffeid.TrustDomain, suffix string) spiffeid.ID

RequireAgentID creates an agent SPIFFE ID given a trust domain and a path suffix. The path suffix must be an absolute path. The /spire/agent prefix is prefixed to the suffix to form the path. It panics if the given trust domain isn't valid.

func RequireIDFromProto

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

RequireIDFromProto returns a SPIFFE ID from the proto representation. It panics if the proto is not well formed.

func RequireIDProtoString

func RequireIDProtoString(id *types.SPIFFEID) string

RequireIDProtoString constructs a SPIFFE ID string for the given ID proto. It panics if the proto is not well formed.

func RequireServerID

func RequireServerID(td spiffeid.TrustDomain) spiffeid.ID

RequireServerID returns the server SPIFFE ID for the given trust domain. It panics if the given trust domain isn't valid.

func ServerID

func ServerID(td spiffeid.TrustDomain) (spiffeid.ID, error)

ServerID creates a server SPIFFE ID string given a trust domain.