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 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
|
package jws
import (
"fmt"
"io/ioutil"
"os"
"strings"
"github.com/smallstep/cli/flags"
"github.com/smallstep/cli/utils"
"github.com/pkg/errors"
"github.com/smallstep/cli/errs"
"github.com/smallstep/cli/jose"
"github.com/urfave/cli"
)
func signCommand() cli.Command {
return cli.Command{
Name: "sign",
Action: cli.ActionFunc(signAction),
Usage: "create a signed JWS data structure",
UsageText: `**step crypto jws sign** [- | <filename>]
[**--alg**=<algorithm>] [**--jku**=<jwk-url>] [**--jwk**] [**--typ**=<type>]
[**--cty**=<content-type>] [**--key**=<path>] [**--jwks**=<jwks>] [**--kid**=<kid>]
[**--password-file**=<path>] [**--x5c-cert**=<path>] [**--x5c-key**=<path>]
[**--x5t-cert**=<path>] [**--x5t-key**=<path>]`,
// others: x5u, x5c, x5t, x5t#S256, and crit
Description: `**step crypto jws sign** generates a signed JSON Web Signature (JWS) by
computing a digital signature or message authentication code for an arbitrary
payload. By default, the payload to sign is read from STDIN and the JWS will
be written to STDOUT.
For examples, see **step help crypto jws**.`,
Flags: []cli.Flag{
cli.StringFlag{
Name: "alg, algorithm",
Usage: `The signature or MAC algorithm to use. Algorithms are case-sensitive strings
defined in RFC7518. The selected algorithm must be compatible with the key
type. This flag is optional. If not specified, the "alg" member of the JWK is
used. If the JWK has no "alg" member then a default is selected depending on
the JWK key type. If the JWK has an "alg" member and the "alg" flag is passed
the two options must match unless the '--subtle' flag is also passed.
: <algorithm> is a case-sensitive string and must be one of:
**HS256**
: HMAC using SHA-256 (default for "oct" key type)
**HS384**
: HMAC using SHA-384
**HS512**
: HMAC using SHA-512
**RS256**
: RSASSA-PKCS1-v1_5 using SHA-256 (default for "RSA" key type)
**RS384**
: RSASSA-PKCS1-v1_5 using SHA-384
**RS512**
: RSASSA-PKCS1-v1_5 using SHA-512
**ES256**
: ECDSA using P-256 and SHA-256 (default for "EC" key type)
**ES384**
: ECDSA using P-384 and SHA-384
**ES512**
: ECDSA using P-521 and SHA-512
**PS256**
: RSASSA-PSS using SHA-256 and MGF1 with SHA-256
**PS384**
: RSASSA-PSS using SHA-384 and MGF1 with SHA-384
**PS512**
: RSASSA-PSS using SHA-512 and MGF1 with SHA-512
**EdDSA**
: EdDSA signature algorithm`,
},
cli.StringFlag{
Name: "jku",
Usage: `The "jku" (JWK Set URL) Header Parameter is a URI that refers to a resource
for a set of JSON-encoded public keys, one of which corresponds to the key
used to digitally sign the JWS. The keys MUST be encoded as a JWK Set (JWK).
The protocol used to acquire the resource MUST provide integrity protection;
an HTTP GET request to retrieve the JWK Set MUST use Transport Layer Security
(TLS); and the identity of the server MUST be validated. Use of <jwk-url> is
optional.`,
},
cli.BoolFlag{
Name: "jwk",
Usage: `The "jwk" (JSON Web Key) Header Parameter is the public key that corresponds
to the key used to digitally sign the JWS. This key is represented as a JSON
Web Key (JWK). Use of <jwk> is optional.`,
},
cli.StringFlag{
Name: "typ, type",
Usage: `The "typ" (type) Header Parameter is used by JWS applications to declare the
media type of this complete JWS. This is intended for use by the application
when more than one kind of object could be present in an application data
structure that can contain a JWS; the application can use this value to
disambiguate among the different kinds of objects that might be present. It
will typically not be used by applications when the kind of object is already
known. This parameter is ignored by JWS implementations; any processing of
this parameter is performed by the JWS application. Use of <type> is
optional.
The "typ" value "JOSE" can be used by applications to indicate that this
object is a JWS or JWE using the JWS Compact Serialization or the JWE Compact
Serialization. The "typ" value "JOSE+JSON" can be used by applications to
indicate that this object is a JWS or JWE using the JWS JSON Serialization or
the JWE JSON Serialization. Other type values can also be used by
applications.`,
},
cli.StringFlag{
Name: "cty",
Usage: `The "cty" (content type) Header Parameter is used by JWS applications to
declare the media type of the secured content (the payload). This is intended
for use by the application when more than one kind of object could be present
in the JWS Payload; the application can use this value to disambiguate among
the different kinds of objects that might be present. It will typically not be
used by applications when the kind of object is already known. This parameter
is ignored by JWS implementations; any processing of this parameter is
performed by the JWS application. Use of <content-type> is optional.`,
},
cli.StringFlag{
Name: "key, x5c-key, x5t-key",
Usage: `The <path> to the key with which to sign the JWS.
JWSs can be signed using a private JWK (or a JWK encrypted as a JWE payload) or
a PEM encoded private key (or a private key encrypted using the modes described
on RFC 1423 or with PBES2+PBKDF2 described in RFC 2898).`,
},
cli.StringFlag{
Name: "jwks",
Usage: `The JWK Set containing the key to use to sign the JWS. The <jwks> argument
should be the name of a file. The file contents should be a JWK Set or a JWE
with a JWK Set payload. The **--jwks** flag requires the use of the **--kid**
flag to specify which key to use.`,
},
cli.StringFlag{
Name: "kid",
Usage: `The ID of the key used to sign the JWS. The <kid> argument is a case-sensitive
string. When used with '--jwk' the <kid> value must match the **"kid"** member
of the JWK. When used with **--jwks** (a JWK Set) the <kid> value must match
the **"kid"** member of one of the JWKs in the JWK Set.`,
},
cli.BoolFlag{
Name: "subtle",
Hidden: true,
},
cli.BoolFlag{
Name: "no-kid",
Hidden: true,
},
flags.PasswordFile,
flags.X5cCert,
flags.X5tCert,
},
}
}
func signAction(ctx *cli.Context) error {
var err error
var payload []byte
// Read payload if provided
args := ctx.Args()
switch len(args) {
case 0: // read payload from stdin
if payload, err = readPayload(""); err != nil {
return err
}
case 1: // read payload from file or stdin (-)
if payload, err = readPayload(args[0]); err != nil {
return err
}
default:
return errs.TooManyArguments(ctx)
}
isSubtle := ctx.Bool("subtle")
alg := ctx.String("alg")
x5cCertFile, x5cKeyFile := ctx.String("x5c-cert"), ctx.String("x5c-key")
x5tCertFile, x5tKeyFile := ctx.String("x5t-cert"), ctx.String("x5t-key")
key := ctx.String("key")
jwks := ctx.String("jwks")
kid := ctx.String("kid")
var isX5C bool
if len(x5cCertFile) > 0 {
if len(x5cKeyFile) == 0 {
return errs.RequiredWithOrFlag(ctx, "x5c-cert", "key", "x5c-key")
}
if len(x5tCertFile) > 0 {
return errs.MutuallyExclusiveFlags(ctx, "x5c-cert", "x5t-cert")
}
if ctx.IsSet("jwk") {
return errs.MutuallyExclusiveFlags(ctx, "x5c-cert", "jwk")
}
if len(jwks) > 0 {
return errs.MutuallyExclusiveFlags(ctx, "x5c-cert", "jwks")
}
isX5C = true
}
var isX5T bool
if len(x5tCertFile) > 0 {
if len(x5tKeyFile) == 0 {
return errs.RequiredWithOrFlag(ctx, "x5t-cert", "key", "x5t-key")
}
if len(x5cCertFile) > 0 {
return errs.MutuallyExclusiveFlags(ctx, "x5t-cert", "x5c-cert")
}
if ctx.IsSet("jwk") {
return errs.MutuallyExclusiveFlags(ctx, "x5t-cert", "jwk")
}
if len(jwks) > 0 {
return errs.MutuallyExclusiveFlags(ctx, "x5t-cert", "jwks")
}
isX5T = true
}
if !isX5C && !isX5T {
// Validate key, jwks and kid
switch {
case key == "" && jwks == "":
return errs.RequiredOrFlag(ctx, "key", "jwks")
case key != "" && jwks != "":
return errs.MutuallyExclusiveFlags(ctx, "key", "jwks")
case jwks != "" && kid == "":
return errs.RequiredWithFlag(ctx, "kid", "jwks")
}
}
// Add parse options
var options []jose.Option
options = append(options, jose.WithUse("sig"))
if len(alg) > 0 {
options = append(options, jose.WithAlg(alg))
}
if len(kid) > 0 {
options = append(options, jose.WithKid(kid))
}
if isSubtle {
options = append(options, jose.WithSubtle(true))
}
if passwordFile := ctx.String("password-file"); len(passwordFile) != 0 {
options = append(options, jose.WithPasswordFile(passwordFile))
}
// Read key from --key, --jwks, --x5c-key, or --x5t-key
var jwk *jose.JSONWebKey
switch {
case isX5T:
jwk, err = jose.ParseKey(x5tKeyFile, options...)
case isX5C:
jwk, err = jose.ParseKey(x5cKeyFile, options...)
case key != "":
jwk, err = jose.ParseKey(key, options...)
case jwks != "":
jwk, err = jose.ParseKeySet(jwks, options...)
default:
return errs.RequiredOrFlag(ctx, "key", "jwks")
}
if err != nil {
return err
}
// Public keys cannot be used for signing
if jwk.IsPublic() {
return errors.New("cannot use a public key for signing")
}
// Key "use" must be "sig" to use for signing
if jwk.Use != "sig" && jwk.Use != "" {
return errors.Errorf("invalid jwk use: found '%s', expecting 'sig' (signature)", jwk.Use)
}
// At this moment jwk.Algorithm should have an alg from:
// * alg parameter
// * jwk or jwkset
// * guessed for ecdsa and Ed25519 keys
if jwk.Algorithm == "" {
return errors.New("flag '--alg' is required with the given key")
}
if err = jose.ValidateJWK(jwk); err != nil {
return err
}
// Sign
so := new(jose.SignerOptions)
if ctx.IsSet("typ") {
so.WithType(jose.ContentType(ctx.String("typ")))
}
if ctx.IsSet("cty") {
so.WithContentType(jose.ContentType(ctx.String("cty")))
}
if !ctx.Bool("no-kid") && jwk.KeyID != "" {
so.WithHeader("kid", jwk.KeyID)
}
if ctx.IsSet("jku") {
so.WithHeader("jku", ctx.String("jku"))
}
if ctx.Bool("jwk") {
so.WithHeader("jwk", jwk.Public())
}
if isX5C {
certStrs, err := jose.ValidateX5C(x5cCertFile, jwk.Key)
if err != nil {
return errors.Wrap(err, "error validating x5c certificate chain and key for use in x5c header")
}
so.WithHeader("x5c", certStrs)
}
if isX5T {
fingerprint, err := jose.ValidateX5T(x5tCertFile, jwk.Key)
if err != nil {
return errors.Wrap(err, "error validating x5t certificate and key for use in x5t header")
}
so.WithHeader("x5t", fingerprint)
}
signer, err := jose.NewSigner(jose.SigningKey{
Algorithm: jose.SignatureAlgorithm(jwk.Algorithm),
Key: jwk.Key,
}, so)
if err != nil {
return errors.Wrap(err, "error creating JWS signer")
}
signed, err := signer.Sign(payload)
if err != nil {
return errors.Errorf("error signing payload: %s", strings.TrimPrefix(err.Error(), "square/go-jose: "))
}
raw, err := signed.CompactSerialize()
if err != nil {
return errors.Wrapf(err, "error serializing JWS")
}
fmt.Println(raw)
return nil
}
func readPayload(filename string) ([]byte, error) {
switch filename {
case "":
st, err := os.Stdin.Stat()
if err != nil {
return nil, errors.Wrap(err, "error reading data")
}
if st.Size() == 0 && st.Mode()&os.ModeNamedPipe == 0 {
return []byte{}, nil
}
return utils.ReadAll(os.Stdin)
case "-":
return utils.ReadAll(os.Stdin)
default:
b, err := ioutil.ReadFile(filename)
if err != nil {
return nil, errs.FileError(err, filename)
}
return b, nil
}
}
|