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 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
|
// Copyright (C) 2018 ProtonTech AG
package packet
import (
"bytes"
"crypto/rand"
"encoding/hex"
"io"
mathrand "math/rand"
"testing"
"github.com/ProtonMail/go-crypto/openpgp/errors"
)
// Note: This implementation does not produce packets with chunk sizes over
// 1<<27, but can parse packets with chunk size octets up to 56 and decrypt
// them within limits of the running system. See RFC4880bis, sec 5.16.
var maxChunkSizeExp = 62
const maxPlaintextLength = 1 << 18
func TestAeadRFCParse(t *testing.T) {
for _, sample := range samplesAeadEncryptedDataPacket {
key, _ := hex.DecodeString(sample.cek)
packetBytes, _ := hex.DecodeString(sample.full)
packetReader := bytes.NewBuffer(packetBytes)
packet := new(AEADEncrypted)
ptype, _, contentsReader, err := readHeader(packetReader)
if ptype != packetTypeAEADEncrypted || err != nil {
t.Error("Error reading packet header")
}
if err = packet.parse(contentsReader); err != nil {
t.Error(err)
}
// decrypted plaintext can be read from 'rc'
rc, err := packet.decrypt(key)
if err != nil {
t.Error(err)
}
got, err := readDecryptedStream(rc)
if err != nil {
t.Error(err)
}
want, _ := hex.DecodeString(sample.plaintext)
if !bytes.Equal(got, want) {
t.Errorf("Error opening:\ngot\n%s\nwant\n%s", got, want)
}
}
}
// Test if it is possible to stream an empty plaintext correctly. For
// compatibility with OpenPGPjs, if the stream has no contents, it has two
// authentication tags: One for the empty chunk, and the final auth. tag. This
// test also checks if it cannot decrypt a corrupt stream of empty plaintext.
func TestAeadEmptyStream(t *testing.T) {
key := randomKey(16)
config := randomConfig()
raw, _, err := randomStream(key, 0, config)
if err != nil {
t.Error(err)
}
// Packet is ready.
corruptBytes := make([]byte, len(raw.Bytes()))
copy(corruptBytes, raw.Bytes())
for bytes.Equal(corruptBytes, raw.Bytes()) {
corruptBytes[mathrand.Intn(len(corruptBytes)-5)+5] = byte(mathrand.Intn(256))
}
corrupt := bytes.NewBuffer(corruptBytes)
// Decrypt correct stream
packet := new(AEADEncrypted)
ptype, _, contentsReader, err := readHeader(raw)
if ptype != packetTypeAEADEncrypted || err != nil {
t.Error("Error reading packet header")
}
if err = packet.parse(contentsReader); err != nil {
t.Error(err)
}
// decrypted plaintext can be read from 'rc'
rc, err := packet.decrypt(key)
if err != nil {
t.Error(err)
}
_, err = readDecryptedStream(rc)
if err != nil {
t.Error(err)
}
// Decrypt corrupt stream
packet = new(AEADEncrypted)
ptype, _, contentsReader, err = readHeader(corrupt)
if ptype != packetTypeAEADEncrypted || err != nil {
t.Error("Error reading packet header")
}
if err = packet.parse(contentsReader); err != nil {
t.Error(err)
}
// decrypted plaintext can be read from 'rc'
rc, err = packet.decrypt(key)
if err != nil {
t.Error(err)
}
_, err = readDecryptedStream(rc)
if err == nil {
t.Errorf("No error raised when reading corrupt stream with empty plaintext")
}
}
// Tests if encrypt/decrypt functions are callable and correct with a nil config
func TestAeadNilConfigStream(t *testing.T) {
// Sample key
key := randomKey(16)
randomLength := mathrand.Intn(maxPlaintextLength) + 1
raw, plain, err := randomStream(key, randomLength, nil)
if err != nil {
t.Error(err)
}
// Packet is ready in 'raw'
packet := new(AEADEncrypted)
ptype, _, contentsReader, err := readHeader(raw)
if ptype != packetTypeAEADEncrypted || err != nil {
t.Error("Error reading packet header")
}
if err = packet.parse(contentsReader); err != nil {
t.Error(err)
}
// decrypted plaintext can be read from 'rc'
rc, err := packet.decrypt(key)
if err != nil {
t.Error(err)
}
got, err := readDecryptedStream(rc)
if err != nil {
t.Error(err)
}
want := plain
if !bytes.Equal(got, want) {
t.Errorf("Error encrypting/decrypting random stream with nil config")
}
}
// Encrypts and decrypts a random stream, checking correctness and integrity
func TestAeadStreamRandomizeSlow(t *testing.T) {
key := randomKey(16)
config := randomConfig()
randomLength := mathrand.Intn(maxPlaintextLength) + 1
raw, plain, err := randomStream(key, randomLength, config)
if err != nil {
t.Error(err)
}
// Packet is ready in 'raw'
packet := new(AEADEncrypted)
ptype, _, contentsReader, err := readHeader(raw)
if ptype != packetTypeAEADEncrypted || err != nil {
t.Error("Error reading packet header")
}
if err = packet.parse(contentsReader); err != nil {
t.Error(err)
}
// decrypted plaintext can be read from 'rc'
rc, err := packet.decrypt(key)
if err != nil {
t.Error(err)
}
got, err := readDecryptedStream(rc)
if err != nil {
t.Error(err)
}
// Close MUST be called - it checks if the final chunk was witnessed
if err = rc.Close(); err != nil {
t.Error(err)
}
want := plain
if !bytes.Equal(got, want) {
t.Errorf("Error encrypting/decrypting random stream")
}
}
// Encrypts a random stream, corrupt some bytes, and check if it fails
func TestAeadCorruptStreamRandomizeSlow(t *testing.T) {
key := randomKey(16)
config := randomConfig()
randomLength := mathrand.Intn(maxPlaintextLength) + 1
raw, plain, err := randomStream(key, randomLength, config)
if err != nil {
t.Error(err)
}
// Corrupt some bytes of the stream
for j := 0; j < 10; j++ {
index := mathrand.Intn(len(raw.Bytes()))
if index < 8 || len(plain) == 0 {
// avoid corrupting header or nonce, that's useless
continue
}
raw.Bytes()[index] = 255 - raw.Bytes()[index]
}
packet := new(AEADEncrypted)
ptype, _, contentsReader, err := readHeader(raw)
if ptype != packetTypeAEADEncrypted || err != nil {
t.Error("Error reading packet header")
}
if err = packet.parse(contentsReader); err != nil {
// Header was corrupted
t.Error(err)
return
}
rc, err := packet.decrypt(key)
if err != nil {
t.Error(err)
}
got, err := readDecryptedStream(rc)
if err == nil || err == io.EOF {
t.Errorf("No error raised when decrypting corrupt stream")
}
if bytes.Equal(got, plain) {
t.Errorf("Error: Successfully decrypted corrupt stream")
}
}
// Encrypts a random stream, truncate the end, and check if it fails
func TestAeadTruncatedStreamRandomizeSlow(t *testing.T) {
key := randomKey(16)
config := randomConfig()
randomLength := mathrand.Intn(maxPlaintextLength)
if randomLength < 16 {
return
}
raw, plain, err := randomStream(key, randomLength, config)
if err != nil {
t.Error(err)
}
// Truncate the packet by some bytes
var truncatedRaw []byte
cut := 0
for cut == 0 {
cut = mathrand.Intn(randomLength / 2)
}
truncatedRaw = raw.Bytes()[:len(raw.Bytes())-cut]
truncated := bytes.NewBuffer(truncatedRaw)
packet := new(AEADEncrypted)
ptype, _, truncatedContentsReader, err := readHeader(truncated)
if ptype != packetTypeAEADEncrypted || err != nil {
t.Error("Error reading packet header")
}
if err = packet.parse(truncatedContentsReader); err != nil {
t.Error(err)
}
rc, err := packet.decrypt(key)
if err != nil {
return
}
got, err := readDecryptedStream(rc)
if err == nil || err == io.EOF {
t.Errorf("No truncate error raised when decrypting truncated stream")
}
if bytes.Equal(got, plain) {
t.Errorf("Error: Successfully decrypted truncated stream")
}
}
// Encrypts a random stream, truncate the end, and check if it fails
func TestAeadUnclosedStreamRandomizeSlow(t *testing.T) {
key := randomKey(16)
config := randomConfig()
ptLen := mathrand.Intn(maxPlaintextLength)
// Sample random plaintext of given length
plain := make([]byte, ptLen)
_, err := rand.Read(plain)
if err != nil {
t.Error(err)
}
// 'writeCloser' encrypts and writes the plaintext bytes.
rawCipher := bytes.NewBuffer(nil)
writeCloser, err := SerializeAEADEncrypted(rawCipher, key, config)
if err != nil {
t.Error(err)
}
// Write the partial lengths packet into 'raw'
if _, err = writeCloser.Write(plain); err != nil {
t.Error(err)
}
// Don't call Close
packet := new(AEADEncrypted)
_, _, contentsReader, err := readHeader(rawCipher)
if err != nil {
return
}
if err = packet.parse(contentsReader); err != nil {
return
}
rc, err := packet.decrypt(key)
if err != nil {
return
}
got, err := readDecryptedStream(rc)
if err == nil || err == io.EOF {
t.Errorf("No error raised when decrypting unclosed stream")
}
if bytes.Equal(got, plain) {
t.Errorf("Error: Successfully decrypted unclosed stream")
}
}
// ----------------------------------- //
// ------- UTILS --------- //
// ----------------------------------- //
func randomKey(length int) []byte {
key := make([]byte, length)
_, err := rand.Read(key)
if err != nil {
panic("can't read from rand")
}
return key
}
func randomConfig() *Config {
var aeadCompatibleCiphers = []CipherFunction{
CipherAES128,
CipherAES192,
CipherAES256,
}
var modes = []AEADMode{
AEADModeEAX,
AEADModeOCB,
}
// Random chunk size
chunkSizeExp := 6 + mathrand.Intn(maxChunkSizeExp-5)
chunkSize := uint64(1 << uint(chunkSizeExp))
// Random cipher and mode
ciph := aeadCompatibleCiphers[mathrand.Intn(len(aeadCompatibleCiphers))]
aeadConf := AEADConfig{
ChunkSize: uint64(chunkSize),
DefaultMode: modes[mathrand.Intn(len(modes))],
}
config := &Config{
AEADConfig: &aeadConf,
DefaultCipher: ciph,
}
return config
}
// Samples a random plaintext and gives the raw AEADEncrypted packet contents.
// Returns said contents, the plaintext, and an error.
func randomStream(key []byte, ptLen int, config *Config) (*bytes.Buffer, []byte, error) {
// Sample random plaintext of given length
plaintext := make([]byte, ptLen)
_, err := rand.Read(plaintext)
if err != nil {
return nil, nil, err
}
// 'writeCloser' encrypts and writes the plaintext bytes.
rawCipher := bytes.NewBuffer(nil)
writeCloser, err := SerializeAEADEncrypted(rawCipher, key, config)
if err != nil {
return nil, nil, err
}
// Write the partial lengths packet into 'raw'
_, err = writeCloser.Write(plaintext)
if err != nil {
return nil, nil, err
}
// Close MUST be called - it appends the final auth. tag
if err = writeCloser.Close(); err != nil {
return nil, nil, err
}
// Packet is ready.
return rawCipher, plaintext, nil
}
func readDecryptedStream(rc io.ReadCloser) (got []byte, err error) {
for {
// Read a random number of bytes, until the end of the packet.
decrypted := make([]byte, mathrand.Intn(200))
n, err := rc.Read(decrypted)
decrypted = decrypted[:n]
got = append(got, decrypted...)
if err != nil {
if err == io.EOF {
// Finished reading
break
} else {
// Something happened
return nil, err
}
}
}
err = rc.Close()
return got, err
}
// SerializeAEADEncrypted initializes the aeadCrypter and returns a writer.
// This writer encrypts and writes bytes (see aeadEncrypter.Write()).
// This funcion is moved to the test suite to prevent it from creating this deprecated package
func SerializeAEADEncrypted(w io.Writer, key []byte, config *Config) (io.WriteCloser, error) {
writeCloser := noOpCloser{w}
writer, err := serializeStreamHeader(writeCloser, packetTypeAEADEncrypted)
if err != nil {
return nil, err
}
// Data for en/decryption: tag, version, cipher, aead mode, chunk size
aeadConf := config.AEAD()
prefix := []byte{
0xD4,
aeadEncryptedVersion,
byte(config.Cipher()),
byte(aeadConf.Mode()),
aeadConf.ChunkSizeByte(),
}
n, err := writer.Write(prefix[1:])
if err != nil || n < 4 {
return nil, errors.AEADError("could not write AEAD headers")
}
// Sample nonce
nonceLen := aeadConf.Mode().IvLength()
nonce := make([]byte, nonceLen)
_, err = rand.Read(nonce)
if err != nil {
panic("Could not sample random nonce")
}
_, err = writer.Write(nonce)
if err != nil {
return nil, err
}
blockCipher := CipherFunction(config.Cipher()).new(key)
alg := aeadConf.Mode().new(blockCipher)
chunkSize := decodeAEADChunkSize(aeadConf.ChunkSizeByte())
tagLen := alg.Overhead()
chunkBytes := make([]byte, chunkSize+tagLen)
return &aeadEncrypter{
aeadCrypter: aeadCrypter{
aead: alg,
chunkSize: chunkSize,
associatedData: prefix,
chunkIndex: make([]byte, 8),
nonce: nonce,
packetTag: packetTypeAEADEncrypted,
},
writer: writer,
chunkBytes: chunkBytes,
}, nil
}
|