2 Star 14 Fork 4

ClownFish / vncproxy

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

VncProxy GitHub release report card github issues github closed issues GoDoc view examples

VncProxy简介

VncProxy 是使用Golang实现的Vnc远程桌面代理组件,完全解析rfb协议,支持远程桌面代理,rbs文件录屏,rbs文件回放,截图,录制视频.

  • 全协议支持的vnc proxy。
    • 支持Tcp代理
    • 支持Websocket代理
  • 屏幕录像,保存为RBS文件
  • 重播服务器,支持vnc客户端链接,播放RBS文件。
  • 支持实时录制视频
  • 支持通过RBS文件录制视频。
  • 支持屏幕截图

支持的编码格式

  • Raw
  • CopyRect
  • CoRRE
  • rre
  • Hextile
  • Tight
  • TightPng
  • ZLib
  • Zrle
  • CursorPseudo
  • CursorWithAlphaPseudo
  • DesktopNamePseudo
  • DesktopSizePseudo
  • ExtendedDesktopSizePseudo
  • LedStatePseudo
  • CursorPosPseudo
  • XCursorPseudo
  • jpeg
  • jrle
  • trle

组件说明

Proxy

  1. 启动server接受vnc viewer的链接.
  2. 启动client连接到指定的vnc server.
  3. vnc viewervnc server之间建立起消息转发通道。
  4. 因为rfb协议被完全解析,可以针对通信的消息进行转发处理,产生了后续的功能。

Recorder

  1. 启动client连接到指定的vnc server.
  2. 发送帧缓冲区更新消息FramebufferUpdateRequestvnc server
  3. 处理vnc server回复的界面更新消息FramebufferUpdate
  4. 把这一过程以rbs文件格式记录下来。

Player

  1. 启动server接受vnc viewer的链接.
  2. 读取rbs文件,并按格式生成FramebufferUpdate消息发送给vnc viewer
  3. vnc viewer的界面就会回放动作。

Video

  1. 支持Proxy,Recorderrbs文件作为输入源。
  2. FramebufferUpdate消息转换为视频文件。

Screenshot

  1. 支持Proxy,Recorderrbs文件作为输入源。
  2. 把当前的界面视图转换为图片文件。

使用说明

vncProxy项目有多种应用场景。 可以作为单独的应用程序编译,也可以作为库被其他应用程序引用。 接下来,分别介绍各种场景下的使用方式。

编译

# 使用方式:
# build.sh [-s app_name] [-v version] [-g go_bin]
# app_name 需要编译的应用名称
#          选项: proxy,player,recorder,video,screenshot.
#          默认是所有应用,多个应用可以逗号分割.
# version  编译后的文件版本号,默认为当前git的commit id.
# go_bin   使用的golang程序

# 编译所有应用
$ ./build 

# 编译proxy
$ ./build -s proxy -v v0.1.0

# 编译player,recorder
$ ./build -s player,recorder -v v0.1.0

编译后的二进制文件在./bin/目录

Proxy

代码路径在./cmd/proxy,如果单独编译该组件,也可以到该目录下自行执行go build命令编译

获取帮助信息

# 查看帮助信息
$ ./proxy --help

# 查看版本信息
$ ./proxy version

启动tcp服务


# 启动tcp server接受vnc viewer的连接
# vncHost  vnc服务器host
# vncPort  vnc服务器port
# vncPassword  vnc服务器密码
# tcpHost  本地监听的地址
# tcpPort  本地监听的端口
# proxyPassword  vnc连接的密码
# debug  使用debug模式启动服务

$ ./proxy start tcpServer --vncHost=192.168.1.2 \     
                          --vncPort=5901 \           
                          --vncPassword=vprix \       
                          --tcpHost=0.0.0.0 \        
                          --tcpPort=8989 \           
                          --proxyPassword=12345612 \  
                          --debug                    

启动WebSocket服务


# 启动ws server接受novnc的连接
# vncHost  vnc服务器host
# vncPort  vnc服务器port
# vncPassword  vnc服务器密码
# wsHost  本地监听的地址
# wsPort  本地监听的端口
# wsPath  websocket连接的地址
# proxyPassword  vnc连接的密码
# debug  使用debug模式启动服务

$ ./proxy start wsServer  --vncHost=192.168.1.2 \      
                          --vncPort=5901         \     
                          --vncPassword=vprix \       
                          --wsHost=0.0.0.0 \          
                          --wsPort=8988    \           
                          --wsPath=/websockify \         
                          --proxyPassword=12345612 \    
                          --debug              

Recorder

代码路径在./cmd/recorder,如果单独编译该组件,也可以到该目录下自行执行go build命令编译

获取帮助信息

# 查看帮助信息
$ ./recorder --help

# 查看版本信息
$ ./recorder version

启动Recorder服务


# rbsFile  要保存的rbs文件路径(必填)
# vncHost  vnc服务器host
# vncPort  vnc服务器port
# vncPassword  vnc服务器密码
# debug  使用debug模式启动服务

$ ./recorder start --rbsFile=/path/to/foo.rbs
							--vncHost=192.168.1.2 
							--vncPort=5901
							--vncPassword=vprix
							--debug             

Player

代码路径在./cmd/player,如果单独编译该组件,也可以到该目录下自行执行go build命令编译

获取帮助信息

# 查看帮助信息
$ ./player --help

# 查看版本信息
$ ./player version

启动Player Tcp服务


# rbsFile  要保存的rbs文件路径(必填)
# tcpHost   本地监听的tcp协议地址 默认0.0.0.0
# tcpPort  本地监听的tcp协议端口 默认8989
# proxyPassword  连接到proxy的密码   不传入密码则使用auth none
# debug  使用debug模式启动服务

$ ./player start tcpServer  --rbsFile=/path/to/foo.rbs
                            --tcpHost=0.0.0.0
                            --tcpPort=8989
                            --proxyPassword=12345612
                            --debug             

启动Player WS服务


# rbsFile  要保存的rbs文件路径(必填)
# wsHost   启动websocket服务的本地地址  默认 0.0.0.0
# wsPort   启动websocket服务的本地端口 默认8988
# wsPath   启动websocket服务的url path 默认'/'
# proxyPassword  连接到proxy的密码   不传入密码则使用auth none
# debug  使用debug模式启动服务

$ ./player start wsServer --rbsFile=/path/to/foo.rbs
                          --wsHost=0.0.0.0
                          --wsPort=8989
                          --wsPath=/
                          --proxyPassword=12345612
                          --debug             

Screenshot

代码路径在./cmd/screenshot,如果单独编译该组件,也可以到该目录下自行执行go build命令编译

获取帮助信息

# 查看帮助信息
$ ./screenshot --help

# 查看版本信息
$ ./screenshot version

启动Screenshot 获取vnc服务器的屏幕截图


# imageFile  要生成的截图地址,暂时只支持jpeg格式(必填)
# vncHost   要连接的vnc服务端地址(必填)
# vncPort   要连接的vnc服务端端口(必填)
# vncPassword  要连接的vnc服务端密码,不传则使用auth none

$ ./screenshot --imageFile=./screen.jpeg --vncHost=127.0.0.1 --vncPort=5900 --vncPassword=12345612       

项目参考

本项目参考了以下项目完成。

交流

我在做这个项目的过程中碰到了很多问题,查遍了互联网,缺少中文资料,大部分信息都是雷同的。 所以我萌生了开源的想法,帮助更多有需要的人。

我建立了一个可供交流的微信群,以便大家在使用的过程中碰到疑问,能有解答的地方。 当然,如果你对vnc有兴趣,也可以加我微信,多多交流。 欢迎各位贡献代码。

微信二维码

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

This is a VNC proxy program, fully resolved the RFB protocol, support VNC proxy, record playback video, record operations as a log file, and support log file playback. 展开 收起
Go 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/osgochina/vncproxy.git
git@gitee.com:osgochina/vncproxy.git
osgochina
vncproxy
vncproxy
main

搜索帮助