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
|
//
// Copyright 2024 The Sigstore 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 encoding has helper functions for encoding and decoding some method arguments and return values.
package encoding
// We have some type assertions that seem like they may panic, but this is just to satisfy
// golanci-lint's forcetypeassert linter. If they were to ever fail, unit tests would also fail.
// We know the asserted types are valid because otherwise we would have compiler failures.
import (
"context"
"crypto"
"time"
"github.com/sigstore/sigstore/pkg/signature"
"github.com/sigstore/sigstore/pkg/signature/kms/cliplugin/common"
"github.com/sigstore/sigstore/pkg/signature/options"
)
// PackRPCOptions extracts properties of all of opts into struct ready for serializing.
func PackRPCOptions(opts []signature.RPCOption) *common.RPCOptions {
ctx := context.Background()
var keyVersion string
var remoteVerification bool
for _, opt := range opts {
opt.ApplyContext(&ctx)
opt.ApplyKeyVersion(&keyVersion)
opt.ApplyRemoteVerification(&remoteVerification)
}
var ctxDeadline *time.Time
if deadline, ok := ctx.Deadline(); ok {
ctxDeadline = &deadline
}
return &common.RPCOptions{
CtxDeadline: ctxDeadline,
KeyVersion: &keyVersion,
RemoteVerification: &remoteVerification,
}
}
// UnpackRPCOptions builds the []signature.RPCOption from common.RPCOptions.
func UnpackRPCOptions(commonOpts *common.RPCOptions) []signature.RPCOption {
opts := []signature.RPCOption{}
if commonOpts.CtxDeadline != nil {
// no need fot this package to cancel the context early,
// and users may still check if the deadline is exceeded with ctx.Err().
ctx, _ := context.WithDeadline(context.Background(), *commonOpts.CtxDeadline) //nolint:govet
opts = append(opts, options.WithContext(ctx))
}
if commonOpts.KeyVersion != nil {
opts = append(opts, options.WithKeyVersion(*commonOpts.KeyVersion))
}
if commonOpts.RemoteVerification != nil {
opts = append(opts, options.WithRemoteVerification(*commonOpts.RemoteVerification))
}
return opts
}
// PackMessageOptions extracts properties of all of opts into struct ready for serializing.
func PackMessageOptions(opts []signature.MessageOption) *common.MessageOptions {
var digest []byte
var signerOpts crypto.SignerOpts
for _, opt := range opts {
opt.ApplyDigest(&digest)
opt.ApplyCryptoSignerOpts(&signerOpts)
}
var hashFunc *crypto.Hash
if signerOpts != nil {
hf := signerOpts.HashFunc()
hashFunc = &hf
}
return &common.MessageOptions{
Digest: &digest,
HashFunc: hashFunc,
}
}
// PackPublicKeyOptions extracts properties of all of opts into struct ready for serializing.
func PackPublicKeyOptions(opts []signature.PublicKeyOption) *common.PublicKeyOptions {
rpcOpts := []signature.RPCOption{}
for _, opt := range opts {
rpcOpts = append(rpcOpts, opt)
}
return &common.PublicKeyOptions{
RPCOptions: *PackRPCOptions(rpcOpts),
}
}
// UnpackPublicKeyOptions builds the []signature.PublicKeyOption from common.PublicKeyOptions.
func UnpackPublicKeyOptions(commonOpts *common.PublicKeyOptions) []signature.PublicKeyOption {
opts := []signature.PublicKeyOption{}
for _, opt := range UnpackRPCOptions(&commonOpts.RPCOptions) {
opt, ok := opt.(signature.PublicKeyOption)
if !ok {
panic("cannot assert as PublicKeyOption")
}
opts = append(opts, opt)
}
return opts
}
// UnpackMessageOptions builds the []signature.MessageOption from common.MessageOptions.
func UnpackMessageOptions(commonOpts *common.MessageOptions) []signature.MessageOption {
opts := []signature.MessageOption{}
if commonOpts.Digest != nil {
opts = append(opts, options.WithDigest(*commonOpts.Digest))
}
if commonOpts.HashFunc != nil {
opts = append(opts, options.WithCryptoSignerOpts(*commonOpts.HashFunc))
}
return opts
}
// PackSignOptions extracts properties of all of opts into struct ready for serializing,
func PackSignOptions(opts []signature.SignOption) *common.SignOptions {
rpcOpts := []signature.RPCOption{}
for _, opt := range opts {
rpcOpts = append(rpcOpts, opt)
}
messageOpts := []signature.MessageOption{}
for _, opt := range opts {
messageOpts = append(messageOpts, opt)
}
return &common.SignOptions{
RPCOptions: *PackRPCOptions(rpcOpts),
MessageOptions: *PackMessageOptions(messageOpts),
}
}
// UnpackSignOptions builds the []]signature.SignOption from common.SignOptions.
func UnpackSignOptions(commonOpts *common.SignOptions) []signature.SignOption {
opts := []signature.SignOption{}
for _, opt := range UnpackRPCOptions(&commonOpts.RPCOptions) {
opt, ok := opt.(signature.SignOption)
if !ok {
panic("cannot assert as SignOption")
}
opts = append(opts, opt)
}
for _, opt := range UnpackMessageOptions(&commonOpts.MessageOptions) {
opt, ok := opt.(signature.SignOption)
if !ok {
panic("cannot assert as SignOption")
}
opts = append(opts, opt)
}
return opts
}
// PackVerifyOptions extracts properties of all of opts into struct ready for serializing,
func PackVerifyOptions(opts []signature.VerifyOption) *common.VerifyOptions {
rpcOpts := []signature.RPCOption{}
for _, opt := range opts {
rpcOpts = append(rpcOpts, opt)
}
messageOpts := []signature.MessageOption{}
for _, opt := range opts {
messageOpts = append(messageOpts, opt)
}
return &common.VerifyOptions{
RPCOptions: *PackRPCOptions(rpcOpts),
MessageOptions: *PackMessageOptions(messageOpts),
}
}
// UnpackVerifyOptions builds the []]signature.VerifyOption from common.VerifyOptions.
func UnpackVerifyOptions(commonOpts *common.VerifyOptions) []signature.VerifyOption {
opts := []signature.VerifyOption{}
for _, opt := range UnpackRPCOptions(&commonOpts.RPCOptions) {
opt, ok := opt.(signature.VerifyOption)
if !ok {
panic("cannot assert as VerifyOption")
}
opts = append(opts, opt)
}
for _, opt := range UnpackMessageOptions(&commonOpts.MessageOptions) {
opt, ok := opt.(signature.VerifyOption)
if !ok {
panic("cannot assert as VerifyOption")
}
opts = append(opts, opt)
}
return opts
}
|