-
Notifications
You must be signed in to change notification settings - Fork 20.4k
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
cmd/ethkey: add command to change a keyfile passphrase #16516
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 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,74 @@ | ||
package main | ||
|
||
import ( | ||
"fmt" | ||
"io/ioutil" | ||
"strings" | ||
|
||
"github.com/ethereum/go-ethereum/accounts/keystore" | ||
"github.com/ethereum/go-ethereum/cmd/utils" | ||
"gopkg.in/urfave/cli.v1" | ||
) | ||
|
||
var commandChangePassphrase = cli.Command{ | ||
Name: "changepassphrase", | ||
Usage: "change the passphrase on a keyfile", | ||
ArgsUsage: "<keyfile>", | ||
Description: ` | ||
Change the passphrase of a keyfile.`, | ||
Flags: []cli.Flag{ | ||
passphraseFlag, | ||
cli.StringFlag{ | ||
Name: "newpassfile", | ||
Usage: "the file that contains the new passphrase for the keyfile", | ||
}, | ||
}, | ||
Action: func(ctx *cli.Context) error { | ||
keyfilepath := ctx.Args().First() | ||
|
||
// Read key from file. | ||
keyjson, err := ioutil.ReadFile(keyfilepath) | ||
if err != nil { | ||
utils.Fatalf("Failed to read the keyfile at '%s': %v", keyfilepath, err) | ||
} | ||
|
||
// Decrypt key with passphrase. | ||
passphrase := getPassphrase(ctx) | ||
key, err := keystore.DecryptKey(keyjson, passphrase) | ||
if err != nil { | ||
utils.Fatalf("Error decrypting key: %v", err) | ||
} | ||
|
||
// Get a new passphrase. | ||
fmt.Println("Please provide a new passphrase") | ||
var newPhrase string | ||
// Look for the --newpassfile flag. | ||
if passFile := ctx.String(passphraseFlag.Name); passFile != "" { | ||
content, err := ioutil.ReadFile(passFile) | ||
if err != nil { | ||
utils.Fatalf("Failed to read new passphrase file '%s': %v", | ||
passFile, err) | ||
} | ||
newPhrase = strings.TrimRight(string(content), "\r\n") | ||
} else { | ||
// If not present, ask for new passphrase. | ||
newPhrase = promptPassphrase(true) | ||
} | ||
|
||
// Encrypt the key with the new passphrase. | ||
newJson, err := keystore.EncryptKey(key, newPhrase, | ||
keystore.StandardScryptN, keystore.StandardScryptP) | ||
if err != nil { | ||
utils.Fatalf("Error encrypting with new passphrase: %v", err) | ||
} | ||
|
||
// Then write the new keyfile in place of the old one. | ||
if err := ioutil.WriteFile(keyfilepath, newJson, 600); err != nil { | ||
utils.Fatalf("Error writing new keyfile to disk: %v", err) | ||
} | ||
|
||
// Don't print anything. Just return successfully, | ||
// producing a positive exit code. | ||
return nil | ||
}, | ||
} |
This file contains 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 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 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 |
---|---|---|
|
@@ -38,6 +38,7 @@ func init() { | |
app.Commands = []cli.Command{ | ||
commandGenerate, | ||
commandInspect, | ||
commandChangePassphrase, | ||
commandSignMessage, | ||
commandVerifyMessage, | ||
} | ||
|
@@ -46,7 +47,7 @@ func init() { | |
// Commonly used command line flags. | ||
var ( | ||
passphraseFlag = cli.StringFlag{ | ||
Name: "passwordfile", | ||
Name: "passfile", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please don't change the name of this option. |
||
Usage: "the file that contains the passphrase for the keyfile", | ||
} | ||
jsonFlag = cli.BoolFlag{ | ||
|
This file contains 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 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 |
---|---|---|
|
@@ -28,26 +28,14 @@ import ( | |
"gopkg.in/urfave/cli.v1" | ||
) | ||
|
||
// getPassPhrase obtains a passphrase given by the user. It first checks the | ||
// --passphrase command line flag and ultimately prompts the user for a | ||
// passphrase. | ||
func getPassPhrase(ctx *cli.Context, confirmation bool) string { | ||
// Look for the --passphrase flag. | ||
passphraseFile := ctx.String(passphraseFlag.Name) | ||
if passphraseFile != "" { | ||
content, err := ioutil.ReadFile(passphraseFile) | ||
if err != nil { | ||
utils.Fatalf("Failed to read passphrase file '%s': %v", | ||
passphraseFile, err) | ||
} | ||
return strings.TrimRight(string(content), "\r\n") | ||
} | ||
|
||
// Otherwise prompt the user for the passphrase. | ||
// promptPassphrase prompts the user for a passphrase. Set confirmation to true | ||
// to require the user to confirm the passphrase. | ||
func promptPassphrase(confirmation bool) string { | ||
passphrase, err := console.Stdin.PromptPassword("Passphrase: ") | ||
if err != nil { | ||
utils.Fatalf("Failed to read passphrase: %v", err) | ||
} | ||
|
||
if confirmation { | ||
confirm, err := console.Stdin.PromptPassword("Repeat passphrase: ") | ||
if err != nil { | ||
|
@@ -57,9 +45,29 @@ func getPassPhrase(ctx *cli.Context, confirmation bool) string { | |
utils.Fatalf("Passphrases do not match") | ||
} | ||
} | ||
|
||
return passphrase | ||
} | ||
|
||
// getPassPhrase obtains a passphrase given by the user. It first checks the | ||
// --passfile command line flag and ultimately prompts the user for a | ||
// passphrase. | ||
func getPassphrase(ctx *cli.Context) string { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please fix the function name in the documentation comment. |
||
// Look for the --passfile flag. | ||
passphraseFile := ctx.String(passphraseFlag.Name) | ||
if passphraseFile != "" { | ||
content, err := ioutil.ReadFile(passphraseFile) | ||
if err != nil { | ||
utils.Fatalf("Failed to read passphrase file '%s': %v", | ||
passphraseFile, err) | ||
} | ||
return strings.TrimRight(string(content), "\r\n") | ||
} | ||
|
||
// Otherwise prompt the user for the passphrase. | ||
return promptPassphrase(false) | ||
} | ||
|
||
// signHash is a helper function that calculates a hash for the given message | ||
// that can be safely used to calculate a signature from. | ||
// | ||
|
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.
I see that you renamed the existing flag to match this one.
--newpasswordfile
sounds bad, but it's probably the better option so we don't break existing scripts.