restrictionKey.go

package model

import (
	"encoding/json"

	"github.com/oidc-mytoken/api/v0"
	"github.com/pkg/errors"
	"gopkg.in/yaml.v3"
)

// RestrictionKey is an enum like type for restriction keys
type RestrictionKey int

// RestrictionKeys is a slice of RestrictionKey
type RestrictionKeys []RestrictionKey

// AllRestrictionKeyStrings holds all defined RestrictionKey strings
var AllRestrictionKeyStrings = api.AllRestrictionKeys

// AllRestrictionKeys holds all defined RestrictionKeys
var AllRestrictionKeys RestrictionKeys

func init() {
	for i := 0; i < int(maxRestrictionKey); i++ {
		AllRestrictionKeys = append(AllRestrictionKeys, RestrictionKey(i))
	}
}

// RestrictionKeys
const ( // assert that these are in the same order as api.AllRestrictionKeys
	RestrictionKeyNotBefore RestrictionKey = iota
	RestrictionKeyExpiresAt
	RestrictionKeyScope
	RestrictionKeyAudiences
	RestrictionKeyIPs
	RestrictionKeyGeoIPAllow
	RestrictionKeyGeoIPDisallow
	RestrictionKeyUsagesAT
	RestrictionKeyUsagesOther
	maxRestrictionKey
)

// NewRestrictionKey creates a new RestrictionKey from the grant type string
func NewRestrictionKey(s string) RestrictionKey {
	for i, f := range AllRestrictionKeyStrings {
		if f == s {
			return RestrictionKey(i)
		}
	}
	return -1
}

func (rk *RestrictionKey) String() string {
	if *rk < 0 || int(*rk) >= len(AllRestrictionKeys) {
		return ""
	}
	return AllRestrictionKeyStrings[*rk]
}

// Valid checks that RestrictionKey is a defined grant type
func (rk *RestrictionKey) Valid() bool {
	return *rk < maxRestrictionKey && *rk >= 0
}

const valueNotValidFmt = "value '%s' not valid for RestrictionKey"

// UnmarshalYAML implements the yaml.Unmarshaler interface
func (rk *RestrictionKey) UnmarshalYAML(value *yaml.Node) error {
	s := value.Value
	if s == "" {
		return errors.New("empty value in unmarshal grant type")
	}
	*rk = NewRestrictionKey(s)
	if !rk.Valid() {
		return errors.Errorf(valueNotValidFmt, s)
	}
	return nil
}

// UnmarshalJSON implements the json.Unmarshaler interface
func (rk *RestrictionKey) UnmarshalJSON(data []byte) error {
	var s string
	if err := json.Unmarshal(data, &s); err != nil {
		return errors.WithStack(err)
	}
	*rk = NewRestrictionKey(s)
	if !rk.Valid() {
		return errors.Errorf(valueNotValidFmt, s)
	}
	return nil
}

// UnmarshalText implements the encoding.TextUnmarshaler interface
func (rk *RestrictionKey) UnmarshalText(data []byte) error {
	s := string(data)
	*rk = NewRestrictionKey(s)
	if !rk.Valid() {
		return errors.Errorf(valueNotValidFmt, s)
	}
	return nil
}

// MarshalJSON implements the json.Marshaler interface
func (rk RestrictionKey) MarshalJSON() ([]byte, error) {
	data, err := json.Marshal(rk.String())
	return data, errors.WithStack(err)
}

// Has checks if a a RestrictionKey is in a RestrictionKeys
func (rks RestrictionKeys) Has(rk RestrictionKey) bool {
	for _, k := range rks {
		if k == rk {
			return true
		}
	}
	return false
}

// Disable subtracts the passed RestrictionKeys from this RestrictionKeys and returns the left RestrictionKeys
func (rks RestrictionKeys) Disable(disable RestrictionKeys) (left RestrictionKeys) {
	for _, r := range rks {
		if !disable.Has(r) {
			left = append(left, r)
		}
	}
	return
}