feat(server): Add Rustdesk Command

And add build full s6 image for rustdesk command

.github/workflows/build.yml

@@ -292,6 +292,21 @@ jobs:
             ${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-${{ matrix.job.platform }}
           labels: ${{ steps.meta.outputs.labels }}
 
+      - name: Build and push Docker Full S6 image to Docker Hub ${{ matrix.job.platform }}
+        if: ${{ env.SKIP_DOCKER_HUB == 'false' }}  # Only run this step if SKIP_DOCKER_HUB is false
+        uses: docker/build-push-action@v5
+        with:
+          context: "."
+          file: ./Dockerfile_full_s6
+          platforms: ${{ matrix.job.docker_platform }}
+          push: true
+          provenance: false
+          build-args: |
+            BUILDARCH=${{ matrix.job.platform }}
+          tags: |
+            ${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-${{ matrix.job.platform }}
+          labels: ${{ steps.meta.outputs.labels }}
+
       - name: Build and push Docker image to GHCR ${{ matrix.job.platform }}
         if: ${{ env.SKIP_GHCR == 'false' }}  # Only run this step if SKIP_GHCR is false
         uses: docker/build-push-action@v5
@@ -308,6 +323,21 @@ jobs:
             ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:${{ env.TAG }}-${{ matrix.job.platform }}
           labels: ${{ steps.meta.outputs.labels }}
 
+      - name: Build and push Docker Full S6 image to GHCR ${{ matrix.job.platform }}
+        if: ${{ env.SKIP_GHCR == 'false' }}  # Only run this step if SKIP_GHCR is false
+        uses: docker/build-push-action@v5
+        with:
+          context: "."
+          file: ./Dockerfile
+          platforms: ${{ matrix.job.docker_platform }}
+          push: true
+          provenance: false
+          build-args: |
+            BUILDARCH=${{ matrix.job.platform }}
+          tags: |
+            ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-${{ matrix.job.platform }}
+          labels: ${{ steps.meta.outputs.labels }}
+
   #
   docker-manifest:
     name: Push Docker Manifest
@@ -379,3 +409,25 @@ jobs:
             ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:latest-arm64
           push: true
           amend: true
+
+      - name: Create and push Full S6 manifest Docker Hub (:version)
+        if: ${{ env.SKIP_DOCKER_HUB == 'false' }}
+        uses: Noelware/docker-manifest-action@master
+        with:
+          base-image: ${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api:full-s6
+          extra-images: ${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-amd64,
+            ${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-armv7l,
+            ${{ env.DOCKERHUB_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-arm64
+          push: true
+          amend: true
+
+      - name: Create and push Full S6 manifest GHCR (:latest)
+        if: ${{ env.SKIP_GHCR == 'false' }}
+        uses: Noelware/docker-manifest-action@master
+        with:
+          base-image: ghcr.io/${{ env.BASE_IMAGE_NAMESPACE }}/rustdesk-api:full-s6
+          extra-images: ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-amd64,
+            ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-armv7l,
+            ghcr.io/${{ env.GHCR_IMAGE_NAMESPACE }}/rustdesk-api:full-s6-arm64
+          push: true
+          amend: true

Dockerfile

@@ -2,9 +2,8 @@ FROM alpine
 
 ARG BUILDARCH
 WORKDIR /app
-RUN apk add --no-cache tzdata file
+RUN apk add --no-cache tzdata
 COPY ./${BUILDARCH}/release /app/
-RUN file /app/apimain
 VOLUME /app/data
 
 EXPOSE 21114

Dockerfile_full_s6

@@ -0,0 +1,38 @@
+FROM rustdesk/rustdesk-server-s6:latest as server
+
+FROM alpine
+
+ARG BUILDARCH
+WORKDIR /app
+RUN apk add --no-cache tzdata
+COPY ./${BUILDARCH}/release /app/
+
+COPY --from=server /init /init
+COPY --from=server /etc/s6-overlay /etc/s6-overlay
+COPY --from=server /package /package
+COPY --from=server /usr/bin/healthcheck.sh /usr/bin/healthcheck.sh
+COPY --from=server /usr/bin/hbbr /usr/bin/hbbr
+COPY --from=server /usr/bin/hbbs /usr/bin/hbbs
+COPY --from=server /usr/bin/rustdesk-utils /usr/bin/rustdesk-utils
+COPY --from=server /command /command
+
+RUN \
+  mkdir -p /etc/s6-overlay/s6-rc.d/api && \
+  echo -e "key-secret\nhbbs" > /etc/s6-overlay/s6-rc.d/api/dependencies && \
+  echo "longrun" > /etc/s6-overlay/s6-rc.d/api/type && \
+  echo "#!/command/with-contenv sh" > /etc/s6-overlay/s6-rc.d/api/run && \
+  echo "cd /app" >> /etc/s6-overlay/s6-rc.d/api/run && \
+  echo "./apimain" >> /etc/s6-overlay/s6-rc.d/api/run && \
+  touch /etc/s6-overlay/s6-rc.d/user/contents.d/api && \
+  echo "/package/admin/s6/command/s6-svstat /run/s6-rc/servicedirs/api || exit 1" >> /usr/bin/healthcheck.sh && \
+  ln -s /run /var/run
+
+ENV RELAY=relay.example.com
+ENV ENCRYPTED_ONLY=0
+
+VOLUME /data
+VOLUME /app/data
+
+EXPOSE 21114 21115 21116 21116/udp 21117 21118 21119
+
+ENTRYPOINT ["/init"]

README.md

@@ -43,51 +43,6 @@
 - CLI
     - 重置管理员密码
 
-## 使用前准备
-
-### [Rustdesk](https://github.com/rustdesk/rustdesk)
-
-#### PC客户端使用的是 ***1.3.0***，经测试 ***1.2.6+*** 都可以
-
-#### 关于PC端链接超时或者链接不上的问题以及解决方案
-##### 链接不上或者超时
-因为server端相对于客户端落后版本，server不会响应客户端的`secure_tcp`请求，所以客户端超时。
-相关代码代码位置在`https://github.com/rustdesk/rustdesk/blob/master/src/client.rs#L322`
-  ```rust
-    if !key.is_empty() && !token.is_empty() {
-    // mainly for the security of token
-    allow_err!(secure_tcp(&mut socket, key).await);
-    }
-  ```
-  可看到当`key`和`token`都不为空时，会调用`secure_tcp`，但是server端不会响应，所以客户端超时
-  `secure_tcp` 代码位置在 `https://github.com/rustdesk/rustdesk/blob/master/src/common.rs#L1203`
-  
-##### 4种解决方案
-1. server端指定key。
-    - 优点：简单
-    - 缺点：链接不是加密的
-       ```bash
-       hbbs -r <relay-server-ip[:port]> -k <key>
-       hbbr -k <key>
-       ```
-       比如
-       ```bash
-         hbbs -r <relay-server-ip[:port]> -k abc1234567
-         hbbr -k abc1234567
-       ```
-2. server端使用系统生成的key，或者自定义的密钥对，但如果client已登录，链接时容易超时或者链接不上，可以退出登录后再链接就可以了，webclient可以不用退出登录
-    - 优点：链接加密
-    - 缺点：操作麻烦
-3. server端使用系统生成的key，或者自定义的密钥对，fork官方客户端的代码将`secure_tcp`修改成直接返回，然后通过`Github Actions`编译，下载编译后的客户端。
-参考[官方文档](https://rustdesk.com/docs/en/dev/build/all/)
-    - 优点：链接加密，可以自定义客户端一些功能，编译后直接可用
-    - 缺点：需要自己fork代码，编译，有点难度
-4. 使用[我fork的代码](https://github.com/lejianwen/rustdesk)，已经修改了`secure_tcp`，可以直接下载使用，[下载地址](https://github.com/lejianwen/rustdesk/releases)
-    - 优点：代码改动可查看，`Github Actions`编译，链接加密，直接下载使用
-    - 缺点：可能跟不上官方版本更新
-     
-***对链接加密要求不高的可以使用`1`，对链接加密要求高的可以使用`3`或`4`***
-
 ## 功能
 
 ### API 服务 
@@ -310,5 +265,6 @@ proxy:
 
 ## 其他
 
+- [链接超时问题](https://github.com/lejianwen/rustdesk-api/issues/92)
 - [修改客户端ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)
 - [webclient来源](https://hub.docker.com/r/keyurbhole/flutter_web_desk)

README_EN.md

@@ -40,52 +40,6 @@ desktop software that provides self-hosted solutions.
     - Visitors are remotely to the device via a temporary sharing link
 - CLI
     - Reset admin password
-## Prerequisites
-
-### [Rustdesk](https://github.com/rustdesk/rustdesk)
-
-
-#### The PC client uses version ***1.3.0***, and versions ***1.2.6+*** have been tested to work.
-
-#### Solutions for PC client connection timeout or connection issues
-##### Connection issues or timeouts
-Because the server version lags behind the client version, the server does not respond to the client's `secure_tcp` request, causing the client to timeout.
-  Relevant code can be found at `https://github.com/rustdesk/rustdesk/blob/master/src/client.rs#L322`
-  ```rust
-    if !key.is_empty() && !token.is_empty() {
-    // mainly for the security of token
-    allow_err!(secure_tcp(&mut socket, key).await);
-    }
-  ```
-  
-As seen, when both `key` and `token` are not empty, `secure_tcp` is called, but the server does not respond, causing the client to timeout.
-The `secure_tcp` code is located at `https://github.com/rustdesk/rustdesk/blob/master/src/common.rs#L1203`
-
-##### Four Solutions
-1. Specify the key on the server.
-    - Advantage: Simple
-    - Disadvantage: The connection is not encrypted
-       ```bash
-       hbbs -r <relay-server-ip[:port]> -k <key>
-       hbbr -k <key>
-       ```
-      For example
-       ```bash
-         hbbs -r <relay-server-ip[:port]> -k abc1234567
-         hbbr -k abc1234567
-       ```
-2. Use a system-generated key or a custom key pair on the server. If the client is already logged in, it may timeout or fail to connect. Logging out and reconnecting usually resolves the issue, and the web client does not need to log out.
-    - Advantage: Encrypted connection
-    - Disadvantage: Complicated operation
-3. Use a system-generated key or a custom key pair on the server, fork the official client code to modify `secure_tcp` to return directly, then compile using `Github Actions` and download the compiled client.
-   Refer to [official documentation](https://rustdesk.com/docs/en/dev/build/all/)
-    - Advantage: Encrypted connection, customizable client features, ready to use after compilation
-    - Disadvantage: Requires forking code and compiling, which can be challenging
-4. Use [my forked code](https://github.com/lejianwen/rustdesk), which has already modified `secure_tcp`. You can download and use it directly from [here](https://github.com/lejianwen/rustdesk/releases)
-    - Advantage: Code changes are viewable, compiled with `Github Actions`, encrypted connection, ready to use
-    - Disadvantage: May not keep up with official version updates
-   
-***If encryption is not a high priority, use `1`. If encryption is important, use `3` or `4`.***
 
 ## Overview
 
@@ -317,5 +271,6 @@ Download the release from [release](https://github.com/lejianwen/rustdesk-api/re
 
 ## Others
 
+- [Connection Timeout](https://github.com/lejianwen/rustdesk-api/issues/92)
 - [Change client ID](https://github.com/abdullah-erturk/RustDesk-ID-Changer)
 - [Web client source](https://hub.docker.com/r/keyurbhole/flutter_web_desk)

cmd/apimain.go

@@ -169,7 +169,7 @@ func InitGlobal() {
 	global.Lock = lock.NewLocal()
 }
 func DatabaseAutoUpdate() {
-	version := 247
+	version := 251
 
 	db := global.DB
 
@@ -253,6 +253,7 @@ func Migrate(version uint) {
 		&model.AuditFile{},
 		&model.AddressBookCollection{},
 		&model.AddressBookCollectionRule{},
+		&model.ServerCmd{},
 	)
 	if err != nil {
 		fmt.Println("migrate err :=>", err)

http/controller/admin/rustdesk.go

@@ -2,45 +2,114 @@ package admin
 
 import (
 	"Gwen/global"
+	"Gwen/http/request/admin"
 	"Gwen/http/response"
+	"Gwen/model"
+	"Gwen/service"
 	"github.com/gin-gonic/gin"
 )
 
 type Rustdesk struct {
 }
 
-// ServerConfig RUSTDESK服务配置
-// @Tags ADMIN
-// @Summary RUSTDESK服务配置
-// @Description 服务配置,给webclient提供api-server
-// @Accept  json
-// @Produce  json
-// @Success 200 {object} response.Response
-// @Failure 500 {object} response.Response
-// @Router /admin/server-config [get]
-// @Security token
-func (r *Rustdesk) ServerConfig(c *gin.Context) {
-	cf := &response.ServerConfigResponse{
-		IdServer:    global.Config.Rustdesk.IdServer,
-		Key:         global.Config.Rustdesk.Key,
-		RelayServer: global.Config.Rustdesk.RelayServer,
-		ApiServer:   global.Config.Rustdesk.ApiServer,
-	}
-	response.Success(c, cf)
+type RustdeskCmd struct {
+	Cmd    string `json:"cmd"`
+	Option string `json:"option"`
 }
 
-// AppConfig APP服务配置
-// @Tags ADMIN
-// @Summary APP服务配置
-// @Description APP服务配置
-// @Accept  json
-// @Produce  json
-// @Success 200 {object} response.Response
-// @Failure 500 {object} response.Response
-// @Router /admin/app-config [get]
-// @Security token
-func (r *Rustdesk) AppConfig(c *gin.Context) {
-	response.Success(c, &gin.H{
-		"web_client": global.Config.App.WebClient,
-	})
+func (r *Rustdesk) CmdList(c *gin.Context) {
+	q := &admin.PageQuery{}
+	if err := c.ShouldBindQuery(q); err != nil {
+		response.Fail(c, 101, response.TranslateMsg(c, "ParamsError")+err.Error())
+		return
+	}
+	res := service.AllService.ServerCmdService.List(q.Page, 9999)
+	//在列表前添加系统命令
+	list := make([]*model.ServerCmd, 0)
+	list = append(list, model.SysServerCmds...)
+	list = append(list, res.ServerCmds...)
+	res.ServerCmds = list
+	response.Success(c, res)
+}
+
+func (r *Rustdesk) CmdDelete(c *gin.Context) {
+	f := &model.ServerCmd{}
+	if err := c.ShouldBindJSON(f); err != nil {
+		response.Fail(c, 101, response.TranslateMsg(c, "ParamsError")+err.Error())
+		return
+	}
+	if f.Id == 0 {
+		response.Fail(c, 101, response.TranslateMsg(c, "ParamsError"))
+		return
+	}
+
+	ex := service.AllService.ServerCmdService.Info(f.Id)
+	if ex.Id == 0 {
+		response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound"))
+		return
+	}
+
+	err := service.AllService.ServerCmdService.Delete(ex)
+	if err != nil {
+		response.Fail(c, 101, err.Error())
+		return
+	}
+	response.Success(c, nil)
+}
+func (r *Rustdesk) CmdCreate(c *gin.Context) {
+	f := &model.ServerCmd{}
+	if err := c.ShouldBindJSON(f); err != nil {
+		response.Fail(c, 101, response.TranslateMsg(c, "ParamsError")+err.Error())
+		return
+	}
+	errList := global.Validator.ValidStruct(c, f)
+	if len(errList) > 0 {
+		response.Fail(c, 101, errList[0])
+		return
+	}
+	err := service.AllService.ServerCmdService.Create(f)
+	if err != nil {
+		response.Fail(c, 101, err.Error())
+		return
+	}
+	response.Success(c, nil)
+}
+
+func (r *Rustdesk) CmdUpdate(c *gin.Context) {
+	f := &model.ServerCmd{}
+	if err := c.ShouldBindJSON(f); err != nil {
+		response.Fail(c, 101, response.TranslateMsg(c, "ParamsError")+err.Error())
+		return
+	}
+	errList := global.Validator.ValidStruct(c, f)
+	if len(errList) > 0 {
+		response.Fail(c, 101, errList[0])
+		return
+	}
+	ex := service.AllService.ServerCmdService.Info(f.Id)
+	if ex.Id == 0 {
+		response.Fail(c, 101, response.TranslateMsg(c, "ItemNotFound"))
+		return
+	}
+	err := service.AllService.ServerCmdService.Update(f)
+	if err != nil {
+		response.Fail(c, 101, err.Error())
+		return
+	}
+	response.Success(c, nil)
+}
+
+func (r *Rustdesk) SendCmd(c *gin.Context) {
+	rc := &RustdeskCmd{}
+	c.ShouldBindJSON(rc)
+	if rc.Cmd == "" {
+		response.Fail(c, 101, "cmd is required")
+		return
+	}
+	res, err := service.AllService.ServerCmdService.SendCmd(rc.Cmd, rc.Option)
+	if err != nil {
+		response.Fail(c, 101, err.Error())
+		return
+	}
+	response.Success(c, res)
 }

http/router/admin.go

@@ -46,9 +46,20 @@ func Init(g *gin.Engine) {
 	ShareRecordBind(adg)
 	MyBind(adg)
 
+	RustdeskCmdBind(adg)
+
 	//访问静态文件
 	//g.StaticFS("/upload", http.Dir(global.Config.Gin.ResourcesPath+"/upload"))
 }
+
+func RustdeskCmdBind(adg *gin.RouterGroup) {
+	cont := &admin.Rustdesk{}
+	rg := adg.Group("/rustdesk")
+	rg.POST("/sendCmd", cont.SendCmd)
+	rg.GET("/cmdList", cont.CmdList)
+	rg.POST("/cmdDelete", cont.CmdDelete)
+	rg.POST("/cmdCreate", cont.CmdCreate)
+}
 func LoginBind(rg *gin.RouterGroup) {
 	cont := &admin.Login{}
 	rg.POST("/login", cont.Login)

model/serverCmd.go

@@ -0,0 +1,24 @@
+package model
+
+type ServerCmd struct {
+	IdModel
+	Cmd     string `json:"cmd" gorm:"default:'';not null;"`
+	Alias   string `json:"alias" gorm:"default:'';not null;"`
+	Option  string `json:"option" gorm:"default:'';not null;"`
+	Explain string `json:"explain" gorm:"default:'';not null;"`
+	TimeModel
+}
+
+type ServerCmdList struct {
+	ServerCmds []*ServerCmd `json:"list"`
+	Pagination
+}
+
+var SysServerCmds = []*ServerCmd{
+	{Cmd: "h", Option: "", Explain: "show help"},
+	{Cmd: "relay-servers", Alias: "rs", Option: "<separated by ,>", Explain: "set or show relay servers"},
+	{Cmd: "ip-blocker", Alias: "ib", Option: "[<ip>|<number>] [-]", Explain: "block or unblock ip or show blocked ip"},
+	{Cmd: "ip-changes", Alias: "ic", Option: "[<id>|<number>] [-]", Explain: "ip-changes(ic) [<id>|<number>] [-]"},
+	{Cmd: "always-use-relay(aur)", Alias: "aur", Option: "[y|n]", Explain: "always use relay"},
+	{Cmd: "test-geo", Alias: "tg", Option: "<ip1> <ip2>", Explain: "test geo"},
+}

service/serverCmd.go

@@ -0,0 +1,92 @@
+package service
+
+import (
+	"Gwen/global"
+	"Gwen/model"
+	"fmt"
+	"net"
+	"time"
+)
+
+type ServerCmdService struct{}
+
+// List
+func (is *ServerCmdService) List(page, pageSize uint) (res *model.ServerCmdList) {
+	res = &model.ServerCmdList{}
+	res.Page = int64(page)
+	res.PageSize = int64(pageSize)
+	tx := global.DB.Model(&model.ServerCmd{})
+	tx.Count(&res.Total)
+	tx.Scopes(Paginate(page, pageSize))
+	tx.Find(&res.ServerCmds)
+	return
+}
+
+// Info
+func (is *ServerCmdService) Info(id uint) *model.ServerCmd {
+	u := &model.ServerCmd{}
+	global.DB.Where("id = ?", id).First(u)
+	return u
+}
+
+// Delete
+func (is *ServerCmdService) Delete(u *model.ServerCmd) error {
+	return global.DB.Delete(u).Error
+}
+
+// Create
+func (is *ServerCmdService) Create(u *model.ServerCmd) error {
+	res := global.DB.Create(u).Error
+	return res
+}
+
+// SendCmd 发送命令
+func (is *ServerCmdService) SendCmd(cmd string, arg string) (string, error) {
+	//组装命令
+	cmd = cmd + " " + arg
+	res, err := is.SendSocketCmd("v6", cmd)
+	if err == nil {
+		return res, nil
+	}
+	//v6连接失败，尝试v4
+	res, err = is.SendSocketCmd("v4", cmd)
+	if err == nil {
+		return res, nil
+	}
+	return "", err
+}
+
+// SendSocketCmd
+func (is *ServerCmdService) SendSocketCmd(ty string, cmd string) (string, error) {
+	addr := "[::1]"
+	tcp := "tcp6"
+	if ty == "v4" {
+		tcp = "tcp"
+		addr = "127.0.0.1"
+	}
+	conn, err := net.Dial(tcp, addr+":21115")
+	if err != nil {
+		fmt.Printf("connect to id %s server failed: %v\n", ty, err)
+		return "", err
+	}
+	defer conn.Close()
+	//发送命令
+	_, err = conn.Write([]byte(cmd))
+	if err != nil {
+		fmt.Printf("send cmd failed: %v\n", err)
+		return "", err
+	}
+	time.Sleep(100 * time.Millisecond)
+	//读取返回
+	buf := make([]byte, 1024)
+	n, err := conn.Read(buf)
+	if err != nil && err.Error() != "EOF" {
+		fmt.Printf("read response failed: %v\n", err)
+		return "", err
+	}
+	return string(buf[:n]), nil
+}
+
+func (is *ServerCmdService) Update(f *model.ServerCmd) error {
+	return global.DB.Model(f).Updates(f).Error
+}

service/service.go

@@ -17,6 +17,7 @@ type Service struct {
 	*LoginLogService
 	*AuditService
 	*ShareRecordService
+	*ServerCmdService
 }
 
 func New() *Service {