Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

:bug: Enforce DAV conditional write preconditions https://github.com/siyuan-note/siyuan/issues/20996

Danielca7fcac539cc
diff --git a/kernel/model/caldav.go b/kernel/model/caldav.go
index c383f2e7c4..fc0dc2fc06 100644
--- a/kernel/model/caldav.go
+++ b/kernel/model/caldav.go
@@ -378,7 +378,15 @@ func (c *Calendars) PutCalendarObject(objectPath string, calendarData *ical.Cale
return
}
- // TODO: 处理 opts.IfNoneMatch (If-None-Match) 与 opts.IfMatch (If-Match)
+ if opts != nil {
+ etag := ""
+ if value, ok := calendar.Objects.Load(objectID); ok {
+ etag = value.(*CalendarObject).Data.ETag
+ }
+ if err = checkDAVConditions(etag, opts.IfMatch, opts.IfNoneMatch); err != nil {
+ return
+ }
+ }
// Do not mutate a cached object until its replacement is persisted.
object := &CalendarObject{
diff --git a/kernel/model/carddav.go b/kernel/model/carddav.go
index 3876e6dc23..52b66e9388 100644
--- a/kernel/model/carddav.go
+++ b/kernel/model/carddav.go
@@ -497,7 +497,15 @@ func (c *Contacts) PutAddressObject(addressPath string, card vcard.Card, opts *c
return
}
- // TODO: 处理 opts.IfNoneMatch (If-None-Match) 与 opts.IfMatch (If-Match)
+ if opts != nil {
+ etag := ""
+ if value, ok := addressBook.Addresses.Load(addressID); ok {
+ etag = value.(*AddressObject).Data.ETag
+ }
+ if err = checkDAVConditions(etag, opts.IfMatch, opts.IfNoneMatch); err != nil {
+ return
+ }
+ }
// Do not mutate a cached object until its replacement is persisted.
address := &AddressObject{
diff --git a/kernel/model/dav.go b/kernel/model/dav.go
index c843fff809..4907f99c03 100644
--- a/kernel/model/dav.go
+++ b/kernel/model/dav.go
@@ -18,13 +18,16 @@ package model
import (
"crypto/sha256"
+ "errors"
"fmt"
"io"
+ "net/http"
"os"
"path"
"path/filepath"
"github.com/88250/gulu"
+ "github.com/emersion/go-webdav"
"github.com/emersion/go-webdav/caldav"
"github.com/emersion/go-webdav/carddav"
"github.com/siyuan-note/logging"
@@ -33,6 +36,29 @@ import (
var writeDAVFile = gulu.File.WriteFileSafer
+// Check preconditions while holding the collection lock, before any mutation.
+func checkDAVConditions(etag string, ifMatch, ifNoneMatch webdav.ConditionalMatch) error {
+ if ifMatch.IsSet() {
+ matched, err := ifMatch.MatchETag(etag)
+ if err != nil {
+ return webdav.NewHTTPError(http.StatusBadRequest, err)
+ }
+ if !matched {
+ return webdav.NewHTTPError(http.StatusPreconditionFailed, errors.New("If-Match condition failed"))
+ }
+ }
+ if ifNoneMatch.IsSet() {
+ matched, err := ifNoneMatch.MatchETag(etag)
+ if err != nil {
+ return webdav.NewHTTPError(http.StatusBadRequest, err)
+ }
+ if matched {
+ return webdav.NewHTTPError(http.StatusPreconditionFailed, errors.New("If-None-Match condition failed"))
+ }
+ }
+ return nil
+}
+
// PathJoinWithSlash joins the elements to a path with slash ('/') character
func PathJoinWithSlash(elems ...string) string {
return filepath.ToSlash(filepath.Join(elems...))
diff --git a/kernel/model/dav_conditions_test.go b/kernel/model/dav_conditions_test.go
new file mode 100644
index 0000000000..8daeded4df
--- /dev/null
+++ b/kernel/model/dav_conditions_test.go
@@ -0,0 +1,137 @@
+package model
+
+import (
+ "bytes"
+ "context"
+ "fmt"
+ "net/http"
+ "net/http/httptest"
+ "os"
+ "sync"
+ "testing"
+
+ "github.com/emersion/go-ical"
+ "github.com/emersion/go-vcard"
+ "github.com/emersion/go-webdav/caldav"
+ "github.com/emersion/go-webdav/carddav"
+)
+
+type caldavPutTestBackend struct {
+ caldav.Backend
+ store *Calendars
+}
+
+func (b *caldavPutTestBackend) PutCalendarObject(_ context.Context, p string, data *ical.Calendar, opts *caldav.PutCalendarObjectOptions) (*caldav.CalendarObject, error) {
+ return b.store.PutCalendarObject(PathCleanWithSlash(p), data, opts)
+}
+
+type carddavPutTestBackend struct {
+ carddav.Backend
+ store *Contacts
+}
+
+func (b *carddavPutTestBackend) PutAddressObject(_ context.Context, p string, data vcard.Card, opts *carddav.PutAddressObjectOptions) (*carddav.AddressObject, error) {
+ return b.store.PutAddressObject(PathCleanWithSlash(p), data, opts)
+}
+
+func davConditionalRequest(f davPersistenceFixture, kind, header, value string) *httptest.ResponseRecorder {
+ body, contentType := "BEGIN:VCARD\r\nVERSION:3.0\r\nFN:replacement\r\nEND:VCARD\r\n", vcard.MIMEType
+ if kind == "calendar" {
+ body, contentType = "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:test\r\nBEGIN:VEVENT\r\nUID:test-event\r\nDTSTAMP:20231114T221320Z\r\nSUMMARY:replacement\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n", ical.MIMEType
+ }
+ request := httptest.NewRequest(http.MethodPut, f.urlPath, bytes.NewBufferString(body))
+ request.Header.Set("Content-Type", contentType)
+ request.Header.Set(header, value)
+ response := httptest.NewRecorder()
+ f.handler.ServeHTTP(response, request)
+ return response
+}
+
+func TestDAVConditionalWrites(t *testing.T) {
+ for _, kind := range []string{"calendar", "contact"} {
+ for _, test := range []struct {
+ name, header, value string
+ missing bool
+ status int
+ }{
+ {"current", "If-Match", "current", false, 201},
+ {"stale", "If-Match", "stale", false, 412},
+ {"matchAny", "If-Match", "*", false, 201},
+ {"matchMissing", "If-Match", "*", true, 412},
+ {"createExisting", "If-None-Match", "*", false, 412},
+ {"createMissing", "If-None-Match", "*", true, 201},
+ {"noneCurrent", "If-None-Match", "current", false, 412},
+ {"noneOther", "If-None-Match", "stale", false, 201},
+ {"malformed", "If-Match", "unquoted", false, 400},
+ {"unconditional", "", "", false, 201},
+ } {
+ t.Run(kind+"/"+test.name, func(t *testing.T) {
+ f := newDAVPersistenceFixture(t, kind)
+ if err := f.put("old"); err != nil {
+ t.Fatal(err)
+ }
+ etag, err := FileETag(f.file)
+ if err != nil {
+ t.Fatal(err)
+ }
+ if err = f.put("latest"); err != nil {
+ t.Fatal(err)
+ }
+ if test.value == "current" {
+ etag, err = FileETag(f.file)
+ if err != nil {
+ t.Fatal(err)
+ }
+ }
+ value := test.value
+ if value == "current" || value == "stale" {
+ value = fmt.Sprintf("%q", etag)
+ }
+ if test.missing {
+ if err = f.remove(); err != nil {
+ t.Fatal(err)
+ }
+ }
+ before, _ := os.ReadFile(f.file)
+ response := davConditionalRequest(f, kind, test.header, value)
+ if response.Code != test.status {
+ t.Fatalf("status=%d want=%d: %s", response.Code, test.status, response.Body.String())
+ }
+ if test.status != 201 {
+ after, _ := os.ReadFile(f.file)
+ if !bytes.Equal(before, after) {
+ t.Fatal("rejected request changed disk")
+ }
+ name, err := f.get()
+ if test.missing {
+ if err == nil {
+ t.Fatal("rejected request created cached object")
+ }
+ } else if err != nil || name != "latest" {
+ t.Fatalf("rejected request changed cache: %q, %v", name, err)
+ }
+ }
+ })
+ }
+ t.Run(kind+"/concurrent", func(t *testing.T) {
+ f := newDAVPersistenceFixture(t, kind)
+ if err := f.put("old"); err != nil {
+ t.Fatal(err)
+ }
+ etag, err := FileETag(f.file)
+ if err != nil {
+ t.Fatal(err)
+ }
+ results := make(chan int, 2)
+ var wg sync.WaitGroup
+ for range 2 {
+ wg.Go(func() { results <- davConditionalRequest(f, kind, "If-Match", fmt.Sprintf("%q", etag)).Code })
+ }
+ wg.Wait()
+ first, second := <-results, <-results
+ if first+second != 201+412 {
+ t.Fatalf("concurrent writes returned %d, %d", first, second)
+ }
+ })
+ }
+}
diff --git a/kernel/model/dav_persistence_test.go b/kernel/model/dav_persistence_test.go
index be8a4dc5d5..a4b592663c 100644
--- a/kernel/model/dav_persistence_test.go
+++ b/kernel/model/dav_persistence_test.go
@@ -2,6 +2,7 @@ package model
import (
"errors"
+ "net/http"
"os"
"path/filepath"
"testing"
@@ -9,6 +10,8 @@ import (
"github.com/emersion/go-ical"
"github.com/emersion/go-vcard"
+ "github.com/emersion/go-webdav/caldav"
+ "github.com/emersion/go-webdav/carddav"
"github.com/siyuan-note/siyuan/kernel/util"
)
@@ -20,6 +23,8 @@ type davPersistenceFixture struct {
load func() error
loaded func() bool
setPath func(string)
+ handler http.Handler
+ urlPath string
}
func newDAVPersistenceFixture(t *testing.T, kind string) davPersistenceFixture {
@@ -34,6 +39,7 @@ func newDAVPersistenceFixture(t *testing.T, kind string) davPersistenceFixture {
t.Fatal(err)
}
return davPersistenceFixture{
+ handler: &caldav.Handler{Prefix: CalDavPrincipalsPath, Backend: &caldavPutTestBackend{store: store}}, urlPath: objectPath,
file: DavPath2DirectoryPath(objectPath), load: store.Load,
loaded: func() bool { return store.loaded },
put: func(name string) error {
@@ -65,6 +71,7 @@ func newDAVPersistenceFixture(t *testing.T, kind string) davPersistenceFixture {
t.Fatal(err)
}
return davPersistenceFixture{
+ handler: &carddav.Handler{Prefix: CardDavPrincipalsPath, Backend: &carddavPutTestBackend{store: store}}, urlPath: objectPath,
file: DavPath2DirectoryPath(objectPath), load: store.Load,
loaded: func() bool { return store.loaded },
put: func(name string) error {