1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
|
package token
import (
"crypto/sha256"
"encoding/hex"
"time"
"github.com/pkg/errors"
"github.com/smallstep/cli/crypto/pemutil"
"github.com/smallstep/cli/jose"
)
// Options is a function that set claims.
type Options func(c *Claims) error
// WithClaim is an Options function that adds a custom claim to the JWT.
func WithClaim(name string, value interface{}) Options {
return func(c *Claims) error {
if name == "" {
return errors.New("name cannot be empty")
}
c.Set(name, value)
return nil
}
}
// WithRootCA returns an Options function that calculates the SHA256 of the
// given root certificate to be used in the token claims. If this method it's
// not used the default root certificate in the $STEPPATH secrets directory will
// be used.
func WithRootCA(path string) Options {
return func(c *Claims) error {
cert, err := pemutil.ReadCertificate(path)
if err != nil {
return err
}
sum := sha256.Sum256(cert.Raw)
c.Set(RootSHAClaim, hex.EncodeToString(sum[:]))
return nil
}
}
// WithSHA returns an Options function that sets the SHA claim to the given
// value.
func WithSHA(sum string) Options {
return func(c *Claims) error {
c.Set(RootSHAClaim, sum)
return nil
}
}
// WithSANS returns an Options function that sets the list of required SANs
// in the token claims.
func WithSANS(sans []string) Options {
return func(c *Claims) error {
c.Set(SANSClaim, sans)
return nil
}
}
// WithStep returns an Options function that sets the step claim in the payload.
func WithStep(v interface{}) Options {
return func(c *Claims) error {
c.Set(StepClaim, v)
return nil
}
}
// WithSSH returns an Options function that sets the step claim with the ssh
// property in the value.
func WithSSH(v interface{}) Options {
return WithStep(map[string]interface{}{
"ssh": v,
})
}
// WithValidity validates boundary inputs and sets the 'nbf' (NotBefore) and
// 'exp' (expiration) options.
func WithValidity(notBefore, expiration time.Time) Options {
return func(c *Claims) error {
now := time.Now().UTC()
if expiration.Before(notBefore) {
return errors.Errorf("nbf < exp: nbf=%v, exp=%v", notBefore, expiration)
}
requestedDelay := notBefore.Sub(now)
if requestedDelay > MaxValidityDelay {
return errors.Errorf("requested validity delay is too long: 'requested validity delay'=%v, 'max validity delay'=%v", requestedDelay, MaxValidityDelay)
}
requestedValidity := expiration.Sub(notBefore)
if requestedValidity < MinValidity {
return errors.Errorf("requested token validity is too short: 'requested token validity'=%v, 'minimum token validity'=%v", requestedValidity, MinValidity)
} else if requestedValidity > MaxValidity {
return errors.Errorf("requested token validity is too long: 'requested token validity'=%v, 'maximum token validity'=%v", requestedValidity, MaxValidity)
}
c.NotBefore = jose.NewNumericDate(notBefore)
c.Expiry = jose.NewNumericDate(expiration)
return nil
}
}
// WithIssuer returns an Options function that sets the issuer to use in the
// token claims. If Issuer is not used the default issuer will be used.
func WithIssuer(s string) Options {
return func(c *Claims) error {
if s == "" {
return errors.New("issuer cannot be empty")
}
c.Issuer = s
return nil
}
}
// WithSubject returns an Options that sets the subject to use in the token
// claims.
func WithSubject(s string) Options {
return func(c *Claims) error {
if s == "" {
return errors.New("subject cannot be empty")
}
c.Subject = s
return nil
}
}
// WithAudience returns a Options that sets the audience to use in the token
// claims. If Audience is not used the default audience will be used.
func WithAudience(s string) Options {
return func(c *Claims) error {
if s == "" {
return errors.New("audience cannot be empty")
}
c.Audience = append(jose.Audience{}, s)
return nil
}
}
// WithJWTID returns a Options that sets the jwtID to use in the token
// claims. If WithJWTID is not used a random identifier will be used.
func WithJWTID(s string) Options {
return func(c *Claims) error {
if s == "" {
return errors.New("jwtID cannot be empty")
}
c.ID = s
return nil
}
}
// WithKid returns a Options that sets the header kid claims.
// If WithKid is not used a thumbprint using SHA256 will be used.
func WithKid(s string) Options {
return func(c *Claims) error {
if s == "" {
return errors.New("kid cannot be empty")
}
c.SetHeader("kid", s)
return nil
}
}
// WithX5CFile returns a Options that sets the header x5c claims.
func WithX5CFile(certFile string, key interface{}) Options {
return func(c *Claims) error {
certStrs, err := jose.ValidateX5C(certFile, key)
if err != nil {
return errors.Wrap(err, "error validating x5c certificate chain and key for use in x5c header")
}
c.SetHeader("x5c", certStrs)
return nil
}
}
// WithX5CInsecureFile returns a Options that sets the header x5cAllowInvalid claims.
// The `x5c` claims can only be accessed by running a method on the jose Token
// which validates the certificate chain before returning it. This option serves
// a use case where the user would prefer not to validate the certificate chain
// before returning it. Presumably the user would then perform their own validation.
// NOTE: here be dragons. Use WithX5CFile unless you know what you are doing.
func WithX5CInsecureFile(certFile string, key interface{}) Options {
return func(c *Claims) error {
certStrs, err := jose.ValidateX5C(certFile, key)
if err != nil {
return errors.Wrap(err, "error validating x5c certificate chain and key for use in x5c header")
}
c.SetHeader(jose.X5cInsecureKey, certStrs)
return nil
}
}
// WithSSHPOPFile returns a Options that sets the header sshpop claims.
func WithSSHPOPFile(certFile string, key interface{}) Options {
return func(c *Claims) error {
certStrs, err := jose.ValidateSSHPOP(certFile, key)
if err != nil {
return errors.Wrap(err, "error validating SSH certificate and key for use in sshpop header")
}
c.SetHeader("sshpop", certStrs)
return nil
}
}
|