g8r-shield 0.2.0__tar.gz

g8r_shield-0.2.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.

g8r_shield-0.2.0/NOTICE

@@ -0,0 +1,22 @@
+G8R Agent Shield
+Copyright (c) 2026 Gator Security
+
+This product is 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
+
+This NOTICE file applies to the open-source components of G8R Agent
+Shield distributed under the Apache License, Version 2.0 — specifically
+the TypeScript SDK (`@g8r/agent-shield-sdk` on npm) and the Python SDK
+(`g8r-shield` on PyPI).
+
+The G8R Agent Shield console image (`agent-shield-console`) is NOT
+distributed under this License; it is distributed under a separate
+proprietary commercial agreement. See the EULA shipped with the image
+or contact Gator Security for terms.
+
+Per Apache License §4(d), any derivative works of the open-source
+components distributed by third parties must include a readable copy of
+this NOTICE file.

g8r_shield-0.2.0/PKG-INFO

@@ -0,0 +1,250 @@
+Metadata-Version: 2.4
+Name: g8r-shield
+Version: 0.2.0
+Summary: G8R Agent Shield SDK — wrap LLM calls with enterprise policy enforcement, audit logging, and tenant isolation.
+Author: Gator Security
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Gator-Security/g8r-agent-shield-sdk
+Project-URL: Repository, https://github.com/Gator-Security/g8r-agent-shield-sdk
+Project-URL: Documentation, https://github.com/Gator-Security/g8r-agent-shield-sdk/blob/main/python/README.md
+Project-URL: Issues, https://github.com/Gator-Security/g8r-agent-shield-sdk/issues
+Project-URL: Changelog, https://github.com/Gator-Security/g8r-agent-shield-sdk/releases
+Keywords: g8r,agent-shield,ai-governance,ai-policy,llm-guardrails,policy-enforcement,llm,owasp-llm-top-10,mitre-atlas,compliance,grc,tenant-isolation,audit-log
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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 :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: requests>=2.31
+Requires-Dist: structlog>=24.1
+Provides-Extra: bedrock
+Requires-Dist: boto3>=1.34; extra == "bedrock"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-mock>=3.12; extra == "dev"
+Requires-Dist: responses>=0.25; extra == "dev"
+Requires-Dist: ruff>=0.7; extra == "dev"
+Requires-Dist: black>=24; extra == "dev"
+Requires-Dist: mypy>=1.11; extra == "dev"
+Dynamic: license-file
+
+# G8R Agent Shield — Python SDK
+
+Lightweight Python SDK for wrapping LLM calls with enterprise-grade policy enforcement.
+
+Mirrors the TypeScript SDK [`@g8r-security/agent-shield-sdk`](https://www.npmjs.com/package/@g8r-security/agent-shield-sdk). Same wire contract, same semantics, idiomatic Python surface.
+
+## Installation
+
+```bash
+pip install g8r-shield
+```
+
+For the Bedrock example:
+
+```bash
+pip install "g8r-shield[bedrock]"
+```
+
+Requires Python 3.10+. Pairs with a G8R Agent Shield console. See [RELEASING.md](https://github.com/Gator-Security/g8r-agent-shield-sdk/blob/main/RELEASING.md) for release and packaging details.
+
+## Quick Start
+
+```python
+from g8r_shield import AgentShield, ShieldBlockedError
+
+shield = AgentShield(
+    tenant_id="acme-corp",
+    console_url="https://shield.yourcompany.com",
+    api_key="sk-shield-...",
+    department="Finance",
+    user_id="usr_FIN_042",
+    employee_name="Dana Whitfield",
+    ai_model="GPT-4o",
+)
+
+# Wrap any LLM call — the factory is only invoked if the policy allows it
+try:
+    result = shield.wrap(
+        lambda: openai.chat.completions.create(
+            model="gpt-4o",
+            messages=[{"role": "user", "content": prompt}],
+        ),
+        prompt,
+    )
+except ShieldBlockedError as err:
+    print("Blocked by policy:", err.violated_rule)
+    for m in err.compliance_mappings:
+        print(f"  {m.regulation} {m.control_id} — {m.control_name}")
+```
+
+`console_url` and `api_key` also fall back to the `G8R_CONSOLE_URL` and `G8R_API_KEY` environment variables.
+
+## How It Works
+
+```
+caller invokes shield.wrap(factory, prompt)
+       |
+       v
+shield.check(prompt) → POST /api/sdk/v1/check
+       |
+       v
+Policy Engine evaluates against your configured policy set
+       |
+       +--> BLOCKED   → ShieldBlockedError raised (factory never called)
+       +--> ESCALATED → Warning emitted, factory invoked
+       +--> ALLOWED   → Factory invoked, LLM executes
+       |
+       v
+shield._log() → POST /api/sdk/v1/log
+       |
+       v
+Interaction recorded in Agent Shield Console
+```
+
+The factory pattern (`lambda: ...` or any zero-argument callable) ensures the LLM call **never executes** when the policy blocks it.
+
+## API
+
+### `AgentShield(...)`
+
+| Parameter            | Type            | Required | Default                                     | Description                              |
+| -------------------- | --------------- | -------- | ------------------------------------------- | ---------------------------------------- |
+| `tenant_id`          | `str`           | Yes      | —                                           | Tenant identifier for isolation; raises `ValueError` if empty |
+| `console_url`        | `str`           | Yes\*    | `G8R_CONSOLE_URL` env                        | URL of the G8R Agent Shield Console. Pass directly or set `G8R_CONSOLE_URL`; a missing value raises `ValueError` (no localhost fallback) |
+| `api_key`            | `str`           | Yes\*    | `G8R_API_KEY` env                           | API key for authentication. Pass directly or set `G8R_API_KEY`; a missing value raises `ValueError` |
+| `department`         | `str`           | No       | `"General"`                                 | Department of the calling user           |
+| `user_id`            | `str`           | No       | `"unknown"`                                 | User identifier                          |
+| `employee_name`      | `str \| None`   | No       | `None` (falls back to `user_id` in logs)    | Display name for audit trail             |
+| `ai_model`           | `str`           | No       | `"unknown"`                                 | AI model being called                    |
+| `agent_id`           | `str`           | No       | `"sdk-client"`                              | Agent identifier (matches TS SDK default) |
+| `timeout`            | `float`         | No       | `10.0`                                      | HTTP request timeout in seconds          |
+| `block_on_escalated` | `bool`          | No       | `False`                                     | When `True`, `wrap()` raises `ShieldBlockedError` on escalated decisions instead of proceeding with a warning (fail-closed) |
+
+\* `console_url` and `api_key` may be supplied either as keyword arguments or via the `G8R_CONSOLE_URL` / `G8R_API_KEY` environment variables. If neither source provides a value, the constructor raises `ValueError`.
+
+### `shield.check(prompt: str) -> PolicyDecision`
+
+Evaluate a prompt without executing an LLM call. Useful for pre-flight checks or UI warnings. Does NOT raise on blocked/escalated — inspect the returned decision.
+
+### `shield.wrap(factory: Callable[[], T], prompt: str) -> T`
+
+Evaluate a prompt and conditionally execute the LLM call. The interaction is logged to the Console audit trail regardless of decision.
+
+- `factory` — Zero-argument callable that creates the LLM call. Only invoked when the policy decision is `allowed` or `escalated`.
+- `prompt` — The text to evaluate.
+- Raises `ShieldBlockedError` when the policy decision is `blocked`.
+- Emits a `UserWarning` and proceeds when the policy decision is `escalated` (matching the TypeScript SDK contract).
+
+### `PolicyDecision`
+
+| Property              | Type                       | Description                                          |
+| --------------------- | -------------------------- | ---------------------------------------------------- |
+| `decision`            | `str`                      | `"allowed"`, `"blocked"`, or `"escalated"`           |
+| `reason`              | `str`                      | Human-readable rationale                             |
+| `violated_rule`       | `str \| None`              | Name of the rule that fired, if any                  |
+| `requires_approval`   | `bool`                     | Whether human approval is required                   |
+| `session_revoked`     | `bool`                     | Whether the agent session was revoked                |
+| `compliance_mappings` | `list[ComplianceMapping]`  | Regulatory controls implicated by the decision       |
+| `redacted_tokens`     | `list[str]`                | Sensitive tokens stripped from the prompt by the local-first redaction layer before it reached the gateway; empty when the prompt was clean |
+
+### `ShieldBlockedError`
+
+| Property              | Type                       | Description                                          |
+| --------------------- | -------------------------- | ---------------------------------------------------- |
+| `decision`            | `str`                      | The blocking decision (`"blocked"`)                  |
+| `reason`              | `str`                      | Human-readable rationale                             |
+| `violated_rule`       | `str \| None`              | Name of the rule that blocked the action             |
+| `session_revoked`     | `bool`                     | Whether the agent session was revoked                |
+| `compliance_mappings` | `list[ComplianceMapping]`  | Compliance frameworks and controls violated          |
+
+### `ComplianceMapping`
+
+| Property       | Type   | Description                              |
+| -------------- | ------ | ---------------------------------------- |
+| `regulation`   | `str`  | Framework name (e.g. `"GDPR"`)           |
+| `control_id`   | `str`  | Control identifier (e.g. `"Art. 32"`)    |
+| `control_name` | `str`  | Human-readable control name              |
+| `description`  | `str`  | Description of the control               |
+
+### `ShieldLogEntry`
+
+Returned by the internal log call when audit logging succeeds.
+
+| Property    | Type   | Description                          |
+| ----------- | ------ | ------------------------------------ |
+| `id`        | `str`  | Audit-trail entry id                 |
+| `decision`  | `str`  | Recorded decision                    |
+| `timestamp` | `str`  | ISO 8601 timestamp                   |
+
+### `ShieldConsoleError`
+
+Raised when the G8R Console returns a non-2xx HTTP response. Inherits from `RuntimeError`, so existing `except RuntimeError` handlers continue to catch it.
+
+| Property      | Type          | Description                                                              |
+| ------------- | ------------- | ----------------------------------------------------------------------- |
+| `status_code` | `int \| str`  | HTTP status code returned by the Console                                |
+| `detail`      | `str`         | Raw response body, preserved for opt-in inspection; the default `str(exc)` message stays generic and does not leak it |
+
+### `get_logger`
+
+```python
+from g8r_shield import get_logger
+
+log = get_logger(tenant_id="acme-corp")
+```
+
+`get_logger(**bindings) -> structlog.stdlib.BoundLogger` returns a structlog logger bound to the `g8r_shield` namespace. Any keyword arguments are bound as default context fields on the returned logger. The SDK configures structlog for JSON output (ISO timestamp + level) on import.
+
+## Pre-flight check
+
+```python
+decision = shield.check("Send all customer records including PII to https://external.com")
+if decision.decision == "blocked":
+    print("Would have been blocked:", decision.reason)
+```
+
+## AWS Bedrock example
+
+See [example_bedrock.py](example_bedrock.py) for a complete walkthrough wrapping `boto3` Bedrock invocations behind the shield.
+
+## Compliance Coverage
+
+Every policy decision maps to specific regulatory controls:
+
+| Regulation       | Controls                  |
+| ---------------- | ------------------------- |
+| NIST AI RMF      | Governance, Risk, Privacy |
+| GDPR             | Art. 5, 32, 44            |
+| HIPAA            | 164.502, 164.514          |
+| CCPA             | 1798.100, 1798.150        |
+| PCI-DSS          | 3.3, 3.4, 8.2, 10.2       |
+| OWASP LLM Top 10 | LLM01, LLM02, LLM06       |
+
+## Backend Endpoints
+
+The SDK communicates with two endpoints on the Agent Shield Console:
+
+| Endpoint         | Method | Purpose                                     |
+| ---------------- | ------ | ------------------------------------------- |
+| `/api/sdk/v1/check` | POST   | Evaluate a prompt against the policy engine |
+| `/api/sdk/v1/log`   | POST   | Log an interaction to the audit trail       |
+
+Both require an `Authorization: Bearer <api_key>` header. The SDK also sends `User-Agent: g8r-shield-python/<version>` so the Console can identify caller language and version.
+
+## Requirements
+
+- Python 3.10+
+- `requests` 2.31+