From 59182f7c86282869eaf7090ca4a217a706dd7e82 Mon Sep 17 00:00:00 2001 From: CodFrm Date: Tue, 21 Jul 2026 09:04:16 +0800 Subject: [PATCH 1/6] feat: add sctl daemon --- .github/workflows/ci.yaml | 45 ++ .github/workflows/release.yaml | 26 ++ .gitignore | 2 + .goreleaser.yaml | 46 ++ LICENSE | 674 +++++++++++++++++++++++++++ PROTOCOL.md | 198 ++++++++ README.md | 95 ++++ THREAT-MODEL.md | 86 ++++ cmd/sctl/main.go | 29 ++ configs/config.yaml | 8 + embed.go | 10 + go.mod | 34 ++ go.sum | 78 ++++ internal/audit/audit.go | 128 +++++ internal/audit/audit_test.go | 87 ++++ internal/auth/atomic.go | 35 ++ internal/auth/clientstore.go | 173 +++++++ internal/auth/crypto.go | 215 +++++++++ internal/auth/crypto_test.go | 151 ++++++ internal/auth/keystore.go | 43 ++ internal/auth/store_test.go | 122 +++++ internal/bridge/audit_test.go | 174 +++++++ internal/bridge/component.go | 144 ++++++ internal/bridge/conn.go | 233 +++++++++ internal/bridge/control.go | 210 +++++++++ internal/bridge/control_test.go | 277 +++++++++++ internal/bridge/envelope.go | 146 ++++++ internal/bridge/server.go | 529 +++++++++++++++++++++ internal/bridge/server_test.go | 354 ++++++++++++++ internal/cli/cli.go | 98 ++++ internal/cli/cli_test.go | 231 +++++++++ internal/cli/daemon_cmds.go | 104 +++++ internal/cli/dispatch.go | 85 ++++ internal/cli/mcp.go | 127 +++++ internal/cli/scripts.go | 108 +++++ internal/cli/serve.go | 59 +++ internal/cli/write.go | 104 +++++ internal/config/paths.go | 75 +++ internal/control/client.go | 305 ++++++++++++ internal/control/client_test.go | 117 +++++ internal/control/protocol.go | 113 +++++ internal/control/spawn_unix.go | 26 ++ internal/control/spawn_windows.go | 31 ++ internal/control/token.go | 42 ++ internal/fsutil/atomic.go | 36 ++ internal/logging/logging.go | 54 +++ internal/mcpidentity/identity.go | 59 +++ internal/mcpserver/mcpserver.go | 149 ++++++ internal/mcpserver/mcpserver_test.go | 223 +++++++++ internal/mcpserver/tools.go | 58 +++ internal/protocol/protocol.go | 84 ++++ internal/protocol/protocol_test.go | 57 +++ internal/ratelimit/ratelimit.go | 49 ++ internal/ratelimit/ratelimit_test.go | 40 ++ protocol.json | 88 ++++ 55 files changed, 6874 insertions(+) create mode 100644 .github/workflows/ci.yaml create mode 100644 .github/workflows/release.yaml create mode 100644 .gitignore create mode 100644 .goreleaser.yaml create mode 100644 LICENSE create mode 100644 PROTOCOL.md create mode 100644 THREAT-MODEL.md create mode 100644 cmd/sctl/main.go create mode 100644 configs/config.yaml create mode 100644 embed.go create mode 100644 go.mod create mode 100644 go.sum create mode 100644 internal/audit/audit.go create mode 100644 internal/audit/audit_test.go create mode 100644 internal/auth/atomic.go create mode 100644 internal/auth/clientstore.go create mode 100644 internal/auth/crypto.go create mode 100644 internal/auth/crypto_test.go create mode 100644 internal/auth/keystore.go create mode 100644 internal/auth/store_test.go create mode 100644 internal/bridge/audit_test.go create mode 100644 internal/bridge/component.go create mode 100644 internal/bridge/conn.go create mode 100644 internal/bridge/control.go create mode 100644 internal/bridge/control_test.go create mode 100644 internal/bridge/envelope.go create mode 100644 internal/bridge/server.go create mode 100644 internal/bridge/server_test.go create mode 100644 internal/cli/cli.go create mode 100644 internal/cli/cli_test.go create mode 100644 internal/cli/daemon_cmds.go create mode 100644 internal/cli/dispatch.go create mode 100644 internal/cli/mcp.go create mode 100644 internal/cli/scripts.go create mode 100644 internal/cli/serve.go create mode 100644 internal/cli/write.go create mode 100644 internal/config/paths.go create mode 100644 internal/control/client.go create mode 100644 internal/control/client_test.go create mode 100644 internal/control/protocol.go create mode 100644 internal/control/spawn_unix.go create mode 100644 internal/control/spawn_windows.go create mode 100644 internal/control/token.go create mode 100644 internal/fsutil/atomic.go create mode 100644 internal/logging/logging.go create mode 100644 internal/mcpidentity/identity.go create mode 100644 internal/mcpserver/mcpserver.go create mode 100644 internal/mcpserver/mcpserver_test.go create mode 100644 internal/mcpserver/tools.go create mode 100644 internal/protocol/protocol.go create mode 100644 internal/protocol/protocol_test.go create mode 100644 internal/ratelimit/ratelimit.go create mode 100644 internal/ratelimit/ratelimit_test.go create mode 100644 protocol.json diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..45f58cb --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,45 @@ +name: ci + +on: + push: + branches: [main] + pull_request: + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v5 + - uses: actions/setup-go@v6 + with: + go-version-file: go.mod + cache: true + - run: go build ./... + - run: go vet ./... + - run: go test -race ./... + + protocol-drift: + # protocol.json 是扩展与守卫共用的单一事实源(设计文档 §5):两份镜像一旦漂移, + # 双方对 action / scope / 限值的理解就会分叉,且只在运行时才暴露。这里做逐字节比对。 + # + # 扩展侧该文件随 MCP 桥接 PR 合入 main 后此 job 才能通过;在那之前把仓库变量 + # EXT_PROTOCOL_REF 指到对应 PR 分支。 + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v5 + - name: 拉取扩展侧协议镜像 + env: + EXT_REF: ${{ vars.EXT_PROTOCOL_REF || 'main' }} + run: | + set -euo pipefail + url="https://raw.githubusercontent.com/scriptscat/scriptcat/${EXT_REF}/src/app/service/service_worker/mcp/protocol.json" + if ! curl -fsSL "$url" -o ext-protocol.json; then + echo "::error::拉取扩展侧 protocol.json 失败(ref=${EXT_REF})。扩展侧尚未合入时,请把仓库变量 EXT_PROTOCOL_REF 指到对应分支。" + exit 1 + fi + - name: 比对协议单源 + run: | + if ! diff -u ext-protocol.json protocol.json; then + echo "::error::protocol.json 与扩展侧镜像不一致,两侧须同步更新。" + exit 1 + fi diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..9f44a99 --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,26 @@ +name: release + +on: + push: + tags: ["v*"] + +permissions: + contents: write + +jobs: + goreleaser: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v5 + with: + fetch-depth: 0 + - uses: actions/setup-go@v6 + with: + go-version-file: go.mod + cache: true + - uses: goreleaser/goreleaser-action@v6 + with: + version: "~> v2" + args: release --clean + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..415301e --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/sctl +dist/ diff --git a/.goreleaser.yaml b/.goreleaser.yaml new file mode 100644 index 0000000..35ba900 --- /dev/null +++ b/.goreleaser.yaml @@ -0,0 +1,46 @@ +version: 2 + +project_name: sctl + +before: + hooks: + - go mod tidy + +builds: + - id: sctl + main: ./cmd/sctl + binary: sctl + env: + - CGO_ENABLED=0 + goos: [darwin, linux, windows] + goarch: [amd64, arm64] + # 版本注入到 internal/cli.Version(sctl version / hello 的 daemonVersion 都读它)。 + ldflags: + - -s -w -X github.com/scriptscat/sctl/internal/cli.Version={{ .Version }} + +archives: + - id: sctl + formats: [tar.gz] + format_overrides: + - goos: windows + formats: [zip] + files: + - README.md + - PROTOCOL.md + - THREAT-MODEL.md + - LICENSE* + +checksum: + name_template: checksums.txt + +changelog: + use: github + sort: asc + filters: + exclude: + - "^docs:" + - "^test:" + - "^chore:" + +release: + draft: true diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/PROTOCOL.md b/PROTOCOL.md new file mode 100644 index 0000000..d0c0725 --- /dev/null +++ b/PROTOCOL.md @@ -0,0 +1,198 @@ +# ScriptCat 桥接协议(WS 版,protocol v1) + +> 状态:Phase 0 草案。常量的唯一权威是同目录 [`protocol.json`](./protocol.json),本文只解释语义;两者冲突以 json 为准。 +> 最终归宿:`protocol.json` 入 scriptcat 仓库、镜像进 `scriptscat/sctl`(CI 逐字节比对);本文改写为 sctl 仓库 `PROTOCOL.md`(届时补英文版)。 +> 设计背景与决策记录见 [`../2026-07-17-mcp-bridge-ws-redesign-design.md`](../2026-07-17-mcp-bridge-ws-redesign-design.md)。 + +## 1. 角色与拓扑 + +```text +MCP 客户端 ─ stdio ─→ sctl mcp ──┐(进程内/本机内部,不属于本协议) +CLI 动词(sctl install …)────────┤ + ▼ + sctl serve(daemon,WS server,仅绑定 127.0.0.1:8643) + ▲ 本协议 = 这条 WS 连接上的消息 + ScriptCat 扩展(offscreen WS client) +``` + +本协议只定义 **扩展 ↔ daemon** 这条 WS 连接。`sctl mcp` / CLI 动词与 daemon 之间是同一二进制的内部通信,不需要跨实现互操作,不在此约定。 + +角色约定:daemon 是 server 但**不是权威**——脚本数据与写操作决策的权威在扩展侧;daemon 是 MCP 客户端授权(token/scope)的权威,扩展保存镜像用于 UI 与二次校验。 + +## 2. 传输与 Envelope + +- WebSocket,JSON text frame,单帧上限 `limits.maxFrameBytes`(4 MiB),超限即 `PAYLOAD_TOO_LARGE` 或直接断开; +- daemon 仅监听 loopback;`ws://` 明文仅允许 loopback,远程必须 `wss://`(v1 不实现); +- 所有消息共用信封: + +```jsonc +{ "v": 1, "type": "", "requestId": "", "payload": { } } +``` + +- `requestId` 由发起方生成,应答方原样回填;推送类消息(`pair.request`、`client.sync` 等)也带独立 `requestId` 仅作日志关联; +- 未知 `type`:忽略并记日志(前向兼容);`v` 不等于 1:立即断开; +- 心跳:双方任一侧可发 `ping`(空 payload),对端回 `pong`;建议间隔 `limits.pingIntervalMs`,两个周期无响应视为断线。 + +## 3. 连接生命周期 + +```text +connect → auth.challenge → auth.response → auth.ok → hello → [业务消息…] → close +``` + +握手完成前,除 `auth.*` 外的任何消息导致立即断开。认证在 `limits.authTimeoutMs`(5s)内未完成即断开。**认证失败不回显原因**:统一以 close code 1008 关闭,无详细 reason(不给探测者信息;不做 Origin 判别,唯一闸门是握手本身)。 + +### 3.1 会话握手(已配对,双向 HMAC) + +K = 配对建立的 256-bit 共享密钥。nonce 为 32 字节随机数,一律小写 hex;比较一律恒定时间。 + +```text +daemon → ext auth.challenge { nonceD } +ext → daemon auth.response { mode: "session", nonceE, + hmac: HMAC(K, ctx.sessionExt || nonceD || nonceE) } +daemon 验证 → auth.ok { hmac: HMAC(K, ctx.sessionDaemon || nonceE || nonceD) } +ext 验证 → 握手完成 +``` + +任一侧验证失败即断开。nonce 每连接新生成,重放无效。 + +### 3.2 配对握手(首次/重新配对) + +前置:用户在终端执行 `sctl pair`,daemon 生成一次性配对码(Crockford base32,8 字符,展示为 `XXXX-XXXX`,TTL 2 分钟、验证 3 次失败即作废)并打开配对窗口;用户将码填入扩展设置。 + +从配对码派生临时密钥(salt/info 见 `crypto.context`): + +```text +Kp_mac = HKDF-SHA-256(code, salt=pairKdfSalt, info=pairKdfInfoMac) +Kp_enc = HKDF-SHA-256(code, salt=pairKdfSalt, info=pairKdfInfoEnc) +``` + +握手同 3.1,但 `mode: "pairing"`、MAC 上下文换用 `ctx.pairExt` / `ctx.pairDaemon`、密钥用 `Kp_mac`;daemon 校验通过后生成新的长期密钥 K,在 `auth.ok` 中附加: + +```jsonc +{ "hmac": "…", "key": { "ciphertext": "", "iv": "" } } +``` + +扩展解密并持久化 K(`chrome.storage.local`),daemon 落盘(0600)。配对窗口随即关闭。**重新配对即替换**:daemon 只保存一份 K(单扩展实例),替换时立即断开旧密钥的存活连接。 + +### 3.3 hello 与版本协商 + +握手成功后 daemon 立即推送: + +```jsonc +{ "type": "hello", "payload": { "daemonVersion": "0.1.0", "protocolVersion": 1 } } +``` + +扩展校验:`protocolVersion` 不符,或 `daemonVersion < versions.minDaemonVersion` → 断开并将 UI 状态置为「版本过旧」。 + +### 3.4 关闭 + +- daemon 计划退出 → 推送 `bridge.shutdown`(空 payload)后关闭;扩展进入指数退避重连; +- 扩展禁用桥接/kill switch → 直接关闭连接即可(无专用消息);kill switch 另通过 `client.revoke` 逐个撤销(见 §6)。 + +## 4. bridge actions(daemon → ext 请求,扩展执行) + +daemon 转发 MCP 工具调用 / CLI 动词为 `bridge.request`: + +```jsonc +{ "type": "bridge.request", "requestId": "…", "payload": { + "protocolVersion": 1, + "clientId": "<发起客户端,内建 CLI 为 'sctl-cli'>", + "action": "", + "input": { } +} } +``` + +应答 `bridge.response`(payload 二选一): + +```jsonc +{ "ok": true, "result": { } } +{ "ok": false, "error": { "code": "", "message": "…" } } +``` + +鉴权双层:daemon 先按自己的 token/scope 记录过滤;扩展再按镜像的客户端记录独立复核(`INSUFFICIENT_SCOPE`)。`input` 严格白名单校验,多余字段即 `INVALID_REQUEST`。 + +| action | input | result(ok 时) | +|---|---|---| +| `scripts.list` | `{}` | `{ scripts: ScriptSummary[] }` | +| `scripts.metadata.get` | `{ uuid }` | `ScriptMetadata` | +| `scripts.source.get` | `{ uuid }` | `ScriptSource`(≤ `limits.maxSourceBytes`,超出 `PAYLOAD_TOO_LARGE`) | +| `scripts.install.request` | `{ url }` 或 `{ code }`(二选一,同给或全缺 = `INVALID_REQUEST`) | `{ uuid, name, version?, enabled }`(enabled 默认 false,用户在确认页勾选「立即启用」才为 true) | +| `scripts.toggle.request` | `{ uuid, enable: boolean }` | `{ uuid, enabled }` | +| `scripts.delete.request` | `{ uuid }` | `{ uuid, deleted: true }` | + +`ScriptSummary` / `ScriptMetadata` / `ScriptSource` 结构沿用 #1573(`ScriptSource.contentTrust` 恒为 `"untrusted-user-script-source"`,脚本控制的文本永远作为结构化数据返回,不得拼进工具描述或 Markdown)。metadata 层不返回真实更新 URL(可能含 token),只返回 `hasUpdateUrl`。 + +## 5. 写操作与阻塞语义 + +写类 action(`actions[*].write == true`)与源码披露(`blocking: "disclosure"`)在扩展侧**挂起**,直到用户在确认页/披露弹窗决策后才回 `bridge.response`: + +- 批准 → 执行(执行前重验 TOCTOU 锚点:staged `contentHash`、目标脚本 `existingCodeHash`、客户端未撤销;不符 → `CONFLICT`)→ `ok: true`; +- 拒绝 → `USER_REJECTED`; +- 挂起达 `limits.writeDecisionTtlMs`(5 分钟)→ 作废 → `OPERATION_EXPIRED`; +- 写策略为「直接允许」(全局或该客户端覆盖)→ 不挂起,立即执行返回(源码披露不受此豁免;内建 `sctl-cli` 的源码读取例外,见设计文档 §3.1)。 + +**断开即作废(bridge.cancel)**:请求方链路任何一环消失(MCP 客户端超时或 `notifications/cancelled`、shim 退出、CLI Ctrl-C、内部会话断开),daemon 立即发: + +```jsonc +{ "type": "bridge.cancel", "requestId": "<原 bridge.request 的 requestId>", "payload": {} } +``` + +扩展作废对应操作、关闭/失效确认页,且**不再**对该 requestId 发送 `bridge.response`;daemon 忽略取消后迟到的应答。批准与作废在扩展侧**串行仲裁,先到先得,单次生效**——不存在批准已死请求。WS 连接整体断开 = 隐式取消全部在途请求。 + +确认页语义:误关标签页 ≠ 拒绝,请求保持挂起(至作废/超时),扩展从 popup/设置页「待确认」入口可重新打开;多个待决请求串行展示。 + +## 6. MCP 客户端管理(daemon 权威,扩展 UI 决策) + +**配对**:未知客户端首次调用工具时,daemon 生成 `pairingId` + 8 字符核对码,在请求方终端展示,同时推送: + +```jsonc +{ "type": "pair.request", "payload": { + "pairingId": "…", "clientName": "…", "requestedScopes": ["…"], "code": "XXXXXXXX" +} } +``` + +扩展弹配对对话框(用户核对两端码一致、勾选授予的 scope),回: + +```jsonc +{ "type": "pair.decision", "payload": { "pairingId": "…", "approved": true, "grantedScopes": ["…"] } } +``` + +批准后 daemon 铸造 clientId/token(token 只存 SHA-256,原文永不过线、不进日志/URL/扩展存储),TTL 2 分钟未决即作废。 + +**同步**:客户端集合任何变化(新配对、撤销、scope 调整、lastUsed)后,daemon 推送全量镜像: + +```jsonc +{ "type": "client.sync", "payload": [ McpClientRecord, … ] } +``` + +`McpClientRecord = { clientId, displayName, tokenHash, scopes, createdAt, lastUsedAt, revoked }`(#1573 原样)。扩展逐字镜像存储,用于 UI 展示与请求二次校验。 + +**撤销**:用户在扩展 UI 撤销某客户端 → `client.revoke { clientId }`(ext → daemon)→ daemon 立即失效 token、断开该客户端在途请求(触发其 `bridge.cancel` 路径)、回推 `client.sync`。kill switch = 逐个 revoke + 扩展断开连接。 + +内建 `sctl-cli` 身份不在 `client.sync` 列表中,不可撤销(与桥接开关同生命周期),审计照常记录。 + +## 7. 错误码 + +| code | 触发 | +|---|---| +| `INVALID_REQUEST` | envelope/input 校验失败、未知 action、多余字段 | +| `UNAUTHENTICATED` | daemon 侧 token 无效/已撤销(握手失败不走错误码,直接断开) | +| `INSUFFICIENT_SCOPE` | daemon 或扩展任一层 scope 校验失败 | +| `WRITE_MODE_DISABLED` | 桥接写功能被全局禁用(kill switch 后) | +| `USER_APPROVAL_REQUIRED` | 保留(阻塞模型下正常流程不返回;供非阻塞客户端未来使用) | +| `USER_REJECTED` | 用户在确认页/披露弹窗点了拒绝 | +| `OPERATION_EXPIRED` | 挂起超过 writeDecisionTtlMs 未决 | +| `CONFLICT` | 批准瞬间 TOCTOU 复核失败(staged/目标哈希不符、脚本已变) | +| `NOT_FOUND` | uuid 不存在 | +| `RATE_LIMITED` | 超过 daemon 或扩展侧限流 | +| `PAYLOAD_TOO_LARGE` | 源码超 maxSourceBytes / 帧超 maxFrameBytes | +| `INTERNAL_ERROR` | 其余异常;message 不携带内部细节 | + +限流默认值(实现可调,非协议常量):配对尝试 5/分;每客户端读 60/分、写 10/分;审计事件永不记录 token、源码或含凭据的 URL。 + +## 8. 一致性与安全注记 + +- **一致性**:扩展侧 conformance test 与 sctl CI 均逐字节比对各自打包的 `protocol.json` 与权威副本;枚举新增走 `protocolVersion` 递增或前向兼容的「未知即忽略」路径; +- **不做 Origin 判别**:防小人不防君子(非浏览器进程可任意伪造),闸门只有握手; +- **威胁边界**:同用户完整权限的本机进程不设防(可读 daemon 密钥文件),见 THREAT-MODEL; +- **扩展实现注记**(非协议约束):挂起请求不得依赖 SW 内存悬挂 Promise(MV3 SW 可休眠),`bridge.response` 由决策事件驱动经 offscreen 回发;offscreen 由 WS 连接保活。 diff --git a/README.md b/README.md index 5aba2c3..4f63b77 100644 --- a/README.md +++ b/README.md @@ -1 +1,96 @@ # sctl + +ScriptCat 的本地控制工具:桥接 daemon、MCP server 与脚本管理命令,单二进制跨平台分发。基于 [cago](https://github.com/cago-frame/cago) 框架 + [cobra](https://github.com/spf13/cobra)。 + +> ⚠️ 开发中(WIP)。协议见 [`PROTOCOL.md`](./PROTOCOL.md),安全边界见 [`THREAT-MODEL.md`](./THREAT-MODEL.md);`protocol.json` 为常量镜像,权威副本在 [scriptcat 主仓库](https://github.com/scriptscat/scriptcat)。 + +```text +MCP 客户端(Claude/Codex…)─ stdio ─→ sctl mcp ─┐(本机内部连接:loopback 控制 API) +CLI 动词(sctl scripts list / install …)───────┤ + ▼ + sctl serve(daemon,WS 仅监听 127.0.0.1:8643) + ▲ WebSocket(扩展主动连接 + 双向 HMAC 握手) + ScriptCat 浏览器扩展(审批与授权的权威端) +``` + +`sctl mcp` / CLI 动词与常驻 `sctl serve` 是**独立进程**,经 daemon listener 上的 `/control/*` HTTP/JSON 控制 API 通信(与扩展 WS 面同端口、独立路径,凭 daemon 写下的 0600 控制令牌鉴权)。发现 daemon 未运行时自动以 detached 方式拉起;多个前端冷启动的绑定竞态按「绑定失败即连接既有实例」处理。 + +## 子命令 + +| 命令 | 说明 | +|---|---| +| `sctl serve` | 运行桥接 daemon(cago 应用;WS 仅监听 loopback,并挂载控制 API) | +| `sctl mcp [--name