toolbound 0.2.0__tar.gz

toolbound-0.2.0/.gitignore

@@ -0,0 +1,19 @@
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.hypothesis/
+dist/
+build/
+*.egg-info/
+.coverage
+htmlcov/
+.env
+.env.*
+!.env.example
+*.pem
+*.key
+.DS_Store
+benchmarks/results/*.local.json

toolbound-0.2.0/CHANGELOG.md

@@ -0,0 +1,142 @@
+# Changelog
+
+All notable changes are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project uses
+[Semantic Versioning](https://semver.org/) (before 1.0, minor versions may break the API).
+
+## [Unreleased]
+
+## [0.2.0] - unreleased
+
+Security-hardening release after an independent production-readiness review of 0.1.0.
+**Everyone on 0.1.0 should upgrade.** 0.1.0 was never published to PyPI.
+
+### Security
+
+- **Critical:** `SecureTransport` stored upstream cookies in a client shared by all users,
+  so a `Set-Cookie` from one user's call was sent on later calls for other users and
+  tenants. The transport no longer stores cookies.
+- **High:** `Operation(method="DELETE")` without `effect` was treated as a read tool (no
+  approval, no duplicate-call protection). The effect is now inferred from the method.
+- **High:** `Gateway.grant()` signed any `PendingApproval` object, so a host that rebuilt
+  one from client data could execute arguments the human never saw. Approval requests are
+  now gateway-issued encrypted tokens, and only the token is trusted.
+- **High:** trimming a large result to the token budget could block the event loop for
+  seconds. Trimming work is bounded, and large bodies are processed in a worker thread.
+- **Medium:** cursors were signed but readable (they exposed upstream tokens and trusted
+  path values). They are now encrypted.
+- **Medium:** a timed-out or interrupted write told the model `retryable: true`, inviting a
+  duplicate write. Such failures are now `outcome_unknown` (not retryable), and 5xx after
+  a write is not retryable.
+- **Medium:** `MemoryStateStore` evicted unexpired replay keys when full, so an approval
+  could be reused. It now refuses new claims (fail closed). Any `StateStore` error fails
+  the call closed.
+- **Medium:** approval summaries were truncated silently and hid trusted values and the
+  target URL. They now show the method, resolved URL, all arguments and trusted values,
+  escape control and bidi characters, and flag truncation.
+- **Medium:** no warning for an ephemeral signing key. A `ToolboundWarning` is now emitted.
+- **Low:** `HttpRequest`/`HttpResponse` reprs no longer print headers, bodies or query
+  values. The rate limiter forgets idle callers and is thread-safe. A per-call
+  `Limits.total_timeout` bounds retries and `Retry-After` waits. The transport falls back
+  to the next checked address on connect failure. Key-based redaction applies to renamed
+  fields. Non-object list items are reported and continuation offsets stay aligned. An
+  explicit special-purpose IP blocklist no longer depends on the Python patch version.
+  Unenforced JSON Schema `format`s produce a warning.
+
+### Security (second, adversarial review of 0.2.0)
+
+- **High:** a secret-detection regex was quadratic: an 800 KB response froze the process
+  for 71 s (threads did not help, the regex holds the GIL). Patterns are now linear and
+  only scan what can still be returned.
+- **High:** when the last retry of a write failed before sending, an earlier attempt that
+  had reached the upstream was hidden and the model saw a retryable error. Any attempt or
+  redirect hop that may have landed now makes a write `outcome_unknown`; so does a 3xx.
+- **High:** echoed credentials in URL-encoded, JSON-escaped or base64 form, or used as
+  object keys, were not scrubbed, and `accessToken`-style keys escaped key redaction.
+- **Medium-High:** automatic retries followed the HTTP method, so a destructive GET was
+  retried. Only declared reads (or idempotency-keyed calls) are retried now.
+- **Medium:** cursors were not bound to trusted bound values; nested schemas with
+  `properties` but a non-`"object"` type stayed open (mass assignment); one actor could
+  exhaust the replay store for everyone; the FastAPI example let the agent approve its own
+  request and did not make rejections final.
+- **Low:** the per-actor rate limit was not tenant-qualified; hidden group actions could
+  be told apart from missing ones; a duplicate call id or a pre-send failure used up an
+  approval; IPv4-translated (`::ffff:0:a.b.c.d`) addresses were allowed; concurrency limits
+  were keyed by service name only; stuck sync tools could starve DNS resolution; missing
+  provider call ids became the string `"None"`; release tooling was unpinned and releases
+  were not restricted to commits on `main`.
+
+### Breaking
+
+- `PythonTool` and `@gateway.tool` require `effect=`.
+- `POST`/`PUT`/`PATCH` operations default to `effect="write"` and `DELETE` to
+  `"destructive"`. Declare `effect="read"` for read-only POSTs. `DELETE` + `read` is
+  rejected.
+- `Gateway.grant()`/`resume()` accept a gateway-issued `PendingApproval` or its `token`.
+  Hand-built `PendingApproval` objects are rejected with `ApprovalInvalid`. Grant tokens
+  changed prefix (`tba1` → `tba2`).
+- Cursor format changed (`tbc1` → `tbc2`); 0.1 cursors are rejected.
+- New runtime dependency: `cryptography>=42`.
+- New error code `outcome_unknown`. Writes that may have reached the upstream are no longer
+  marked retryable.
+
+### Added
+
+- `Gateway.pending_approval(token)`; `PendingApproval.token`, `.target`,
+  `.summary_truncated`; `to_dict()` now includes the token and trusted values.
+- `ApprovalInvalid`, `StateStoreError`, `ToolboundWarning`; `Limits.total_timeout`.
+- `Gateway.deny()` / `SyncGateway.deny()`; `SyncGateway.resume(call_id=...)`;
+  `MemoryStateStore(max_per_partition=...)`.
+- Gateways can be shared across event loops and threads.
+- FastAPI and LangGraph examples with automated tests (`tests/integrations`).
+- Dedicated security regression suite (`tests/security`, `pytest -m security`), threat
+  model (`docs/security/threat-model.md`), vulnerability process
+  (`docs/security/vulnerability-process.md`).
+- CI: separate security-suite job, `pip-audit`, dependency review, CodeQL, `zizmor`,
+  actions pinned by commit SHA, and a single `required checks` gate. The release workflow
+  refuses to build unless all of them pass.
+- README: why Toolbound exists, a worked example with a comparison diagram, and a "how a
+  tool call flows" diagram.
+
+### Fixed
+
+- `Gateway(state=...)`, `estimator=` and `observer=` were replaced by defaults when the
+  given object was falsy (for example an empty store with `__len__`).
+- Docs: removed the claim that the model cannot read cursor contents (true only from 0.2),
+  corrected the LangChain recipe (it lost tool-call ids), and corrected the event-loop
+  guidance.
+
+## [0.1.0] - 2026-11-10
+
+First public alpha.
+
+### Added
+
+- `Gateway`: one execution pipeline for REST operations and trusted Python tools
+  (validation, trusted bindings, scopes, required `authorize` hook, rate limits, approval,
+  replay protection, execution, output shaping, structured results).
+- Contracts in Python (`Service`, `Operation`, `PythonTool`, `Output`, `Field`,
+  `Pagination`, policies) and in YAML/JSON (format version 1, published meta-schema,
+  `status: draft` review gate).
+- `SecureTransport`: DNS resolution with every address checked, IP pinning with TLS host
+  verification, non-public ranges blocked unless explicitly trusted, no proxies from the
+  environment, decompressed size caps, total deadlines.
+- Redirect policy (off by default; per-hop checks; credentials dropped across origins).
+- Output pipeline: allowlist projection with a safe path language, nested shapes,
+  transforms, defaults, limits, key/secret/credential redaction, PII hooks, output schema
+  checks, token budgets with `truncate`/`reject`, required evidence fields, transparent
+  omission metadata.
+- Signed, expiring, argument-bound cursors for upstream cursor/link/page pagination and
+  local continuation.
+- Approval grants bound to actor, tenant, tool, contract fingerprint and arguments;
+  single use; inline approver or two-step `grant`/`resume`.
+- Duplicate call-id protection for writes; idempotency keys; retries only when safe.
+- Exposure strategies `direct` and compact `grouped`; scope, visibility and tag filtering.
+- Adapters for the Anthropic Messages API and OpenAI Chat Completions / Responses.
+- `SyncGateway`, `TiktokenEstimator`, `LoggingObserver`, `MockTransport`, CLI
+  (`validate`, `tools`, `schema`).
+- Security regression suite, property-based tests, runnable examples, reproducible
+  benchmarks, documentation.
+
+[Unreleased]: https://github.com/SaeedNoshadi89/toolbound/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/SaeedNoshadi89/toolbound/releases/tag/v0.1.0

toolbound-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.
+