mirror of
https://github.com/infinite-iroha/touka.git
synced 2026-02-03 00:41:10 +08:00
26cbf45074
This commit introduces a new, high-performance, and extensible WebDAV submodule, implemented natively without external dependencies. It also adds a high-level API to simplify common use cases and incorporates numerous fixes based on detailed code reviews. Features: - A core WebDAV handler supporting `PROPFIND`, `MKCOL`, `GET`, `PUT`, `DELETE`, `COPY`, `MOVE`, `LOCK`, `UNLOCK`. - An extensible design with `FileSystem` and `LockSystem` interfaces. - `MemFS`: A robust, tree-based in-memory filesystem for testing. - `OSFS`: A secure OS-based filesystem with protection against path traversal and symlink attacks. - `MemLock`: An in-memory locking system with graceful shutdown to prevent resource leaks. - A high-level API (`webdav.Serve`, `webdav.Register`) for ease of use. Fixes & Improvements: - Security: Patched directory traversal and symlink vulnerabilities. Ensured secure lock token generation. - RFC Compliance: Corrected status codes for `COPY`/`MOVE` (201 vs 204), `DELETE` on non-empty collections (409), and `Timeout` header parsing. - Performance: Implemented `sync.Pool` for object reuse and `sync/atomic` for file size management to reduce GC pressure. - Robustness: Fixed numerous bugs related to path handling, resource cleanup (goroutine leaks), and header parsing. Integration: - The Touka framework's core has been updated to recognize all necessary WebDAV methods. - Includes comprehensive unit tests and a working example.
47 lines
1.3 KiB
Go
47 lines
1.3 KiB
Go
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
// Copyright 2024 WJQSERVER. All rights reserved.
|
|
// All rights reserved by WJQSERVER, related rights can be exercised by the infinite-iroha organization.
|
|
package webdav
|
|
|
|
import (
|
|
"io"
|
|
"log"
|
|
"os"
|
|
|
|
"github.com/infinite-iroha/touka"
|
|
)
|
|
|
|
// Config is a configuration for the WebDAV handler.
|
|
type Config struct {
|
|
FileSystem FileSystem
|
|
LockSystem LockSystem
|
|
Logger Logger
|
|
}
|
|
|
|
// Register registers a WebDAV handler on the given router.
|
|
func Register(engine *touka.Engine, prefix string, cfg *Config) {
|
|
handler := NewHandler(prefix, cfg.FileSystem, cfg.LockSystem, cfg.Logger)
|
|
|
|
webdavMethods := []string{
|
|
"OPTIONS", "GET", "HEAD", "DELETE", "PUT", "MKCOL", "COPY", "MOVE", "PROPFIND", "PROPPATCH", "LOCK", "UNLOCK",
|
|
}
|
|
engine.HandleFunc(webdavMethods, prefix+"/*path", handler.ServeTouka)
|
|
}
|
|
|
|
// Serve serves a local directory via WebDAV.
|
|
func Serve(engine *touka.Engine, prefix string, rootDir string) (io.Closer, error) {
|
|
fs, err := NewOSFS(rootDir)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
ls := NewMemLock()
|
|
cfg := &Config{
|
|
FileSystem: fs,
|
|
LockSystem: ls,
|
|
Logger: log.New(os.Stdout, "", 0),
|
|
}
|
|
Register(engine, prefix, cfg)
|
|
return ls, nil
|
|
}
|