open-vault/command/lease_renew.go

113 lines
2.5 KiB
Go
Raw Normal View History

2015-04-14 00:37:39 +00:00
package command
import (
"fmt"
"strings"
2017-09-05 04:03:58 +00:00
"time"
2016-04-01 17:16:05 +00:00
2017-09-05 04:03:58 +00:00
"github.com/mitchellh/cli"
"github.com/posener/complete"
2015-04-14 00:37:39 +00:00
)
2017-09-08 01:59:31 +00:00
var _ cli.Command = (*LeaseRenewCommand)(nil)
var _ cli.CommandAutocomplete = (*LeaseRenewCommand)(nil)
2017-09-05 04:03:58 +00:00
2017-09-08 01:59:31 +00:00
type LeaseRenewCommand struct {
2017-09-05 04:03:58 +00:00
*BaseCommand
flagIncrement time.Duration
}
2017-09-08 01:59:31 +00:00
func (c *LeaseRenewCommand) Synopsis() string {
2017-09-05 04:03:58 +00:00
return "Renews the lease of a secret"
}
2017-09-08 01:59:31 +00:00
func (c *LeaseRenewCommand) Help() string {
2017-09-05 04:03:58 +00:00
helpText := `
2017-09-08 01:59:31 +00:00
Usage: vault lease renew [options] ID
2017-09-05 04:03:58 +00:00
Renews the lease on a secret, extending the time that it can be used before
it is revoked by Vault.
Every secret in Vault has a lease associated with it. If the owner of the
secret wants to use it longer than the lease, then it must be renewed.
Renewing the lease does not change the contents of the secret. The ID is the
full path lease ID.
Renew a secret:
2017-09-08 01:59:31 +00:00
$ vault lease renew database/creds/readonly/2f6a614c...
2017-09-05 04:03:58 +00:00
Lease renewal will fail if the secret is not renewable, the secret has already
been revoked, or if the secret has already reached its maximum TTL.
For a full list of examples, please see the documentation.
` + c.Flags().Help()
return strings.TrimSpace(helpText)
}
2017-09-08 01:59:31 +00:00
func (c *LeaseRenewCommand) Flags() *FlagSets {
2017-09-05 04:03:58 +00:00
set := c.flagSet(FlagSetHTTP | FlagSetOutputFormat)
f := set.NewFlagSet("Command Options")
f.DurationVar(&DurationVar{
Name: "increment",
Target: &c.flagIncrement,
Default: 0,
EnvVar: "",
Completion: complete.PredictAnything,
Usage: "Request a specific increment in seconds. Vault is not required " +
"to honor this request.",
})
return set
}
2017-09-08 01:59:31 +00:00
func (c *LeaseRenewCommand) AutocompleteArgs() complete.Predictor {
2017-09-05 04:03:58 +00:00
return complete.PredictAnything
}
2017-09-08 01:59:31 +00:00
func (c *LeaseRenewCommand) AutocompleteFlags() complete.Flags {
2017-09-05 04:03:58 +00:00
return c.Flags().Completions()
2015-04-14 00:37:39 +00:00
}
2017-09-08 01:59:31 +00:00
func (c *LeaseRenewCommand) Run(args []string) int {
2017-09-05 04:03:58 +00:00
f := c.Flags()
2015-04-14 00:37:39 +00:00
2017-09-05 04:03:58 +00:00
if err := f.Parse(args); err != nil {
c.UI.Error(err.Error())
2015-04-14 00:37:39 +00:00
return 1
}
2017-09-05 04:03:58 +00:00
leaseID := ""
increment := c.flagIncrement
args = f.Args()
switch len(args) {
case 0:
c.UI.Error("Missing ID!")
return 1
case 1:
leaseID = strings.TrimSpace(args[0])
default:
c.UI.Error(fmt.Sprintf("Too many arguments (expected 1-2, got %d)", len(args)))
return 1
2015-04-14 00:37:39 +00:00
}
client, err := c.Client()
if err != nil {
2017-09-05 04:03:58 +00:00
c.UI.Error(err.Error())
2015-04-14 00:37:39 +00:00
return 2
}
2017-09-05 04:03:58 +00:00
secret, err := client.Sys().Renew(leaseID, truncateToSeconds(increment))
2015-04-14 00:37:39 +00:00
if err != nil {
2017-09-05 04:03:58 +00:00
c.UI.Error(fmt.Sprintf("Error renewing %s: %s", leaseID, err))
return 2
2015-04-14 00:37:39 +00:00
}
CLI Enhancements (#3897) * Use Colored UI if stdout is a tty * Add format options to operator unseal * Add format test on operator unseal * Add -no-color output flag, and use BasicUi if no-color flag is provided * Move seal status formatting logic to OutputSealStatus * Apply no-color to warnings from DeprecatedCommands as well * Add OutputWithFormat to support arbitrary data, add format option to auth list * Add ability to output arbitrary list data on TableFormatter * Clear up switch logic on format * Add format option for list-related commands * Add format option to rest of commands that returns a client API response * Remove initOutputYAML and initOutputJSON, and use OutputWithFormat instead * Remove outputAsYAML and outputAsJSON, and use OutputWithFormat instead * Remove -no-color flag, use env var exclusively to toggle colored output * Fix compile * Remove -no-color flag in main.go * Add missing FlagSetOutputFormat * Fix generate-root/decode test * Migrate init functions to main.go * Add no-color flag back as hidden * Handle non-supported data types for TableFormatter.OutputList * Pull formatting much further up to remove the need to use c.flagFormat (#3950) * Pull formatting much further up to remove the need to use c.flagFormat Also remove OutputWithFormat as the logic can cause issues. * Use const for env var * Minor updates * Remove unnecessary check * Fix SSH output and some tests * Fix tests * Make race detector not run on generate root since it kills Travis these days * Update docs * Update docs * Address review feedback * Handle --format as well as -format
2018-02-12 23:12:16 +00:00
return OutputSecret(c.UI, secret)
2015-04-14 00:37:39 +00:00
}