integrable-firewall 0.1.0__tar.gz

integrable_firewall-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.py[cod]
+/dist/
+/build/
+*.egg-info/
+/.venv/

integrable_firewall-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.

integrable_firewall-0.1.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.5
+Name: integrable-firewall
+Version: 0.1.0
+Summary: Connect an AI agent built in code to its firewall, which screens every user message, tool call and tool result.
+Project-URL: Homepage, https://integrable.tech
+Author-email: Integrable <enquiries@integrable.tech>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agents,ai,firewall,google-adk,guardrails,langchain,openai-agents,prompt injection,pydantic-ai
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+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 :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: adk
+Requires-Dist: google-adk>=1.18; extra == 'adk'
+Provides-Extra: langchain
+Requires-Dist: langchain>=1.3; extra == 'langchain'
+Provides-Extra: openai-agents
+Requires-Dist: openai-agents>=0.6; extra == 'openai-agents'
+Provides-Extra: pydantic-ai
+Requires-Dist: pydantic-ai-slim>=2.16; extra == 'pydantic-ai'
+Description-Content-Type: text/markdown
+
+# integrable-firewall
+
+Connects an AI agent you build in code to its firewall. The firewall screens
+every message from the agent's user, every tool call before it runs and every
+tool result before the model reads it. Each step passes, is stopped, or has its
+result rewritten. A stopped step never waits for a person: the model reads the
+reason and tells its user.
+
+Documentation: `/docs/agents.html` on your firewall, for example
+`https://<your firewall>.cloudfront.net/docs/agents.html`.
+
+## Install
+
+```sh
+pip install "integrable-firewall[langchain]"      # or [openai-agents], [adk], [pydantic-ai]
+```
+
+The core has no dependencies and runs on Python 3.9 or later. Each framework
+is an optional extra, and an adapter imports its framework only when you
+import the adapter.
+
+## Settings
+
+One adapter protects one agent, named in code. The firewall makes a key for
+that agent, bound to its name, and the setup command puts two settings where
+the agent runs:
+
+- `FIREWALL_URL`: your firewall's address.
+- `FIREWALL_KEY_<AGENT>`: the agent's key (`support-widget` reads
+  `FIREWALL_KEY_SUPPORT_WIDGET`). `FIREWALL_KEY` is read when that is not set.
+
+The `url=` and `key=` options take precedence over both. If the key was made
+for another agent, the adapter raises when you create it. The key is never
+logged or put in an error message.
+
+## LangChain
+
+```python
+from langchain.agents import create_agent
+from integrable_firewall import FirewallBlocked
+from integrable_firewall.langchain import FirewallMiddleware
+
+agent = create_agent(model, tools, middleware=[FirewallMiddleware(agent="support-widget")])
+
+try:
+    result = agent.invoke({"messages": [{"role": "user", "content": text}]}, {"configurable": {"thread_id": conversation_id}})
+except FirewallBlocked as stop:
+    reply = stop.reason
+```
+
+## OpenAI Agents SDK
+
+```python
+from agents import Agent, InputGuardrailTripwireTriggered, Runner
+from integrable_firewall.openai_agents import FirewallGuardrails, blocked_reason
+
+firewall = FirewallGuardrails(agent="support-widget")
+support = firewall.protect(Agent(name="Support", instructions="...", tools=[lookup_order, issue_refund]))
+
+try:
+    result = await Runner.run(support, text)
+except InputGuardrailTripwireTriggered as stop:
+    reply = blocked_reason(stop)
+```
+
+## Google ADK
+
+```python
+from google.adk.apps import App
+from google.adk.runners import Runner
+from integrable_firewall.adk import FirewallPlugin
+
+firewall = FirewallPlugin(agent="support-widget")
+runner = Runner(app=App(name="support", root_agent=root_agent, plugins=[firewall]), session_service=session_service)
+
+async for event in runner.run_async(user_id=user_id, session_id=session_id, new_message=message):
+    reason = firewall.blocked_reason(event)   # set when the message was blocked
+```
+
+## Pydantic AI
+
+```python
+from pydantic_ai import Agent
+from integrable_firewall import FirewallBlocked
+from integrable_firewall.pydantic_ai import FirewallCapability
+
+agent = Agent(model, tools=[lookup_order, issue_refund], capabilities=[FirewallCapability(agent="support-widget")])
+
+try:
+    result = await agent.run(text, message_history=history)
+except FirewallBlocked as stop:
+    reply = stop.reason
+```
+
+## When the firewall cannot be reached
+
+Nothing passes without an answer from the firewall. If the firewall cannot be
+reached, answers with an error, refuses the key, or has not answered after
+9.5 s, the user's message is blocked, the tool does not run, or the tool's
+result is withheld. The model, or your app for a user message, reads a reason
+that starts with `Firewall:`. There is no setting that lets steps through
+instead.
+
+## Notes
+
+- OpenAI Agents SDK: hosted tools such as web search run outside the SDK's
+  tool guardrails, so `protect()` logs a warning that names them. When a
+  guardrail stops a user message, the SDK still saves that message to a
+  `Session`; call `await session.pop_item()` before the next run.
+- Google ADK: list the plugin first in `plugins=[...]`.
+- Without a framework adapter, use `integrable_firewall.Firewall` directly:
+  `user_message()`, `before_tool()`, `after_tool()` and their `a`-prefixed
+  async forms each return a `Verdict`.

integrable_firewall-0.1.0/README.md

@@ -0,0 +1,113 @@
+# integrable-firewall
+
+Connects an AI agent you build in code to its firewall. The firewall screens
+every message from the agent's user, every tool call before it runs and every
+tool result before the model reads it. Each step passes, is stopped, or has its
+result rewritten. A stopped step never waits for a person: the model reads the
+reason and tells its user.
+
+Documentation: `/docs/agents.html` on your firewall, for example
+`https://<your firewall>.cloudfront.net/docs/agents.html`.
+
+## Install
+
+```sh
+pip install "integrable-firewall[langchain]"      # or [openai-agents], [adk], [pydantic-ai]
+```
+
+The core has no dependencies and runs on Python 3.9 or later. Each framework
+is an optional extra, and an adapter imports its framework only when you
+import the adapter.
+
+## Settings
+
+One adapter protects one agent, named in code. The firewall makes a key for
+that agent, bound to its name, and the setup command puts two settings where
+the agent runs:
+
+- `FIREWALL_URL`: your firewall's address.
+- `FIREWALL_KEY_<AGENT>`: the agent's key (`support-widget` reads
+  `FIREWALL_KEY_SUPPORT_WIDGET`). `FIREWALL_KEY` is read when that is not set.
+
+The `url=` and `key=` options take precedence over both. If the key was made
+for another agent, the adapter raises when you create it. The key is never
+logged or put in an error message.
+
+## LangChain
+
+```python
+from langchain.agents import create_agent
+from integrable_firewall import FirewallBlocked
+from integrable_firewall.langchain import FirewallMiddleware
+
+agent = create_agent(model, tools, middleware=[FirewallMiddleware(agent="support-widget")])
+
+try:
+    result = agent.invoke({"messages": [{"role": "user", "content": text}]}, {"configurable": {"thread_id": conversation_id}})
+except FirewallBlocked as stop:
+    reply = stop.reason
+```
+
+## OpenAI Agents SDK
+
+```python
+from agents import Agent, InputGuardrailTripwireTriggered, Runner
+from integrable_firewall.openai_agents import FirewallGuardrails, blocked_reason
+
+firewall = FirewallGuardrails(agent="support-widget")
+support = firewall.protect(Agent(name="Support", instructions="...", tools=[lookup_order, issue_refund]))
+
+try:
+    result = await Runner.run(support, text)
+except InputGuardrailTripwireTriggered as stop:
+    reply = blocked_reason(stop)
+```
+
+## Google ADK
+
+```python
+from google.adk.apps import App
+from google.adk.runners import Runner
+from integrable_firewall.adk import FirewallPlugin
+
+firewall = FirewallPlugin(agent="support-widget")
+runner = Runner(app=App(name="support", root_agent=root_agent, plugins=[firewall]), session_service=session_service)
+
+async for event in runner.run_async(user_id=user_id, session_id=session_id, new_message=message):
+    reason = firewall.blocked_reason(event)   # set when the message was blocked
+```
+
+## Pydantic AI
+
+```python
+from pydantic_ai import Agent
+from integrable_firewall import FirewallBlocked
+from integrable_firewall.pydantic_ai import FirewallCapability
+
+agent = Agent(model, tools=[lookup_order, issue_refund], capabilities=[FirewallCapability(agent="support-widget")])
+
+try:
+    result = await agent.run(text, message_history=history)
+except FirewallBlocked as stop:
+    reply = stop.reason
+```
+
+## When the firewall cannot be reached
+
+Nothing passes without an answer from the firewall. If the firewall cannot be
+reached, answers with an error, refuses the key, or has not answered after
+9.5 s, the user's message is blocked, the tool does not run, or the tool's
+result is withheld. The model, or your app for a user message, reads a reason
+that starts with `Firewall:`. There is no setting that lets steps through
+instead.
+
+## Notes
+
+- OpenAI Agents SDK: hosted tools such as web search run outside the SDK's
+  tool guardrails, so `protect()` logs a warning that names them. When a
+  guardrail stops a user message, the SDK still saves that message to a
+  `Session`; call `await session.pop_item()` before the next run.
+- Google ADK: list the plugin first in `plugins=[...]`.
+- Without a framework adapter, use `integrable_firewall.Firewall` directly:
+  `user_message()`, `before_tool()`, `after_tool()` and their `a`-prefixed
+  async forms each return a `Verdict`.

integrable_firewall-0.1.0/integrable_firewall/__init__.py

@@ -0,0 +1,38 @@
+"""Connect an AI agent built in code to its firewall.
+
+The firewall screens every user message, every tool call before it runs and
+every tool result before the model reads it. One adapter protects one agent::
+
+    from integrable_firewall.langchain import FirewallMiddleware
+    agent = create_agent(model, tools, middleware=[FirewallMiddleware(agent="support-widget")])
+
+Adapters: ``integrable_firewall.langchain``, ``integrable_firewall.openai_agents``,
+``integrable_firewall.adk``, ``integrable_firewall.pydantic_ai``. Each imports
+its framework only when it is imported itself.
+"""
+
+from ._client import (
+    TIMEOUT_SECONDS,
+    UNREACHABLE,
+    Firewall,
+    FirewallAgentMismatch,
+    FirewallBlocked,
+    FirewallConfigError,
+    FirewallError,
+    Verdict,
+    key_variable,
+)
+from ._version import __version__
+
+__all__ = [
+    "Firewall",
+    "Verdict",
+    "FirewallBlocked",
+    "FirewallError",
+    "FirewallConfigError",
+    "FirewallAgentMismatch",
+    "UNREACHABLE",
+    "TIMEOUT_SECONDS",
+    "key_variable",
+    "__version__",
+]