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
|
// Package crypto provides a high-level API for common OpenPGP functionality.
// The package provides abstract interfaces for encryption ([PGPEncryption]),
// decryption ([PGPDecryption]), signing ([PGPSign]), and verifying ([PGPVerify]).
//
// # Usage
//
// To get a concrete instantiation of the interfaces use the top level [PGPHandle] by
// calling PGP() or PGPWithProfile(...). An example to instantiate a handle
// that implements [PGPEncryption]:
//
// pgp := PGP()
// encryptionHandle, _ :=pgp.Encryption().Password(...).New()
package crypto
import (
"time"
"github.com/ProtonMail/gopenpgp/v3/profile"
)
type PGPHandle struct {
profile *profile.Custom
defaultTime Clock
}
// PGP creates a PGPHandle to interact with the API.
// Uses the default profile for configuration.
func PGP() *PGPHandle {
return PGPWithProfile(profile.Default())
}
// PGPWithProfile creates a PGPHandle to interact with the API.
// Uses the provided profile for configuration.
func PGPWithProfile(profile *profile.Custom) *PGPHandle {
return &PGPHandle{
profile: profile,
defaultTime: time.Now,
}
}
// Encryption returns a builder to create an EncryptionHandle
// for encrypting messages.
func (p *PGPHandle) Encryption() *EncryptionHandleBuilder {
return newEncryptionHandleBuilder(p.profile, p.defaultTime)
}
// Decryption returns a builder to create a DecryptionHandle
// for decrypting pgp messages.
func (p *PGPHandle) Decryption() *DecryptionHandleBuilder {
return newDecryptionHandleBuilder(p.profile, p.defaultTime)
}
// Sign returns a builder to create a SignHandle
// for signing messages.
func (p *PGPHandle) Sign() *SignHandleBuilder {
return newSignHandleBuilder(p.profile, p.defaultTime)
}
// Verify returns a builder to create an VerifyHandle
// for verifying signatures.
func (p *PGPHandle) Verify() *VerifyHandleBuilder {
return newVerifyHandleBuilder(p.profile, p.defaultTime)
}
// KeyGeneration returns a builder to create a KeyGeneration handle.
func (p *PGPHandle) KeyGeneration() *KeyGenerationBuilder {
return newKeyGenerationBuilder(p.profile, p.defaultTime)
}
// LockKey encrypts the private parts of a copy of the input key with the given passphrase.
func (p *PGPHandle) LockKey(key *Key, passphrase []byte) (*Key, error) {
return key.lock(passphrase, p.profile)
}
// GenerateSessionKey generates a random session key for the profile.
// Use GenerateSessionKey on the encryption handle, if the PGP encryption keys are known.
// This function only considers the profile to determine the session key type.
func (p *PGPHandle) GenerateSessionKey() (*SessionKey, error) {
config := p.profile.EncryptionConfig()
return generateSessionKey(config, nil, nil)
}
|
