File: key_generation_handle_builder.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 (52 lines) | stat: -rw-r--r-- 1,977 bytes parent folder | download | duplicates (3)
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
package crypto

// KeyGenerationBuilder allows to configure a key generation handle to generate OpenPGP keys.
type KeyGenerationBuilder struct {
	handle       *keyGenerationHandle
	defaultClock Clock
}

func newKeyGenerationBuilder(profile KeyGenerationProfile, clock Clock) *KeyGenerationBuilder {
	return &KeyGenerationBuilder{
		handle:       defaultKeyGenerationHandle(profile, clock),
		defaultClock: clock,
	}
}

// GenerationTime sets the key generation time to the given unixTime.
func (kgb *KeyGenerationBuilder) GenerationTime(unixTime int64) *KeyGenerationBuilder {
	kgb.handle.clock = NewConstantClock(unixTime)
	return kgb
}

// Lifetime sets the key lifetime to the given value in seconds.
// The lifetime defaults to zero i.e., infinite lifetime.
func (kgb *KeyGenerationBuilder) Lifetime(seconds int32) *KeyGenerationBuilder {
	kgb.handle.keyLifetimeSecs = uint32(seconds)
	return kgb
}

// AddUserId adds the provided user identity to any generated key.
func (kgb *KeyGenerationBuilder) AddUserId(name, email string) *KeyGenerationBuilder {
	kgb.handle.identities = append(kgb.handle.identities, identity{name, "", email})
	return kgb
}

// OverrideProfileAlgorithm allows to override the algorithm of the output key instead of using the profile's
// algorithm with the respective security level.
//
// Allowed inputs (integer enum for go-mobile compatibility):
// crypto.KeyGenerationRSA4096, crypto.KeyGenerationC25519, crypto.KeyGenerationC25519Refresh
// crypto.KeyGenerationC448, crypto.KeyGenerationC448Refresh.
func (kgb *KeyGenerationBuilder) OverrideProfileAlgorithm(algorithm int) *KeyGenerationBuilder {
	kgb.handle.overrideAlgorithm = algorithm
	return kgb
}

// New creates a new key generation handle from the internal configuration
// that allows to generate pgp keys.
func (kgb *KeyGenerationBuilder) New() PGPKeyGeneration {
	handle := kgb.handle
	kgb.handle = defaultKeyGenerationHandle(kgb.handle.profile, kgb.defaultClock)
	return handle
}