claims_reg.go

package sjwt

import "time"

const (
	// TokenID is a unique identifier for this token
	TokenID = "jti"

	// Issuer is the principal that issued the token
	Issuer = "iss"

	// Audience identifies the recipents the token is intended for
	Audience = "aud"

	// Subject is the subject of the token
	Subject = "sub"

	// IssuedAt is a timesatamp for when the token was issued
	IssuedAt = "iat"

	// ExpiresAt is a timestamp for when the token should expire
	ExpiresAt = "exp"

	// NotBeforeAt is a timestamp for which this token should not be excepted until
	NotBeforeAt = "nbf"
)

// SetTokenID will set a random uuid v4 id
func (c Claims) SetTokenID() { c[TokenID] = UUID() }

// DeleteTokenID deletes token id
func (c Claims) DeleteTokenID() { delete(c, TokenID) }

// GetTokenID will get the id set on the Claims
func (c Claims) GetTokenID() (string, error) {
	if !c.Has(TokenID) {
		return "", ErrNotFound
	}

	switch val := c[TokenID].(type) {
	case string:
		return val, nil
	}

	return "", ErrClaimValueInvalid
}

// SetIssuer will set a string value for the issuer
func (c Claims) SetIssuer(issuer string) { c[Issuer] = issuer }

// DeleteIssuer deletes issuer
func (c Claims) DeleteIssuer() { delete(c, Issuer) }

// GetIssuer will get the issuer set on the Claims
func (c Claims) GetIssuer() (string, error) {
	if !c.Has(Issuer) {
		return "", ErrNotFound
	}

	switch val := c[Issuer].(type) {
	case string:
		return val, nil
	}

	return "", ErrClaimValueInvalid
}

// SetAudience will set a string value for the audience
func (c Claims) SetAudience(audience []string) { c[Audience] = audience }

// DeleteAudience deletes audience
func (c Claims) DeleteAudience() { delete(c, Audience) }

// GetAudience will get the audience set on the Claims
func (c Claims) GetAudience() ([]string, error) {
	if !c.Has(Audience) {
		return []string{}, ErrNotFound
	}

	switch val := c[Audience].(type) {
	case []string:
		return val, nil
	}

	return []string{}, ErrClaimValueInvalid
}

// SetSubject will set a subject value
func (c Claims) SetSubject(subject string) { c[Subject] = subject }

// DeleteSubject deletes token id
func (c Claims) DeleteSubject() { delete(c, Subject) }

// GetSubject will get the subject set on the Claims
func (c Claims) GetSubject() (string, error) {
	if !c.Has(Subject) {
		return "", ErrNotFound
	}

	switch val := c[Subject].(type) {
	case string:
		return val, nil
	}

	return "", ErrClaimValueInvalid
}

// SetIssuedAt will set an issued at timestamp in nanoseconds
func (c Claims) SetIssuedAt(issuedAt time.Time) { c[IssuedAt] = issuedAt.Unix() }

// DeleteIssuedAt deletes issued at
func (c Claims) DeleteIssuedAt() { delete(c, IssuedAt) }

// GetIssuedAt will get the issued at timestamp set on the Claims
func (c Claims) GetIssuedAt() (int64, error) {
	if !c.Has(IssuedAt) {
		return 0, ErrNotFound
	}

	issuedAt, err := c.GetInt(IssuedAt)
	if err != nil {
		return 0, ErrClaimValueInvalid
	}

	return int64(issuedAt), nil
}

// SetExpiresAt will set an expires at timestamp in nanoseconds
func (c Claims) SetExpiresAt(expiresAt time.Time) { c[ExpiresAt] = expiresAt.Unix() }

// DeleteExpiresAt deletes expires at
func (c Claims) DeleteExpiresAt() { delete(c, ExpiresAt) }

// GetExpiresAt will get the expires at timestamp set on the Claims
func (c Claims) GetExpiresAt() (int64, error) {
	if !c.Has(ExpiresAt) {
		return 0, ErrNotFound
	}

	expiresAt, err := c.GetInt(ExpiresAt)
	if err != nil {
		return 0, ErrClaimValueInvalid
	}

	return int64(expiresAt), nil
}

// SetNotBeforeAt will set an not before at timestamp in nanoseconds
func (c Claims) SetNotBeforeAt(notbeforeAt time.Time) { c[NotBeforeAt] = notbeforeAt.Unix() }

// DeleteNotBeforeAt deletes not before at
func (c Claims) DeleteNotBeforeAt() { delete(c, NotBeforeAt) }

// GetNotBeforeAt will get the not before at timestamp set on the Claims
func (c Claims) GetNotBeforeAt() (int64, error) {
	if !c.Has(NotBeforeAt) {
		return 0, ErrNotFound
	}

	notBeforeAt, err := c.GetInt(NotBeforeAt)
	if err != nil {
		return 0, ErrClaimValueInvalid
	}

	return int64(notBeforeAt), nil
}