README
¶
Base64 Secret Source (base64://)
The Base64 secret source allows you to embed secrets directly into the URI by encoding them in Base64 format. This is primarily useful for testing, configuration injection (where secrets are passed as env vars or flags), or when you want to use spelunk uniformly even for static values.
Status
Built-in: This source is included and enabled by default in spelunk.
Usage
To use the Base64 source, prefix your base64-encoded secret string with base64://.
Syntax
base64://<base64_encoded_string>
- Type:
base64 - Location: The Base64-encoded string itself.
Example
Suppose you want to provide the secret "mysecretpassword".
-
Encode the secret:
echo -n "mysecretpassword" | base64 # Output: bXlzZWNyZXRwYXNzd29yZA== -
Construct the URI:
base64://bXlzZWNyZXRwYXNzd29yZA==
When spelunk processes this URI, it will return the original string: mysecretpassword.
Behavior
- Decoding: The source uses standard Base64 decoding (RFC 4648).
- Validation: If the provided string is not valid Base64,
DigUpwill return an error (ErrSecretSourceBase64FailedDecoding). - Result: Returns the decoded byte slice converted to a string.
Use Cases
- Testing: Quickly verify that your application correctly handles secret retrieval without needing external dependencies like files or Kubernetes.
- Fallback: Provide a default value directly in configuration if a more secure source is unavailable.
- Static Configuration: Embed non-sensitive "secrets" directly in code or config files while maintaining a consistent
spelunkinterface.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrSecretSourceBase64FailedDecoding = fmt.Errorf("failed to decode base64 secret")
Functions ¶
This section is empty.
Types ¶
type SecretSourceBase64 ¶
type SecretSourceBase64 struct{}
SecretSourceBase64 digs up secrets that are base64-encoded in the URI-coordinates. The URI scheme for this source is "base64".
base64://BASE64_ENCODED_SECRET
This types.SecretSource is built-in to spelunker.Spelunker.
func (*SecretSourceBase64) DigUp ¶
func (s *SecretSourceBase64) DigUp(_ context.Context, coord types.SecretCoord) (string, error)
func (*SecretSourceBase64) Type ¶
func (s *SecretSourceBase64) Type() string
Source Files