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
|
// Copyright (c) Contributors to the Apptainer project, established as
// Apptainer a Series of LF Projects LLC.
// For website terms of use, trademark policy, privacy policy and other
// project policies see https://lfprojects.org/policies
// Copyright (c) 2019-2022, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package cryptkey
import (
"bytes"
"crypto/rand"
"crypto/rsa"
"crypto/sha256"
"crypto/x509"
"encoding/asn1"
"encoding/pem"
"errors"
"fmt"
"io"
"os"
"strings"
"github.com/apptainer/sif/v2/pkg/sif"
)
var (
// ErrEncryptedKeyNotFound indicates the encrypted key is not found.
ErrEncryptedKeyNotFound = errors.New("encrypted key not found")
// ErrUnsupportedKeyURI indicates the key URI is not supported.
ErrUnsupportedKeyURI = errors.New("unsupported key URI")
// ErrNoEncryptedKeyData indicates there is no encrypted key data.
ErrNoEncryptedKeyData = errors.New("no encrypted key data")
// ErrNoPEMData indicates there is no PEM data.
ErrNoPEMData = errors.New("no PEM data")
)
const (
// Unknown indicates the key material format is not known.
Unknown = iota
// Passphrase indicates the key material is formatted as a passphrase.
Passphrase
// PEM indicates the key material is formatted as a PEM file.
PEM
// ENV indicates PEM content saved in an environment variable.
ENV
// hash size for encryption (Bytes)
Hash = 32
)
// KeyInfo contains information for passing around
// or extracting a passphrase for an encrypted container
type KeyInfo struct {
Format int
Material string
Path string
}
func getRandomBytes(size int) ([]byte, error) {
buf := make([]byte, size)
_, err := rand.Read(buf)
if err != nil {
return nil, err
}
return buf, nil
}
func NewPlaintextKey(k KeyInfo) ([]byte, error) {
switch k.Format {
case PEM:
// in this case we will generate a random secret and
// encrypt it using the PEM key.use the PEM key to
// encrypt a secret
return getRandomBytes(64)
case Passphrase:
// return the original value unmodified
return []byte(k.Material), nil
default:
return nil, ErrUnsupportedKeyURI
}
}
func EncryptKey(k KeyInfo, plaintext []byte) ([]byte, error) {
switch k.Format {
case PEM, ENV:
pubKey, err := LoadPEMPublicKey(k)
if err != nil {
return nil, fmt.Errorf("loading public key for key encryption: %v", err)
}
msglen := len(plaintext)
step := pubKey.Size() - 2*Hash - 2
var cipherText bytes.Buffer
for start := 0; start < msglen; start = start + step {
finish := start + step
if finish > msglen {
finish = msglen
}
ciphertext, err := rsa.EncryptOAEP(sha256.New(), rand.Reader, pubKey, plaintext[start:finish], nil)
if err != nil {
return nil, fmt.Errorf("encrypting key: %v", err)
}
_, err = cipherText.Write(ciphertext)
if err != nil {
return nil, fmt.Errorf("could not write encrypted message to buf: %v", err)
}
}
var buf bytes.Buffer
if err := savePEMMessage(&buf, cipherText.Bytes()); err != nil {
return nil, fmt.Errorf("serializing encrypted key: %v", err)
}
return buf.Bytes(), nil
case Passphrase:
return nil, nil
default:
return nil, ErrUnsupportedKeyURI
}
}
func PlaintextKey(k KeyInfo, image string) ([]byte, error) {
switch k.Format {
case PEM, ENV:
privateKey, err := LoadPEMPrivateKey(k)
if err != nil {
return nil, fmt.Errorf("could not load PEM private key: %v", err)
}
pemKey, err := getEncryptionKeyFromImage(image)
if err != nil {
return nil, fmt.Errorf("could not get encryption information from SIF: %v", err)
}
pemBuf := bytes.NewReader(pemKey)
encKey, err := loadPEMMessage(pemBuf)
if err != nil {
return nil, fmt.Errorf("could not unpack LUKS PEM from SIF: %v", err)
}
msglen := len(encKey)
step := privateKey.PublicKey.Size()
var plainText bytes.Buffer
for start := 0; start < msglen; start = start + step {
finish := start + step
if finish > msglen {
finish = msglen
}
plaintext, err := rsa.DecryptOAEP(sha256.New(), rand.Reader, privateKey, encKey[start:finish], nil)
if err != nil {
return nil, fmt.Errorf("could not decrypt LUKS key: %v", err)
}
_, err = plainText.Write(plaintext)
if err != nil {
return nil, fmt.Errorf("could not write decrypt LUKS key to buffer: %v", err)
}
}
return plainText.Bytes(), nil
case Passphrase:
return []byte(k.Material), nil
default:
return nil, ErrUnsupportedKeyURI
}
}
func LoadPEMPrivateKey(k KeyInfo) (*rsa.PrivateKey, error) {
switch k.Format {
case PEM:
priKey, err := LoadPEMPrivateKeyFile(k.Path)
if err != nil {
return nil, fmt.Errorf("loading public key for key encryption: %v", err)
}
return priKey, err
case ENV:
priKey, err := LoadPEMPrivateKeyEnvVar(k.Material)
if err != nil {
return nil, fmt.Errorf("loading public key for key encryption: %v", err)
}
return priKey, err
default:
return nil, ErrUnsupportedKeyURI
}
}
func LoadPEMPrivateKeyFile(fn string) (*rsa.PrivateKey, error) {
b, err := os.ReadFile(fn)
if err != nil {
return nil, err
}
block, _ := pem.Decode(b)
if block == nil {
return nil, fmt.Errorf("could not read %s: %v", fn, ErrNoPEMData)
}
if strings.Contains(block.Headers["Proc-Type"], "ENCRYPTED") {
return nil, fmt.Errorf("passphrase protected pem files not supported")
}
return x509.ParsePKCS1PrivateKey(block.Bytes)
}
func LoadPEMPrivateKeyEnvVar(en string) (*rsa.PrivateKey, error) {
b := []byte(en)
if len(b) == 0 {
return nil, fmt.Errorf("data in private PEM env var is invalid")
}
block, _ := pem.Decode(b)
if block == nil {
return nil, fmt.Errorf("could not read %s: %v", en, ErrNoPEMData)
}
if strings.Contains(block.Headers["Proc-Type"], "ENCRYPTED") {
return nil, fmt.Errorf("passphrase protected pem files not supported")
}
return x509.ParsePKCS1PrivateKey(block.Bytes)
}
func LoadPEMPublicKey(k KeyInfo) (*rsa.PublicKey, error) {
switch k.Format {
case PEM:
pubKey, err := LoadPEMPublicKeyFile(k.Path)
if err != nil {
return nil, fmt.Errorf("loading public key for key encryption: %v", err)
}
return pubKey, err
case ENV:
pubKey, err := LoadPEMPublicKeyEnvVar(k.Material)
if err != nil {
return nil, fmt.Errorf("loading public key for key encryption: %v", err)
}
return pubKey, err
default:
return nil, ErrUnsupportedKeyURI
}
}
func LoadPEMPublicKeyFile(fn string) (*rsa.PublicKey, error) {
b, err := os.ReadFile(fn)
if err != nil {
return nil, err
}
block, _ := pem.Decode(b)
if block == nil {
return nil, fmt.Errorf("could not read %s: %v", fn, ErrNoPEMData)
}
return x509.ParsePKCS1PublicKey(block.Bytes)
}
func LoadPEMPublicKeyEnvVar(en string) (*rsa.PublicKey, error) {
b := []byte(en)
if len(b) == 0 {
return nil, fmt.Errorf("data in public PEM env var is invalid")
}
block, _ := pem.Decode(b)
if block == nil {
return nil, fmt.Errorf("could not read %s: %v", en, ErrNoPEMData)
}
return x509.ParsePKCS1PublicKey(block.Bytes)
}
func loadPEMMessage(r io.Reader) ([]byte, error) {
b, err := io.ReadAll(r)
if err != nil {
return nil, err
}
block, _ := pem.Decode(b)
if block == nil {
return nil, fmt.Errorf("could not load decode PEM key %s: %v", r, ErrNoPEMData)
}
var buf []byte
if _, err := asn1.Unmarshal(block.Bytes, &buf); err != nil {
return nil, fmt.Errorf("could not unmarshal key asn1 data: %v", err)
}
return buf, nil
}
func savePEMMessage(w io.Writer, msg []byte) error {
asn1Bytes, err := asn1.Marshal(msg)
if err != nil {
return err
}
b := &pem.Block{
Type: "MESSAGE",
Bytes: asn1Bytes,
}
return pem.Encode(w, b)
}
func getEncryptionKeyFromImage(fn string) ([]byte, error) {
img, err := sif.LoadContainerFromPath(fn, sif.OptLoadWithFlag(os.O_RDONLY))
if err != nil {
return nil, fmt.Errorf("could not load container: %w", err)
}
defer img.UnloadContainer()
primDescr, err := img.GetDescriptor(sif.WithPartitionType(sif.PartPrimSys))
if err != nil {
return nil, fmt.Errorf("could not retrieve primary system partition from '%s': %w", fn, err)
}
descr, err := img.GetDescriptors(
sif.WithLinkedID(primDescr.ID()),
sif.WithDataType(sif.DataCryptoMessage),
)
if err != nil {
return nil, fmt.Errorf("could not retrieve linked descriptors for primary system partition from %s: %w", fn, err)
}
for _, d := range descr {
format, message, err := d.CryptoMessageMetadata()
if err != nil {
return nil, fmt.Errorf("could not get crypto message metadata: %w", err)
}
// currently only support one type of message
if format != sif.FormatPEM || message != sif.MessageRSAOAEP {
continue
}
// TODO(ian): For now, assume the first linked message is what we
// are looking for. We should consider what we want to do in the
// case of multiple linked messages
key, err := d.GetData()
if err != nil {
return nil, fmt.Errorf("could not retrieve LUKS key data from %s: %w", fn, err)
}
return key, nil
}
return nil, fmt.Errorf("could not read LUKS key from %s: %v", fn, ErrEncryptedKeyNotFound)
}
|