aisecuritywarden 0.7.0__tar.gz

aisecuritywarden-0.7.0/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]   # the client must work on Linux, Windows and macOS
+        python: ["3.10", "3.12", "3.13"]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - run: pip install -e ".[dev]"
+      - run: pytest -q
+      - name: Installed commands start, and swadmin has a usable Tk (8.6+)
+        shell: bash
+        run: |
+          swctl --version
+          sw-mcp --help > /dev/null
+          python -c "import tkinter, securitywarden.client.gui; assert tkinter.TkVersion >= 8.6, tkinter.TkVersion; print('Tk', tkinter.TkVersion)"
+
+  wheel:
+    needs: [test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build && python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*

aisecuritywarden-0.7.0/.github/workflows/release.yml

@@ -0,0 +1,58 @@
+# Publishes the client to PyPI as "aisecuritywarden" when a version tag (v0.7.0, ...) is pushed.
+# Uses PyPI trusted publishing: no password or token is stored anywhere. One-time setup on pypi.org:
+# Your account -> Publishing -> add a (pending) publisher: project aisecuritywarden, owner SoftDevEng,
+# repository aiSecurityWarden-client, workflow release.yml, environment pypi. And a "pypi" environment here
+# (Settings -> Environments), optionally with required reviewers so each upload waits for a click.
+# PyPI never lets a version's files be replaced: a mistake means a new version.
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: The tag matches the version
+        run: |
+          v=$(python -c "import re; print(re.search(r'__version__ = \"([^\"]+)\"', open('src/securitywarden/__init__.py').read())[1])")
+          if [ "v$v" != "$GITHUB_REF_NAME" ]; then echo "tag $GITHUB_REF_NAME doesn't match __version__ $v"; exit 1; fi
+      - name: Test
+        run: |
+          python -m pip install -e ".[dev]"
+          python -m pytest -q
+      - name: Build
+        run: |
+          python -m pip install build
+          python -m build
+          ls -l dist
+      - name: The built wheel installs and runs
+        run: |
+          python -m venv /tmp/check
+          /tmp/check/bin/pip install dist/*.whl
+          cd /tmp && /tmp/check/bin/sw-mcp --version && /tmp/check/bin/swctl --version
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write        # trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

aisecuritywarden-0.7.0/.gitignore

@@ -0,0 +1,13 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+
+# never commit credentials
+*.cred
+token
+.env

aisecuritywarden-0.7.0/CLAUDE.md

@@ -0,0 +1,52 @@
+# CLAUDE.md — aiSecurityWarden client
+
+The open-source (Apache-2.0) client for aiSecurityWarden: scoped machine tokens and end-to-end encryption.
+Primary consumer: Hermes Agent via its command-helper secret source (`swctl export`).
+Must run on Linux and Windows. The server is a separate, private repository (`aiSecurityWarden-server`),
+which depends on this package for its crypto and parsers.
+
+## Layout
+
+- `src/securitywarden/crypto.py`: **all** crypto and the credential format. Keep it the only place crypto lives
+  (including approval capabilities, nonces, their lookup hashes and match codes, and account key derivation).
+- `src/securitywarden/approval.py`, `ipallow.py`: strict parsers for approval policies and per-token address
+  lists, shared with the server. `account.py`: email and password rules shared with the server and web front end.
+- `src/securitywarden/client/`: `SecurityWardenClient` (`api.py`), the `swctl` CLI (`cli.py`) and the `swadmin`
+  Tkinter window (`gui.py`; no crypto of its own, never persists credentials).
+- `src/securitywarden/vectors.py`: builds the crypto test vectors (`tests/vectors/crypto-v1.json`) every other
+  implementation is checked against (the server repo's browser crypto keeps a copy).
+- `docs/DESIGN.md` is the source of truth for the protocol. Update it with any protocol change.
+
+## Commands
+
+```bash
+pip install -e ".[dev]" && pytest -q
+python -m securitywarden.vectors      # after any change to crypto.py, approval.py or account.py;
+                                      # then update the copy in the server repo (tests/vectors/) and its web crypto
+```
+
+Tests that need a running server (end-to-end, swctl, swadmin, approvals) live in the server repo, which installs
+this package; run them there before releasing a change here.
+
+## Invariants (do not break)
+
+1. The client never sends a credential's `key` part, a project key, an account key, a password or a password-
+   derived key, or plaintext secret names/values to the server.
+2. Every ciphertext is AES-256-GCM with AAD binding it to its context (see DESIGN.md). Don't add encryption
+   without AAD.
+3. No custom crypto primitives. Only `cryptography` (AES-GCM, HKDF, HMAC, PBKDF2).
+4. Secret values are never accepted on the command line (argv). Use a prompt or stdin.
+5. `Credential.__repr__` must never include `secret` or `key`. Don't log credentials, JWTs or session tokens.
+6. The client refuses plain `http://` to non-local hosts unless `SW_ALLOW_HTTP=1`.
+7. Any wire/format change bumps the `sw1` / `v1.` version prefixes instead of silently changing them.
+8. `tests/vectors/crypto-v1.json` changes only by regenerating it; other implementations must then match.
+
+## Conventions
+
+- Python ≥ 3.10, standard library first; keep dependencies minimal (`cryptography`, `httpx`).
+- Tests for every security property you add (negative tests matter most).
+- Releases are tagged `vX.Y.Z[.devN]`; the server pins a tag. A `v*` tag publishes to PyPI as `aisecuritywarden`
+  (`.github/workflows/release.yml`, trusted publishing); the tag must equal `__version__`. PyPI files can't be
+  replaced: a mistake means a new version.
+- Installs as `aisecuritywarden` (PyPI), imports as `securitywarden`. User-facing text says "aiSecurityWarden". The
+  `securitywarden/v1/...` labels in crypto.py and the config folders never change (existing data depends on them).

aisecuritywarden-0.7.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

aisecuritywarden-0.7.0/PKG-INFO

@@ -0,0 +1,276 @@
+Metadata-Version: 2.5
+Name: aisecuritywarden
+Version: 0.7.0
+Summary: aiSecurityWarden client: scoped, revocable machine tokens, end-to-end encrypted secrets and human approval for AI agents.
+Project-URL: Homepage, https://github.com/SoftDevEng/aiSecurityWarden-client
+Project-URL: Issues, https://github.com/SoftDevEng/aiSecurityWarden-client/issues
+Author: SoftDevEng
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-agents,aisecuritywarden,end-to-end-encryption,hermes-agent,machine-tokens,mcp,secrets,secrets-manager,vault
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Security :: Cryptography
+Requires-Python: >=3.10
+Requires-Dist: cryptography>=42
+Requires-Dist: httpx>=0.27
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# aiSecurityWarden client
+
+The open-source client for **aiSecurityWarden**, a secrets service with **scoped, revocable machine tokens**
+and **end-to-end encryption**. Built so AI agents (like [Hermes Agent](https://hermes-agent.nousresearch.com))
+and other unattended services can fetch API keys at startup without ever storing those keys on disk.
+
+All encryption and decryption happens here, in the client. The server only ever receives ciphertext,
+proofs it keeps only as Argon2id hashes, and wrapped keys, so you can check what leaves your machine by
+reading this code.
+
+This repository contains:
+
+- the Python client library (`securitywarden.client.SecurityWardenClient`);
+- `swctl`, the command-line tool (machines: `swctl export` / `swctl run`; admins: `swctl admin ...`);
+- `swadmin`, a small desktop admin window;
+- the cryptography (`src/securitywarden/crypto.py`), the approval-policy and address-list parsers, and the
+  shared test vectors other implementations are checked against;
+- the protocol and design document: [docs/DESIGN.md](docs/DESIGN.md).
+
+The aiSecurityWarden server is a separate product.
+
+> **Status: alpha.** The design is deliberately small and reviewable, but it has not had an independent
+> security audit. Read the [threat model](#threat-model).
+
+## How it works
+
+```
+ Admin workstation                 aiSecurityWarden server                Agent box (e.g. jarvis)
+ ─────────────────                 ─────────────────────                ───────────────────────
+ swctl admin ...                   stores only:                         sw1.m.<id>.<secret>:<key>
+  • creates project key  ───────▶   • ciphertext                        (chmod 600 file)
+  • encrypts secrets                • Argon2 hashes                            │
+  • wraps project key               • wrapped keys          ◀── id+secret ─────┤  1. auth → 5-min JWT
+    per machine token               • audit log             ─── ciphertext ──▶ │  2. fetch
+                                                                               │  3. decrypt locally with <key>
+                                                                               ▼
+                                                                    KEY=VALUE → agent env → tools
+```
+
+A machine token has three parts:
+
+| Part     | Sent to server? | Purpose |
+|----------|-----------------|---------|
+| `id`     | yes             | identifies the token |
+| `secret` | yes (over TLS)  | proves possession; server keeps only an Argon2id hash |
+| `key`    | **never**       | unwraps the project key, which decrypts the secrets |
+
+So the server can authenticate a token and hand out ciphertext, but it **cannot
+read any secret**. A full copy of the server's database is useless without a token key.
+
+## Threat model
+
+**Protects against**
+- Secrets at rest on agent machines: only a token sits on disk, not your API keys.
+  Backups, copied dotfiles and logs leak a token you can revoke in one command.
+- Server compromise: the database holds only AES-256-GCM ciphertext, Argon2 hashes and
+  wrapped keys. Ciphertext is bound to its project, token and name (AAD), so a
+  malicious server can't swap blobs around either.
+- Over-broad access: each token is read-only and scoped to one project.
+- Stale credentials: tokens can expire; revocation takes effect on the next request
+  (access JWTs are re-checked against the database every time).
+- Brute force: Argon2id hashing, per-IP and per-token failure rate limiting, and the
+  same timing for unknown token ids.
+
+**Does not protect against**
+- An attacker who already controls the agent machine while it's running. They can read the
+  token file, or read the decrypted secrets from the process memory or environment.
+  No secrets manager can prevent that.
+- Losing the admin credential. Project keys are wrapped under it; without it the
+  secrets can't be recovered (by design). Keep it in your password manager.
+- A server operator who swaps in malicious *client* code. Install `swctl` from a source you trust.
+
+## Install
+
+```bash
+pipx install aisecuritywarden     # or: pip install aisecuritywarden (in a virtual environment)
+```
+
+It installs the commands `swctl`, `sw-mcp` and `swadmin`. In Python code (connectors) the package is imported as
+`securitywarden`, e.g. `from securitywarden.mcp import Connector`.
+
+**Coming from 0.6 (installed as `securitywarden`)?** Reinstall once under the new name; your tokens and settings
+stay where they are:
+
+```bash
+pip uninstall securitywarden && pip install aisecuritywarden     # same environment as before
+```
+
+Needs Python 3.10+, on Linux, Windows or macOS (all three are tested in CI). `swadmin` also needs Tkinter:
+it ships with the python.org installers for Windows and macOS; on Debian/Ubuntu, `sudo apt install python3-tk`.
+
+### macOS
+
+1. Install Python from [python.org](https://www.python.org/downloads/macos/) (3.10 or newer). Its installer
+   includes a current Tk, so `swadmin` works. Avoid Apple's built-in `/usr/bin/python3`: its Tk is old and
+   draws windows badly. With Homebrew's Python, also run `brew install python-tk`.
+2. Install the client in its own virtual environment:
+
+   ```bash
+   python3 -m venv ~/.venvs/securitywarden
+   ~/.venvs/securitywarden/bin/pip install aisecuritywarden
+   ~/.venvs/securitywarden/bin/swadmin          # the admin window; swctl and sw-mcp are next to it
+   ```
+
+3. Files live where they do on Linux: `~/.config/securitywarden/` (tokens, the admin credential file if you use
+   one, swctl's cached 2FA session), each readable by you only.
+
+The website works in Safari too (CI runs it in WebKit, Safari's engine).
+
+### Updating
+
+```bash
+sw-mcp update --check     # or: swctl update --check
+sw-mcp update             # installs the newest signed release; never an older one
+```
+
+Or ask your agent: "check for aiSecurityWarden updates" / "update aiSecurityWarden". The agent's
+`securitywarden_update` tool asks you to approve the exact version first. Restart the agent app afterwards. When a
+newer client is out, the agent is told once (and every time if the server requires it). Updates are signed with
+an offline release key and checked against the key built into the client; see DESIGN.md "Client updates".
+
+From source:
+
+```bash
+git clone https://github.com/SoftDevEng/aiSecurityWarden-client && cd aiSecurityWarden-client
+pip install -e ".[dev]" && pytest
+```
+
+## Quick start
+
+You need the address of an aiSecurityWarden server and, to administer it, its admin credential.
+
+### 1. Admin (from your workstation)
+
+```bash
+mkdir -p ~/.config/securitywarden
+echo 'sw1.a....' > ~/.config/securitywarden/admin.cred && chmod 600 ~/.config/securitywarden/admin.cred
+export SW_SERVER_URL=https://vault.example.com
+
+swctl admin project create hermes-webull
+swctl admin secret set hermes-webull WEBULL_APP_KEY       # prompts; value never in argv/history
+swctl admin secret set hermes-webull WEBULL_APP_SECRET
+swctl admin token create hermes-webull --name jarvis --expires-days 180
+```
+
+### 2. Machine
+
+```bash
+export SW_SERVER_URL=https://vault.example.com SW_TOKEN_ID=<token id> SW_TOKEN_NAME=jarvis
+swctl setup                       # paste the one-time setup code the website (or --setup-code) shows
+
+swctl export                      # KEY=VALUE lines
+swctl export --format json
+swctl run -- python my_bot.py     # run a command with secrets in its environment
+```
+
+### Hermes Agent integration
+
+Hermes supports custom vaults through a **command helper** that prints `KEY=VALUE`
+lines at launch. That's exactly what `swctl export` does. See
+[examples/hermes/](examples/hermes/) for a wrapper script and config.
+
+### AI agent tools with approval (`sw-mcp`)
+
+`sw-mcp` gives an agent tools for an application, such as Gmail, as an MCP server. Every action goes through
+the token's rules in aiSecurityWarden: reading may be allowed outright, while sending an email waits until you
+approve exactly that email (on the website, in swadmin, Telegram or ntfy). The agent is told it's waiting and
+checks back. See [docs/mcp-gmail.md](docs/mcp-gmail.md) for the Gmail set-up with Hermes, and
+[DESIGN.md](docs/DESIGN.md#mcp-connectors) for writing a connector for another application.
+
+```bash
+sw-mcp tools --connector gmail          # the tools, their actions, risks and suggested rules
+sw-mcp serve --connector gmail          # what Hermes runs (stdio)
+sw-mcp call gmail_search query=is:unread limit=5   # try one tool by hand; waits for approval if needed
+sw-mcp setup --token-file ~/.config/securitywarden/gmail-token   # store the token from a one-time setup code
+```
+
+Other applications get a **connector**: one Python class whose tools each declare an action and a risk. An AI can
+write one: `sw-mcp new-connector NAME` creates the project (with instructions for the AI in `AGENTS.md`),
+`sw-mcp guide` prints the rules, and `sw-mcp check` plus the generated tests confirm it's right. Installed
+connector packages are found by name (`--connector NAME`). See [docs/connectors.md](docs/connectors.md).
+
+Connectors can also come from aiSecurityWarden itself: turn a built-in one (Gmail) on for a project on the website,
+or upload your own (`sw-mcp pack NAME`, then **Connectors > Upload**; encrypted in the browser, account-wide,
+versioned with a backup of the version replaced). `sw-mcp serve` then loads whatever the token's project uses,
+with no `--connector` needed, and picks up new versions as you choose: at once, or on the next restart.
+
+## Admin commands
+
+| Command | |
+|---|---|
+| `swctl admin project create|list|delete NAME` | manage projects |
+| `swctl admin secret set|get|delete PROJECT NAME` | values read from a prompt or stdin |
+| `swctl admin secret list PROJECT` | names only |
+| `swctl admin token create PROJECT --name N [--expires-days D] [--allow-ip ADDR]...` | prints the token once; `--allow-ip` (address or CIDR, repeatable) pins where it may connect from |
+| `swctl admin token set-ips ID --allow-ip ADDR... \| --any` | replace or remove a token's allowed addresses |
+| `swctl admin token list [PROJECT]` | status, expiry, last used, last IP, allowed addresses, approval |
+| `swctl admin token create ... --approval session\|every_fetch [--session-ttl 8h] [--channel C]...` | require a person to approve the token's use (see below) |
+| `swctl admin token set-approval ID --approval none\|session\|every_fetch [...]` | change or remove it; ends pending requests and approved sessions |
+| `swctl admin token reset-approval-limits ID` | let a token that hit its hourly limit ask again now (also in swadmin: **Reset approval limit…**) |
+| `swctl admin approvals list` / `approve ID [--match NN]` / `deny ID` | decide pending requests |
+| `swctl admin token revoke ID` | immediate |
+| `swctl admin audit [--limit N]` | auth, fetch and admin events |
+
+### Human approval
+
+A machine token can require a person to approve it before it gets any secrets: once per
+session (`--approval session`, the session lasts `--session-ttl`, default 8 h) or for
+every fetch (`--approval every_fetch`). Requests go to the channels you choose:
+
+- `admin_ui`: the Approvals tab in `swadmin` (or `swctl admin approvals`);
+- `push:telegram` and `push:ntfy`: a phone notification with Approve / Deny buttons.
+  These work behind an IIS/firewall allowlist, because the server polls Telegram / ntfy
+  for the answer instead of the phone calling in. They are set up on the server, per project
+  (the project's **Approval setup** tab in the web admin).
+
+```bash
+swctl admin token set-approval <token-id> --approval session --session-ttl 8h \
+      --channel admin_ui --channel push:telegram
+```
+
+The machine prints a two-digit **match code** while it waits (`swctl: waiting for a person
+to approve this session (match code 47, up to 120 s)...`); approve only if the prompt shows
+the same code. An approval works once, only for the process and address that asked, and
+ends when the token is revoked or its policy changes. Details: [docs/DESIGN.md](docs/DESIGN.md#human-approval).
+
+### Admin window (`swadmin`)
+
+If you would rather not use a terminal, `swadmin` opens a small desktop window that does
+the same things as `swctl admin`: projects, secrets, tokens (create, revoke, allowed
+addresses, approval policy), pending approval requests and the activity log. The Approvals
+tab checks for new requests every few seconds while you are signed in. It is installed with the client and needs only Tkinter,
+which ships with Python on Windows and macOS (`sudo apt install python3-tk` on Debian/Ubuntu).
+
+- The admin credential and secret values are pasted into the window and held in memory
+  only: nothing reaches argv, the environment or shell history. Only the server address is
+  remembered between runs.
+- Encryption still happens on your machine, in the same code `swctl` uses.
+- New tokens and revealed values are shown once with a Copy button; the clipboard is
+  cleared after a minute. The window signs out after 15 minutes without input.
+
+## Cryptography
+
+All of it lives in [`src/securitywarden/crypto.py`](src/securitywarden/crypto.py): AES-256-GCM (random
+96-bit nonces) with associated data binding every ciphertext to its context, HKDF-SHA256 for key separation,
+HMAC-SHA256 for secret-name lookup ids (names are encrypted too) and PBKDF2-SHA256 for account passwords,
+all from the `cryptography` library. There's no custom crypto. The server stores Argon2id hashes of the
+proofs clients send. Test vectors: [`tests/vectors/crypto-v1.json`](tests/vectors/crypto-v1.json)
+(regenerate with `python -m securitywarden.vectors`). Full design: [docs/DESIGN.md](docs/DESIGN.md).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE). Security reports: see [SECURITY.md](SECURITY.md).