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
|
// Copyright The Notary Project Authors.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package jws
import (
"crypto/x509"
"encoding/base64"
"encoding/json"
"fmt"
"github.com/golang-jwt/jwt/v4"
"github.com/notaryproject/notation-core-go/internal/timestamp"
"github.com/notaryproject/notation-core-go/signature"
"github.com/notaryproject/notation-core-go/signature/internal/base"
"github.com/notaryproject/tspclient-go"
)
// MediaTypeEnvelope defines the media type name of JWS envelope.
const MediaTypeEnvelope = "application/jose+json"
func init() {
if err := signature.RegisterEnvelopeType(MediaTypeEnvelope, NewEnvelope, ParseEnvelope); err != nil {
panic(err)
}
}
type envelope struct {
base *jwsEnvelope
}
// NewEnvelope generates an JWS envelope.
func NewEnvelope() signature.Envelope {
return &base.Envelope{
Envelope: &envelope{},
}
}
// ParseEnvelope parses the envelope bytes and return a JWS envelope.
func ParseEnvelope(envelopeBytes []byte) (signature.Envelope, error) {
var e jwsEnvelope
err := json.Unmarshal(envelopeBytes, &e)
if err != nil {
return nil, &signature.InvalidSignatureError{Msg: err.Error()}
}
return &base.Envelope{
Envelope: &envelope{base: &e},
Raw: envelopeBytes,
}, nil
}
// Sign generates and sign the envelope according to the sign request.
func (e *envelope) Sign(req *signature.SignRequest) ([]byte, error) {
// get signingMethod for JWT package
method, err := getSigningMethod(req.Signer)
if err != nil {
return nil, &signature.InvalidSignRequestError{Msg: err.Error()}
}
// get all attributes ready to be signed
signedAttrs, err := getSignedAttributes(req, method.Alg())
if err != nil {
return nil, &signature.InvalidSignRequestError{Msg: err.Error()}
}
// parse payload as jwt.MapClaims
// [jwt-go]: https://pkg.go.dev/github.com/dgrijalva/jwt-go#MapClaims
var payload jwt.MapClaims
if err = json.Unmarshal(req.Payload.Content, &payload); err != nil {
return nil, &signature.InvalidSignRequestError{
Msg: fmt.Sprintf("payload format error: %v", err.Error())}
}
// JWT sign and get certificate chain
compact, certs, err := sign(payload, signedAttrs, method)
if err != nil {
return nil, &signature.InvalidSignRequestError{Msg: err.Error()}
}
// generate envelope
env, err := generateJWS(compact, req, certs)
if err != nil {
return nil, &signature.InvalidSignatureError{Msg: err.Error()}
}
// timestamping
if err := timestampJWS(env, req, signedAttrs[headerKeySigningScheme].(string)); err != nil {
return nil, err
}
encoded, err := json.Marshal(env)
if err != nil {
return nil, &signature.InvalidSignatureError{Msg: err.Error()}
}
e.base = env
return encoded, nil
}
// Verify verifies the envelope and returns its enclosed payload and signer info.
func (e *envelope) Verify() (*signature.EnvelopeContent, error) {
if e.base == nil {
return nil, &signature.SignatureEnvelopeNotFoundError{}
}
if len(e.base.Header.CertChain) == 0 {
return nil, &signature.InvalidSignatureError{Msg: "certificate chain is not present"}
}
cert, err := x509.ParseCertificate(e.base.Header.CertChain[0])
if err != nil {
return nil, &signature.InvalidSignatureError{Msg: "malformed leaf certificate"}
}
// verify JWT
compact := compactJWS(e.base)
if err = verifyJWT(compact, cert.PublicKey); err != nil {
return nil, err
}
return e.Content()
}
// Content returns the payload and signer information of the envelope.
// Content is trusted only after the successful call to `Verify()`.
func (e *envelope) Content() (*signature.EnvelopeContent, error) {
if e.base == nil {
return nil, &signature.SignatureEnvelopeNotFoundError{}
}
// parse protected headers
protected, err := parseProtectedHeaders(e.base.Protected)
if err != nil {
return nil, err
}
// extract payload
payload, err := e.payload(protected)
if err != nil {
return nil, err
}
// extract signer info
signerInfo, err := e.signerInfo(protected)
if err != nil {
return nil, err
}
return &signature.EnvelopeContent{
SignerInfo: *signerInfo,
Payload: *payload,
}, nil
}
// payload returns the payload of JWS envelope.
func (e *envelope) payload(protected *jwsProtectedHeader) (*signature.Payload, error) {
payload, err := base64.RawURLEncoding.DecodeString(e.base.Payload)
if err != nil {
return nil, &signature.InvalidSignatureError{
Msg: fmt.Sprintf("payload error: %v", err)}
}
return &signature.Payload{
Content: payload,
ContentType: protected.ContentType,
}, nil
}
// signerInfo returns the SignerInfo of JWS envelope.
func (e *envelope) signerInfo(protected *jwsProtectedHeader) (*signature.SignerInfo, error) {
var signerInfo signature.SignerInfo
// populate protected header to signerInfo
if err := populateProtectedHeaders(protected, &signerInfo); err != nil {
return nil, err
}
// parse signature
sig, err := base64.RawURLEncoding.DecodeString(e.base.Signature)
if err != nil {
return nil, &signature.InvalidSignatureError{Msg: err.Error()}
}
if len(sig) == 0 {
return nil, &signature.InvalidSignatureError{Msg: "signature missing in jws-json envelope"}
}
signerInfo.Signature = sig
// parse headers
var certs []*x509.Certificate
for _, certBytes := range e.base.Header.CertChain {
cert, err := x509.ParseCertificate(certBytes)
if err != nil {
return nil, &signature.InvalidSignatureError{Msg: err.Error()}
}
certs = append(certs, cert)
}
signerInfo.CertificateChain = certs
signerInfo.UnsignedAttributes.SigningAgent = e.base.Header.SigningAgent
signerInfo.UnsignedAttributes.TimestampSignature = e.base.Header.TimestampSignature
return &signerInfo, nil
}
// sign the given payload and headers using the given signature provider.
func sign(payload jwt.MapClaims, headers map[string]interface{}, method signingMethod) (string, []*x509.Certificate, error) {
// generate token
token := jwt.NewWithClaims(method, payload)
token.Header = headers
// sign and return compact JWS
compact, err := token.SignedString(method.PrivateKey())
if err != nil {
return "", nil, err
}
// access certificate chain after sign
certs, err := method.CertificateChain()
if err != nil {
return "", nil, err
}
return compact, certs, nil
}
// timestampJWS timestamps a JWS envelope
func timestampJWS(env *jwsEnvelope, req *signature.SignRequest, signingScheme string) error {
if signingScheme != string(signature.SigningSchemeX509) || req.Timestamper == nil {
return nil
}
primitiveSignature, err := base64.RawURLEncoding.DecodeString(env.Signature)
if err != nil {
return &signature.TimestampError{Detail: err}
}
ks, err := req.Signer.KeySpec()
if err != nil {
return &signature.TimestampError{Detail: err}
}
hash := ks.SignatureAlgorithm().Hash()
if hash == 0 {
return &signature.TimestampError{Msg: fmt.Sprintf("got hash value 0 from key spec %+v", ks)}
}
timestampOpts := tspclient.RequestOptions{
Content: primitiveSignature,
HashAlgorithm: hash,
}
timestampToken, err := timestamp.Timestamp(req, timestampOpts)
if err != nil {
return &signature.TimestampError{Detail: err}
}
// on success, embed the timestamp token to TimestampSignature
env.Header.TimestampSignature = timestampToken
return nil
}
|