Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lwch/natpass

🔥居家办公，远程开发神器
https://github.com/lwch/natpass

code-server golang protobuf shell tls vnc

Last synced: 3 days ago
JSON representation

🔥居家办公，远程开发神器

Host: GitHub
URL: https://github.com/lwch/natpass
Owner: lwch
License: mit
Created: 2021-07-30T08:02:42.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-04-24T05:43:55.000Z (9 months ago)
Last Synced: 2025-01-16T05:05:02.045Z (10 days ago)
Topics: code-server, golang, protobuf, shell, tls, vnc
Language: Go
Homepage: https://lwch.gitbook.io/natpass/
Size: 16.8 MB
Stars: 4,362
Watchers: 52
Forks: 492
Open Issues: 18
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

awesome-ops - lwch/natpass - 07-30|2024-04-24 | 主机管理工具，支持 Shell 管理，支持远程桌面管理 | (堡垒机)
awesome-hacking-lists - lwch/natpass - 🔥居家办公，远程开发神器 (Go)

README

        # natpass

[![natpass](https://github.com/lwch/natpass/actions/workflows/build.yml/badge.svg)](https://github.com/lwch/natpass/actions/workflows/build.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/lwch/natpass)](https://goreportcard.com/report/github.com/lwch/natpass)

[![license](https://img.shields.io/github/license/lwch/natpass)](https://opensource.org/licenses/MIT)

[![QQ群711086098](https://img.shields.io/badge/QQ%E7%BE%A4-711086098-success)](https://jq.qq.com/?_wv=1027&k=6Fz2vkVE)

![downloads](https://img.shields.io/github/downloads/lwch/natpass/total)

新一代主机管理工具，支持shell管理，支持远程桌面管理[实现原理](docs/desc.md)

1. [如何部署](docs/startup.md)

2. [规则配置](docs/rules.md)

3. [开发文档](https://lwch.gitbook.io/natpass/dev)

功能与特性：

1. 支持私有化部署

2. 较小的内存占用（约20M左右）

3. 支持tls安全连接

4. 支持多路异步IO

5. 支持虚拟链路层

6. 支持链路和终端会话监控

7. protobuf数据编码

8. 支持web shell

   - linux和mac系统支持创建pty设备和颜色输出

   - windows系统支持powershell

9. 支持web vnc

   - 支持基本的键盘鼠标操作

   - 支持全屏显示

   - 支持滚动

   - 支持远程剪贴板设置与读取

10. 支持code-server

11. 支持多种操作系统

   - [x] linux

   - [x] windows

   - [x] macos

## 效果图

dashboard页面

![dashboard](docs/imgs/dashboard.png)

命令行

| platform | 386 | amd64 | arm | arm64 |

| -------- | :-: | :---: | :-: | :---: |

| windows | ✅ | ✅ | ✅ | ✅ |

| macos   |    | ✅ |     | ✅ |

| linux   | ✅ | ✅ | ✅ | ✅ |

![shell](docs/imgs/shell.gif)

远程桌面

| platform | 386 | amd64 | arm | arm64 |

| -------- | :-: | :---: | :-: | :---: |

| windows | ✅ | ✅ | ❌ | ❌ |

| macos   |    | ✅ |    | ✅ |

| linux   | ✅ | ✅ | ❌ | ❌ |

![vnc](docs/imgs/vnc.gif)

windows剪贴板内容

![vnc-clipboard](docs/imgs/vnc_clipboard.png)

code-server支持

![code-server](docs/imgs/code_server.png)

## 性能

在vmware环境下创建4C2G（AMD Ryzen 7 4800U with Radeon Graphics）测试环境，并进行all in one部署server、remote端和local端，使用bench规则进行压测，结果如下：

![bench](docs/imgs/bench.png)

1. 压测结果仅包含local端发起连接到remote端收到连接并返回成功的整个过程

2. 实验结果表明，在4C2G环境下可达到上万+的qps，且p99和p100均在60ms以下

## TODO

1. ~~支持include的yaml配置文件~~

2. ~~通用的connect、connect_response、disconnect消息~~

3. ~~dashboard页面~~

4. 文件传输

5. ~web远程桌面~

6. ~~流量监控统计页面，server还是client?~~

7. web端管理规则

8. 支持录屏

## 编译

1. 由于html/dashboard等目录下引用第三方库时使用软连接的方式进行处理，

   因此在windows环境下进行编译时需要将这些软连接的目录进行手工替换，

   第三方库的代码都在上级目录下可找到。

## stars

![stars](https://starchart.cc/lwch/natpass.svg)

## 免责声明

本软件仅用于个人研究学习，包括但不限于以下条款：

1. 严禁用于黑客攻击、远程控制他人计算机等违法违规行为

2. 软件使用者使用该软件造成的任何损失均与软件作者无关，

   一切后果由使用者自己负责

3. 严禁用于一切商业用途，包括但不限于提供云桌面、云主机等

## 贡献代码

为了更好的发展，我们鼓励大家为natpass项目做出贡献及提出建议，项目的地址为[https://github.com/lwch/natpass](https://github.com/lwch/natpass)，因此在gitee上提交的pr将不被接受，请大家将pr提交到github的同名项目中。