Skip to content

Kernel serve WebDAV service on path /webdav/ #12412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion kernel/go.mod
Original file line number Diff line number Diff line change
@@ -71,6 +71,7 @@ require (
golang.org/x/image v0.19.0
golang.org/x/mobile v0.0.0-20240520174638-fa72addaaa1b
golang.org/x/mod v0.20.0
golang.org/x/net v0.28.0
golang.org/x/text v0.17.0
golang.org/x/time v0.6.0
)
@@ -164,7 +165,6 @@ require (
golang.org/x/arch v0.9.0 // indirect
golang.org/x/crypto v0.26.0 // indirect
golang.org/x/exp v0.0.0-20240823005443-9b4947da3948 // indirect
golang.org/x/net v0.28.0 // indirect
golang.org/x/sync v0.8.0 // indirect
golang.org/x/sys v0.24.0 // indirect
golang.org/x/tools v0.24.0 // indirect
2 changes: 1 addition & 1 deletion kernel/model/export.go
Original file line number Diff line number Diff line change
@@ -441,7 +441,7 @@ func ExportData() (zipPath string, err error) {
util.PushEndlessProgress(Conf.Language(65))
defer util.ClearPushProgress(100)

name := util.FilterFileName(filepath.Base(util.WorkspaceDir)) + "-" + util.CurrentTimeSecondsStr()
name := util.FilterFileName(util.WorkspaceName) + "-" + util.CurrentTimeSecondsStr()
exportFolder := filepath.Join(util.TempDir, "export", name)
zipPath, err = exportData(exportFolder)
if err != nil {
20 changes: 19 additions & 1 deletion kernel/model/session.go
Original file line number Diff line number Diff line change
@@ -250,6 +250,16 @@ func CheckAuth(c *gin.Context) {
return
}

// 通过 BasicAuth (header: Authorization)
if username, password, ok := c.Request.BasicAuth(); ok {
// 使用访问授权码作为密码
if util.WorkspaceName == username && Conf.AccessAuthCode == password {
c.Set(RoleContextKey, RoleAdministrator)
c.Next()
return
}
}

// 通过 API token (header: Authorization)
if authHeader := c.GetHeader("Authorization"); "" != authHeader {
var token string
@@ -289,7 +299,15 @@ func CheckAuth(c *gin.Context) {
return
}

if "/check-auth" == c.Request.URL.Path { // 跳过访问授权页
// WebDAV BasicAuth Authenticate
if strings.HasPrefix(c.Request.RequestURI, "/webdav") {
c.Header("WWW-Authenticate", "Basic realm=Authorization Required")
c.AbortWithStatus(http.StatusUnauthorized)
return
}

// 跳过访问授权页
if "/check-auth" == c.Request.URL.Path {
c.Next()
return
}
43 changes: 41 additions & 2 deletions kernel/server/serve.go
Original file line number Diff line number Diff line change
@@ -44,10 +44,21 @@ import (
"github.com/siyuan-note/siyuan/kernel/model"
"github.com/siyuan-note/siyuan/kernel/server/proxy"
"github.com/siyuan-note/siyuan/kernel/util"
"golang.org/x/net/webdav"
)

var (
cookieStore = cookie.NewStore([]byte("ATN51UlxVq1Gcvdf"))
cookieStore = cookie.NewStore([]byte("ATN51UlxVq1Gcvdf"))
WebDavMethod = []string{
"OPTIONS",
"GET", "HEAD",
"POST", "PUT",
"DELETE",
"MKCOL",
"COPY", "MOVE",
"LOCK", "UNLOCK",
"PROPFIND", "PROPPATCH",
}
)

func Serve(fastMode bool) {
@@ -76,6 +87,7 @@ func Serve(fastMode bool) {
serveAssets(ginServer)
serveAppearance(ginServer)
serveWebSocket(ginServer)
serveWebDAV(ginServer)
serveExport(ginServer)
serveWidgets(ginServer)
servePlugins(ginServer)
@@ -371,7 +383,7 @@ func serveAuthPage(c *gin.Context) {
"l8": model.Conf.Language(95),
"appearanceMode": model.Conf.Appearance.Mode,
"appearanceModeOS": model.Conf.Appearance.ModeOS,
"workspace": filepath.Base(util.WorkspaceDir),
"workspace": util.WorkspaceName,
"workspacePath": util.WorkspaceDir,
"keymapGeneralToggleWin": keymapHideWindow,
"trayMenuLangs": util.TrayMenuLangs[util.Lang],
@@ -589,6 +601,33 @@ func serveWebSocket(ginServer *gin.Engine) {
})
}

func serveWebDAV(ginServer *gin.Engine) {
// REF: https://github.com/fungaren/gin-webdav
handler := webdav.Handler{
Prefix: "/webdav/",
FileSystem: webdav.Dir(util.WorkspaceDir),
LockSystem: webdav.NewMemLS(),
Logger: func(r *http.Request, err error) {
if nil != err {
logging.LogErrorf("WebDAV [%s %s]: %s", r.Method, r.URL.String(), err.Error())
}
// logging.LogDebugf("WebDAV [%s %s]", r.Method, r.URL.String())
},
}

ginGroup := ginServer.Group("/webdav", model.CheckAuth, model.CheckAdminRole)
ginGroup.Match(WebDavMethod, "/*path", func(c *gin.Context) {
if util.ReadOnly {
switch c.Request.Method {
case "POST", "PUT", "DELETE", "MKCOL", "COPY", "MOVE", "LOCK", "UNLOCK", "PROPPATCH":
c.AbortWithError(http.StatusForbidden, fmt.Errorf(model.Conf.Language(34)))
return
}
}
handler.ServeHTTP(c.Writer, c.Request)
})
}

func shortReqMsg(msg []byte) []byte {
s := gulu.Str.FromBytes(msg)
max := 128
2 changes: 2 additions & 0 deletions kernel/util/working.go
Original file line number Diff line number Diff line change
@@ -198,6 +198,7 @@ var (
WorkingDir, _ = os.Getwd()

WorkspaceDir string // 工作空间目录路径
WorkspaceName string // 工作空间名称
WorkspaceLock *flock.Flock // 工作空间锁
ConfDir string // 配置目录路径
DataDir string // 数据目录路径
@@ -269,6 +270,7 @@ func initWorkspaceDir(workspaceArg string) {
os.Exit(logging.ExitCodeInitWorkspaceErr)
}

WorkspaceName = filepath.Base(WorkspaceDir)
ConfDir = filepath.Join(WorkspaceDir, "conf")
DataDir = filepath.Join(WorkspaceDir, "data")
RepoDir = filepath.Join(WorkspaceDir, "repo")
1 change: 1 addition & 0 deletions kernel/util/working_mobile.go
Original file line number Diff line number Diff line change
@@ -141,6 +141,7 @@ func initWorkspaceDirMobile(workspaceBaseDir string) {
os.Exit(logging.ExitCodeInitWorkspaceErr)
}

WorkspaceName = filepath.Base(WorkspaceDir)
ConfDir = filepath.Join(WorkspaceDir, "conf")
DataDir = filepath.Join(WorkspaceDir, "data")
RepoDir = filepath.Join(WorkspaceDir, "repo")