mirror of
https://github.com/hashicorp/vault.git
synced 2025-11-28 22:21:30 +01:00
c6832a8099
* Support registering plugin with name only * Make RegisterPlugin backwards compatible * Add CLI backwards compat command to plugin info and deregister * Add server-side deprecation warnings if old read/dereg API endpoints are called * Address feedback
104 lines
2.5 KiB
Go
104 lines
2.5 KiB
Go
package command
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/vault/api"
|
|
"github.com/hashicorp/vault/helper/consts"
|
|
"github.com/mitchellh/cli"
|
|
"github.com/posener/complete"
|
|
)
|
|
|
|
var _ cli.Command = (*PluginDeregisterCommand)(nil)
|
|
var _ cli.CommandAutocomplete = (*PluginDeregisterCommand)(nil)
|
|
|
|
type PluginDeregisterCommand struct {
|
|
*BaseCommand
|
|
}
|
|
|
|
func (c *PluginDeregisterCommand) Synopsis() string {
|
|
return "Deregister an existing plugin in the catalog"
|
|
}
|
|
|
|
func (c *PluginDeregisterCommand) Help() string {
|
|
helpText := `
|
|
Usage: vault plugin deregister [options] TYPE NAME
|
|
|
|
Deregister an existing plugin in the catalog. If the plugin does not exist,
|
|
no action is taken (the command is idempotent). The argument of type
|
|
takes "auth", "database", or "secret".
|
|
|
|
Deregister the plugin named my-custom-plugin:
|
|
|
|
$ vault plugin deregister auth my-custom-plugin
|
|
|
|
` + c.Flags().Help()
|
|
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *PluginDeregisterCommand) Flags() *FlagSets {
|
|
return c.flagSet(FlagSetHTTP)
|
|
}
|
|
|
|
func (c *PluginDeregisterCommand) AutocompleteArgs() complete.Predictor {
|
|
return c.PredictVaultPlugins(consts.PluginTypeUnknown)
|
|
}
|
|
|
|
func (c *PluginDeregisterCommand) AutocompleteFlags() complete.Flags {
|
|
return c.Flags().Completions()
|
|
}
|
|
|
|
func (c *PluginDeregisterCommand) Run(args []string) int {
|
|
f := c.Flags()
|
|
|
|
if err := f.Parse(args); err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 1
|
|
}
|
|
|
|
var pluginNameRaw, pluginTypeRaw string
|
|
args = f.Args()
|
|
switch {
|
|
case len(args) < 1:
|
|
c.UI.Error(fmt.Sprintf("Not enough arguments (expected 1 or 2, got %d)", len(args)))
|
|
return 1
|
|
case len(args) > 2:
|
|
c.UI.Error(fmt.Sprintf("Too many arguments (expected 1 or 2, got %d)", len(args)))
|
|
return 1
|
|
|
|
// These cases should come after invalid cases have been checked
|
|
case len(args) == 1:
|
|
pluginTypeRaw = "unknown"
|
|
pluginNameRaw = args[0]
|
|
case len(args) == 2:
|
|
pluginTypeRaw = args[0]
|
|
pluginNameRaw = args[1]
|
|
}
|
|
|
|
client, err := c.Client()
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 2
|
|
}
|
|
|
|
pluginType, err := consts.ParsePluginType(strings.TrimSpace(pluginTypeRaw))
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 2
|
|
}
|
|
pluginName := strings.TrimSpace(pluginNameRaw)
|
|
|
|
if err := client.Sys().DeregisterPlugin(&api.DeregisterPluginInput{
|
|
Name: pluginName,
|
|
Type: pluginType,
|
|
}); err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error deregistering plugin named %s: %s", pluginName, err))
|
|
return 2
|
|
}
|
|
|
|
c.UI.Output(fmt.Sprintf("Success! Deregistered plugin (if it was registered): %s", pluginName))
|
|
return 0
|
|
}
|