├── .gitignore ├── LICENSE ├── README.md ├── cmd ├── build.sh └── main.go ├── go.mod └── pkgs ├── common ├── common.go ├── options.go └── runner.go ├── page └── browser.go └── web └── web.go /.gitignore: -------------------------------------------------------------------------------- 1 | # If you prefer the allow list template instead of the deny list, see community template: 2 | # https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore 3 | # 4 | # Binaries for programs and plugins 5 | *.exe 6 | *.exe~ 7 | *.dll 8 | *.so 9 | *.dylib 10 | 11 | # Test binary, built with `go test -c` 12 | *.test 13 | 14 | # Output of the go coverage tool, specifically when used with LiteIDE 15 | *.out 16 | 17 | # Dependency directories (remove the comment below to include it) 18 | # vendor/ 19 | 20 | # Go workspace file 21 | go.work 22 | remotejs_* 23 | .idea/ 24 | go.sum 25 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # remotejs 2 | remote execute js when debugger.paused (use CDP) 3 | 基于CDP实现的远程JS debug工具 4 | 5 | ## example 6 | ```shell 7 | 前置条件, 需要安装chrome 8 | 9 | # 查看帮助 10 | ./remotejs -h 11 | GLOBAL OPTIONS: 12 | --url value, -u value open url when open chrome, default blank url 13 | --chrome-path value, --cp value use specified chrome path 14 | --proxy value set proxy for browser 15 | --remote-debug-address value use remote chrome debugging 16 | --web-listen value web server port (default: "8088") 17 | --help, -h show help 18 | 19 | 20 | ./remotejs # 打开一个空白的浏览器 21 | ./remotejs -u [URL] # 打开一个浏览器，并加载指定url 22 | ./remotejs --remote-debug-address "ws://127.0.0.1:9222" # 指定一个远程浏览器(需要目标开remote-debugger-port) 23 | 24 | # 调用方法 25 | 请求 `curl -X POST "http://127.0.0.1:8088/remote" -d "eval=myMask.target.id"` 26 | 响应 27 | `{"type":"string","value":"ext-comp-1009"}` 28 | 29 | 30 | # 其他看 --help 31 | ``` 32 | 33 | ## Todos (下次一定的事情) 34 | - [ ] 多tab的debugPauseEvent捕获 35 | - [ ] 配置文件 36 | - [ ] 其他 37 | -------------------------------------------------------------------------------- /cmd/build.sh: -------------------------------------------------------------------------------- 1 | rm -rf remotejs_windows_386.exe remotejs_windows_amd64.exe remotejs_darwin_amd64 remotejs_darwin_arm64 2 | echo "gen windows" 3 | CGO_ENABLED=1 GOOS=windows GOARCH=386 CC="i686-w64-mingw32-gcc" go build --trimpath -ldflags "-s -w" -o remotejs_windows_386.exe main.go 4 | CGO_ENABLED=1 GOOS=windows GOARCH=amd64 CC="x86_64-w64-mingw32-gcc" go build --trimpath -ldflags "-s -w" -o remotejs_windows_amd64.exe main.go 5 | echo "gen darwin" 6 | go build --trimpath -ldflags "-s -w" -o remotejs_darwin_amd64 main.go 7 | echo "gen darwin arm64" 8 | CGO_ENABLED=1 GOOS=darwin GOARCH=arm64 SDKROOT=$(xcrun --sdk macosx --show-sdk-path) go build --trimpath -ldflags "-s -w" -o remotejs_darwin_arm64 main.go 9 | -------------------------------------------------------------------------------- /cmd/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "errors" 5 | "github.com/1oid/remotejs/pkgs/common" 6 | "github.com/1oid/remotejs/pkgs/page" 7 | "github.com/1oid/remotejs/pkgs/web" 8 | "github.com/chromedp/cdproto/runtime" 9 | "github.com/chromedp/chromedp" 10 | "github.com/urfave/cli/v2" 11 | "log" 12 | "os" 13 | ) 14 | 15 | func runner(c *cli.Context) error { 16 | var tasks = chromedp.Tasks{} 17 | var opts = page.NewOpts( 18 | chromedp.Flag("headless", false)) 19 | 20 | if common.Vars.Url != "" { 21 | tasks = append(tasks, chromedp.Navigate(common.Vars.Url)) 22 | } 23 | 24 | if common.Vars.ChromePath != "" { 25 | if _, err := os.Stat(common.Vars.ChromePath); err != nil { 26 | log.Fatal(errors.New("error chrome path")) 27 | } 28 | opts = append(opts, chromedp.ExecPath(common.Vars.ChromePath)) 29 | } 30 | 31 | if common.Vars.Proxy != "" { 32 | opts = append(opts, chromedp.ProxyServer(common.Vars.Proxy)) 33 | } 34 | 35 | var ctx = page.LaunchBrowser(tasks, opts, common.Vars.RemoteDebuggingAddr) 36 | 37 | web.WebRunner(common.Vars.WebListenPort, func(t string) (*runtime.RemoteObject, error) { 38 | return page.EvaluateCall(ctx, page.CallFrameId, t) 39 | }) 40 | return nil 41 | } 42 | 43 | func main() { 44 | common.NewRunner(runner) 45 | } 46 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/1oid/remotejs 2 | 3 | go 1.18 4 | 5 | require ( 6 | github.com/bytedance/sonic v1.9.1 // indirect 7 | github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect 8 | github.com/chromedp/cdproto v0.0.0-20230601223857-b9862e644d94 // indirect 9 | github.com/chromedp/chromedp v0.9.1 // indirect 10 | github.com/chromedp/sysutil v1.0.0 // indirect 11 | github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect 12 | github.com/gabriel-vasile/mimetype v1.4.2 // indirect 13 | github.com/gin-contrib/sse v0.1.0 // indirect 14 | github.com/gin-gonic/gin v1.9.1 // indirect 15 | github.com/go-playground/locales v0.14.1 // indirect 16 | github.com/go-playground/universal-translator v0.18.1 // indirect 17 | github.com/go-playground/validator/v10 v10.14.0 // indirect 18 | github.com/gobwas/httphead v0.1.0 // indirect 19 | github.com/gobwas/pool v0.2.1 // indirect 20 | github.com/gobwas/ws v1.2.1 // indirect 21 | github.com/goccy/go-json v0.10.2 // indirect 22 | github.com/josharian/intern v1.0.0 // indirect 23 | github.com/json-iterator/go v1.1.12 // indirect 24 | github.com/klauspost/cpuid/v2 v2.2.4 // indirect 25 | github.com/leodido/go-urn v1.2.4 // indirect 26 | github.com/mailru/easyjson v0.7.7 // indirect 27 | github.com/mattn/go-isatty v0.0.19 // indirect 28 | github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect 29 | github.com/modern-go/reflect2 v1.0.2 // indirect 30 | github.com/pelletier/go-toml/v2 v2.0.8 // indirect 31 | github.com/russross/blackfriday/v2 v2.1.0 // indirect 32 | github.com/twitchyliquid64/golang-asm v0.15.1 // indirect 33 | github.com/ugorji/go/codec v1.2.11 // indirect 34 | github.com/urfave/cli/v2 v2.25.5 // indirect 35 | github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect 36 | golang.org/x/arch v0.3.0 // indirect 37 | golang.org/x/crypto v0.9.0 // indirect 38 | golang.org/x/net v0.10.0 // indirect 39 | golang.org/x/sys v0.8.0 // indirect 40 | golang.org/x/text v0.9.0 // indirect 41 | google.golang.org/protobuf v1.30.0 // indirect 42 | gopkg.in/yaml.v3 v3.0.1 // indirect 43 | ) 44 | -------------------------------------------------------------------------------- /pkgs/common/common.go: -------------------------------------------------------------------------------- 1 | package common 2 | 3 | var Vars = &VarsOption{} 4 | -------------------------------------------------------------------------------- /pkgs/common/options.go: -------------------------------------------------------------------------------- 1 | package common 2 | 3 | type VarsOption struct { 4 | Url string 5 | ChromePath string 6 | Devtools bool 7 | WebListenPort string 8 | Proxy string 9 | RemoteDebuggingAddr string 10 | } 11 | -------------------------------------------------------------------------------- /pkgs/common/runner.go: -------------------------------------------------------------------------------- 1 | package common 2 | 3 | import ( 4 | "github.com/urfave/cli/v2" 5 | "log" 6 | "os" 7 | ) 8 | 9 | var cliApp *cli.App 10 | 11 | func NewRunner(action cli.ActionFunc) { 12 | cliApp.Action = action 13 | err := cliApp.Run(os.Args) 14 | if err != nil { 15 | log.Fatal(err) 16 | } 17 | } 18 | 19 | func init() { 20 | cliApp = &cli.App{ 21 | Flags: []cli.Flag{ 22 | &cli.StringFlag{ 23 | Name: "url", 24 | Aliases: []string{"u"}, 25 | Usage: "open url when open chrome, default blank url", 26 | Destination: &Vars.Url, 27 | Value: "", 28 | }, 29 | &cli.StringFlag{ 30 | Name: "chrome-path", 31 | Aliases: []string{"cp"}, 32 | Usage: "use specified chrome path", 33 | Destination: &Vars.ChromePath, 34 | Value: "", 35 | }, 36 | &cli.StringFlag{ 37 | Name: "proxy", 38 | Usage: "set proxy for browser", 39 | Destination: &Vars.Proxy, 40 | Value: "", 41 | }, 42 | &cli.StringFlag{ 43 | Name: "remote-debug-address", 44 | Usage: "use remote chrome debugging", 45 | Destination: &Vars.RemoteDebuggingAddr, 46 | Value: "", 47 | }, 48 | &cli.StringFlag{ 49 | Name: "web-listen", 50 | Usage: "web server port", 51 | Destination: &Vars.WebListenPort, 52 | Value: "8088", 53 | }, 54 | }, 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /pkgs/page/browser.go: -------------------------------------------------------------------------------- 1 | package page 2 | 3 | import ( 4 | "context" 5 | "errors" 6 | "github.com/chromedp/cdproto/cdp" 7 | "github.com/chromedp/cdproto/debugger" 8 | "github.com/chromedp/cdproto/runtime" 9 | "github.com/chromedp/chromedp" 10 | "log" 11 | ) 12 | 13 | var CallFrameId debugger.CallFrameID 14 | 15 | func addListener(ctx context.Context) { 16 | chromedp.ListenTarget(ctx, func(ev interface{}) { 17 | switch ev.(type) { 18 | case *debugger.EventPaused: 19 | var d = ev.(*debugger.EventPaused) 20 | 21 | if len(d.CallFrames) > 0 { 22 | CallFrameId = d.CallFrames[0].CallFrameID 23 | } 24 | } 25 | }) 26 | } 27 | 28 | func getContext(ctx context.Context) (*chromedp.Context, error) { 29 | c := chromedp.FromContext(ctx) 30 | // If c is nil, it's not a chromedp context. 31 | // If c.Allocator is nil, NewContext wasn't used properly. 32 | // If c.cancel is nil, Run is being called directly with an allocator 33 | // context. 34 | if c == nil || c.Allocator == nil { 35 | return nil, chromedp.ErrInvalidContext 36 | } 37 | return c, nil 38 | } 39 | 40 | func EvaluateCall(ctx context.Context, callFrameId debugger.CallFrameID, expression string) (*runtime.RemoteObject, error) { 41 | c, _ := getContext(ctx) 42 | call := &debugger.EvaluateOnCallFrameParams{ 43 | CallFrameID: callFrameId, 44 | Expression: expression, 45 | ObjectGroup: "console", 46 | IncludeCommandLineAPI: true, 47 | ReturnByValue: true, 48 | } 49 | var result, _, err = call.Do(cdp.WithExecutor(ctx, c.Target)) 50 | if err != nil { 51 | return nil, err 52 | } 53 | if result == nil { 54 | return nil, errors.New("execute error") 55 | } 56 | if result.Subtype == runtime.SubtypeError { 57 | return nil, errors.New(result.Description) 58 | } 59 | return result, nil 60 | 61 | } 62 | 63 | func NewOpts(opts ...chromedp.ExecAllocatorOption) []chromedp.ExecAllocatorOption { 64 | return append(chromedp.DefaultExecAllocatorOptions[:], opts...) 65 | } 66 | 67 | func LaunchBrowser(tasks chromedp.Tasks, opts []chromedp.ExecAllocatorOption, remote string) context.Context { 68 | 69 | var allocCtx context.Context 70 | 71 | if remote != "" { 72 | allocCtx, _ = chromedp.NewRemoteAllocator(context.Background(), remote) 73 | } else { 74 | allocCtx, _ = chromedp.NewExecAllocator(context.Background(), opts...) 75 | } 76 | var ctx, _ = chromedp.NewContext( 77 | allocCtx, chromedp.WithLogf(log.Printf)) 78 | 79 | err := chromedp.Run(ctx) 80 | if err != nil { 81 | log.Fatal(err) 82 | } 83 | 84 | chromedp.Run(ctx, tasks, chromedp.ActionFunc(func(ctx context.Context) error { 85 | _, err := debugger.Enable().Do(ctx) 86 | return err 87 | })) 88 | go addListener(ctx) 89 | 90 | return ctx 91 | } 92 | -------------------------------------------------------------------------------- /pkgs/web/web.go: -------------------------------------------------------------------------------- 1 | package web 2 | 3 | import ( 4 | "fmt" 5 | "github.com/chromedp/cdproto/runtime" 6 | "github.com/gin-gonic/gin" 7 | "net/http" 8 | ) 9 | 10 | func WebRunner(port string, callFunc func(t string) (*runtime.RemoteObject, error)) { 11 | gin.SetMode(gin.ReleaseMode) 12 | route := gin.New() 13 | route.Use(gin.Recovery()) 14 | 15 | route.POST("/remote", func(context *gin.Context) { 16 | evalString := context.PostForm("eval") 17 | 18 | if result, err := callFunc(evalString); err != nil { 19 | context.JSON(http.StatusOK, gin.H{ 20 | "error": err.Error(), 21 | }) 22 | } else { 23 | context.JSON(http.StatusOK, gin.H{ 24 | "value": result.Value, 25 | "type": result.Type, 26 | }) 27 | } 28 | 29 | }) 30 | 31 | addr := fmt.Sprintf(`0.0.0.0:%s`, port) 32 | fmt.Printf("[*] web server start: %s\n", addr) 33 | route.Run(addr) 34 | } 35 | --------------------------------------------------------------------------------