Add traffic token rotation logic to Python SDK

.github/workflows/publish-e2b-python-client.yml

@@ -0,0 +1,55 @@
+name: Publish E2B Python Client to PyPI
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to release'
+        required: true
+        default: '0.1.0'
+        type: string
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install build tools
+        run: pip install build twine
+
+      - name: Update version in pyproject.toml
+        run: |
+          cd e2b/python
+          sed -i "s/version = \".*\"/version = \"$VERSION\"/" pyproject.toml
+        env:
+          VERSION: ${{ github.event.inputs.version }}
+
+      - name: Build package
+        run: |
+          cd e2b/python
+          python -m build
+
+      - name: Publish to PyPI
+        run: |
+          cd e2b/python
+          twine upload dist/* --username __token__
+        env:
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Upload build artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: e2b-python-client-artifacts
+          path: e2b/python/dist/*
+          retention-days: 1

.gitignore

@@ -19,5 +19,11 @@ vendor/
 
 # Python
 .ruff_cache/
+__pycache__/
+*.egg-info/
+*.egg-link
+dist/
+build/
+
+.vscode/
 
-.vscode/

Makefile

@@ -138,6 +138,12 @@ test-e2e-python: setup-test-e2e
 cleanup-test-e2e:
 	@$(KIND) delete cluster --name $(KIND_CLUSTER_NAME)
 
+# ==================== Python E2B Patch Tests ====================
+
+.PHONY: test-e2b-patch
+test-e2b-patch:
+	cd e2b/python && pip install -e ".[dev]" && pytest tests/ -v
+
 # ==================== Schema Generation ====================
 
 .PHONY: gen-schema-only

e2b/python/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

e2b/python/README.md

@@ -0,0 +1,114 @@
+# Customized E2B SDK patch
+
+This Python library patches the E2B client, converting the native E2B protocol to the OpenKruise Agents private
+protocol, thereby simplifying sandbox-manager deployment.
+
+## Installation
+
+### Install from source via git
+
+```bash
+# Replace "main" with a specific version tag (e.g., "v0.1.0") from
+# https://github.com/openkruise/agents-api/releases to pin a version tag.
+pip install git+https://github.com/openkruise/agents-api.git@${VERSION}#subdirectory=e2b/python
+```
+
+### Install from Source
+
+```bash
+git clone https://github.com/openkruise/agents-api.git
+cd e2b/python
+pip install -e .
+```
+
+## Problem Statement
+
+The E2B SDK requests the backend using the following protocol:
+
+| Protocol                    | Description          | Example                                |
+|-----------------------------|----------------------|----------------------------------------|
+| api.E2B_DOMAIN              | Management interface | api.e2b.dev                            |
+| \<port\>-\<sid\>.E2B_DOMAIN | Sandbox interface    | 49999-i37sc83s52e2cv85h636jjgs.e2b.dev |
+
+Meanwhile, E2B SDK forces the use of HTTPS.
+
+In our practice, we found that in K8s scenarios, this protocol has the following issues:
+
+1. Requires configuring wildcard domain resolution to the management service (sandbox-manager), unable to use methods
+   like hosts for resolution.
+2. Requires using expensive wildcard certificates.
+
+The above issues simultaneously make deploying a backend service compatible with E2B have a high threshold: not only
+increasing user costs, but also making it difficult to automate the setup of an E2E test environment.
+
+## Usage
+
+Requirements:
+
+- Python 3.9 or newer
+- `e2b>=2.8.0`
+- `e2b-code-interpreter>=2.4.1`
+
+```python
+from agents_api.patch_e2b import patch_e2b
+from e2b_code_interpreter import Sandbox
+
+patch_e2b(https=False)  # patch sdk
+
+if __name__ == "__main__":
+    with Sandbox.create() as sbx:
+        sbx.run_code("print('hello world')")
+```
+
+## Traffic JWT Refresh
+
+Traffic JWT refresh is an independent, opt-in monkey patch. It requires Python
+3.10 or newer, `e2b>=2.35.0,<2.38.0`, and
+`e2b-code-interpreter>=2.9.0,<2.10.0`.
+
+```python
+from agents_api.patch_e2b import patch_e2b
+from agents_api.patch_traffic_token import patch_traffic_access_token
+
+patch_e2b(https=False)
+patch_traffic_access_token()
+```
+
+When a Sandbox is configured for Traffic JWT authentication, the patch keeps
+its token in memory and refreshes it before expiration. Sync and async envd
+HTTP/RPC requests and code-interpreter Jupyter requests read the latest token
+immediately before sending. Refreshes for one Sandbox that overlap on the same
+sandbox-manager replica are combined into one issuance. The completed result is
+not cached by sandbox-manager; a later refresh request issues a new token.
+Legacy opaque traffic tokens keep their existing behavior and do not enable
+expiration-based refresh.
+
+Connect only resumes or extends the Sandbox and does not issue a token. A
+class-level `Sandbox.connect(sandbox_id)` checks the Sandbox metadata with
+`get_info()`; for JWT-protected Sandboxes without a token, the first data-plane
+request refreshes one before sending.
+
+Sync and async clients refresh on demand immediately before a data-plane
+request. Refresh failures continue using the previous token while it remains
+valid; once expired, data-plane calls fail locally with
+`TrafficAccessTokenExpired` instead of sending a known-invalid credential.
+
+An application can explicitly refresh a token when needed:
+
+```python
+token = sandbox.refresh_traffic_access_token(force=True)
+token = await async_sandbox.refresh_traffic_access_token(force=True)
+```
+
+## Rollout
+
+Sandbox-manager preserves the legacy, approximately 100-year Traffic JWT
+validity by default. Deploy this patch, or another client with equivalent
+refresh support, before configuring a shorter
+`--traffic-access-token-validity` for existing JWT-authenticated workloads.
+Clients that do not refresh will lose data-plane access when a short-lived
+token expires.
+
+Deploy the lazy-Connect SDK behavior before upgrading sandbox-manager to a
+version that no longer issues Traffic JWTs from Connect. Older clients cannot
+recover a missing token when reconnecting by Sandbox ID.