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 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
|
package crypto
import (
"errors"
"fmt"
"io"
"time"
"github.com/ProtonMail/go-crypto/openpgp/packet"
openpgp "github.com/ProtonMail/go-crypto/openpgp/v2"
"github.com/ProtonMail/gopenpgp/v3/constants"
"github.com/ProtonMail/gopenpgp/v3/internal"
)
// pgpSplitWriter type implements the PGPSplitWriter
// interface.
type pgpSplitWriter struct {
keyPackets Writer
ciphertext Writer
detachedSignature Writer
}
// pgpSplitWriter implements the PGPSplitWriter interface
func (mw *pgpSplitWriter) Keys() Writer {
return mw.keyPackets
}
func (mw *pgpSplitWriter) Write(b []byte) (int, error) {
return mw.ciphertext.Write(b)
}
func (mw *pgpSplitWriter) Signature() Writer {
return mw.detachedSignature
}
// NewPGPSplitWriter creates a type that implements the PGPSplitWriter interface
// for encrypting a plaintext where the output PGP packets should be written to the different streams provided.
// Key packets are written to keyPackets whereas the encrypted data packets are written to encPackets.
// The encrypted detached signature data is written to encSigPacket.
func NewPGPSplitWriter(keyPackets Writer, encPackets Writer, encSigPacket Writer) PGPSplitWriter {
return &pgpSplitWriter{
keyPackets: keyPackets,
ciphertext: encPackets,
detachedSignature: encSigPacket,
}
}
// NewPGPSplitWriterKeyAndData creates a type that implements the PGPSplitWriter interface
// for encrypting a plaintext where the output PGP packets should be written to the different streams provided.
// Key packets are written to keyPackets whereas the encrypted data packets are written to encPackets.
func NewPGPSplitWriterKeyAndData(keyPackets Writer, encPackets Writer) PGPSplitWriter {
return NewPGPSplitWriter(keyPackets, encPackets, nil)
}
// NewPGPSplitWriterDetachedSignature creates a type that implements the PGPSplitWriter interface
// for encrypting a plaintext where the output PGP messages should be written to the different streams provided.
// The encrypted data message is written to encMessage whereas the encrypted detached signature is written to
// encSigMessage.
func NewPGPSplitWriterDetachedSignature(encMessage Writer, encSigMessage Writer) PGPSplitWriter {
return NewPGPSplitWriter(nil, encMessage, encSigMessage)
}
// NewPGPSplitWriterFromWriter creates a type that implements the PGPSplitWriter interface
// for encrypting a plaintext where the output PGP messages to the provided Writer.
func NewPGPSplitWriterFromWriter(writer Writer) PGPSplitWriter {
return NewPGPSplitWriter(writer, writer, nil)
}
type signAndEncryptWriteCloser struct {
signWriter WriteCloser
encryptWriter WriteCloser
}
func (w *signAndEncryptWriteCloser) Write(b []byte) (int, error) {
return w.signWriter.Write(b)
}
func (w *signAndEncryptWriteCloser) Close() error {
if err := w.signWriter.Close(); err != nil {
return err
}
return w.encryptWriter.Close()
}
func (eh *encryptionHandle) prepareEncryptAndSign(
plainMessageMetadata *LiteralMetadata,
) (hints *openpgp.FileHints, config *packet.Config, signEntities []*openpgp.Entity, err error) {
hints = &openpgp.FileHints{
FileName: plainMessageMetadata.Filename(),
IsUTF8: eh.IsUTF8,
ModTime: time.Unix(plainMessageMetadata.Time(), 0),
}
config = eh.profile.EncryptionConfig()
config.Time = eh.clock
compressionConfig := eh.selectCompression()
config.DefaultCompressionAlgo = compressionConfig.DefaultCompressionAlgo
config.CompressionConfig = compressionConfig.CompressionConfig
if eh.SigningContext != nil {
config.SignatureNotations = append(config.SignatureNotations, eh.SigningContext.getNotation())
}
if eh.SignKeyRing != nil && len(eh.SignKeyRing.entities) > 0 {
signEntities, err = eh.SignKeyRing.signingEntities()
if err != nil {
return
}
}
return
}
func (eh *encryptionHandle) encryptStream(
keyPacketWriter Writer,
dataPacketWriter Writer,
plainMessageMetadata *LiteralMetadata,
) (plainMessageWriter WriteCloser, err error) {
var sessionKeyBytes []byte
var additionalPasswords [][]byte
if eh.SessionKey != nil {
sessionKeyBytes = eh.SessionKey.Key
}
if eh.Password != nil {
additionalPasswords = [][]byte{eh.Password}
}
hints, config, signers, err := eh.prepareEncryptAndSign(plainMessageMetadata)
if err != nil {
return nil, err
}
var encryptionTimeOverride *time.Time
if eh.encryptionTimeOverride != nil {
encryptionTime := eh.encryptionTimeOverride()
encryptionTimeOverride = &encryptionTime
}
plainMessageWriter, err = openpgp.EncryptWithParams(
dataPacketWriter,
eh.Recipients.getEntities(),
eh.HiddenRecipients.getEntities(),
&openpgp.EncryptParams{
KeyWriter: keyPacketWriter,
Signers: signers,
Hints: hints,
SessionKey: sessionKeyBytes,
Passwords: additionalPasswords,
Config: config,
TextSig: eh.IsUTF8,
OutsideSig: eh.ExternalSignature,
EncryptionTime: encryptionTimeOverride,
},
)
if err != nil {
return nil, fmt.Errorf("gopenpgp: error in encrypting asymmetrically: %w", err)
}
return plainMessageWriter, nil
}
func (eh *encryptionHandle) encryptStreamWithPassword(
keyPacketWriter Writer,
dataPacketWriter Writer,
plainMessageMetadata *LiteralMetadata,
) (plainMessageWriter io.WriteCloser, err error) {
var sessionKeyBytes []byte
if eh.SessionKey != nil {
sessionKeyBytes = eh.SessionKey.Key
}
hints, config, signers, err := eh.prepareEncryptAndSign(plainMessageMetadata)
if err != nil {
return
}
plainMessageWriter, err = openpgp.SymmetricallyEncryptWithParams(
eh.Password,
dataPacketWriter,
&openpgp.EncryptParams{
KeyWriter: keyPacketWriter,
Signers: signers,
Hints: hints,
SessionKey: sessionKeyBytes,
Config: config,
TextSig: eh.IsUTF8,
OutsideSig: eh.ExternalSignature,
},
)
if err != nil {
return nil, fmt.Errorf("gopenpgp: error in encrypting asymmetrically: %w", err)
}
return plainMessageWriter, nil
}
func (eh *encryptionHandle) encryptStreamWithSessionKey(
dataPacketWriter Writer,
plainMessageMetadata *LiteralMetadata,
) (plainMessageWriter WriteCloser, err error) {
encryptWriter, signWriter, err := eh.encryptStreamWithSessionKeyHelper(
plainMessageMetadata,
dataPacketWriter,
)
if err != nil {
return nil, err
}
if signWriter != nil {
plainMessageWriter = &signAndEncryptWriteCloser{signWriter, encryptWriter}
} else {
plainMessageWriter = encryptWriter
}
return plainMessageWriter, err
}
func (eh *encryptionHandle) encryptStreamWithSessionKeyHelper(
plainMessageMetadata *LiteralMetadata,
dataPacketWriter io.Writer,
) (encryptWriter, signWriter io.WriteCloser, err error) {
hints, config, signers, err := eh.prepareEncryptAndSign(plainMessageMetadata)
if err != nil {
return nil, nil, err
}
if eh.SessionKey.hasAlgorithm() {
config.DefaultCipher, err = eh.SessionKey.GetCipherFunc()
if err != nil {
return nil, nil, fmt.Errorf("gopenpgp: unable to encrypt with session key: %w", err)
}
}
encryptWriter, err = packet.SerializeSymmetricallyEncrypted(
dataPacketWriter,
config.Cipher(),
eh.SessionKey.v6,
packet.CipherSuite{Cipher: config.Cipher(), Mode: config.AEAD().Mode()},
eh.SessionKey.Key,
config,
)
if err != nil {
return nil, nil, fmt.Errorf("gopenpgp: unable to encrypt: %w", err)
}
if signers != nil {
// SignWithParams handles compression.
signWriter, err = openpgp.SignWithParams(encryptWriter, signers, &openpgp.SignParams{
Hints: hints,
TextSig: eh.IsUTF8,
OutsideSig: eh.ExternalSignature,
Config: config,
})
if err != nil {
return nil, nil, fmt.Errorf("gopenpgp: unable to sign: %w", err)
}
} else {
// We need to handle compression outside of go-crypto.
if algo := config.Compression(); algo != packet.CompressionNone {
encryptWriter, err = packet.SerializeCompressed(encryptWriter, algo, config.CompressionConfig)
if err != nil {
return nil, nil, fmt.Errorf("gopenpgp: error in compression: %w", err)
}
}
encryptWriter, err = packet.SerializeLiteral(
encryptWriter,
!plainMessageMetadata.IsUtf8(),
plainMessageMetadata.Filename(),
uint32(plainMessageMetadata.Time()),
)
if err != nil {
return nil, nil, fmt.Errorf("gopenpgp: unable to serialize: %w", err)
}
}
return encryptWriter, signWriter, nil
}
type encryptSignDetachedWriter struct {
ptToCiphertextWriter WriteCloser
sigToCiphertextWriter WriteCloser
ptToEncSigWriter WriteCloser
ptWriter Writer
}
func (w *encryptSignDetachedWriter) Write(b []byte) (int, error) {
return w.ptWriter.Write(b)
}
func (w *encryptSignDetachedWriter) Close() error {
if err := w.ptToCiphertextWriter.Close(); err != nil {
return err
}
if err := w.ptToEncSigWriter.Close(); err != nil {
return err
}
return w.sigToCiphertextWriter.Close()
}
// encryptSignDetachedStreamWithSessionKey wraps writers to encrypt a message
// with a session key and produces a detached signature for the plaintext.
func (eh *encryptionHandle) encryptSignDetachedStreamWithSessionKey(
plainMessageMetadata *LiteralMetadata,
encryptedSignatureWriter io.Writer,
encryptedDataWriter io.Writer,
encryptSignature bool,
) (io.WriteCloser, error) {
signKeyRing := eh.SignKeyRing
eh.SignKeyRing = nil
defer func() {
eh.SignKeyRing = signKeyRing
}()
// Create a writer to encrypt the message.
ptToCiphertextWriter, err := eh.encryptStreamWithSessionKey(encryptedDataWriter, plainMessageMetadata)
if err != nil {
return nil, err
}
var sigToCiphertextWriter io.WriteCloser
if encryptSignature {
// Create a writer to encrypt the signature.
sigToCiphertextWriter, err = eh.encryptStreamWithSessionKey(encryptedSignatureWriter, nil)
if err != nil {
return nil, err
}
} else {
// The signature is not encrypted
sigToCiphertextWriter = internal.NewNoOpWriteCloser(encryptedSignatureWriter)
}
// Create a writer to sign the message.
ptToEncSigWriter, err := signMessageDetachedWriter(
signKeyRing,
sigToCiphertextWriter,
eh.IsUTF8,
eh.SigningContext,
eh.clock,
eh.profile.EncryptionConfig(),
)
if err != nil {
return nil, err
}
// Return a wrapped plaintext writer that writes encrypted data and the encrypted signature.
return &encryptSignDetachedWriter{
ptToCiphertextWriter: ptToCiphertextWriter,
sigToCiphertextWriter: sigToCiphertextWriter,
ptToEncSigWriter: ptToEncSigWriter,
ptWriter: io.MultiWriter(ptToCiphertextWriter, ptToEncSigWriter),
}, nil
}
func (eh *encryptionHandle) encryptSignDetachedStreamToRecipients(
plainMessageMetadata *LiteralMetadata,
encryptedSignatureWriter io.Writer,
encryptedDataWriter io.Writer,
keyPacketWriter io.Writer,
encryptSignature bool,
) (plaintextWriter io.WriteCloser, err error) {
configInput := eh.profile.EncryptionConfig()
configInput.Time = NewConstantClock(eh.clock().Unix())
// Generate a session key for encryption.
if eh.SessionKey == nil {
eh.SessionKey, err = eh.GenerateSessionKey()
if err != nil {
return nil, err
}
defer func() {
eh.SessionKey.Clear()
eh.SessionKey = nil
}()
}
if keyPacketWriter == nil {
// If no separate keyPacketWriter is given, write the key packets
// as prefix to the encrypted data and encrypted signature.
keyPacketWriter = io.MultiWriter(encryptedDataWriter, encryptedSignatureWriter)
}
encryptionTimeOverride := configInput.Now()
if eh.encryptionTimeOverride != nil {
encryptionTimeOverride = eh.encryptionTimeOverride()
}
if eh.Recipients != nil || eh.HiddenRecipients != nil {
// Encrypt the session key to the different recipients.
if err = encryptSessionKeyToWriter(
eh.Recipients,
eh.HiddenRecipients,
eh.SessionKey,
keyPacketWriter,
encryptionTimeOverride,
configInput,
); err != nil {
return nil, err
}
}
if eh.Password != nil {
// If not recipients present use the provided password
if err = encryptSessionKeyWithPasswordToWriter(
eh.Password,
eh.SessionKey,
keyPacketWriter,
configInput,
); err != nil {
return nil, err
}
}
if eh.Password == nil && eh.Recipients == nil && eh.HiddenRecipients == nil {
return nil, errors.New("openpgp: no key material to encrypt")
}
// Use the session key to encrypt message + signature of the message.
plaintextWriter, err = eh.encryptSignDetachedStreamWithSessionKey(
plainMessageMetadata,
encryptedSignatureWriter,
encryptedDataWriter,
encryptSignature,
)
if err != nil {
return nil, err
}
return plaintextWriter, err
}
func (eh *encryptionHandle) selectCompression() (config *packet.Config) {
config = &packet.Config{}
switch eh.Compression {
case constants.DefaultCompression:
config = eh.profile.CompressionConfig()
case constants.ZIPCompression:
config.DefaultCompressionAlgo = packet.CompressionZIP
config.CompressionConfig = &packet.CompressionConfig{
Level: 6,
}
case constants.ZLIBCompression:
config.DefaultCompressionAlgo = packet.CompressionZLIB
config.CompressionConfig = &packet.CompressionConfig{
Level: 6,
}
}
return config
}
|