mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-08 07:37:01 +02:00
0b12cdcfd1
* Adding explicit MPL license for sub-package. This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Adding explicit MPL license for sub-package. This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Updating the license from MPL to Business Source License. Going forward, this project will be licensed under the Business Source License v1.1. Please see our blog post for more details at https://hashi.co/bsl-blog, FAQ at www.hashicorp.com/licensing-faq, and details of the license at www.hashicorp.com/bsl. * add missing license headers * Update copyright file headers to BUS-1.1 * Fix test that expected exact offset on hcl file --------- Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com> Co-authored-by: Sarah Thompson <sthompson@hashicorp.com> Co-authored-by: Brian Kassouf <bkassouf@hashicorp.com>
122 lines
2.6 KiB
Go
122 lines
2.6 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package command
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/mitchellh/cli"
|
|
"github.com/posener/complete"
|
|
)
|
|
|
|
var (
|
|
_ cli.Command = (*PathHelpCommand)(nil)
|
|
_ cli.CommandAutocomplete = (*PathHelpCommand)(nil)
|
|
)
|
|
|
|
var pathHelpVaultSealedMessage = strings.TrimSpace(`
|
|
Error: Vault is sealed.
|
|
|
|
The "path-help" command requires the Vault to be unsealed so that the mount
|
|
points of the secret engines are known.
|
|
`)
|
|
|
|
type PathHelpCommand struct {
|
|
*BaseCommand
|
|
}
|
|
|
|
func (c *PathHelpCommand) Synopsis() string {
|
|
return "Retrieve API help for paths"
|
|
}
|
|
|
|
func (c *PathHelpCommand) Help() string {
|
|
helpText := `
|
|
Usage: vault path-help [options] PATH
|
|
|
|
Retrieves API help for paths. All endpoints in Vault provide built-in help
|
|
in markdown format. This includes system paths, secret engines, and auth
|
|
methods.
|
|
|
|
Get help for the thing mounted at database/:
|
|
|
|
$ vault path-help database/
|
|
|
|
The response object will return additional paths to retrieve help:
|
|
|
|
$ vault path-help database/roles/
|
|
|
|
Each secret engine produces different help output.
|
|
|
|
If -format is specified as JSON, the output will be in OpenAPI format.
|
|
|
|
` + c.Flags().Help()
|
|
|
|
return strings.TrimSpace(helpText)
|
|
}
|
|
|
|
func (c *PathHelpCommand) Flags() *FlagSets {
|
|
return c.flagSet(FlagSetHTTP | FlagSetOutputFormat)
|
|
}
|
|
|
|
func (c *PathHelpCommand) AutocompleteArgs() complete.Predictor {
|
|
return complete.PredictAnything // TODO: programatic way to invoke help
|
|
}
|
|
|
|
func (c *PathHelpCommand) AutocompleteFlags() complete.Flags {
|
|
return c.Flags().Completions()
|
|
}
|
|
|
|
func (c *PathHelpCommand) Run(args []string) int {
|
|
f := c.Flags()
|
|
|
|
if err := f.Parse(args); err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 1
|
|
}
|
|
|
|
args = f.Args()
|
|
switch {
|
|
case len(args) < 1:
|
|
c.UI.Error(fmt.Sprintf("Not enough arguments (expected 1, got %d)", len(args)))
|
|
return 1
|
|
case len(args) > 1:
|
|
c.UI.Error(fmt.Sprintf("Too many arguments (expected 1, got %d)", len(args)))
|
|
return 1
|
|
}
|
|
|
|
client, err := c.Client()
|
|
if err != nil {
|
|
c.UI.Error(err.Error())
|
|
return 2
|
|
}
|
|
|
|
path := sanitizePath(args[0])
|
|
|
|
help, err := client.Help(path)
|
|
if err != nil {
|
|
if strings.Contains(err.Error(), "Vault is sealed") {
|
|
c.UI.Error(pathHelpVaultSealedMessage)
|
|
} else {
|
|
c.UI.Error(fmt.Sprintf("Error retrieving help: %s", err))
|
|
}
|
|
return 2
|
|
}
|
|
|
|
switch c.flagFormat {
|
|
case "json":
|
|
b, err := json.Marshal(help.OpenAPI)
|
|
if err != nil {
|
|
c.UI.Error(fmt.Sprintf("Error marshaling OpenAPI: %s", err))
|
|
return 2
|
|
}
|
|
c.UI.Output(string(b))
|
|
default:
|
|
c.UI.Output(help.Help)
|
|
}
|
|
|
|
return 0
|
|
}
|