-
Notifications
You must be signed in to change notification settings - Fork 19
/
keytool.go
258 lines (235 loc) · 7.68 KB
/
keytool.go
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
package generator
import (
"bytes"
"context"
"flag"
"fmt"
"io/ioutil"
"os"
"os/exec"
"path"
"github.com/ForgeRock/secret-agent/api/v1alpha1"
"github.com/ForgeRock/secret-agent/pkg/secretsmanager"
"github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
)
var keytoolPath *string
var opensslPath *string
func init() {
// follow java home if it exists
javaHome, exists := os.LookupEnv("JAVA_HOME")
defaultKeytoolPath := "/usr/bin/keytool"
if exists {
defaultKeytoolPath = path.Join(javaHome, "bin/keytool")
}
keytoolPath = flag.String("keytoolPath", defaultKeytoolPath, "The path to the keytool executable")
opensslPath = flag.String("opensslPath", "/usr/bin/openssl", "The path to the openssl executable")
}
type cmdRunner func(cmdName string, args []string) *exec.Cmd
// used for openssl and tests
func execCommand(execCmd string, baseArgs []string) func(cmdName string, args []string) *exec.Cmd {
return func(cmdName string, args []string) *exec.Cmd {
cmdArgs := []string{}
cmdArgs = append(cmdArgs, cmdName)
cmdArgs = append(cmdArgs, baseArgs...)
cmdArgs = append(cmdArgs, args...)
return exec.Command(execCmd, cmdArgs...)
}
}
// AliasMgr an interface for managing keytool aliases
type AliasMgr interface {
References() ([]string, []string)
LoadReferenceData(data map[string][]byte) error
Generate(baseDir string, baseCmd cmdRunner) error
}
// NewKeyTool creates new keytool instance
func NewKeyTool(key *v1alpha1.KeyConfig) (*KeyTool, error) {
var err error
tool := &KeyTool{}
tool.Name = key.Name
tool.V1Spec = key.Spec
tool.storeDir, err = ioutil.TempDir("", "store-*")
if err != nil {
return &KeyTool{}, errors.WithMessage(err, "couldn't create a temporary keystore file")
}
tool.storePath = path.Join(tool.storeDir, fmt.Sprintf("keytool.%s", tool.V1Spec.StoreType))
for _, alias := range key.Spec.KeytoolAliases {
tool.loadAliasManager(alias)
}
return tool, nil
}
// KeyTool an object for managing keytool aliases.
type KeyTool struct {
Name string
V1Spec *v1alpha1.KeySpec
storeDir string
storePath string
storeBytes []byte
aliasMgrs []AliasMgr
keyToolCmd cmdRunner
storePassValue string
keyPassValue string
}
func (kt *KeyTool) baseCommand(execCmd string) func(cmdName string, args []string) *exec.Cmd {
baseArgs := []string{
"-storetype", string(kt.V1Spec.StoreType),
"-storepass", kt.storePassValue,
"-keypass", kt.keyPassValue,
"-keystore", kt.storePath,
}
return func(cmdName string, args []string) *exec.Cmd {
// for special cmds
switch cmdName {
case "-importkeystore":
baseArgs = []string{
"-deststoretype", string(kt.V1Spec.StoreType),
"-deststorepass", kt.storePassValue,
"-destkeypass", kt.keyPassValue,
"-destkeystore", kt.storePath,
}
}
cmdArgs := []string{}
cmdArgs = append(cmdArgs, cmdName)
cmdArgs = append(cmdArgs, baseArgs...)
cmdArgs = append(cmdArgs, args...)
return exec.Command(execCmd, cmdArgs...)
}
}
func (kt *KeyTool) loadAliasManager(alias *v1alpha1.KeytoolAliasConfig) {
switch alias.Cmd {
case v1alpha1.KeytoolCmdImportpassword:
pwdAlias := NewKeyToolImportPassword(alias)
kt.aliasMgrs = append(kt.aliasMgrs, pwdAlias)
case v1alpha1.KeytoolCmdGenseckey:
genSecAlias := NewKeyToolGenSecKey(alias)
kt.aliasMgrs = append(kt.aliasMgrs, genSecAlias)
case v1alpha1.KeytoolCmdGenkeypair:
kpAlias := NewKeyToolGenKeyPair(alias)
kt.aliasMgrs = append(kt.aliasMgrs, kpAlias)
case v1alpha1.KeytoolCmdImportkeystore:
importKeyStoreAlias := NewKeyToolImportKeystore(alias)
kt.aliasMgrs = append(kt.aliasMgrs, importKeyStoreAlias)
case v1alpha1.KeytoolCmdImportcert:
importCertAlias := NewKeyToolImportCert(alias)
kt.aliasMgrs = append(kt.aliasMgrs, importCertAlias)
}
return
}
// InSecret return true if the key is one found in the secret
func (kt *KeyTool) InSecret(secObject *corev1.Secret) bool {
if secObject.Data == nil || secObject.Data[kt.Name] == nil || kt.IsEmpty() {
return false
}
if bytes.Compare(kt.storeBytes, secObject.Data[kt.Name]) == 0 {
return true
}
return false
}
// References all names the ids of references required for generation
func (kt *KeyTool) References() ([]string, []string) {
refNames := []string{}
refDataKeys := []string{}
for _, mgr := range kt.aliasMgrs {
_refNames, _refDataKeys := mgr.References()
refNames = append(refNames, _refNames...)
refDataKeys = append(refDataKeys, _refDataKeys...)
}
if kt.V1Spec.StorePassPath != "" {
storePassName, storePassDataKey := handleRefPath(kt.V1Spec.StorePassPath)
refNames = append(refNames, storePassName)
refDataKeys = append(refDataKeys, storePassDataKey)
}
if kt.V1Spec.KeyPassPath != "" {
keyPassName, keyPassDataKey := handleRefPath(kt.V1Spec.KeyPassPath)
refNames = append(refNames, keyPassName)
refDataKeys = append(refDataKeys, keyPassDataKey)
}
return refNames, refDataKeys
}
// LoadReferenceData load all alias reference data
func (kt *KeyTool) LoadReferenceData(data map[string][]byte) error {
kt.storePassValue = string(data[kt.V1Spec.StorePassPath])
kt.keyPassValue = string(data[kt.V1Spec.KeyPassPath])
for _, mgr := range kt.aliasMgrs {
if err := mgr.LoadReferenceData(data); err != nil {
return err
}
}
return nil
}
// LoadSecretFromManager populates keytool data from secret manager
func (kt *KeyTool) LoadSecretFromManager(ctx context.Context, sm secretsmanager.SecretManager, secretManagerKeyNamespace string) error {
var err error
keyToolFmt := fmt.Sprintf("%s_%s", secretManagerKeyNamespace, kt.Name)
storePassFmt := fmt.Sprintf("%s_%s_storepass", secretManagerKeyNamespace, kt.Name)
keyPasslFmt := fmt.Sprintf("%s_%s_keypass", secretManagerKeyNamespace, kt.Name)
kt.storeBytes, err = sm.LoadSecret(ctx, keyToolFmt)
if err != nil {
return err
}
storePassValueBytes, err := sm.LoadSecret(ctx, storePassFmt)
kt.storePassValue = string(storePassValueBytes)
if err != nil {
return err
}
keyPassValueBytes, err := sm.LoadSecret(ctx, keyPasslFmt)
kt.keyPassValue = string(keyPassValueBytes)
if err != nil {
return err
}
return nil
}
// EnsureSecretManager adds keytool to secret manager
func (kt *KeyTool) EnsureSecretManager(ctx context.Context, sm secretsmanager.SecretManager, secretManagerKeyNamespace string) error {
var err error
keyToolFmt := fmt.Sprintf("%s_%s", secretManagerKeyNamespace, kt.Name)
storePassFmt := fmt.Sprintf("%s_%s_storepass", secretManagerKeyNamespace, kt.Name)
keyPasslFmt := fmt.Sprintf("%s_%s_keypass", secretManagerKeyNamespace, kt.Name)
err = sm.EnsureSecret(ctx, keyToolFmt, kt.storeBytes)
if err != nil {
return err
}
err = sm.EnsureSecret(ctx, storePassFmt, []byte(kt.storePassValue))
if err != nil {
return err
}
err = sm.EnsureSecret(ctx, keyPasslFmt, []byte(kt.keyPassValue))
if err != nil {
return err
}
return nil
}
// Generate keystore and all of its aliases
func (kt *KeyTool) Generate() error {
// clean up after ourselves, we store as bytes in memory
defer os.RemoveAll(kt.storeDir)
cmd := kt.baseCommand(*keytoolPath)
for _, mgr := range kt.aliasMgrs {
if err := mgr.Generate(kt.storeDir, cmd); err != nil {
return err
}
}
storeBytes, err := ioutil.ReadFile(kt.storePath)
if err != nil {
return errors.WithStack(err)
}
kt.storeBytes = storeBytes
return nil
}
// LoadFromData keystore from from bytes
func (kt *KeyTool) LoadFromData(secData map[string][]byte) {
if keyStoreBytes, ok := secData[kt.Name]; ok {
kt.storeBytes = keyStoreBytes
}
}
// IsEmpty test if the keystore is empty
func (kt *KeyTool) IsEmpty() bool {
return len(kt.storeBytes) == 0
}
// ToKubernetes serializes data to kubernetes secret
func (kt *KeyTool) ToKubernetes(secObject *corev1.Secret) {
if secObject.Data == nil {
secObject.Data = make(map[string][]byte)
}
secObject.Data[kt.Name] = kt.storeBytes
}