keywright 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,48 @@
1
+ # Local configuration and credentials
2
+ .env
3
+ .env.*
4
+ *.env
5
+ *.env.*
6
+ !**/.env.example
7
+ !**/*.env.example
8
+ *.pem
9
+ *.key
10
+ *.p12
11
+ *.pfx
12
+ id_rsa*
13
+ id_ed25519*
14
+ # Runtime and local environments
15
+ .venv/
16
+ venv/
17
+ data/
18
+ *.db
19
+ *.db-*
20
+ *.sqlite*
21
+ *.log
22
+ __pycache__/
23
+ *.py[cod]
24
+ .pytest_cache/
25
+ .ruff_cache/
26
+ .coverage
27
+ htmlcov/
28
+ # Build and local tooling
29
+ dist/
30
+ build/
31
+ *.egg-info/
32
+ .idea/
33
+ .vscode/
34
+ .DS_Store
35
+ # Operational captures belong outside the source repository
36
+ reports/
37
+ artifacts/
38
+ backups/
39
+ *.tar.gz
40
+ *.zip
41
+
42
+ # Generated release material outputs (never source inputs)
43
+ /inventory.json
44
+ /materials/
45
+ /source-link.Dockerfile
46
+ /release-input/
47
+ /release-assets/
48
+ /release-state.json
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
keywright-0.0.1/NOTICE ADDED
@@ -0,0 +1,5 @@
1
+ Keywright
2
+ Copyright 2026 Keywright contributors
3
+
4
+ Licensed under the Apache License, Version 2.0.
5
+ https://github.com/johnrcarty/keywright
@@ -0,0 +1,77 @@
1
+ Metadata-Version: 2.5
2
+ Name: keywright
3
+ Version: 0.0.1
4
+ Summary: Keywright client: the kw command agents use to reach brokered hosts and tools, the hazard tripwire, and the agent-machine setup.
5
+ Project-URL: Repository, https://github.com/johnrcarty/keywright
6
+ Project-URL: Issues, https://github.com/johnrcarty/keywright/issues
7
+ License-Expression: Apache-2.0
8
+ License-File: LICENSE
9
+ License-File: NOTICE
10
+ License-File: THIRD_PARTY_NOTICES
11
+ Requires-Python: >=3.12
12
+ Requires-Dist: mcp<3,>=2.2
13
+ Provides-Extra: dev
14
+ Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
15
+ Requires-Dist: pytest>=8; extra == 'dev'
16
+ Requires-Dist: ruff>=0.5; extra == 'dev'
17
+ Description-Content-Type: text/markdown
18
+
19
+ # keywright
20
+
21
+ The client half of [Keywright](https://github.com/johnrcarty/keywright), a just-in-time credential broker for AI agents.
22
+
23
+ - `kw run|put|get|capture|request|status|tool` reach brokered SSH hosts and MCP tools from any shell.
24
+ - `kw hazards --hook` is the destructive-command tripwire, usable as a Claude Code PreToolUse hook.
25
+ - `kw setup claude-code|codex|check` configures the agent machine.
26
+
27
+ This is an unreleased source preview. Run installation commands from the repository root.
28
+
29
+ ```bash
30
+ pipx install ./client
31
+ kw login https://keywright.example.org/mcp --paste
32
+ kw setup claude-code
33
+ kw setup check
34
+ ```
35
+
36
+ The client requires Python 3.12 or newer. On a Raspberry Pi or other machine with
37
+ an older system Python, [uv](https://docs.astral.sh/uv/guides/tools/) can install a
38
+ separate runtime for the client:
39
+
40
+ ```bash
41
+ uv tool install --python 3.13 ./client
42
+ ```
43
+
44
+ Run agent setup as the user who runs the agents. `kw setup check` validates the
45
+ integrations present on that machine; a Codex-only installation does not require
46
+ Claude Code hooks.
47
+
48
+ ## Codex sandbox and approvals
49
+
50
+ `kw guide` (also `kw guides`) explains the agent workflow. Codex execution permission controls
51
+ whether the local command can reach the broker; Keywright separately controls each brokered
52
+ operation and its phone approval. For blocked network access, request a narrow execution prefix
53
+ such as `["kw", "resources"]` or `["kw", "run", "dev-host"]` through Codex's approval interface.
54
+ Review those prefixes before saving them; do not blanket-allow `kw` or disable the sandbox.
55
+ See the [official Codex rules documentation](https://learn.chatgpt.com/docs/agent-configuration/rules).
56
+ Setup installs agent instructions; it does not change Codex execution rules.
57
+
58
+ Network calls have a 15-second startup/handshake deadline and a separate response deadline of
59
+ the requested operation timeout plus 30 seconds. Worker cleanup adds at most one second before
60
+ termination. The worker inherits the sandbox and receives credentials over a private pipe.
61
+ This also bounds stalls in DNS resolution or SDK shutdown. Phone approval polling and remote
62
+ command timeouts keep their existing budgets. Transport errors exit 6 without retrying operations;
63
+ check the audit record before repeating an operation with an unknown outcome.
64
+
65
+ Session attribution uses `KW_SESSION` first, then header-safe `CODEX_THREAD_ID` metadata when
66
+ present, then Linux process ancestry. The metadata path was observed in Codex desktop; hosts
67
+ that do not supply it retain the fallback. Compare `kw session` inside and outside the sandbox
68
+ to check attribution. Process fallback is per process, not necessarily per conversation.
69
+ Switching from process to thread identity requires fresh session-scoped approvals.
70
+
71
+ ## License
72
+
73
+ Keywright is licensed under [Apache-2.0](LICENSE). Copyright 2026 Keywright
74
+ contributors. See [NOTICE](NOTICE) and [third-party notices](THIRD_PARTY_NOTICES).
75
+ Commercial use and proprietary extensions are permitted under the license's terms.
76
+ Unless explicitly stated otherwise, contributions intentionally submitted for
77
+ inclusion in Keywright are provided under Apache-2.0.
@@ -0,0 +1,59 @@
1
+ # keywright
2
+
3
+ The client half of [Keywright](https://github.com/johnrcarty/keywright), a just-in-time credential broker for AI agents.
4
+
5
+ - `kw run|put|get|capture|request|status|tool` reach brokered SSH hosts and MCP tools from any shell.
6
+ - `kw hazards --hook` is the destructive-command tripwire, usable as a Claude Code PreToolUse hook.
7
+ - `kw setup claude-code|codex|check` configures the agent machine.
8
+
9
+ This is an unreleased source preview. Run installation commands from the repository root.
10
+
11
+ ```bash
12
+ pipx install ./client
13
+ kw login https://keywright.example.org/mcp --paste
14
+ kw setup claude-code
15
+ kw setup check
16
+ ```
17
+
18
+ The client requires Python 3.12 or newer. On a Raspberry Pi or other machine with
19
+ an older system Python, [uv](https://docs.astral.sh/uv/guides/tools/) can install a
20
+ separate runtime for the client:
21
+
22
+ ```bash
23
+ uv tool install --python 3.13 ./client
24
+ ```
25
+
26
+ Run agent setup as the user who runs the agents. `kw setup check` validates the
27
+ integrations present on that machine; a Codex-only installation does not require
28
+ Claude Code hooks.
29
+
30
+ ## Codex sandbox and approvals
31
+
32
+ `kw guide` (also `kw guides`) explains the agent workflow. Codex execution permission controls
33
+ whether the local command can reach the broker; Keywright separately controls each brokered
34
+ operation and its phone approval. For blocked network access, request a narrow execution prefix
35
+ such as `["kw", "resources"]` or `["kw", "run", "dev-host"]` through Codex's approval interface.
36
+ Review those prefixes before saving them; do not blanket-allow `kw` or disable the sandbox.
37
+ See the [official Codex rules documentation](https://learn.chatgpt.com/docs/agent-configuration/rules).
38
+ Setup installs agent instructions; it does not change Codex execution rules.
39
+
40
+ Network calls have a 15-second startup/handshake deadline and a separate response deadline of
41
+ the requested operation timeout plus 30 seconds. Worker cleanup adds at most one second before
42
+ termination. The worker inherits the sandbox and receives credentials over a private pipe.
43
+ This also bounds stalls in DNS resolution or SDK shutdown. Phone approval polling and remote
44
+ command timeouts keep their existing budgets. Transport errors exit 6 without retrying operations;
45
+ check the audit record before repeating an operation with an unknown outcome.
46
+
47
+ Session attribution uses `KW_SESSION` first, then header-safe `CODEX_THREAD_ID` metadata when
48
+ present, then Linux process ancestry. The metadata path was observed in Codex desktop; hosts
49
+ that do not supply it retain the fallback. Compare `kw session` inside and outside the sandbox
50
+ to check attribution. Process fallback is per process, not necessarily per conversation.
51
+ Switching from process to thread identity requires fresh session-scoped approvals.
52
+
53
+ ## License
54
+
55
+ Keywright is licensed under [Apache-2.0](LICENSE). Copyright 2026 Keywright
56
+ contributors. See [NOTICE](NOTICE) and [third-party notices](THIRD_PARTY_NOTICES).
57
+ Commercial use and proprietary extensions are permitted under the license's terms.
58
+ Unless explicitly stated otherwise, contributions intentionally submitted for
59
+ inclusion in Keywright are provided under Apache-2.0.
@@ -0,0 +1,55 @@
1
+ Third-party components
2
+ ======================
3
+
4
+ Apache-2.0 applies to Keywright's own code and documentation. Dependencies,
5
+ container base images, optional services and embedding models retain their own
6
+ licenses. This file is a guide to those components, not a replacement for their
7
+ license texts or a complete inventory of a particular image.
8
+
9
+ Python dependencies
10
+ -------------------
11
+ Keywright distributions declare dependencies rather than vendoring them. pip
12
+ installs their license files alongside their package metadata, typically under
13
+ /usr/local/lib/python3.13/site-packages/<distribution>.dist-info/ in the supplied
14
+ images. Preserve those files when redistributing an installation or image.
15
+ The pyproject.toml files declare the dependency ranges; resolved versions may
16
+ change between builds.
17
+
18
+ AsyncSSH is used as an unmodified library under EPL-2.0. Its installed asyncssh/
19
+ directory contains the Python source, including upstream copyright headers;
20
+ its distribution metadata includes the Eclipse Public License text. Source and
21
+ release history: https://github.com/ronf/asyncssh
22
+
23
+ Certifi uses MPL-2.0 for its certificate bundle. The installed certifi/ directory
24
+ contains the bundle and Python source, and its distribution metadata includes
25
+ the license. Source and release history: https://github.com/certifi/python-certifi
26
+
27
+ Container operating-system packages
28
+ -----------------------------------
29
+ The images use the official Python slim image and Debian packages. License and
30
+ copyright notices are retained under /usr/share/doc/<package>/copyright and in
31
+ Python's installation. Debian source packages are available through the Debian
32
+ archive and https://snapshot.debian.org/ for the corresponding package version.
33
+ Some system tools have copyleft licenses; redistributors must satisfy their
34
+ source-distribution requirements as well as retaining notices. The release workflow verifies exact installed versions against a reviewed source
35
+ lock and publishes matching source materials before publishing the application
36
+ image. The image label io.keywright.source-image identifies the matching source
37
+ image in the same registry package; retain it while distributing the application.
38
+ Version-tag builds also attach source and notice assets to a draft GitHub Release. A Keywright image license label describes the
39
+ Keywright application, not every component in the image.
40
+
41
+ Optional services
42
+ -----------------
43
+ PostgreSQL, pgvector, LiteLLM and any embedding server/model are separate services
44
+ with their own upstream terms. Check the particular image and model version you
45
+ deploy or redistribute. Keywright's license does not relicense those services.
46
+
47
+ Supplemental native notices and source coverage
48
+ ---------------------------------------------
49
+ Prebuilt images include supplemental upstream notices under
50
+ /usr/share/keywright/licenses/LICENSES.txt and a verified dependency inventory.
51
+ The source lock and notice provenance are maintained under third_party/ in the
52
+ repository. This covers bundled native libraries in addition to installed package
53
+ notices, including libffi, libuv, OpenSSL and Rust components. See
54
+ https://github.com/johnrcarty/keywright/blob/main/third_party/README.md for obtaining
55
+ and verifying the matching source archive without running the source image.
@@ -0,0 +1,3 @@
1
+ """Keywright client: `kw` for agents, the hazard tripwire, and agent-machine setup."""
2
+
3
+ __version__ = "0.0.1"
@@ -0,0 +1,29 @@
1
+ """Private MCP worker. Its stdout is a JSON-lines pipe owned by transport.acall."""
2
+
3
+ import asyncio
4
+ import json
5
+ import sys
6
+
7
+ from .config import Profile
8
+ from .transport import NETWORK_HINT, AuthError, TransportError, _call
9
+
10
+
11
+ def emit(kind, data):
12
+ print(json.dumps([kind, data]), flush=True)
13
+
14
+
15
+ def main():
16
+ try:
17
+ request = json.load(sys.stdin)
18
+ asyncio.run(_call(Profile(**request["profile"]), request["session"], request["tool"],
19
+ request["arguments"], request["read_timeout"], emit))
20
+ except AuthError as e:
21
+ emit("auth", str(e))
22
+ except TransportError as e:
23
+ emit("error", str(e))
24
+ except Exception as e: # noqa: BLE001 - never leak raw exceptions across the worker boundary
25
+ emit("error", f"{type(e).__name__}; {NETWORK_HINT}")
26
+
27
+
28
+ if __name__ == "__main__":
29
+ main()