Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Implement ipfs key {rm, rename} #3892

Merged
merged 10 commits into from
May 18, 2017
Merged

Implement ipfs key {rm, rename} #3892

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4d4d7b8
Implement ipfs key rm
MichaelMure May 1, 2017
730ab61
fix fmt and exported var that shouldn't be
MichaelMure May 1, 2017
bd96f71
Make ipfs key rm variadic
MichaelMure May 1, 2017
a813830
Enable stdin for ipfs key rm's name argument
MichaelMure May 2, 2017
6f815b1
Add a Has(name) method to the keystore
MichaelMure May 4, 2017
3aa6d78
Implement ipfs key rename
MichaelMure May 4, 2017
c0a04a0
add sharness test for ipfs key rename
MichaelMure May 4, 2017
7e91da2
Future-proof keystore.Has by returning an error as well
MichaelMure May 8, 2017
cb8d5eb
Add a test for failure of 'ipfs key rm self'
MichaelMure May 14, 2017
2593495
Document exported symbols
MichaelMure May 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions core/commands/keystore.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ var KeyCmd = &cmds.Command{
Subcommands: map[string]*cmds.Command{
"gen": KeyGenCmd,
"list": KeyListCmd,
"rm": KeyRmCmd,
},
}

Expand Down Expand Up @@ -202,6 +203,61 @@ var KeyListCmd = &cmds.Command{
Type: KeyOutputList{},
}

var KeyRmCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Remove a keypair",
},
Arguments: []cmds.Argument{
cmds.StringArg("name", true, false, "name of key to remove"),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This command should allow for StdIn handling and multiple argument handling. Then it would be possible to remove multiple keys at the same time easily.

},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

name := req.Arguments()[0]
if name == "self" {
res.SetError(fmt.Errorf("cannot remove key with name 'self'"), cmds.ErrNormal)
return
}

removed, err := n.Repo.Keystore().Get(name)
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

err = n.Repo.Keystore().Delete(name)
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

pubKey := removed.GetPublic()

pid, err := peer.IDFromPublicKey(pubKey)
if err != nil {
res.SetError(err, cmds.ErrNormal)
return
}

res.SetOutput(&KeyOutput{
Name: name,
Id: pid.Pretty(),
})
},
Marshalers: cmds.MarshalerMap{
cmds.Text: func(res cmds.Response) (io.Reader, error) {
v := res.Output().(*KeyOutput)
s := fmt.Sprintf("Removed key %s with Id: %s\n", v.Name, v.Id)
return strings.NewReader(s), nil
},
},
Type: KeyOutput{},
}

func keyOutputListMarshaler(res cmds.Response) (io.Reader, error) {
withId, _, _ := res.Request().Option("l").Bool()

Expand Down
8 changes: 8 additions & 0 deletions test/sharness/t0165-keystore.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ test_key_cmd() {
PeerID="$(ipfs config Identity.PeerID)"
ipfs key list -l | grep "$PeerID self"
'

test_expect_success "key rm remove a key" '
ipfs key rm foobarsa
echo bazed > list_exp &&
echo self >> list_exp
ipfs key list | sort > list_out &&
test_cmp list_exp list_out
'
}

test_key_cmd
Expand Down