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
|
package crypto
import (
"errors"
"io"
"github.com/ProtonMail/go-crypto/openpgp/armor"
openpgp "github.com/ProtonMail/go-crypto/openpgp/v2"
"github.com/ProtonMail/gopenpgp/v3/constants"
"github.com/ProtonMail/gopenpgp/v3/internal"
)
// encryptionHandle collects the configuration parameters for encrypting a message.
// Use a encryptionHandleBuilder to create a handle.
type encryptionHandle struct {
// Recipients contains the public keys to which
// the message should be encrypted to.
// Triggers hybrid encryption with public keys of the recipients and hidden recipients.
// The recipients are included in the intended recipient fingerprint list
// of the signature, if a signature is present.
// If nil, set another field for the type of encryption: HiddenRecipients, SessionKey, or Password
Recipients *KeyRing
// HiddenRecipients contains the public keys to which
// the message should be encrypted to.
// Triggers hybrid encryption with public keys of the recipients and hidden recipients.
// The hidden recipients are NOT included in the intended recipient fingerprint list
// of the signature, if a signature is present.
// If nil, set another field for the type of encryption: Recipients, SessionKey, or Password
HiddenRecipients *KeyRing
// SessionKey defines the session key the message should be encrypted with.
// Triggers session key encryption with the included session key.
// If nil, set another field for the type of encryption: Recipients, HiddenRecipients, or Password
SessionKey *SessionKey
// Password defines a password the message should be encrypted with.
// Triggers password based encryption with a key derived from the password.
// If nil, set another field for the type of encryption: Recipients, HiddenRecipients, or SessionKey
Password []byte
// SignKeyRing provides an unlocked key ring to include signature in the message.
// If nil, no signature is included.
SignKeyRing *KeyRing
// SigningContext provides a signing context for the signature in the message.
// SignKeyRing has to be set if a SigningContext is provided.
SigningContext *SigningContext
// ArmorHeaders provides armor headers if the message is armored.
// Only considered if Armored is set to true.
ArmorHeaders map[string]string
// Compression indicates if the plaintext should be compressed before encryption.
// constants.NoCompression: none, constants.DefaultCompression: profile default
// constants.ZIPCompression: zip, constants.ZLIBCompression: zlib
Compression int8
// DetachedSignature indicates if a separate encrypted detached signature
// should be created
DetachedSignature bool
// PlainDetachedSignature indicates that the detached signature should not be encrypted.
// Is only considered if DetachedSignature is not set.
PlainDetachedSignature bool
IsUTF8 bool
// ExternalSignature allows to include an external signature into
// the encrypted message.
ExternalSignature []byte
profile EncryptionProfile
encryptionTimeOverride Clock
clock Clock
}
// --- Default decryption handle to build from
func defaultEncryptionHandle(profile EncryptionProfile, clock Clock) *encryptionHandle {
return &encryptionHandle{
profile: profile,
clock: clock,
}
}
// --- Implements PGPEncryption interface
// EncryptingWriter returns a wrapper around underlying output Writer,
// such that any write-operation via the wrapper results in a write to an encrypted pgp message.
// If the output Writer is of type PGPSplitWriter, the output can be split to multiple writers
// for different parts of the message. For example to write key packets and encrypted data packets
// to different writers or to write a detached signature separately.
// The encoding argument defines the output encoding, i.e., Bytes or Armored
// The returned pgp message WriteCloser must be closed after the plaintext has been written.
func (eh *encryptionHandle) EncryptingWriter(outputWriter Writer, encoding int8) (messageWriter WriteCloser, err error) {
pgpSplitWriter := castToPGPSplitWriter(outputWriter)
if pgpSplitWriter != nil {
return eh.encryptingWriters(pgpSplitWriter.Keys(), pgpSplitWriter, pgpSplitWriter.Signature(), nil, armorOutput(encoding))
}
if eh.DetachedSignature {
return nil, errors.New("gopenpgp: no pgp split writer provided for the detached signature")
}
return eh.encryptingWriters(nil, outputWriter, nil, nil, armorOutput(encoding))
}
// Encrypt encrypts a plaintext message.
func (eh *encryptionHandle) Encrypt(message []byte) (*PGPMessage, error) {
pgpMessageBuffer := NewPGPMessageBuffer()
// Enforce that for a PGPMessage struct the output should not be armored.
encryptingWriter, err := eh.EncryptingWriter(pgpMessageBuffer, Bytes)
if err != nil {
return nil, err
}
_, err = encryptingWriter.Write(message)
if err != nil {
return nil, err
}
err = encryptingWriter.Close()
if err != nil {
return nil, err
}
checksum := eh.armorChecksumRequired()
return pgpMessageBuffer.PGPMessageWithOptions(eh.PlainDetachedSignature, !checksum), nil
}
// EncryptSessionKey encrypts a session key with the encryption handle.
// To encrypt a session key, the handle must contain either recipients or a password.
func (eh *encryptionHandle) EncryptSessionKey(sessionKey *SessionKey) ([]byte, error) {
config := eh.profile.EncryptionConfig()
config.Time = NewConstantClock(eh.clock().Unix())
switch {
case eh.Password != nil:
return encryptSessionKeyWithPassword(sessionKey, eh.Password, config)
case eh.Recipients != nil || eh.HiddenRecipients != nil:
encryptionTimeOverride := config.Now()
if eh.encryptionTimeOverride != nil {
encryptionTimeOverride = eh.encryptionTimeOverride()
}
return encryptSessionKey(eh.Recipients, eh.HiddenRecipients, sessionKey, encryptionTimeOverride, config)
}
return nil, errors.New("gopenpgp: no password or recipients in encryption handle")
}
// GenerateSessionKey generates a random session key for the given encryption handle
// considering the algorithm preferences of the recipient keys.
func (eh *encryptionHandle) GenerateSessionKey() (*SessionKey, error) {
config := eh.profile.EncryptionConfig()
config.Time = NewConstantClock(eh.clock().Unix())
return generateSessionKey(config, eh.Recipients, eh.HiddenRecipients)
}
// --- Helper methods on encryption handle
func (eh *encryptionHandle) validate() error {
if eh.Recipients == nil &&
eh.HiddenRecipients == nil &&
eh.Password == nil &&
eh.SessionKey == nil {
return errors.New("gopenpgp: no encryption key material provided")
}
if eh.SignKeyRing == nil && eh.SigningContext != nil {
return errors.New("gopenpgp: no signing key but signing context provided")
}
if eh.SignKeyRing == nil && eh.DetachedSignature {
return errors.New("gopenpgp: no signing key provided for detached signature")
}
return nil
}
// armorChecksumRequired determines if an armor checksum should be appended or not.
// The OpenPGP Crypto-Refresh mandates that no checksum should be appended with the new packets.
func (eh *encryptionHandle) armorChecksumRequired() bool {
if !constants.ArmorChecksumEnabled {
// If the default behavior is no checksum, we can ignore
// the logic for the RFC9580 check.
return false
}
encryptionConfig := eh.profile.EncryptionConfig()
if encryptionConfig.AEADConfig == nil {
return true
}
checkTime := eh.clock()
if eh.Recipients != nil {
for _, recipient := range eh.Recipients.entities {
primarySelfSignature, err := recipient.PrimarySelfSignature(checkTime, encryptionConfig)
if err != nil {
return true
}
if !primarySelfSignature.SEIPDv2 {
return true
}
}
}
if eh.HiddenRecipients != nil {
for _, recipient := range eh.HiddenRecipients.entities {
primarySelfSignature, err := recipient.PrimarySelfSignature(checkTime, encryptionConfig)
if err != nil {
return true
}
if !primarySelfSignature.SEIPDv2 {
return true
}
}
}
return false
}
type armoredWriteCloser struct {
armorWriter WriteCloser
messageWriter WriteCloser
armorSigWriter WriteCloser
}
func (w *armoredWriteCloser) Write(b []byte) (int, error) {
return w.messageWriter.Write(b)
}
func (w *armoredWriteCloser) Close() error {
if err := w.messageWriter.Close(); err != nil {
return err
}
if w.armorSigWriter != nil {
if err := w.armorSigWriter.Close(); err != nil {
return err
}
}
return w.armorWriter.Close()
}
// ClearPrivateParams clears all private key material contained in EncryptionHandle from memory.
func (eh *encryptionHandle) ClearPrivateParams() {
if eh.SignKeyRing != nil {
eh.SignKeyRing.ClearPrivateParams()
}
if eh.SessionKey != nil {
eh.SessionKey.Clear()
}
if eh.Password != nil {
clearMem(eh.Password)
}
}
func (eh *encryptionHandle) handleArmor(keys, data, detachedSignature Writer) (
dataOut Writer,
detachedSignatureOut Writer,
armorWriter WriteCloser,
armorSigWriter WriteCloser,
err error,
) {
writeChecksum := eh.armorChecksumRequired()
detachedSignatureOut = detachedSignature
// Wrap armored writer
if eh.ArmorHeaders == nil {
eh.ArmorHeaders = internal.ArmorHeaders
}
armorWriter, err = armor.EncodeWithChecksumOption(data, constants.PGPMessageHeader, eh.ArmorHeaders, writeChecksum)
dataOut = armorWriter
if err != nil {
return nil, nil, nil, nil, err
}
if eh.DetachedSignature {
armorSigWriter, err = armor.EncodeWithChecksumOption(detachedSignature, constants.PGPMessageHeader, eh.ArmorHeaders, writeChecksum)
detachedSignatureOut = armorSigWriter
if err != nil {
return nil, nil, nil, nil, err
}
} else if eh.PlainDetachedSignature {
armorSigWriter, err = armor.EncodeWithChecksumOption(detachedSignature, constants.PGPSignatureHeader, eh.ArmorHeaders, writeChecksum)
detachedSignatureOut = armorSigWriter
if err != nil {
return nil, nil, nil, nil, err
}
}
if keys != nil {
return nil, nil, nil, nil, errors.New("gopenpgp: armor is not allowed if key packets are written separately")
}
return dataOut, detachedSignatureOut, armorWriter, armorSigWriter, nil
}
func (eh *encryptionHandle) encryptingWriters(keys, data, detachedSignature Writer, meta *LiteralMetadata, armorOutput bool) (messageWriter WriteCloser, err error) {
var armorWriter WriteCloser
var armorSigWriter WriteCloser
if err = eh.validate(); err != nil {
return nil, err
}
doDetachedSignature := eh.DetachedSignature || eh.PlainDetachedSignature
if doDetachedSignature && detachedSignature == nil {
return nil, errors.New("gopenpgp: no output provided for the detached signature")
}
if armorOutput {
data, detachedSignature, armorWriter, armorSigWriter, err = eh.handleArmor(keys, data, detachedSignature)
if err != nil {
return nil, err
}
}
if keys == nil {
// No writer for key packets provided,
// write the key packets at the beginning of each message.
if eh.DetachedSignature {
keys = io.MultiWriter(data, detachedSignature)
} else {
keys = data
}
}
switch {
case eh.Recipients.CountEntities() > 0 || eh.HiddenRecipients.CountEntities() > 0:
// Encrypt towards recipients
if !doDetachedSignature {
// Signature is inside the ciphertext.
messageWriter, err = eh.encryptStream(keys, data, meta)
} else {
// Encrypted detached signature separate from the ciphertext.
messageWriter, err = eh.encryptSignDetachedStreamToRecipients(meta, detachedSignature, data, keys, eh.DetachedSignature)
}
case eh.Password != nil:
// Encrypt with a password
if !doDetachedSignature {
messageWriter, err = eh.encryptStreamWithPassword(keys, data, meta)
} else {
messageWriter, err = eh.encryptSignDetachedStreamToRecipients(meta, detachedSignature, data, keys, eh.DetachedSignature)
}
case eh.SessionKey != nil:
// Encrypt towards session key
if !doDetachedSignature {
messageWriter, err = eh.encryptStreamWithSessionKey(data, meta)
} else {
messageWriter, err = eh.encryptSignDetachedStreamWithSessionKey(meta, detachedSignature, data, eh.DetachedSignature)
}
default:
// No encryption material provided
err = errors.New("gopenpgp: no encryption key ring, session key, or password provided")
}
if err != nil {
return nil, err
}
if armorOutput {
// Wrap armored writer
messageWriter = &armoredWriteCloser{
armorWriter: armorWriter,
messageWriter: messageWriter,
armorSigWriter: armorSigWriter,
}
}
if eh.IsUTF8 {
messageWriter = internal.NewUtf8CheckWriteCloser(
openpgp.NewCanonicalTextWriteCloser(messageWriter),
)
}
return messageWriter, nil
}
func castToPGPSplitWriter(w Writer) PGPSplitWriter {
v, ok := interface{}(w).(PGPSplitWriter)
if ok {
return v
}
v, ok = interface{}(&w).(PGPSplitWriter)
if ok {
return v
}
return nil
}
|