first commit for RustDeskApiServer

Author: lizenghai

.gitignore

@@ -0,0 +1,21 @@
+# Python
+*.pyc
+*.pyo
+*.spec
+*.c
+*.pyd
+*.so
+test.py
+__pycache__
+
+# Documents
+test
+
+
+# Files
+*.bat
+server.ico
+
+# Build
+build
+dist

README.md

@@ -0,0 +1,84 @@
+## Rustdesk Api接口介绍
+<p align="center">
+    <img src ="https://img.shields.io/badge/version-1.0.0-blueviolet.svg"/>
+    <img src ="https://img.shields.io/badge/platform-windows|linux-green.svg"/>
+    <img src ="https://img.shields.io/badge/python-3.7|3.8|3.9|3.10|3.11-blue.svg" />
+    <img src ="https://img.shields.io/badge/Django-3.2+|4.x-yelow.svg" />
+</p>
+
+### 缘起
+看了市面上各类RustDesk WEB API版本，或多或少的存在一些问题，比如说，需要通过url注册、新版客户端某些接口不支持、无法方便的修改密码等不足，因此博采众长，撸一个自己喜欢的版本来用。在此要感谢论坛及github的各位朋友写的接口，省去了我抓包找接口的时间。
+![主页面](/images/front_main.png)
+
+### 功能特点
+ - 支持前台网页自主注册和登录。
+   - 注册页与登录页：
+  
+  <img src="images/front_reg.png" width="45%" />
+  <img src="images/front_login.png" width="45%" />
+  
+ - 支持前台展示设备信息，分为管理员版、用户版。
+ - 支持自定义别名（备注）。
+ - 支持后台管理。
+ - 支持彩色标签。
+ 
+ <img src="images/rust_books.png" width="45%" />
+ 
+ - 支持设备在线统计。
+ - 支持设备密码保存。
+ - 利用心跳接口自动管理token并保活。
+ - 支持分享设备给其他用户（本功能暂未实现）。
+ 
+ 后台主页：
+<img src="images/admin_main.png" width="60%" />
+
+### 管理员设置
+当数据库中不存在账户时，第一个注册的账户直接获取超级管理员权限，之后注册账户为普通账户。
+
+### 其他说明
+设备信息
+经测试，客户端会在非绿色版模式下，安装为服务的模式中，定时发送设备信息到api接口，
+所以如果想要设备信息，需要安装rustdesk客户端并启动服务。
+
+### 连接速度慢
+新版本Key模式链接速度慢，可以在服务端启动服务时，不要带参数的-k，此时，客户端也不能配置key
+
+
+
+### 获取方法
+
+#### 开箱即用版
+
+  Window独立打包版，无需安装环境，直接运行`启动.bat`即可。请前往release下载。仅支持windows
+  独立版截图：![window独立绿色版](/images/windows_run.png =60x)
+
+
+
+#### 代码版本
+
+将代码克隆到本地后，请先安装依赖：
+`pip install -r requirements.txt`
+
+确保依赖安装正确后，执行：
+`python manage.py runserver 0.0.0.0:21114`  端口号请自行修改。
+
+此时即可使用`http://本机IP:端口`的形式来访问啦。
+
+支持Django3及Django4+
+注意，如果cengtos配置时，Django4会因为系统的sqlite3版本过低而出问题，请修改依赖库中的文件，路径： 
+`xxxx/Lib/site-packages/django/db/backends/sqlite3/base.py` (这是例子，根据情况自行查找包所在地址)
+
+
+修改内容:
+```
+# from sqlite3 import dbapi2 as Database   #(注释掉这行)
+from pysqlite3 import dbapi2 as Database # 启用pysqlite3
+```
+
+
+### 计划开发
+
+1、分享设备给其他已注册用户
+
+    说明：类似网盘url分享，url激活后可以获得某个或某组或某个标签下的设备
+    备注：其实web api作为中间件，可做的不多，更多功能还是需要修改客户端来实现，就不太值当了。

api/__init__.py

@@ -0,0 +1 @@
+from .admin_user import *

api/admin.py

@@ -0,0 +1,98 @@
+# cython:language_level=3
+from django.contrib import admin
+from api import models
+from django import forms
+from django.contrib.auth.models import Group
+from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
+from django.contrib.auth.forms import ReadOnlyPasswordHashField
+
+
+
+class UserCreationForm(forms.ModelForm):
+    """A form for creating new users. Includes all the required
+    fields, plus a repeated password."""
+    password1 = forms.CharField(label='密码', widget=forms.PasswordInput)
+    password2 = forms.CharField(label='再次输入密码', widget=forms.PasswordInput)
+
+    class Meta:
+        model = models.UserProfile
+        fields = ('username','is_active','is_admin')
+
+    def clean_password2(self):
+        # Check that the two password entries match
+        password1 = self.cleaned_data.get("password1")
+        password2 = self.cleaned_data.get("password2")
+        if password1 and password2 and password1 != password2:
+            raise forms.ValidationError("密码校验失败，两次密码不一致。")
+        return password2
+
+    
+    def save(self, commit=True):
+        # Save the provided password in hashed format
+        user = super(UserCreationForm, self).save(commit=False)
+        user.set_password(self.cleaned_data["password1"])
+        if commit:
+            user.save()
+        return user
+
+
+class UserChangeForm(forms.ModelForm):
+    """A form for updating users. Includes all the fields on
+    the user, but replaces the password field with admin's
+    password hash display field.
+    """
+    password = ReadOnlyPasswordHashField(label=("密码Hash值"), help_text=("<a href=\"../password/\">点击修改密码</a>."))
+    class Meta:
+        model = models.UserProfile
+        fields = ('username', 'is_active', 'is_admin')
+
+    def clean_password(self):
+        # Regardless of what the user provides, return the initial value.
+        # This is done here, rather than on the field, because the
+        # field does not have access to the initial value
+        return self.initial["password"]
+        #return self.initial["password"]
+    
+    def save(self, commit=True):
+        # Save the provided password in hashed format
+        user = super(UserChangeForm, self).save(commit=False)
+        
+        if commit:
+            user.save()
+        return user
+
+class UserAdmin(BaseUserAdmin):
+    # The forms to add and change user instances
+    form = UserChangeForm
+    add_form = UserCreationForm
+    password = ReadOnlyPasswordHashField(label=("密码Hash值"), help_text=("<a href=\"../password/\">点击修改密码</a>."))
+    # The fields to be used in displaying the User model.
+    # These override the definitions on the base UserAdmin
+    # that reference specific fields on auth.User.
+    list_display = ('username', 'rid')
+    list_filter = ('is_admin', 'is_active')
+    fieldsets = (
+        ('基本信息', {'fields': ('username', 'password', 'is_active', 'is_admin', 'rid', 'uuid', 'deviceInfo',)}),
+      
+    )
+    readonly_fields = ( 'rid', 'uuid')
+    add_fieldsets = (
+        (None, {
+            'classes': ('wide',),
+            'fields': ('username',  'is_active', 'is_admin', 'password1', 'password2',  )}
+         ),
+    )
+    
+    search_fields = ('username', )
+    ordering = ('username',)
+    filter_horizontal = ()
+
+
+admin.site.register(models.UserProfile, UserAdmin)
+admin.site.register(models.RustDeskToken, models.RustDeskTokenAdmin)
+admin.site.register(models.RustDeskTag, models.RustDeskTagAdmin)
+admin.site.register(models.RustDeskPeer, models.RustDeskPeerAdmin)
+admin.site.register(models.RustDesDevice, models.RustDesDeviceAdmin)
+admin.site.unregister(Group)
+admin.site.site_header = 'RustDesk自建Web'
+admin.site.site_title = '未定义'

api/admin_user.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    name = 'api'