bastionguard 0.1.0__tar.gz

bastionguard-0.1.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.

bastionguard-0.1.0/PKG-INFO

@@ -0,0 +1,300 @@
+Metadata-Version: 2.4
+Name: bastionguard
+Version: 0.1.0
+Summary: Runtime policy enforcement for AI agent tool calls — block, approve, or log unsafe actions before they execute.
+Author-email: Rayaan Sheikh <rayaansheikh442@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/rayaan2003/bastion
+Project-URL: Repository, https://github.com/rayaan2003/bastion
+Project-URL: Issues, https://github.com/rayaan2003/bastion/issues
+Project-URL: Changelog, https://github.com/rayaan2003/bastion/blob/master/CHANGELOG.md
+Keywords: ai-safety,ai-agents,llm,guardrails,langgraph,security,compliance
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: claude-agent-sdk
+Requires-Dist: claude-agent-sdk>=0.1; extra == "claude-agent-sdk"
+Provides-Extra: langgraph
+Requires-Dist: langchain-core>=0.3; extra == "langgraph"
+Requires-Dist: langgraph>=0.2; extra == "langgraph"
+Provides-Extra: openai-agents
+Requires-Dist: openai-agents>=0.1; extra == "openai-agents"
+Provides-Extra: slack
+Requires-Dist: slack_sdk>=3.27; extra == "slack"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: mypy>=1.11; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+<img width="100%" src="https://capsule-render.vercel.app/api?type=waving&color=0:1a1a2e,100:16213e&height=200&section=header&text=bastion&fontSize=70&fontColor=ffffff&desc=A%20firewall%20for%20what%20your%20AI%20agents%20are%20allowed%20to%20do&descSize=18&descAlignY=62&animation=fadeIn" alt="bastion"/>
+
+<img src="https://readme-typing-svg.demolab.com/?font=Fira+Code&size=18&pause=1200&color=5B8DEF&center=true&vCenter=true&width=600&lines=Block+a+tool+call+before+it+runs.;Require+a+human+for+the+risky+ones.;Audit+every+decision%2C+for+free." alt="Typing SVG" />
+
+<br/>
+
+[![CI](https://github.com/rayaan2003/bastion/actions/workflows/ci.yml/badge.svg)](https://github.com/rayaan2003/bastion/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-3776AB?logo=python&logoColor=white)](pyproject.toml)
+[![Type checked: mypy strict](https://img.shields.io/badge/mypy-strict-2A6DB2.svg)](pyproject.toml)
+[![PyPI](https://img.shields.io/badge/pypi-coming%20soon-yellow.svg)](CHANGELOG.md)
+
+**[Quickstart](#quickstart)** · **[Framework integrations](#framework-integrations)** · **[Dashboard](#dashboard)** · **[Live demo](https://bastion-dashboard-two.vercel.app)** · **[Why](#why)**
+
+</div>
+
+---
+
+## Why
+
+AI agents are shipping fast and getting real permissions — deleting
+records, sending emails, moving money, running shell commands. Most teams
+have zero enforcement between "the model decided to call a tool" and "the
+tool ran." bastion sits in that gap:
+
+```
+ agent decides to call a tool
+          │
+          ▼
+    ┌──────────┐      allow    ──▶  tool runs
+    │ bastion  │      block    ──▶  denied, agent sees why
+    │  policy  │      approve  ──▶  human reviews (Slack / dashboard / console)
+    └──────────┘
+          │
+          ▼
+   every decision logged
+```
+
+Not another prompt-injection classifier — enforcement on what agents are
+actually allowed to **do**.
+
+## What you get
+
+| | |
+|---|---|
+| 🛡️ **Policy engine** | Allow / block / require-approval rules, glob-matched tool names, conditions on args (`amount > 500`, regex match, contains-PII, ...) |
+| ✅ **Human-in-the-loop** | Console prompt, Slack (reaction-based, no webhook server), or the hosted dashboard — pluggable |
+| 📝 **Audit log, for free** | Every decision recorded automatically — JSONL locally or shipped to the dashboard |
+| 🔍 **PII/secrets scanning** | Regex-based (no ML model to download) — emails, SSNs, Luhn-validated credit cards, cloud credentials, private keys |
+| 📄 **Declarative policy** | Rules in YAML, editable by a non-engineer reviewer — by hand or from the dashboard's `/policy` page |
+| 🔌 **3 framework integrations** | LangGraph, OpenAI Agents SDK, Claude Agent SDK — one line to wrap your tools |
+| 📊 **Dashboard** | Audit log, approval queue, and a policy editor — a real Next.js app |
+
+## Quickstart
+
+> `pip install bastionguard` — the PyPI distribution is named `bastionguard`
+> (plain `bastion` was already taken — an old Python 2 stdlib module, of
+> all things). The import name is unaffected: still `import bastion`.
+
+```python
+from bastion import PolicyEngine, Rule, Action, guard
+from bastion.policy import arg_exceeds
+
+policy = PolicyEngine()
+policy.add_rule(Rule(tool_pattern="delete_*", action=Action.BLOCK, reason="irreversible"))
+policy.add_rule(Rule(
+    tool_pattern="transfer_funds",
+    action=Action.APPROVE,
+    condition=arg_exceeds("amount", 500),
+    reason="large transfers need a human",
+))
+
+def transfer_funds(account: str, amount: float) -> str:
+    return f"sent ${amount} to {account}"
+
+guarded = guard(transfer_funds, policy=policy)
+guarded(account="acct_1", amount=600)  # prompts for approval in the terminal
+```
+
+```bash
+python examples/basic_example.py   # runs the full demo above
+```
+
+Rules can also live in YAML instead of hand-written Python:
+
+```python
+from bastion import load_policy_from_yaml
+policy = load_policy_from_yaml("policy.yaml")
+```
+
+See [`examples/policy.yaml`](examples/policy.yaml) for the schema.
+
+## Framework integrations
+
+<details>
+<summary><b>LangGraph</b></summary>
+
+```python
+from bastion.integrations.langgraph import guarded_tool_node
+
+tool_node = guarded_tool_node([my_tool_a, my_tool_b], policy=policy)
+# use tool_node exactly where you'd use langgraph.prebuilt.ToolNode(tools)
+```
+
+A blocked or approval-denied call comes back as a normal error `ToolMessage`
+(`handle_tool_errors=BlockedByPolicy`), so the agent can react to it instead
+of the graph run crashing. See [`examples/langgraph_demo.py`](examples/langgraph_demo.py).
+
+```bash
+pip install "bastionguard[langgraph]"
+```
+</details>
+
+<details>
+<summary><b>OpenAI Agents SDK</b></summary>
+
+```python
+from bastion.integrations.openai_agents import guarded_tools
+
+agent = Agent(name="...", tools=guarded_tools([my_tool_a, my_tool_b], policy=policy))
+```
+
+A blocked or approval-denied call returns a descriptive string as the
+tool's result (`"Tool call blocked by policy: <reason>"`) rather than
+raising — the same idiom the SDK itself uses when a tool raises an
+exception, so the model sees why and can react. See
+[`examples/openai_agents_demo.py`](examples/openai_agents_demo.py).
+
+```bash
+pip install "bastionguard[openai-agents]"
+```
+</details>
+
+<details>
+<summary><b>Claude Agent SDK</b></summary>
+
+```python
+from claude_agent_sdk import ClaudeAgentOptions
+from bastion.integrations.claude_agent_sdk import guarded_can_use_tool
+
+options = ClaudeAgentOptions(can_use_tool=guarded_can_use_tool(policy=policy))
+```
+
+Hooks into the SDK's own permission system (`can_use_tool`), which it calls
+for **every** tool invocation — built-in tools (Bash, Read, Write, ...) and
+custom tools registered via `create_sdk_mcp_server` alike. Unlike the other
+two integrations, nothing needs wrapping per-tool — one callback covers
+everything. See [`examples/claude_agent_sdk_demo.py`](examples/claude_agent_sdk_demo.py).
+
+```bash
+pip install "bastionguard[claude-agent-sdk]"
+```
+</details>
+
+## PII / secrets scanning
+
+```python
+from bastion import Rule, Action, contains_pii, enforce_text_policy
+
+policy.add_rule(Rule(
+    tool_pattern="*",
+    action=Action.BLOCK,
+    condition=contains_pii(["ssn_us", "credit_card"]),
+    reason="tool call args contain PII/secrets",
+))
+
+# directly on an LLM response, outside the tool-call path:
+enforce_text_policy(llm_output, categories=["email"], on_detect="redact")
+```
+
+Also available as a YAML condition type (`type: contains_pii`). See
+[`examples/pii_scanning_example.py`](examples/pii_scanning_example.py).
+
+## Slack approval
+
+```python
+from bastion.integrations.slack import SlackApprovalHandler
+
+approval_handler = SlackApprovalHandler(
+    token="xoxb-...",       # needs chat:write + reactions:read scopes
+    channel="#agent-approvals",
+)
+```
+
+Posts a message and polls for a ✅/❌ reaction — no webhook server required.
+Fails closed (denies) if nobody responds within `timeout` seconds.
+
+## Dashboard
+
+<div align="center">
+<a href="https://bastion-dashboard-two.vercel.app"><b>→ Live demo</b></a>
+</div>
+
+A real Next.js app (`dashboard/`) — audit log, approval queue, and a
+policy editor, all wired to the SDK over HTTP:
+
+```python
+from bastion import AuditLogger, guard
+from bastion.integrations.dashboard import (
+    DashboardApprovalHandler,
+    dashboard_audit_sink,
+    load_policy_from_dashboard,
+)
+
+api_key = "..."  # must match DASHBOARD_API_KEY in the dashboard's env
+policy = load_policy_from_dashboard("http://localhost:3000", api_key)
+audit = AuditLogger(sink=dashboard_audit_sink("http://localhost:3000", api_key))
+approval_handler = DashboardApprovalHandler("http://localhost:3000", api_key)
+```
+
+The dashboard UI is behind a separate session login (not this API key) —
+see [`dashboard/README.md`](dashboard/README.md) for the full auth model
+and self-hosting setup.
+
+## Install
+
+```bash
+pip install bastionguard
+# with a framework integration:
+pip install "bastionguard[langgraph]"   # or [openai-agents] / [claude-agent-sdk]
+# with Slack approval:
+pip install "bastionguard[slack]"
+```
+
+For local development (editable install, running the test suite), see
+[CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Tests
+
+```bash
+ruff check . && mypy src && pytest -q
+```
+
+Framework integration tests run against the **real installed package** for
+each framework, never a mock — see [AGENTS.md](AGENTS.md) for why that's a
+hard rule here.
+
+## Project status
+
+Pre-1.0. Core SDK, all three framework integrations, and the dashboard are
+built and tested — see [CHANGELOG.md](CHANGELOG.md) for what's shipped and
+[PLAN.md](PLAN.md) for what's next. Not yet on PyPI; install from source
+for now (see [CONTRIBUTING.md](CONTRIBUTING.md)).
+
+## Contributing
+
+Issues and PRs welcome — see [CONTRIBUTING.md](CONTRIBUTING.md). Found a
+security issue? See [SECURITY.md](SECURITY.md) instead of opening a public
+issue for it.
+
+## License
+
+[Apache 2.0](LICENSE)
+
+<div align="center">
+<img width="100%" src="https://capsule-render.vercel.app/api?type=waving&color=0:16213e,100:1a1a2e&height=100&section=footer" alt=""/>
+</div>