key.go 1.77 KB
Newer Older
1 2
package options

3 4 5
const (
	RSAKey     = "rsa"
	Ed25519Key = "ed25519"
Łukasz Magiera's avatar
Łukasz Magiera committed
6 7

	DefaultRSALen = 2048
8 9
)

10 11 12 13 14 15 16 17 18 19 20 21 22 23
type KeyGenerateSettings struct {
	Algorithm string
	Size      int
}

type KeyRenameSettings struct {
	Force bool
}

type KeyGenerateOption func(*KeyGenerateSettings) error
type KeyRenameOption func(*KeyRenameSettings) error

func KeyGenerateOptions(opts ...KeyGenerateOption) (*KeyGenerateSettings, error) {
	options := &KeyGenerateSettings{
24
		Algorithm: RSAKey,
Łukasz Magiera's avatar
Łukasz Magiera committed
25
		Size:      -1,
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
	}

	for _, opt := range opts {
		err := opt(options)
		if err != nil {
			return nil, err
		}
	}
	return options, nil
}

func KeyRenameOptions(opts ...KeyRenameOption) (*KeyRenameSettings, error) {
	options := &KeyRenameSettings{
		Force: false,
	}

	for _, opt := range opts {
		err := opt(options)
		if err != nil {
			return nil, err
		}
	}
	return options, nil
}

51
type keyOpts struct{}
52

53 54 55 56 57 58 59 60
var Key keyOpts

// Type is an option for Key.Generate which specifies which algorithm
// should be used for the key. Default is options.RSAKey
//
// Supported key types:
// * options.RSAKey
// * options.Ed25519Key
61
func (keyOpts) Type(algorithm string) KeyGenerateOption {
62 63 64 65 66 67
	return func(settings *KeyGenerateSettings) error {
		settings.Algorithm = algorithm
		return nil
	}
}

68 69 70 71 72
// Size is an option for Key.Generate which specifies the size of the key to
// generated. Default is -1
//
// value of -1 means 'use default size for key type':
//  * 2048 for RSA
73
func (keyOpts) Size(size int) KeyGenerateOption {
74 75 76 77 78 79
	return func(settings *KeyGenerateSettings) error {
		settings.Size = size
		return nil
	}
}

80 81
// Force is an option for Key.Rename which specifies whether to allow to
// replace existing keys.
82
func (keyOpts) Force(force bool) KeyRenameOption {
83 84 85 86 87
	return func(settings *KeyRenameSettings) error {
		settings.Force = force
		return nil
	}
}