token

package

v0.124.0 Latest Latest Go to latest Published: Oct 24, 2026 License: MIT Imports: 9 Imported by: 0

Details

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

Repository

github.com/open-rails/contentkit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package token signs and verifies media access tokens, shared by the host signer and the media gateway so the format cannot drift:

{kid}.{exp}.base64url(HMAC-SHA256(secret, "{scope}|{exp}"))

An item token's scope is an item's, "{ns}/{kind}/{id}" or a version's "{ns}/{kind}/{id}/{version}": every file in the item's private/ or none. A private-file token covers one immutable key, never its siblings. A download token covers one key in download/, which neither private token opens. Tokens are bearer tokens, revoked only by expiry.

Index ¶

Constants
Variables
func DownloadScope(key string) string
func Expiry(now time.Time, ttl, window time.Duration) time.Time
func ItemScope(ns, kind, id, version string) string
func PrivateFileScope(key string) string
type Key
- func ParseKey(s string) (Key, error)
type Ring
- func NewRing(current Key, previous *Key) (Ring, error)
- func ParseRing(current, previous string) (Ring, error)

Constants ¶

View Source

const CookieName = "mt"

CookieName carries an item token in cookie delivery mode.

View Source

const DefaultWindow = 4 * time.Hour

DefaultWindow aligns expiries so tokens and URLs repeat within a window.

Variables ¶

View Source

var (
	ErrMalformed  = errors.New("token: malformed")
	ErrExpired    = errors.New("token: expired")
	ErrUnknownKey = errors.New("token: unknown key")
	ErrInvalid    = errors.New("token: signature does not cover this path")
)

Functions ¶

func DownloadScope ¶

func DownloadScope(key string) string

DownloadScope is the scope of a download token for key: the key itself, which no item scope equals.

func Expiry ¶

func Expiry(now time.Time, ttl, window time.Duration) time.Time

Expiry rounds now+ttl up to a window. Token timestamps store whole Unix seconds, so fractional-second windows round up to whole seconds.

func ItemScope ¶ added in v0.62.0

func ItemScope(ns, kind, id, version string) string

ItemScope covers every private file of one item: "{ns}/{kind}/{id}", or "{ns}/{kind}/{id}/{version}" for a version's.

func PrivateFileScope ¶ added in v0.114.0

func PrivateFileScope(key string) string

PrivateFileScope covers one private object key, including tenant, app, kind, item and version. Its domain separator keeps it distinct from download and whole-item scopes.

Types ¶

type Key ¶

type Key struct {
	ID     string
	Secret []byte
}

Key is one signing key.

func ParseKey ¶

func ParseKey(s string) (Key, error)

ParseKey parses "{kid}:{base64 secret}" (standard or URL alphabet, padding optional), the form hosts and the access worker read from their secret store.

type Ring ¶

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

Ring signs with the current key and verifies with the current or previous one.

func NewRing ¶

func NewRing(current Key, previous *Key) (Ring, error)

NewRing validates keys: ids are non-empty without '.', secrets at least 32 bytes.

func ParseRing ¶

func ParseRing(current, previous string) (Ring, error)

ParseRing builds a ring from ParseKey strings; previous may be empty.

func (Ring) Sign ¶

func (r Ring) Sign(scope string, exp time.Time) string

Sign signs scope until exp with the current key.

func (Ring) VerifyDownload ¶ added in v0.87.0

func (r Ring) VerifyDownload(tok, key string, now time.Time) error

VerifyDownload checks tok for the download key "{ns}/{kind}/{id}[/{version}]/download/{name}" at now: that one key's download token.

func (Ring) VerifyPrivate ¶ added in v0.62.0

func (r Ring) VerifyPrivate(tok, key string, now time.Time) error

VerifyPrivate checks an exact-file or whole-item token for a private key.

func (Ring) VerifyScope ¶ added in v0.62.0

func (r Ring) VerifyScope(tok, scope string, now time.Time) error

VerifyScope checks tok for exactly scope at now.

Source Files ¶

View all Source files

token.go

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