README
¶
Plain Text Secret Source (plain://)
The Plain Text secret source treats the URI location itself as the secret value. It returns exactly what you put in the authority and path of the URI.
Status
Built-in: This source is included and enabled by default in spelunk.
Usage
To use the Plain Text source, use the plain:// scheme followed by your secret string.
Syntax
plain://<SECRET_VALUE>
- Type:
plain - Location: The string value to return.
Example
To provide the string "my-secret-token":
plain://my-secret-token
Note: Since the "Location" in spelunk coordinates includes both the URI authority (host/userinfo) and path, you can include slashes:
plain://path/to/my/secret
This will return path/to/my/secret.
Behavior
- Passthrough: This source simply returns the
Locationpart of theSecretCoordstruct. - No Decoding: Unlike
base64://, this source performs no decoding. The value is used as-is.
Use Cases
- Development: Hardcoding non-sensitive values during local development without changing the
spelunkinterface. - Testing: verifying that your application's secret wiring works correctly with a known, static string.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SecretSourcePlain ¶
type SecretSourcePlain struct{}
SecretSourcePlain digs up secrets that can be found with URI-coordinates in the format:
plain://MY_SECRET_VALUE
This types.SecretSource is built-in to spelunker.Spelunker.
Note that `MY_SECRET` can also be in the form `MY/SECRET_VALUE` or `MY/SECRET/VALUE`: the whole combination of URI _authority_ and _path_ is returned.
func (*SecretSourcePlain) DigUp ¶
func (s *SecretSourcePlain) DigUp(_ context.Context, coord types.SecretCoord) (string, error)
func (*SecretSourcePlain) Type ¶
func (s *SecretSourcePlain) Type() string
Source Files