id

package

v1.9.0 Latest Latest Go to latest Published: Nov 3, 2026 License: MIT Imports: 4 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/xraph/keysmith

Links

Open Source Insights

Documentation ¶

Overview ¶

Package id defines TypeID-based identity types for all Keysmith entities.

Every entity in Keysmith uses a single ID struct with a prefix that identifies the entity type. IDs are K-sortable (UUIDv7-based), globally unique, and URL-safe in the format "prefix_suffix".

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AnyID ¶

type AnyID = ID

AnyID is a type alias that accepts any valid prefix.

type ID ¶

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

ID is the primary identifier type for all Keysmith entities. It wraps a TypeID providing a prefix-qualified, globally unique, sortable, URL-safe identifier in the format "prefix_suffix".

var Nil ID

Nil is the zero-value ID.

func MustParse ¶

func MustParse(s string) ID

MustParse is like Parse but panics on error. Use for hardcoded ID values.

func MustParseWithPrefix ¶

func MustParseWithPrefix(s string, expected Prefix) ID

MustParseWithPrefix is like ParseWithPrefix but panics on error.

func New ¶

func New(prefix Prefix) ID

New generates a new globally unique ID with the given prefix. It panics if prefix is not a valid TypeID prefix (programming error).

func NewKeyID ¶

func NewKeyID() ID

NewKeyID generates a new unique API key ID.

func NewPolicyID ¶

func NewPolicyID() ID

NewPolicyID generates a new unique policy ID.

func NewRotationID ¶

func NewRotationID() ID

NewRotationID generates a new unique rotation ID.

func NewScopeID ¶

func NewScopeID() ID

NewScopeID generates a new unique scope ID.

func NewUsageID ¶

func NewUsageID() ID

NewUsageID generates a new unique usage ID.

func Parse ¶

func Parse(s string) (ID, error)

Parse parses a TypeID string (e.g., "akey_01h2xcejqtf2nbrexx3vqjhp41") into an ID. Returns an error if the string is not valid.

func ParseAny ¶

func ParseAny(s string) (ID, error)

ParseAny parses a string into an ID without type checking the prefix.

func ParseKeyID ¶

func ParseKeyID(s string) (ID, error)

ParseKeyID parses a string and validates the "akey" prefix.

func ParsePolicyID ¶

func ParsePolicyID(s string) (ID, error)

ParsePolicyID parses a string and validates the "kpol" prefix.

func ParseRotationID ¶

func ParseRotationID(s string) (ID, error)

ParseRotationID parses a string and validates the "krot" prefix.

func ParseScopeID ¶

func ParseScopeID(s string) (ID, error)

ParseScopeID parses a string and validates the "kscp" prefix.

func ParseUsageID ¶

func ParseUsageID(s string) (ID, error)

ParseUsageID parses a string and validates the "kusg" prefix.

func ParseWithPrefix ¶

func ParseWithPrefix(s string, expected Prefix) (ID, error)

ParseWithPrefix parses a TypeID string and validates that its prefix matches the expected value.

func (ID) IsNil ¶

func (i ID) IsNil() bool

IsNil reports whether this ID is the zero value.

func (ID) MarshalBSONValue ¶

func (i ID) MarshalBSONValue() (bsonType byte, data []byte, err error)

MarshalBSONValue satisfies bson.ValueMarshaler (mongo-driver v2) so the ID is stored as a BSON string instead of an opaque struct. No bson import needed because Go uses structural typing for interface satisfaction.

func (ID) MarshalText ¶

func (i ID) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (ID) Prefix ¶

func (i ID) Prefix() Prefix

Prefix returns the prefix component of this ID.

func (*ID) Scan ¶

func (i *ID) Scan(src any) error

Scan implements sql.Scanner for database retrieval.

func (ID) String ¶

func (i ID) String() string

String returns the full TypeID string representation (prefix_suffix). Returns an empty string for the Nil ID.

func (*ID) UnmarshalBSONValue ¶

func (i *ID) UnmarshalBSONValue(t byte, data []byte) error

UnmarshalBSONValue satisfies bson.ValueUnmarshaler (mongo-driver v2).

func (*ID) UnmarshalText ¶

func (i *ID) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (ID) Value ¶

func (i ID) Value() (driver.Value, error)

Value implements driver.Valuer for database storage. Returns nil for the Nil ID so that optional foreign key columns store NULL.

type KeyID ¶

type KeyID = ID

KeyID is a type-safe identifier for API keys (prefix: "akey").

type PolicyID ¶

type PolicyID = ID

PolicyID is a type-safe identifier for key policies (prefix: "kpol").

type Prefix ¶

type Prefix string

Prefix identifies the entity type encoded in a TypeID.

const (
	PrefixKey      Prefix = "akey"
	PrefixPolicy   Prefix = "kpol"
	PrefixUsage    Prefix = "kusg"
	PrefixRotation Prefix = "krot"
	PrefixScope    Prefix = "kscp"
)

Prefix constants for all Keysmith entity types.

type RotationID ¶

type RotationID = ID

RotationID is a type-safe identifier for rotation records (prefix: "krot").

type ScopeID ¶

type ScopeID = ID

ScopeID is a type-safe identifier for key scopes (prefix: "kscp").

type UsageID ¶

type UsageID = ID

UsageID is a type-safe identifier for usage records (prefix: "kusg").

Source Files ¶

View all Source files

id.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL