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
|
// Copyright (c) 2020, Control Command Inc. All rights reserved.
// Copyright (c) 2017-2021, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package cli
import (
"errors"
"fmt"
"os"
"github.com/spf13/cobra"
"github.com/sylabs/singularity/v4/docs"
"github.com/sylabs/singularity/v4/internal/pkg/remote/endpoint"
"github.com/sylabs/singularity/v4/internal/pkg/sypgp"
"github.com/sylabs/singularity/v4/internal/pkg/util/interactive"
"github.com/sylabs/singularity/v4/pkg/cmdline"
"github.com/sylabs/singularity/v4/pkg/sylog"
)
var (
keyNewPairName string
keyNewPairNameFlag = &cmdline.Flag{
ID: "KeyNewPairNameFlag",
Value: &keyNewPairName,
DefaultValue: "",
Name: "name",
ShortHand: "N",
Usage: "key owner name",
}
keyNewPairEmail string
keyNewPairEmailFlag = &cmdline.Flag{
ID: "KeyNewPairEmailFlag",
Value: &keyNewPairEmail,
DefaultValue: "",
Name: "email",
ShortHand: "E",
Usage: "key owner email",
}
keyNewPairComment string
keyNewPairCommentFlag = &cmdline.Flag{
ID: "KeyNewPairCommentFlag",
Value: &keyNewPairComment,
DefaultValue: "",
Name: "comment",
ShortHand: "C",
Usage: "key comment",
}
keyNewPairPassword string
keyNewPairPasswordFlag = &cmdline.Flag{
ID: "KeyNewPairPasswordFlag",
Value: &keyNewPairPassword,
DefaultValue: "",
Name: "password",
ShortHand: "P",
Usage: "key password",
}
keyNewPairPush bool
keyNewPairPushFlag = &cmdline.Flag{
ID: "KeyNewPairPushFlag",
Value: &keyNewPairPush,
DefaultValue: false,
Name: "push",
ShortHand: "U",
Usage: "specify to push the public key to the remote keystore (default true)",
}
// KeyNewPairCmd is 'singularity key newpair' and generate a new OpenPGP key pair
KeyNewPairCmd = &cobra.Command{
Args: cobra.ExactArgs(0),
DisableFlagsInUseLine: true,
Run: runNewPairCmd,
Use: docs.KeyNewPairUse,
Short: docs.KeyNewPairShort,
Long: docs.KeyNewPairLong,
Example: docs.KeyNewPairExample,
}
)
type keyNewPairOptions struct {
sypgp.GenKeyPairOptions
PushToKeyStore bool
}
func runNewPairCmd(cmd *cobra.Command, _ []string) {
keyring := sypgp.NewHandle("")
opts, err := collectInput(cmd)
if err != nil {
sylog.Errorf("could not collect user input: %v", err)
os.Exit(2)
}
opts.KeyLength = keyNewpairBitLength
fmt.Printf("Generating Entity and OpenPGP Key Pair... ")
key, err := keyring.GenKeyPair(opts.GenKeyPairOptions)
if err != nil {
sylog.Errorf("creating newpair failed: %v", err)
os.Exit(2)
}
fmt.Printf("done\n")
if !opts.PushToKeyStore {
fmt.Println("NOT pushing newly created key to keystore")
return
}
// Only connect to the endpoint if we are pushing the key.
co, err := getKeyserverClientOpts(keyServerURI, endpoint.KeyserverPushOp)
if err != nil {
sylog.Fatalf("Keyserver client failed: %s", err)
}
if err := sypgp.PushPubkey(cmd.Context(), key, co...); err != nil {
fmt.Printf("Failed to push newly created key to keystore: %s\n", err)
} else {
fmt.Println("Key successfully pushed to keystore")
}
}
// collectInput collects passed flags, for missed parameters will ask user input.
func collectInput(cmd *cobra.Command) (*keyNewPairOptions, error) {
var genOpts keyNewPairOptions
// check flags
if cmd.Flags().Changed(keyNewPairNameFlag.Name) {
genOpts.Name = keyNewPairName
} else {
n, err := interactive.AskQuestion("Enter your name (e.g., John Doe) : ")
if err != nil {
return nil, err
}
genOpts.Name = n
}
if cmd.Flags().Changed(keyNewPairEmailFlag.Name) {
genOpts.Email = keyNewPairEmail
} else {
e, err := interactive.AskQuestion("Enter your email address (e.g., john.doe@example.com) : ")
if err != nil {
return nil, err
}
genOpts.Email = e
}
if cmd.Flags().Changed(keyNewPairCommentFlag.Name) {
genOpts.Comment = keyNewPairComment
} else {
c, err := interactive.AskQuestion("Enter optional comment (e.g., development keys) : ")
if err != nil {
return nil, err
}
genOpts.Comment = c
}
if cmd.Flags().Changed(keyNewPairPasswordFlag.Name) {
genOpts.Password = keyNewPairPassword
} else {
// get a password
p, err := interactive.GetPassphrase("Enter a passphrase : ", 3)
if err != nil {
return nil, err
}
if p == "" {
a, err := interactive.AskYNQuestion("n", "WARNING: if there is no password set, your key is not secure. Do you want to continue? [y/n] ")
if err != nil {
return nil, err
}
if a == "n" {
return nil, errors.New("empty passphrase")
}
}
genOpts.Password = p
}
if cmd.Flags().Changed(keyNewPairPushFlag.Name) {
genOpts.PushToKeyStore = keyNewPairPush
} else {
a, err := interactive.AskYNQuestion("y", "Would you like to push it to the keystore? [Y,n] ")
if err != nil {
return nil, err
}
if a == "y" {
genOpts.PushToKeyStore = true
}
}
return &genOpts, nil
}
|
