Compare commits
No commits in common. "2b1d4366d41206c52aef6573a84be2763d9ea62b" and "5fb4191818a891ce8289ac6eb87d2e6f949f07bf" have entirely different histories.
2b1d4366d4
...
5fb4191818
|
@ -18,9 +18,7 @@ Secret loading order:
|
|||
0. Hardcoded values. **This is purely for debugging, prototyping, and for
|
||||
configuring below options.**
|
||||
1. Files pointed to by environment variables. Docker friendly.
|
||||
2. Secrets folder. Also Docker friendly. Defaults to `secrets`, but can be
|
||||
configured through the `SECRETS_DIRECTORY` key (NOTE: passed directly,
|
||||
rather than through a file.)
|
||||
2. Secrets folder. Also Docker friendly.
|
||||
3. [Pass: the standard unix password
|
||||
manager](https://www.passwordstore.org/). Most suited for personal
|
||||
usage; very unsuited for server environments. Requires `pass` installed
|
||||
|
@ -46,7 +44,6 @@ Secret loading order:
|
|||
- [ ] Vault:
|
||||
* [ ] Ensure vault code path works.
|
||||
* [ ] Document usage and requirements.
|
||||
- [ ] Get inspiration from <https://cheatsheetseries.owasp.org/cheatsheets/Secrets_Management_Cheat_Sheet.html>
|
||||
"""
|
||||
|
||||
import logging
|
||||
|
@ -63,15 +60,14 @@ logger = logging.getLogger(__name__)
|
|||
logger.setLevel(logging.INFO)
|
||||
|
||||
ENV_KEY_PREFIX = 'ENV_KEY_PREFIX'
|
||||
ENV_KEY_SECRETS_DIRECTORY = 'SECRETS_DIRECTORY'
|
||||
|
||||
ENV_KEY_VAULT_URL = 'VAULT_URL'
|
||||
ENV_KEY_VAULT_TOKEN = 'VAULT_TOKEN' #noqa: S105
|
||||
ENV_KEY_VAULT_TOKEN = 'VAULT_TOKEN'
|
||||
ENV_KEY_VAULT_MOUNT_POINT = 'VAULT_MOUNT_POINT'
|
||||
|
||||
ENV_KEY_PASS_FOLDER = 'PASS_STORE_SUBFOLDER' #noqa: S105
|
||||
ENV_KEY_PASS_FOLDER = 'PASS_STORE_SUBFOLDER'
|
||||
|
||||
DEFAULT_SECRETS_DIRECTORY = Path('secrets')
|
||||
DEFAULT_SECRETS_DIRECTORY = Path('./secrets/')
|
||||
|
||||
ERROR_MESSAGE_FORMAT = """Failed to load secret with key: \033[1m{secret_name}\033[0m
|
||||
|
||||
|
@ -112,7 +108,6 @@ class SecretLoader:
|
|||
self.pass_folder = None
|
||||
self.vault_client = None
|
||||
self.env_key_prefix = None
|
||||
self.secret_folder = None
|
||||
|
||||
# Setup environment
|
||||
self.env_key_prefix = self._load_or_none(ENV_KEY_PREFIX)
|
||||
|
@ -124,9 +119,6 @@ class SecretLoader:
|
|||
'_',
|
||||
), 'Prefix must not end with _ (this will be added automatically)'
|
||||
|
||||
# Setup secrets path
|
||||
self.secret_folder = Path(self.hardcoded.get(ENV_KEY_SECRETS_DIRECTORY) or self._load_or_none_env(ENV_KEY_SECRETS_DIRECTORY) or DEFAULT_SECRETS_DIRECTORY)
|
||||
|
||||
# Setup pass
|
||||
self.pass_folder = self._load_or_none(ENV_KEY_PASS_FOLDER)
|
||||
|
||||
|
@ -179,13 +171,12 @@ class SecretLoader:
|
|||
Returns `None` if the secret is not present in either the environment
|
||||
or the directory.
|
||||
"""
|
||||
filepath: Path | str | None = self._load_or_none_env(secret_name)
|
||||
filepath: Path | str | None = os.environ.get(
|
||||
f'{self.env_key_prefix}_{secret_name.upper()}',
|
||||
)
|
||||
|
||||
if filepath is None:
|
||||
if self.secret_folder is not None:
|
||||
filepath = self.secret_folder / secret_name.lower()
|
||||
else:
|
||||
return None
|
||||
filepath = DEFAULT_SECRETS_DIRECTORY / secret_name.lower()
|
||||
|
||||
try:
|
||||
with open(filepath) as f:
|
||||
|
@ -193,9 +184,6 @@ class SecretLoader:
|
|||
except FileNotFoundError:
|
||||
return None
|
||||
|
||||
def _load_or_none_env(self, secret_name) -> str | None:
|
||||
return os.environ.get(f'{self.env_key_prefix}_{secret_name.upper()}')
|
||||
|
||||
def _load_or_none_local_password_store(self, secret_name: str) -> str | None:
|
||||
"""Load secret from the `pass` password manager.
|
||||
|
||||
|
|
|
@ -1 +0,0 @@
|
|||
HELLO SECRET
|
|
@ -7,11 +7,6 @@ def test_hardcoded():
|
|||
assert loader.load('KEY') == 'VALUE'
|
||||
|
||||
|
||||
def test_lookup_secrets_dir():
|
||||
loader = secret_loader.SecretLoader(SECRETS_DIRECTORY='test/example-secrets')
|
||||
assert loader.load('MY_SECRET') == 'HELLO SECRET'
|
||||
|
||||
|
||||
def test_lookup_unknown():
|
||||
loader = secret_loader.SecretLoader()
|
||||
assert loader.load('UNKNOWN') is None
|
||||
|
|
Loading…
Reference in New Issue
Block a user