-
-
Notifications
You must be signed in to change notification settings - Fork 406
Add keys generate command #1695
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f014be1
refactor `TempFileCreationFailedError` to be `FileCreationFailedError`
umbynos ea0ce60
add `keys generate` command to generate the encryption keys required …
umbynos 1c34618
print output in json
umbynos 1c6c318
add tests
umbynos 0ff01b7
Apply suggestions from code review
umbynos File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
// This file is part of arduino-cli. | ||
// | ||
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/) | ||
// | ||
// This software is released under the GNU General Public License version 3, | ||
// which covers the main part of arduino-cli. | ||
// The terms of this license can be found at: | ||
// https://www.gnu.org/licenses/gpl-3.0.en.html | ||
// | ||
// You can be released from the requirements of the above licenses by purchasing | ||
// a commercial license. Buying such a license is mandatory if you want to | ||
// modify or otherwise use the software for commercial activities involving the | ||
// Arduino software without disclosing the source code of your own applications. | ||
// To purchase a commercial license, send an email to license@arduino.cc. | ||
|
||
package keys | ||
|
||
import ( | ||
"context" | ||
"os" | ||
|
||
"github.com/arduino/arduino-cli/cli/errorcodes" | ||
"github.com/arduino/arduino-cli/cli/feedback" | ||
"github.com/arduino/arduino-cli/commands/keys" | ||
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1" | ||
"github.com/sirupsen/logrus" | ||
"github.com/spf13/cobra" | ||
) | ||
|
||
var ( | ||
keyName []string // Name of the custom keys to generate. Can be used multiple times for multiple security keys. | ||
algorithmType string // Algorithm type to use | ||
keysKeychain string // Path of the dir where to save the custom keys | ||
) | ||
|
||
func initGenerateCommand() *cobra.Command { | ||
generateCommand := &cobra.Command{ | ||
Use: "generate", | ||
Short: tr("Generate the security keys."), | ||
Long: tr("Generate the security keys required for secure boot"), | ||
Example: "" + | ||
" " + os.Args[0] + " keys generate -t ecdsa-p256 --key-name ecdsa-p256-signing-key.pem --key-name ecdsa-p256-encrypt-key.pem --keys-keychain /home/user/Arduino/MyKeys\n" + | ||
" " + os.Args[0] + " keys generate --key-name ecdsa-p256-signing-key.pem", | ||
Args: cobra.NoArgs, | ||
Run: runGenerateCommand, | ||
} | ||
|
||
generateCommand.Flags().StringVarP(&algorithmType, "type", "t", "ecdsa-p256", tr("Algorithm type to use")) | ||
generateCommand.Flags().StringArrayVar(&keyName, "key-name", []string{}, tr("Name of the custom key to generate. Can be used multiple times for multiple security keys.")) | ||
generateCommand.MarkFlagRequired("key-name") | ||
generateCommand.RegisterFlagCompletionFunc("key-name", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { | ||
defaultKeyNames := []string{"ecdsa-p256-signing-key.pem", "ecdsa-p256-encrypt-key.pem"} | ||
return defaultKeyNames, cobra.ShellCompDirectiveDefault | ||
}) | ||
generateCommand.Flags().StringVar(&keysKeychain, "keys-keychain", "", tr("The path of the dir where to save the custom keys")) | ||
|
||
return generateCommand | ||
} | ||
|
||
func runGenerateCommand(command *cobra.Command, args []string) { | ||
|
||
logrus.Info("Executing `arduino-cli keys generate`") | ||
|
||
resp, err := keys.Generate(context.Background(), &rpc.KeysGenerateRequest{ | ||
AlgorithmType: algorithmType, | ||
KeyName: keyName, | ||
KeysKeychain: keysKeychain, | ||
}) | ||
if err != nil { | ||
feedback.Errorf(tr("Error during generate: %v"), err) | ||
os.Exit(errorcodes.ErrGeneric) | ||
} | ||
feedback.PrintResult(result{resp}) | ||
} | ||
|
||
// output from this command requires special formatting, let's create a dedicated | ||
// feedback.Result implementation | ||
type result struct { | ||
Keychain *rpc.KeysGenerateResponse `json:"keys_keychain"` | ||
} | ||
|
||
func (dr result) Data() interface{} { | ||
return dr.Keychain | ||
} | ||
|
||
func (dr result) String() string { | ||
return (tr("Keys created in: %s", dr.Keychain.KeysKeychain)) | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
// This file is part of arduino-cli. | ||
// | ||
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/) | ||
// | ||
// This software is released under the GNU General Public License version 3, | ||
// which covers the main part of arduino-cli. | ||
// The terms of this license can be found at: | ||
// https://www.gnu.org/licenses/gpl-3.0.en.html | ||
// | ||
// You can be released from the requirements of the above licenses by purchasing | ||
// a commercial license. Buying such a license is mandatory if you want to | ||
// modify or otherwise use the software for commercial activities involving the | ||
// Arduino software without disclosing the source code of your own applications. | ||
// To purchase a commercial license, send an email to license@arduino.cc. | ||
|
||
package keys | ||
|
||
import ( | ||
"os" | ||
|
||
"github.com/arduino/arduino-cli/i18n" | ||
"github.com/spf13/cobra" | ||
) | ||
|
||
var tr = i18n.Tr | ||
|
||
// NewCommand created a new `keys` command | ||
func NewCommand() *cobra.Command { | ||
keysCommand := &cobra.Command{ | ||
Use: "keys", | ||
Short: tr("Arduino keys commands."), | ||
Long: tr("Arduino keys commands. Useful to operate on security keys"), | ||
Example: " " + os.Args[0] + " keys generate --key-name ecdsa-p256-signing-key.pem --keys-keychain /home/user/Arduino/MyKeys", | ||
} | ||
|
||
keysCommand.AddCommand(initGenerateCommand()) | ||
|
||
return keysCommand | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As this is an exported object, this will be a breaking change and so the standard procedure should be followed to communicate that to the users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did not though about it, but you are right