File: sessionkey_test.go

package info (click to toggle)
golang-github-protonmail-gopenpgp-v3 3.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,028 kB
  • sloc: sh: 87; makefile: 2
file content (476 lines) | stat: -rw-r--r-- 15,001 bytes parent folder | download | duplicates (2)
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
467
468
469
470
471
472
473
474
475
476
package crypto

import (
	"bytes"
	"encoding/base64"
	"encoding/hex"
	"os"
	"testing"

	"github.com/ProtonMail/go-crypto/openpgp/packet"
	"github.com/ProtonMail/gopenpgp/v3/constants"
	"github.com/ProtonMail/gopenpgp/v3/profile"
	"github.com/stretchr/testify/assert"
)

var testSessionKey *SessionKey

func init() {
	var err error
	testSessionKey, err = GenerateSessionKeyAlgo("aes256")
	if err != nil {
		panic("Expected no error while generating random session key with aes256, got:" + err.Error())
	}
}

func TestRandomToken(t *testing.T) {
	token40, err := RandomToken(40)
	if err != nil {
		t.Fatal("Expected no error while generating random token, got:", err)
	}
	assert.Len(t, token40, 40)
}

func TestGenerateSessionKey(t *testing.T) {
	assert.Len(t, testSessionKey.Key, 32)
}

func TestAsymmetricKeyPacket(t *testing.T) {
	encHandle, _ := testPGP.Encryption().Recipients(keyRingTestPublic).New()
	keyPacket, err := encHandle.EncryptSessionKey(testSessionKey)
	if err != nil {
		t.Fatal("Expected no error while generating key packet, got:", err)
	}

	// Password defined in keyring_test
	decHandle, _ := testPGP.Decryption().DecryptionKeys(keyRingTestPrivate).New()
	outputSymmetricKey, err := decHandle.DecryptSessionKey(keyPacket)
	if err != nil {
		t.Fatal("Expected no error while decrypting key packet, got:", err)
	}

	assert.Exactly(t, testSessionKey, outputSymmetricKey)
}

func TestMultipleAsymmetricKeyPacket(t *testing.T) {
	encHandle, _ := testPGP.Encryption().Recipients(keyRingTestMultiple).New()
	keyPacket, err := encHandle.EncryptSessionKey(testSessionKey)
	if err != nil {
		t.Fatal("Expected no error while generating key packet, got:", err)
	}

	// Password defined in keyring_test
	decHandle, _ := testPGP.Decryption().DecryptionKeys(keyRingTestPrivate).New()
	outputSymmetricKey, err := decHandle.DecryptSessionKey(keyPacket)
	if err != nil {
		t.Fatal("Expected no error while decrypting key packet, got:", err)
	}

	assert.Exactly(t, testSessionKey, outputSymmetricKey)
}

func TestSymmetricKeyPacket(t *testing.T) {
	password := []byte("I like encryption")

	encHandle, _ := testPGP.Encryption().Password(password).New()
	keyPacket, err := encHandle.EncryptSessionKey(testSessionKey)
	if err != nil {
		t.Fatal("Expected no error while generating key packet, got:", err)
	}

	decHandle, _ := testPGP.Decryption().Password([]byte("Wrong password")).New()
	wrongSymmetricKey, err := decHandle.DecryptSessionKey(keyPacket)
	if err != nil {
		assert.EqualError(t, err, "gopenpgp: unable to decrypt any packet")
	} else {
		assert.NotEqual(t, testSessionKey, wrongSymmetricKey)
	}

	decHandle, _ = testPGP.Decryption().Password(password).New()
	outputSymmetricKey, err := decHandle.DecryptSessionKey(keyPacket)
	if err != nil {
		t.Fatal("Expected no error while decrypting key packet, got:", err)
	}
	assert.Exactly(t, testSessionKey, outputSymmetricKey)
}

func TestSymmetricKeyPacketWrongSize(t *testing.T) {
	r, err := RandomToken(symKeyAlgos[constants.AES256].KeySize())
	if err != nil {
		t.Fatal("Expected no error while generating session key, got:", err)
	}

	sk := &SessionKey{
		Key:  r,
		Algo: constants.AES128,
	}

	password := []byte("I like encryption")

	_, err = encryptSessionKeyWithPassword(sk, password, testPGP.profile.EncryptionConfig())
	if err == nil {
		t.Fatal("Expected error while generating key packet with wrong sized key")
	}
}

func TestDataPacketEncryption(t *testing.T) {
	var message = []byte(
		"The secret code is... 1, 2, 3, 4, 5. I repeat: the secret code is... 1, 2, 3, 4, 5",
	)

	// Encrypt data with session key
	encryptor, _ := testPGP.Encryption().SessionKey(testSessionKey).New()
	pgpMessage, err := encryptor.Encrypt(message)
	if err != nil {
		t.Fatal("Expected no error when encrypting, got:", err)
	}

	assert.Len(t, pgpMessage.Bytes(), 133) // Assert uncompressed encrypted body length

	// Decrypt data with wrong session key
	wrongKey := &SessionKey{
		Key:  []byte("wrong pass"),
		Algo: constants.AES256,
	}
	decryptor, _ := testPGP.Decryption().SessionKey(wrongKey).New()
	_, err = decryptor.Decrypt(pgpMessage.BinaryDataPacket(), Bytes)
	assert.NotNil(t, err)

	// Decrypt data with the good session key
	decryptor, _ = testPGP.Decryption().SessionKey(testSessionKey).New()
	decrypted, err := decryptor.Decrypt(pgpMessage.BinaryDataPacket(), Bytes)
	if err != nil {
		t.Fatal("Expected no error when decrypting, got:", err)
	}
	assert.Exactly(t, message, decrypted.Bytes())

	// Encrypt session key
	assert.Exactly(t, 3, len(keyRingTestMultiple.entities))
	encryptor, _ = testPGP.Encryption().Recipients(keyRingTestMultiple).New()
	keyPackets, err := encryptor.EncryptSessionKey(testSessionKey)
	if err != nil {
		t.Fatal("Unable to encrypt key packet, got:", err)
	}

	// Join key packet and data packet in single message
	pgpMessage.KeyPacket = keyPackets

	// Armor and un-armor message. In alternative it can also be done with NewPgpMessage(splitMessage.GetBinary())
	armored, err := pgpMessage.Armor()
	if err != nil {
		t.Fatal("Unable to armor split message, got:", err)
	}

	pgpMessage, err = NewPGPMessageFromArmored(armored)
	if err != nil {
		t.Fatal("Unable to unarmor pgp message, got:", err)
	}
	ids, ok := pgpMessage.EncryptionKeyIDs()
	assert.True(t, ok)
	assert.Exactly(t, 3, len(ids))

	// Test if final decryption succeeds
	decryptor, _ = testPGP.Decryption().DecryptionKeys(keyRingTestPrivate).New()
	finalMessageResult, err := decryptor.Decrypt(pgpMessage.Bytes(), Bytes)
	if err != nil {
		t.Fatal("Unable to decrypt joined keypacket and datapacket, got:", err)
	}

	assert.Exactly(t, message, finalMessageResult.Bytes())
}

func TestSessionKeyClear(t *testing.T) {
	testSessionKey.Clear()
	assertMemCleared(t, testSessionKey.Key)
}

func TestAEADDataPacketDecryption(t *testing.T) {
	pgpMessageData, err := os.ReadFile("testdata/gpg2.3-aead-pgp-message.pgp")
	if err != nil {
		t.Fatal("Expected no error when reading message data, got:", err)
	}
	pgpMessage := NewPGPMessage(pgpMessageData)

	aeadKey, err := NewKeyFromArmored(readTestFile("gpg2.3-aead-test-key.asc", false))
	if err != nil {
		t.Fatal("Expected no error when unarmoring key, got:", err)
	}

	aeadKeyUnlocked, err := aeadKey.Unlock([]byte("test"))
	if err != nil {
		t.Fatal("Expected no error when unlocking, got:", err)
	}
	kR, err := NewKeyRing(aeadKeyUnlocked)
	if err != nil {
		t.Fatal("Expected no error when creating the keyring, got:", err)
	}
	defer kR.ClearPrivateParams()
	decryptor, _ := testPGP.Decryption().DecryptionKeys(kR).New()
	sessionKey, err := decryptor.DecryptSessionKey(pgpMessage.BinaryKeyPacket())
	if err != nil {
		t.Fatal("Expected no error when decrypting session key, got:", err)
	}

	decryptor, _ = testPGP.Decryption().SessionKey(sessionKey).New()
	decrypted, err := decryptor.Decrypt(pgpMessage.BinaryDataPacket(), Bytes)
	if err != nil {
		t.Fatal("Expected no error when decrypting, got:", err)
	}

	assert.Exactly(t, "hello world\n", string(decrypted.Bytes()))
}

func TestDataPacketEncryptionAndSignature(t *testing.T) {
	var message = []byte(
		"The secret code is... 1, 2, 3, 4, 5. I repeat: the secret code is... 1, 2, 3, 4, 5",
	)

	// Encrypt data with session key
	encryptor, _ := testPGP.Encryption().SessionKey(testSessionKey).SigningKeys(keyRingTestPrivate).New()
	pgpMessage, err := encryptor.Encrypt(message)
	if err != nil {
		t.Fatal("Expected no error when encrypting and signing, got:", err)
	}

	// Decrypt data with wrong session key
	wrongKey := &SessionKey{
		Key:  []byte("wrong pass"),
		Algo: constants.AES256,
	}
	decryptor, _ := testPGP.Decryption().SessionKey(wrongKey).New()
	_, err = decryptor.Decrypt(pgpMessage.BinaryDataPacket(), Bytes)
	assert.NotNil(t, err)

	// Decrypt data with the good session key
	decryptor, _ = testPGP.Decryption().SessionKey(testSessionKey).New()
	decrypted, err := decryptor.Decrypt(pgpMessage.BinaryDataPacket(), Bytes)
	if err != nil {
		t.Fatal("Expected no error when decrypting, got:", err)
	}
	assert.Exactly(t, message, decrypted.Bytes())

	// Decrypt & verify data with the good session key but bad keyring
	ecKeyRing, err := NewKeyRing(keyTestEC)
	if err != nil {
		t.Fatal("Unable to generate EC keyring, got:", err)
	}

	decryptor, _ = testPGP.Decryption().SessionKey(testSessionKey).VerificationKeys(ecKeyRing).New()
	decrypted, err = decryptor.Decrypt(pgpMessage.BinaryDataPacket(), Bytes)
	if err != nil {
		t.Fatal("Wrong error returned for verification failure", err)
	}
	if err = decrypted.SignatureError(); err == nil {
		t.Fatal("No error returned for verification failure", err)
	}

	// Decrypt & verify data with the good session key and keyring
	decryptor, _ = testPGP.Decryption().SessionKey(testSessionKey).VerificationKeys(keyRingTestPublic).New()
	decrypted, err = decryptor.Decrypt(pgpMessage.BinaryDataPacket(), Bytes)
	if err != nil {
		t.Fatal("Expected no error when decrypting & verifying, got:", err)
	}
	if err = decrypted.SignatureError(); err != nil {
		t.Fatal("Expected no error when decrypting & verifying, got:", err)
	}
	assert.Exactly(t, message, decrypted.Bytes())

	// Encrypt session key
	assert.Exactly(t, 3, len(keyRingTestMultiple.entities))
	encryptor, _ = testPGP.Encryption().Recipients(keyRingTestMultiple).New()
	keyPacket, err := encryptor.EncryptSessionKey(testSessionKey)
	if err != nil {
		t.Fatal("Unable to encrypt key packet, got:", err)
	}

	// Join key packet and data packet in single message
	pgpMessage.KeyPacket = keyPacket

	// Armor and un-armor message. In alternative it can also be done with NewPgpMessage(splitMessage.GetBinary())
	armored, err := pgpMessage.Armor()
	if err != nil {
		t.Fatal("Unable to armor split message, got:", err)
	}

	pgpMessage, err = NewPGPMessageFromArmored(armored)
	if err != nil {
		t.Fatal("Unable to unarmor pgp message, got:", err)
	}
	ids, ok := pgpMessage.EncryptionKeyIDs()
	assert.True(t, ok)
	assert.Exactly(t, 3, len(ids))

	// Test if final decryption & verification succeeds
	decryptor, _ = testPGP.Decryption().DecryptionKeys(keyRingTestPrivate).VerificationKeys(keyRingTestPublic).New()
	finalMessage, err := decryptor.Decrypt(pgpMessage.Bytes(), Bytes)
	if err != nil {
		t.Fatal("Unable to decrypt and verify joined keypacket and datapacket, got:", err)
	}
	if err = finalMessage.SignatureError(); err != nil {
		t.Fatal("Unexpected verification error for joined keypacket and datapacket, got:", err)
	}

	assert.Exactly(t, message, finalMessage.Bytes())
}

func TestDataPacketDecryption(t *testing.T) {
	pgpMessage, err := NewPGPMessageFromArmored(readTestFile("message_signed", false))
	if err != nil {
		t.Fatal("Expected no error when unarmoring, got:", err)
	}
	decryptor, _ := testPGP.Decryption().DecryptionKeys(keyRingTestPrivate).New()
	sessionKey, err := decryptor.DecryptSessionKey(pgpMessage.BinaryKeyPacket())
	if err != nil {
		t.Fatal("Expected no error when decrypting session key, got:", err)
	}

	decryptor, _ = testPGP.Decryption().SessionKey(sessionKey).New()
	decrypted, err := decryptor.Decrypt(pgpMessage.BinaryDataPacket(), Bytes)
	if err != nil {
		t.Fatal("Expected no error when decrypting, got:", err)
	}

	assert.Exactly(t, readTestFile("message_plaintext", true), string(decrypted.Bytes()))
}

func TestMDCFailDecryption(t *testing.T) {
	pgpMessage, err := NewPGPMessageFromArmored(readTestFile("message_badmdc", false))
	if err != nil {
		t.Fatal("Expected no error when unarmoring, got:", err)
	}

	sk, _ := hex.DecodeString("F76D3236E4F8A38785C50BDE7167475E95360BCE67A952710F6C16F18BB0655E")

	sessionKey := NewSessionKeyFromToken(sk, "aes256")

	decryptor, _ := testPGP.Decryption().SessionKey(sessionKey).New()
	_, err = decryptor.Decrypt(pgpMessage.BinaryDataPacket(), Bytes)
	assert.NotNil(t, err)
}

func TestAsymmetricKeyPacketDecryptionFailure(t *testing.T) {
	passphrase := []byte("passphrase")
	keyPacket, err := base64.StdEncoding.DecodeString(readTestFile("sessionkey_packet", false))
	if err != nil {
		t.Error("Expected no error while decoding key packet, got:" + err.Error())
	}

	pk, err := NewKeyFromArmored(readTestFile("sessionkey_key", false))
	if err != nil {
		t.Error("Expected no error while unarmoring private key, got:" + err.Error())
	}

	uk, err := pk.Unlock(passphrase)
	if err != nil {
		t.Error("Expected no error while unlocking private key, got:" + err.Error())
	}

	defer uk.ClearPrivateParams()

	ukr, err := NewKeyRing(uk)
	if err != nil {
		t.Error("Expected no error while building private keyring, got:" + err.Error())
	}

	decryptor, _ := testPGP.Decryption().DecryptionKeys(ukr).New()
	_, err = decryptor.DecryptSessionKey(keyPacket)
	assert.Error(t, err, "gopenpgp: unable to decrypt session key")
}

func TestSessionKeyAeadHandling(t *testing.T) {
	pgp := PGPWithProfile(profile.Default())
	profileAead := profile.Default()
	profileAead.AeadEncryption = &packet.AEADConfig{}
	pgpAead := PGPWithProfile(profileAead)

	keyDefault, err := pgp.KeyGeneration().AddUserId("nodeKey", "nodeKey").New().GenerateKey()
	if err != nil {
		t.Fatal(err)
	}

	keyAEAD, err := pgpAead.KeyGeneration().AddUserId("nodeKey", "nodeKey").New().GenerateKey()
	if err != nil {
		t.Fatal(err)
	}

	encHandle, _ := pgpAead.Encryption().Recipient(keyDefault).New()
	encHandleAead, _ := pgpAead.Encryption().Recipient(keyAEAD).New()

	sessionKey, err := encHandle.GenerateSessionKey()
	if err != nil {
		t.Fatal(err)
	}
	sessionKeyAead, err := encHandleAead.GenerateSessionKey()
	if err != nil {
		t.Fatal(err)
	}

	if sessionKey.IsV6() {
		t.Error("Expected session key to be non-v6 compatible")
	}
	if !sessionKeyAead.IsV6() {
		t.Error("Expected session key to be v6 compatible")
	}

	pkeskv3, err := encHandle.EncryptSessionKey(sessionKey)
	if err != nil {
		t.Fatal(err)
	}

	pkeskv6, err := encHandle.EncryptSessionKey(sessionKeyAead)
	if err != nil {
		t.Fatal(err)
	}

	checkPKESK(t, pkeskv3, 3)
	checkPKESK(t, pkeskv6, 6)

	encHandle, _ = pgpAead.Encryption().SessionKey(sessionKey).New()
	encHandleAead, _ = pgpAead.Encryption().SessionKey(sessionKeyAead).New()

	seipdv1, err := encHandle.Encrypt([]byte("hello"))
	if err != nil {
		t.Fatal(err)
	}
	seipdv2, err := encHandleAead.Encrypt([]byte("hello"))
	if err != nil {
		t.Fatal(err)
	}

	checkSEIPD(t, seipdv1.DataPacket, 1)
	checkSEIPD(t, seipdv2.DataPacket, 2)
}

func checkPKESK(t *testing.T, data []byte, version int) {
	packets := packet.NewReader(bytes.NewReader(data))
	p, err := packets.Next()
	if err != nil {
		t.Fatal(err)
	}

	pk, ok := p.(*packet.EncryptedKey)
	if !ok {
		t.Fatal("Expected PKESK packet")
	}

	if pk.Version != version {
		t.Errorf("Expected PKESK version %d, got %d", version, pk.Version)
	}
}

func checkSEIPD(t *testing.T, data []byte, version int) {
	packets := packet.NewReader(bytes.NewReader(data))
	p, err := packets.Next()
	if err != nil {
		t.Fatal(err)
	}

	pk, ok := p.(*packet.SymmetricallyEncrypted)
	if !ok {
		t.Fatal("Expected SEIPD packet")
	}

	if pk.Version != version {
		t.Errorf("Expected SEIPD version %d, got %d", version, pk.Version)
	}
}