Documentation
¶
Overview ¶
Package secrets provides commands for managing scafctl secrets.
Index ¶
- Constants
- func CommandDelete(cliParams *settings.Run, _ *terminal.IOStreams, _ string) *cobra.Command
- func CommandExists(cliParams *settings.Run, ioStreams *terminal.IOStreams, _ string) *cobra.Command
- func CommandExport(cliParams *settings.Run, _ *terminal.IOStreams, _ string) *cobra.Command
- func CommandGet(_ *settings.Run, ioStreams *terminal.IOStreams, _ string) *cobra.Command
- func CommandImport(_ *settings.Run, ioStreams *terminal.IOStreams, _ string) *cobra.Command
- func CommandList(cliParams *settings.Run, ioStreams *terminal.IOStreams, _ string) *cobra.Command
- func CommandRotate(cliParams *settings.Run, _ *terminal.IOStreams, _ string) *cobra.Command
- func CommandSecrets(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command
- func CommandSet(_ *settings.Run, ioStreams *terminal.IOStreams, _ string) *cobra.Command
- func FilterSecrets(names []string, includeInternal bool) []string
- func FilterUserSecrets(names []string) []string
- func IsInternalSecret(name string) bool
- func SecretType(name string) string
- func ValidateSecretName(name string, includeInternal bool) error
- func ValidateUserSecretName(name string) error
- type ExportFormat
- type ExportedSecret
Constants ¶
const ( // InternalSecretPrefix is the prefix used for internal scafctl secrets (e.g. auth tokens). InternalSecretPrefix = "scafctl." //nolint:gosec // Not a credential, just a naming prefix )
Variables ¶
This section is empty.
Functions ¶
func CommandDelete ¶
CommandDelete creates the 'secrets delete' command.
func CommandExists ¶
CommandExists creates the 'secrets exists' command.
func CommandExport ¶
CommandExport creates the 'secrets export' command.
func CommandGet ¶
CommandGet creates the 'secrets get' command.
func CommandImport ¶
CommandImport creates the 'secrets import' command.
func CommandList ¶
CommandList creates the 'secrets list' command.
func CommandRotate ¶
CommandRotate creates the 'secrets rotate' command.
func CommandSecrets ¶
func CommandSecrets(cliParams *settings.Run, ioStreams *terminal.IOStreams, path string) *cobra.Command
CommandSecrets creates the 'secrets' command.
func CommandSet ¶
CommandSet creates the 'secrets set' command.
func FilterSecrets ¶ added in v0.4.0
FilterSecrets filters secret names, optionally including internal secrets (scafctl.*). When includeInternal is false, internal secrets are excluded.
func FilterUserSecrets ¶
FilterUserSecrets filters out internal secrets (scafctl.*) from a list of secret names.
func IsInternalSecret ¶ added in v0.4.0
IsInternalSecret returns true if the secret name belongs to the internal namespace.
func SecretType ¶ added in v0.4.0
SecretType returns "internal" or "user" based on the secret name prefix.
func ValidateSecretName ¶ added in v0.4.0
ValidateSecretName validates a secret name, optionally allowing internal secrets. When includeInternal is false, names starting with "scafctl." are rejected.
func ValidateUserSecretName ¶
ValidateUserSecretName validates a secret name for user operations. Returns an error if the name is invalid or uses the reserved "scafctl." prefix.
Types ¶
type ExportFormat ¶
type ExportFormat struct {
Version string `json:"version" yaml:"version"`
ExportedAt string `json:"exported_at" yaml:"exported_at"`
Secrets []ExportedSecret `json:"secrets" yaml:"secrets"`
}
ExportFormat represents the format for exported secrets.
type ExportedSecret ¶
type ExportedSecret struct {
Name string `json:"name" yaml:"name"`
Value string `json:"value" yaml:"value"`
}
ExportedSecret represents a single exported secret.
Source Files