credstore 0.3.7__tar.gz

credstore-0.3.7/.gitignore

@@ -0,0 +1,232 @@
+# Credential store encrypted backup
+credentials.crypt
+
+# WeChat session files (contain auth tokens)
+wechat_*.json5
+
+# Runtime logs
+logs/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# SQLite database files (may appear anywhere in the project)
+*.db
+*.db-shm
+*.db-wal

credstore-0.3.7/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.4
+Name: credstore
+Version: 0.3.7
+Summary: Cross-platform credential storage — OS keyring with AES-encrypted file backup
+Project-URL: Homepage, https://github.com/juzcn/slife
+Project-URL: Repository, https://github.com/juzcn/slife
+Project-URL: Documentation, https://github.com/juzcn/slife/blob/main/credstore/README.md
+Author-email: juzcn <zhangjun@cueb.edu.cn>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Security
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
+Requires-Dist: keyring>=25.0.0
+Requires-Dist: keyrings-cryptfile>=1.3.0
+Description-Content-Type: text/markdown
+
+# credstore
+
+Cross-platform credential storage — OS keyring + AES-encrypted file backup.
+
+A standalone secret manager that ships with [Slife](https://github.com/juzcn/slife)
+but does **not** depend on it.  Only two lightweight dependencies: `keyring` and
+`keyrings-cryptfile`.
+
+## Install
+
+### One-click (recommended)
+
+```bash
+pip install credstore
+```
+
+Or with uv:
+
+```bash
+uv tool install credstore
+```
+
+### Verify
+
+```bash
+credstore status
+```
+
+No configuration needed — the OS keyring is used automatically.
+Run `credstore set-password` to enable encrypted backup.
+
+---
+
+## CLI
+
+### Setup (first time)
+
+```bash
+credstore set-password
+```
+
+Creates `~/.credstore/credentials.crypt` and sets a master password (dev: `./credentials.crypt`). Path configurable via `CREDSTORE_FILE` env var.
+
+### Command Reference
+
+| Command | Master key | Description |
+|---------|:----------:|-------------|
+| `set-password` | sets it | Create/change master key, init cryptfile |
+| `set KEY` | enters it | Atomic dual-write (cryptfile + keyring). Rolls back on keyring failure |
+| `get KEY` | no | Keyring only, masked output (`sk-5f…b722`) |
+| `get KEY -p` | enters it | Dual-query keyring + cryptfile, plaintext. Fails on mismatch |
+| `delete KEY` | enters it | Remove from keyring + cryptfile |
+| `list` | enters it | List all stored credential keys |
+| `inject KEY...` | no | Persist to system env: registry (Windows) or shell profile (Unix) |
+| `uninject KEY...` | no | Remove from system env: registry (Windows) or shell profile (Unix) |
+| `reset-keyring` | enters it | Restore keyring from cryptfile backup |
+| `reset-backup` | enters it | Sync system keyring → cryptfile |
+| `status` | no | Show backend status |
+
+```bash
+credstore set-password                   # first-time setup
+credstore set DEEPSEEK_API_KEY           # store (masked, atomic dual-write)
+credstore get DEEPSEEK_API_KEY           # retrieve, masked output
+credstore get DEEPSEEK_API_KEY -p        # retrieve plaintext (dual-query)
+credstore list                           # list all stored keys
+credstore delete OLD_KEY                 # delete from keyring + cryptfile
+
+# System environment injection (persistent)
+credstore inject DEEPSEEK_API_KEY        # Windows → registry, Unix → shell profile
+Invoke-Expression (credstore inject KEY) # PowerShell: activate in current shell
+eval "$(credstore inject KEY)"           # Bash/Zsh: activate in current shell
+credstore uninject DEEPSEEK_API_KEY      # remove from registry/profile
+
+credstore reset-keyring                  # restore keyring from cryptfile backup
+credstore reset-backup                   # sync keyring → cryptfile
+credstore status                         # show backend status
+```
+
+### Environment Variable Injection
+
+`inject` reads a secret from the keyring and persists it to the system
+environment.  On Windows, it writes directly to the registry (`HKCU\Environment`);
+on Unix, it appends to the shell profile.  New shells load it automatically.
+
+```bash
+# Persist + activate in current shell
+credstore inject DEEPSEEK_API_KEY        # persist to registry/profile
+Invoke-Expression (credstore inject KEY) # PowerShell: activate now
+eval "$(credstore inject KEY)"           # Bash/Zsh: activate now
+
+# Remove
+credstore uninject DEEPSEEK_API_KEY      # remove from registry/profile
+```
+
+Secret never appears on the terminal — `inject` detects TTY and prints only
+a hint.  The actual export command flows through a pipe when wrapped in
+`Invoke-Expression` / `eval`.
+
+No master password required (keyring only).
+
+### Disaster Recovery
+
+When the OS keyring loses data (e.g. after a Windows password change):
+
+```bash
+credstore reset-keyring               # restore all from cryptfile backup
+```
+
+## Design: Memory Safety
+
+Secrets are immutable Python `str` objects — they cannot be zeroed in place.
+credstore mitigates memory leaks through three design rules:
+
+| Rule | Mechanism |
+|------|-----------|
+| **Never batch-load** | `list` collects only key names. Sync comparison fetches one value at a time and immediately `del`-s it |
+| **Prefer existence checks** | `exists_credential()` / `list_credential_keys()` never retrieve secret content |
+| **Explicit cleanup** | Every CLI handler `del`-s secret references after last use. `set`, `get`, `reset`, `set-password` all clean up on every exit path — including error branches |
+
+### Operations that read/transport secrets
+
+| Operation | How memory is cleaned |
+|-----------|----------------------|
+| `get` | Caller is responsible for `del`-ing the returned value |
+| `set` | `del secret` + `del master_pw` after dual-write (all code paths) |
+| `list` | Values fetched one-at-a-time, compared, `del`-ed immediately |
+| `inject` | Value read → persisted → `del`-ed. TTY: no secret on stdout. Pipe: secret through pipe only |
+| `uninject` | No secrets involved — registry/profile cleanup only |
+| `reset-keyring` | Each value `del`-ed after writing to keyring |
+| `reset-backup` | Batch load unavoidable, `del entries` + `del master_pw` after sync |
+| `set-password` | `old_data` dict `del`-ed after re-encryption; all password strings cleaned up |
+
+The `masked_input()` terminal helper echoes `*` for each keystroke — paste works but the
+actual value is never displayed or logged.
+
+## Python API
+
+```python
+import credstore
+
+# Read / check / write / delete (system keyring only, no prompt)
+credstore.get_credential("myapp/api_key")      # → str | None
+credstore.exists_credential("myapp/api_key")   # → bool  (NEVER returns secret)
+credstore.list_credential_keys()               # → list[str]  (NEVER returns values)
+credstore.set_credential("myapp/api_key", "sk-…")
+credstore.delete_credential("myapp/api_key")   # → bool
+
+# Shell formatting (for env var injection)
+credstore.format_export("MY_KEY", "secret", "bash")   # → "export MY_KEY='secret'"
+credstore.format_unset("MY_KEY", "bash")              # → "unset MY_KEY"
+
+# keyring: URI resolution
+credstore.is_keyring_uri("keyring:myapp/k")    # → True
+credstore.resolve_uri("keyring:myapp/k")       # → the secret value
+
+# Backend info
+credstore.check_backend()       # → {"available": True, "backend": "…", …}
+credstore.is_cryptfile_ready()  # → True if master key is set
+```
+
+Memory rule: callers of `get_credential()` and `resolve_uri()` MUST `del` the
+returned value after use.  Prefer `exists_credential()` or `list_credential_keys()`
+when you only need to know whether a credential exists.
+
+The Python API talks to the system keyring only — no master password, no prompt. Dual-write (keyring + cryptfile) is handled by the CLI.

credstore-0.3.7/README.md

@@ -0,0 +1,165 @@
+# credstore
+
+Cross-platform credential storage — OS keyring + AES-encrypted file backup.
+
+A standalone secret manager that ships with [Slife](https://github.com/juzcn/slife)
+but does **not** depend on it.  Only two lightweight dependencies: `keyring` and
+`keyrings-cryptfile`.
+
+## Install
+
+### One-click (recommended)
+
+```bash
+pip install credstore
+```
+
+Or with uv:
+
+```bash
+uv tool install credstore
+```
+
+### Verify
+
+```bash
+credstore status
+```
+
+No configuration needed — the OS keyring is used automatically.
+Run `credstore set-password` to enable encrypted backup.
+
+---
+
+## CLI
+
+### Setup (first time)
+
+```bash
+credstore set-password
+```
+
+Creates `~/.credstore/credentials.crypt` and sets a master password (dev: `./credentials.crypt`). Path configurable via `CREDSTORE_FILE` env var.
+
+### Command Reference
+
+| Command | Master key | Description |
+|---------|:----------:|-------------|
+| `set-password` | sets it | Create/change master key, init cryptfile |
+| `set KEY` | enters it | Atomic dual-write (cryptfile + keyring). Rolls back on keyring failure |
+| `get KEY` | no | Keyring only, masked output (`sk-5f…b722`) |
+| `get KEY -p` | enters it | Dual-query keyring + cryptfile, plaintext. Fails on mismatch |
+| `delete KEY` | enters it | Remove from keyring + cryptfile |
+| `list` | enters it | List all stored credential keys |
+| `inject KEY...` | no | Persist to system env: registry (Windows) or shell profile (Unix) |
+| `uninject KEY...` | no | Remove from system env: registry (Windows) or shell profile (Unix) |
+| `reset-keyring` | enters it | Restore keyring from cryptfile backup |
+| `reset-backup` | enters it | Sync system keyring → cryptfile |
+| `status` | no | Show backend status |
+
+```bash
+credstore set-password                   # first-time setup
+credstore set DEEPSEEK_API_KEY           # store (masked, atomic dual-write)
+credstore get DEEPSEEK_API_KEY           # retrieve, masked output
+credstore get DEEPSEEK_API_KEY -p        # retrieve plaintext (dual-query)
+credstore list                           # list all stored keys
+credstore delete OLD_KEY                 # delete from keyring + cryptfile
+
+# System environment injection (persistent)
+credstore inject DEEPSEEK_API_KEY        # Windows → registry, Unix → shell profile
+Invoke-Expression (credstore inject KEY) # PowerShell: activate in current shell
+eval "$(credstore inject KEY)"           # Bash/Zsh: activate in current shell
+credstore uninject DEEPSEEK_API_KEY      # remove from registry/profile
+
+credstore reset-keyring                  # restore keyring from cryptfile backup
+credstore reset-backup                   # sync keyring → cryptfile
+credstore status                         # show backend status
+```
+
+### Environment Variable Injection
+
+`inject` reads a secret from the keyring and persists it to the system
+environment.  On Windows, it writes directly to the registry (`HKCU\Environment`);
+on Unix, it appends to the shell profile.  New shells load it automatically.
+
+```bash
+# Persist + activate in current shell
+credstore inject DEEPSEEK_API_KEY        # persist to registry/profile
+Invoke-Expression (credstore inject KEY) # PowerShell: activate now
+eval "$(credstore inject KEY)"           # Bash/Zsh: activate now
+
+# Remove
+credstore uninject DEEPSEEK_API_KEY      # remove from registry/profile
+```
+
+Secret never appears on the terminal — `inject` detects TTY and prints only
+a hint.  The actual export command flows through a pipe when wrapped in
+`Invoke-Expression` / `eval`.
+
+No master password required (keyring only).
+
+### Disaster Recovery
+
+When the OS keyring loses data (e.g. after a Windows password change):
+
+```bash
+credstore reset-keyring               # restore all from cryptfile backup
+```
+
+## Design: Memory Safety
+
+Secrets are immutable Python `str` objects — they cannot be zeroed in place.
+credstore mitigates memory leaks through three design rules:
+
+| Rule | Mechanism |
+|------|-----------|
+| **Never batch-load** | `list` collects only key names. Sync comparison fetches one value at a time and immediately `del`-s it |
+| **Prefer existence checks** | `exists_credential()` / `list_credential_keys()` never retrieve secret content |
+| **Explicit cleanup** | Every CLI handler `del`-s secret references after last use. `set`, `get`, `reset`, `set-password` all clean up on every exit path — including error branches |
+
+### Operations that read/transport secrets
+
+| Operation | How memory is cleaned |
+|-----------|----------------------|
+| `get` | Caller is responsible for `del`-ing the returned value |
+| `set` | `del secret` + `del master_pw` after dual-write (all code paths) |
+| `list` | Values fetched one-at-a-time, compared, `del`-ed immediately |
+| `inject` | Value read → persisted → `del`-ed. TTY: no secret on stdout. Pipe: secret through pipe only |
+| `uninject` | No secrets involved — registry/profile cleanup only |
+| `reset-keyring` | Each value `del`-ed after writing to keyring |
+| `reset-backup` | Batch load unavoidable, `del entries` + `del master_pw` after sync |
+| `set-password` | `old_data` dict `del`-ed after re-encryption; all password strings cleaned up |
+
+The `masked_input()` terminal helper echoes `*` for each keystroke — paste works but the
+actual value is never displayed or logged.
+
+## Python API
+
+```python
+import credstore
+
+# Read / check / write / delete (system keyring only, no prompt)
+credstore.get_credential("myapp/api_key")      # → str | None
+credstore.exists_credential("myapp/api_key")   # → bool  (NEVER returns secret)
+credstore.list_credential_keys()               # → list[str]  (NEVER returns values)
+credstore.set_credential("myapp/api_key", "sk-…")
+credstore.delete_credential("myapp/api_key")   # → bool
+
+# Shell formatting (for env var injection)
+credstore.format_export("MY_KEY", "secret", "bash")   # → "export MY_KEY='secret'"
+credstore.format_unset("MY_KEY", "bash")              # → "unset MY_KEY"
+
+# keyring: URI resolution
+credstore.is_keyring_uri("keyring:myapp/k")    # → True
+credstore.resolve_uri("keyring:myapp/k")       # → the secret value
+
+# Backend info
+credstore.check_backend()       # → {"available": True, "backend": "…", …}
+credstore.is_cryptfile_ready()  # → True if master key is set
+```
+
+Memory rule: callers of `get_credential()` and `resolve_uri()` MUST `del` the
+returned value after use.  Prefer `exists_credential()` or `list_credential_keys()`
+when you only need to know whether a credential exists.
+
+The Python API talks to the system keyring only — no master password, no prompt. Dual-write (keyring + cryptfile) is handled by the CLI.

credstore-0.3.7/config.json5

@@ -0,0 +1,10 @@
+{
+  // credstore configuration.
+  // Lookup order: ./credstore.json5 → ~/.credstore/config.json5
+  // Env var CREDSTORE_FILE overrides both.
+  //
+  // If no config is found, defaults to ~/.credstore/credentials.crypt
+
+  // Custom path for the encrypted credential file:
+  // cryptfile_path: "~/.credstore/credentials.crypt",
+}

credstore-0.3.7/credstore/__init__.py

@@ -0,0 +1,75 @@
+"""credstore — secure credential storage via OS keyring.
+
+Cross-platform API for retrieving secrets stored in the OS keyring
+with keyrings.cryptfile encrypted backup.  Secrets are *stored* only
+via the CLI (``credstore set``) which reads from masked stdin — never
+through Python function arguments.
+
+Modules::
+
+    _store.py        CredentialStore + module-level API
+    _shell.py        Shell formatting helpers
+    _backend.py      Dual-write backends (system keyring + cryptfile)
+    _enumerate.py    Platform-specific credential enumeration
+    _config.py       Config file loading
+    _resolver.py     keyring: URI resolution
+    _tty.py          Masked terminal input
+    __main__.py      CLI (entry point)
+
+Usage::
+
+    import credstore
+
+    # Retrieve a secret
+    value = credstore.get_credential("myapp/api_key")
+
+    # Resolve keyring: URIs in config values
+    resolved = credstore.resolve_uri("keyring:myapp/api_key")
+
+    # Delete
+    credstore.delete_credential("myapp/api_key")
+
+    # Shell formatting
+    credstore.format_export("KEY", "value", "bash")  # → export statement
+
+    # Check backend
+    info = credstore.check_backend()
+"""
+
+from credstore._shell import format_export, format_unset
+from credstore._store import (
+    get_credential,
+    exists_credential,
+    list_credential_keys,
+    set_credential,
+    delete_credential,
+    get_backend_name,
+    check_backend,
+    init_store,
+)
+from credstore._resolver import (
+    resolve_uri,
+    is_keyring_uri,
+    parse_keyring_uri,
+)
+
+__all__ = [
+    # Read / write / delete
+    "get_credential",
+    "exists_credential",
+    "list_credential_keys",
+    "set_credential",
+    "delete_credential",
+    # URI resolution
+    "is_keyring_uri",
+    "parse_keyring_uri",
+    "resolve_uri",
+    # Shell formatting
+    "format_export",
+    "format_unset",
+    # Diagnostics
+    "get_backend_name",
+    "check_backend",
+    "init_store",
+]
+__version__ = "0.3.6"