luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

dev docs: clarify internal and external token helpers (#13014) 

* dev docs: clarify internal and external token helpers

* Add docs for DefaultTokenHelper
This commit is contained in:
mickael-hc 2022-08-16 16:48:24 -04:00 committed by GitHub
parent 21a10e09b6
commit 3e4f7db237
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
command/config/util.go
View File

@ -5,6 +5,7 @@ import (
) )
// DefaultTokenHelper returns the token helper that is configured for Vault. // DefaultTokenHelper returns the token helper that is configured for Vault.
// This helper should only be used for non-server CLI commands.
func DefaultTokenHelper() (token.TokenHelper, error) { func DefaultTokenHelper() (token.TokenHelper, error) {
config, err := LoadConfig("") config, err := LoadConfig("")
if err != nil { if err != nil {

3
command/token/helper_external.go
View File

@ -10,6 +10,7 @@ import (
"strings" "strings"
) )
// ExternalTokenHelperPath should only be used in dev mode.
// ExternalTokenHelperPath takes the configured path to a helper and expands it to // ExternalTokenHelperPath takes the configured path to a helper and expands it to
// a full absolute path that can be executed. As of 0.5, the default token // a full absolute path that can be executed. As of 0.5, the default token
// helper is internal, to avoid problems running in dev mode (see GH-850 and // helper is internal, to avoid problems running in dev mode (see GH-850 and
@ -38,6 +39,8 @@ func ExternalTokenHelperPath(path string) (string, error) {
var _ TokenHelper = (*ExternalTokenHelper)(nil) var _ TokenHelper = (*ExternalTokenHelper)(nil)
// ExternalTokenHelper should only be used in a dev mode. For all other cases,
// InternalTokenHelper should be used.
// ExternalTokenHelper is the struct that has all the logic for storing and retrieving // ExternalTokenHelper is the struct that has all the logic for storing and retrieving
// tokens from the token helper. The API for the helpers is simple: the // tokens from the token helper. The API for the helpers is simple: the
// BinaryPath is executed within a shell with environment Env. The last argument // BinaryPath is executed within a shell with environment Env. The last argument

1
command/util.go
View File

@ -14,6 +14,7 @@ import (
) )
// DefaultTokenHelper returns the token helper that is configured for Vault. // DefaultTokenHelper returns the token helper that is configured for Vault.
// This helper should only be used for non-server CLI commands.
func DefaultTokenHelper() (token.TokenHelper, error) { func DefaultTokenHelper() (token.TokenHelper, error) {
return config.DefaultTokenHelper() return config.DefaultTokenHelper()
} }