hmactoken

Documentation

Overview

Package hmactoken implements generation and validation HMAC-tagged Swarming tokens.

Index

• type Secret
  • func NewRotatingSecret(ctx context.Context, keyName string) (*Secret, error)
  • func NewStaticSecret(secret secrets.Secret) *Secret
  • func (s *Secret) GenerateToken(msg proto.Message) ([]byte, error)
  • func (s *Secret) Tag(pfx, body []byte) []byte
  • func (s *Secret) ValidateToken(tok []byte, msg proto.Message) error
  • func (s *Secret) Verify(pfx, body, tag []byte) bool

Types

type Secret

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

Secret can be used to generate and validate HMAC-tagged tokens.

func NewRotatingSecret

func NewRotatingSecret(ctx context.Context, keyName string) (*Secret, error)

NewRotatingSecret creates a new secret given a key name and subscribes to its rotations.

func NewStaticSecret

func NewStaticSecret(secret secrets.Secret) *Secret

NewStaticSecret creates a new secret from a given static secret value.

Mostly for tests.

func (*Secret) GenerateToken

func (s *Secret) GenerateToken(msg proto.Message) ([]byte, error)

GenerateToken wraps `msg` into a serialized TaggedMessage.

The produced token can be validated and deserialized with validateToken.

TODO: To be deleted once poll tokens are gone.

func (*Secret) Tag

func (s *Secret) Tag(pfx, body []byte) []byte

Tag generates a HMAC-SHA256 tag of `pfx+body`.

func (*Secret) ValidateToken

func (s *Secret) ValidateToken(tok []byte, msg proto.Message) error

ValidateToken deserializes a TaggedMessage, checks the HMAC and deserializes the payload into `msg`.

TODO: To be deleted once poll tokens are gone.

func (*Secret) Verify

func (s *Secret) Verify(pfx, body, tag []byte) bool

Verify checks the given tag matches the expected one for given `pfx+body`.