version 0.4.11

Cargo.lock

@@ -2999,7 +2999,7 @@ dependencies = [
 
 [[package]]
 name = "rustical"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "anyhow",
  "argon2",
@@ -3042,7 +3042,7 @@ dependencies = [
 
 [[package]]
 name = "rustical_caldav"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "async-std",
  "async-trait",
@@ -3080,7 +3080,7 @@ dependencies = [
 
 [[package]]
 name = "rustical_carddav"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "async-trait",
  "axum",
@@ -3112,7 +3112,7 @@ dependencies = [
 
 [[package]]
 name = "rustical_dav"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "async-trait",
  "axum",
@@ -3137,7 +3137,7 @@ dependencies = [
 
 [[package]]
 name = "rustical_dav_push"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "async-trait",
  "axum",
@@ -3163,7 +3163,7 @@ dependencies = [
 
 [[package]]
 name = "rustical_frontend"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "askama",
  "askama_web",
@@ -3196,7 +3196,7 @@ dependencies = [
 
 [[package]]
 name = "rustical_ical"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "axum",
  "chrono",
@@ -3214,7 +3214,7 @@ dependencies = [
 
 [[package]]
 name = "rustical_oidc"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "async-trait",
  "axum",
@@ -3229,7 +3229,7 @@ dependencies = [
 
 [[package]]
 name = "rustical_store"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -3263,7 +3263,7 @@ dependencies = [
 
 [[package]]
 name = "rustical_store_sqlite"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "async-trait",
  "chrono",
@@ -3284,7 +3284,7 @@ dependencies = [
 
 [[package]]
 name = "rustical_xml"
-version = "0.4.9"
+version = "0.4.11"
 dependencies = [
  "quick-xml",
  "thiserror 2.0.12",

Cargo.toml

@@ -2,7 +2,7 @@
 members = ["crates/*"]
 
 [workspace.package]
-version = "0.4.9"
+version = "0.4.11"
 edition = "2024"
 description = "A CalDAV server"
 repository = "https://github.com/lennart-k/rustical"

crates/caldav/src/calendar/methods/get.rs

@@ -4,7 +4,7 @@ use axum::body::Body;
 use axum::extract::State;
 use axum::{extract::Path, response::Response};
 use headers::{ContentType, HeaderMapExt};
-use http::{HeaderValue, StatusCode, header};
+use http::{HeaderValue, Method, StatusCode, header};
 use ical::generator::{Emitter, IcalCalendarBuilder};
 use ical::property::Property;
 use percent_encoding::{CONTROLS, utf8_percent_encode};
@@ -19,6 +19,7 @@ pub async fn route_get<C: CalendarStore, S: SubscriptionStore>(
     Path((principal, calendar_id)): Path<(String, String)>,
     State(CalendarResourceService { cal_store, .. }): State<CalendarResourceService<C, S>>,
     user: Principal,
+    method: Method,
 ) -> Result<Response, Error> {
     if !user.is_principal(&principal) {
         return Err(crate::Error::Unauthorized);
@@ -96,5 +97,9 @@ pub async fn route_get<C: CalendarStore, S: SubscriptionStore>(
         ))
         .unwrap(),
     );
-    Ok(resp.body(Body::new(ical_calendar.generate())).unwrap())
+    if matches!(method, Method::HEAD) {
+        Ok(resp.body(Body::empty()).unwrap())
+    } else {
+        Ok(resp.body(Body::new(ical_calendar.generate())).unwrap())
+    }
 }

crates/caldav/src/calendar_object/methods.rs

@@ -6,7 +6,7 @@ use axum::extract::{Path, State};
 use axum::response::{IntoResponse, Response};
 use axum_extra::TypedHeader;
 use headers::{ContentType, ETag, HeaderMapExt, IfNoneMatch};
-use http::{HeaderMap, StatusCode};
+use http::{HeaderMap, Method, StatusCode};
 use rustical_ical::CalendarObject;
 use rustical_store::CalendarStore;
 use rustical_store::auth::Principal;
@@ -22,6 +22,7 @@ pub async fn get_event<C: CalendarStore>(
     }): Path<CalendarObjectPathComponents>,
     State(CalendarObjectResourceService { cal_store }): State<CalendarObjectResourceService<C>>,
     user: Principal,
+    method: Method,
 ) -> Result<Response, Error> {
     if !user.is_principal(&principal) {
         return Err(crate::Error::Unauthorized);
@@ -42,7 +43,11 @@ pub async fn get_event<C: CalendarStore>(
     let hdrs = resp.headers_mut().unwrap();
     hdrs.typed_insert(ETag::from_str(&event.get_etag()).unwrap());
     hdrs.typed_insert(ContentType::from_str("text/calendar").unwrap());
-    Ok(resp.body(Body::new(event.get_ics().to_owned())).unwrap())
+    if matches!(method, Method::HEAD) {
+        Ok(resp.body(Body::empty()).unwrap())
+    } else {
+        Ok(resp.body(Body::new(event.get_ics().to_owned())).unwrap())
+    }
 }
 
 #[instrument(skip(cal_store))]

crates/carddav/src/address_object/methods.rs

@@ -7,6 +7,7 @@ use axum::extract::{Path, State};
 use axum::response::{IntoResponse, Response};
 use axum_extra::TypedHeader;
 use axum_extra::headers::{ContentType, ETag, HeaderMapExt, IfNoneMatch};
+use http::Method;
 use http::{HeaderMap, StatusCode};
 use rustical_dav::privileges::UserPrivilege;
 use rustical_dav::resource::Resource;
@@ -25,6 +26,7 @@ pub async fn get_object<AS: AddressbookStore>(
     }): Path<AddressObjectPathComponents>,
     State(AddressObjectResourceService { addr_store }): State<AddressObjectResourceService<AS>>,
     user: Principal,
+    method: Method,
 ) -> Result<Response, Error> {
     if !user.is_principal(&principal) {
         return Err(Error::Unauthorized);
@@ -49,7 +51,11 @@ pub async fn get_object<AS: AddressbookStore>(
     let hdrs = resp.headers_mut().unwrap();
     hdrs.typed_insert(ETag::from_str(&object.get_etag()).unwrap());
     hdrs.typed_insert(ContentType::from_str("text/vcard").unwrap());
-    Ok(resp.body(Body::new(object.get_vcf().to_owned())).unwrap())
+    if matches!(method, Method::HEAD) {
+        Ok(resp.body(Body::empty()).unwrap())
+    } else {
+        Ok(resp.body(Body::new(object.get_vcf().to_owned())).unwrap())
+    }
 }
 
 #[instrument(skip(addr_store, body))]

crates/carddav/src/addressbook/methods/get.rs

@@ -5,7 +5,7 @@ use axum::body::Body;
 use axum::extract::{Path, State};
 use axum::response::Response;
 use axum_extra::headers::{ContentType, HeaderMapExt};
-use http::{HeaderValue, StatusCode, header};
+use http::{HeaderValue, Method, StatusCode, header};
 use percent_encoding::{CONTROLS, utf8_percent_encode};
 use rustical_dav::privileges::UserPrivilege;
 use rustical_dav::resource::Resource;
@@ -20,6 +20,7 @@ pub async fn route_get<AS: AddressbookStore, S: SubscriptionStore>(
     Path((principal, addressbook_id)): Path<(String, String)>,
     State(AddressbookResourceService { addr_store, .. }): State<AddressbookResourceService<AS, S>>,
     user: Principal,
+    method: Method,
 ) -> Result<Response, Error> {
     if !user.is_principal(&principal) {
         return Err(Error::Unauthorized);
@@ -55,5 +56,9 @@ pub async fn route_get<AS: AddressbookStore, S: SubscriptionStore>(
         ))
         .unwrap(),
     );
-    Ok(resp.body(Body::new(vcf)).unwrap())
+    if matches!(method, Method::HEAD) {
+        Ok(resp.body(Body::empty()).unwrap())
+    } else {
+        Ok(resp.body(Body::new(vcf)).unwrap())
+    }
 }

crates/dav/src/resource/axum_methods.rs

@@ -18,11 +18,6 @@ pub trait AxumMethods: Sized + Send + Sync + 'static {
         None
     }
 
-    #[inline]
-    fn head() -> Option<MethodFunction<Self>> {
-        None
-    }
-
     #[inline]
     fn post() -> Option<MethodFunction<Self>> {
         None
@@ -58,8 +53,6 @@ pub trait AxumMethods: Sized + Send + Sync + 'static {
         }
         if Self::get().is_some() {
             allow.push(Method::GET);
-        }
-        if Self::head().is_some() {
             allow.push(Method::HEAD);
         }
         if Self::post().is_some() {

crates/dav/src/resource/axum_service.rs

@@ -72,16 +72,11 @@ where
                     return svc(self.resource_service.clone(), req);
                 }
             }
-            "GET" => {
+            "GET" | "HEAD" => {
                 if let Some(svc) = RS::get() {
                     return svc(self.resource_service.clone(), req);
                 }
             }
-            "HEAD" => {
-                if let Some(svc) = RS::head() {
-                    return svc(self.resource_service.clone(), req);
-                }
-            }
             "POST" => {
                 if let Some(svc) = RS::post() {
                     return svc(self.resource_service.clone(), req);

crates/frontend/js-components/lib/create-addressbook-form.ts

@@ -38,7 +38,12 @@ export class CreateAddressbookForm extends LitElement {
         <form @submit=${this.submit} ${ref(this.form)}>
           <label>
             principal (for group addressbooks)
-            <input type="text" name="principal" value=${this.user} @change=${e => this.principal = e.target.value} />
+            <select name="principal" value=${this.user} @change=${e => this.principal = e.target.value}>
+              <option value=${this.user}>${this.user}</option>
+              ${window.rusticalUser.memberships.map(membership => html`
+                <option value=${membership}>${membership}</option>
+              `)}
+            </select>
           </label>
           <br>
           <label>

crates/frontend/js-components/lib/create-calendar-form.ts

@@ -28,6 +28,8 @@ export class CreateCalendarForm extends LitElement {
   @property()
   color: String = ''
   @property()
+  isSubscription: boolean = false
+  @property()
   subscriptionUrl: String = ''
   @property()
   components: Set<"VEVENT" | "VTODO" | "VJOURNAL"> = new Set()
@@ -43,8 +45,13 @@ export class CreateCalendarForm extends LitElement {
         <h3>Create calendar</h3>
         <form @submit=${this.submit} ${ref(this.form)}>
           <label>
-            principal (for group calendar)
-            <input type="text" name="principal" value=${this.user} @change=${e => this.principal = e.target.value} />
+            principal (for group calendars)
+            <select name="principal" value=${this.user} @change=${e => this.principal = e.target.value}>
+              <option value=${this.user}>${this.user}</option>
+              ${window.rusticalUser.memberships.map(membership => html`
+                <option value=${membership}>${membership}</option>
+              `)}
+            </select>
           </label>
           <br>
           <label>
@@ -67,11 +74,20 @@ export class CreateCalendarForm extends LitElement {
             <input type="color" name="color"  @change=${e => this.color = e.target.value} />
           </label>
           <br>
+          <br>
           <label>
-            Subscription URL
-            <input type="text" name="subscription_url" @change=${e => this.subscriptionUrl = e.target.value}  />
+            Calendar is subscription to external calendar
+            <input type="checkbox" name="is_subscription" @change=${e => this.isSubscription = e.target.checked}  />
           </label>
           <br>
+          ${this.isSubscription ? html`
+            <label>
+              Subscription URL
+              <input type="text" name="subscription_url" @change=${e => this.subscriptionUrl = e.target.value}  />
+            </label>
+            <br>
+          `: html``}
+          <br>
           ${["VEVENT", "VTODO", "VJOURNAL"].map(comp => html`
             <label>
               Support ${comp}
@@ -110,7 +126,7 @@ export class CreateCalendarForm extends LitElement {
             <displayname>${this.displayname}</displayname>
             ${this.description ? `<CAL:calendar-description>${this.description}</CAL:calendar-description>` : ''}
             ${this.color ? `<ICAL:calendar-color>${this.color}</ICAL:calendar-color>` : ''}
-            ${this.subscriptionUrl ? `<CS:source><href>${this.subscriptionUrl}</href></CS:source>` : ''}
+            ${(this.isSubscription && this.subscriptionUrl) ? `<CS:source><href>${this.subscriptionUrl}</href></CS:source>` : ''}
             <CAL:supported-calendar-component-set>
               ${Array.from(this.components.keys()).map(comp => `<CAL:comp name="${comp}" />`).join('\n')}
             </CAL:supported-calendar-component-set>

crates/frontend/js-components/lib/delete-button.ts

@@ -1,6 +1,5 @@
 import { html, LitElement } from "lit";
 import { customElement, property } from "lit/decorators.js";
-import { createClient } from "webdav";
 
 @customElement("delete-button")
 export class DeleteButton extends LitElement {

crates/frontend/js-components/lib/global.d.ts

@@ -0,0 +1,9 @@
+interface Window {
+  rusticalUser: {
+    id: String,
+    displayname: String | null,
+    memberships: Array<String>,
+    principal_type: "individual" | "group" | "room" | String
+  }
+}
+

crates/frontend/public/assets/js/create-addressbook-form.mjs

@@ -35,7 +35,12 @@ let CreateAddressbookForm = class extends i {
         <form @submit=${this.submit} ${n(this.form)}>
           <label>
             principal (for group addressbooks)
-            <input type="text" name="principal" value=${this.user} @change=${(e2) => this.principal = e2.target.value} />
+            <select name="principal" value=${this.user} @change=${(e2) => this.principal = e2.target.value}>
+              <option value=${this.user}>${this.user}</option>
+              ${window.rusticalUser.memberships.map((membership) => x`
+                <option value=${membership}>${membership}</option>
+              `)}
+            </select>
           </label>
           <br>
           <label>

crates/frontend/public/assets/js/create-calendar-form.mjs

@@ -22,6 +22,7 @@ let CreateCalendarForm = class extends i {
     this.displayname = "";
     this.description = "";
     this.color = "";
+    this.isSubscription = false;
     this.subscriptionUrl = "";
     this.components = /* @__PURE__ */ new Set();
     this.dialog = e();
@@ -37,8 +38,13 @@ let CreateCalendarForm = class extends i {
         <h3>Create calendar</h3>
         <form @submit=${this.submit} ${n(this.form)}>
           <label>
-            principal (for group calendar)
-            <input type="text" name="principal" value=${this.user} @change=${(e2) => this.principal = e2.target.value} />
+            principal (for group calendars)
+            <select name="principal" value=${this.user} @change=${(e2) => this.principal = e2.target.value}>
+              <option value=${this.user}>${this.user}</option>
+              ${window.rusticalUser.memberships.map((membership) => x`
+                <option value=${membership}>${membership}</option>
+              `)}
+            </select>
           </label>
           <br>
           <label>
@@ -61,11 +67,20 @@ let CreateCalendarForm = class extends i {
             <input type="color" name="color"  @change=${(e2) => this.color = e2.target.value} />
           </label>
           <br>
+          <br>
           <label>
-            Subscription URL
-            <input type="text" name="subscription_url" @change=${(e2) => this.subscriptionUrl = e2.target.value}  />
+            Calendar is subscription to external calendar
+            <input type="checkbox" name="is_subscription" @change=${(e2) => this.isSubscription = e2.target.checked}  />
           </label>
           <br>
+          ${this.isSubscription ? x`
+            <label>
+              Subscription URL
+              <input type="text" name="subscription_url" @change=${(e2) => this.subscriptionUrl = e2.target.value}  />
+            </label>
+            <br>
+          ` : x``}
+          <br>
           ${["VEVENT", "VTODO", "VJOURNAL"].map((comp) => x`
             <label>
               Support ${comp}
@@ -107,7 +122,7 @@ let CreateCalendarForm = class extends i {
             <displayname>${this.displayname}</displayname>
             ${this.description ? `<CAL:calendar-description>${this.description}</CAL:calendar-description>` : ""}
             ${this.color ? `<ICAL:calendar-color>${this.color}</ICAL:calendar-color>` : ""}
-            ${this.subscriptionUrl ? `<CS:source><href>${this.subscriptionUrl}</href></CS:source>` : ""}
+            ${this.isSubscription && this.subscriptionUrl ? `<CS:source><href>${this.subscriptionUrl}</href></CS:source>` : ""}
             <CAL:supported-calendar-component-set>
               ${Array.from(this.components.keys()).map((comp) => `<CAL:comp name="${comp}" />`).join("\n")}
             </CAL:supported-calendar-component-set>
@@ -138,6 +153,9 @@ __decorateClass([
 __decorateClass([
   n$1()
 ], CreateCalendarForm.prototype, "color", 2);
+__decorateClass([
+  n$1()
+], CreateCalendarForm.prototype, "isSubscription", 2);
 __decorateClass([
   n$1()
 ], CreateCalendarForm.prototype, "subscriptionUrl", 2);

crates/frontend/public/assets/style.css

@@ -229,7 +229,7 @@ ul.collection-list {
 
       border: 2px solid var(--border-color);
       border-radius: 12px;
-      margin: 12px;
+      margin: 12px 0;
       box-shadow: 4px 2px 12px -6px black;
       overflow: hidden;
 
@@ -310,12 +310,20 @@ footer {
 }
 
 input[type="text"],
-input[type="password"] {
+input[type="password"],
+input[type="color"],
+select {
   background: color-mix(in srgb, var(--background-color), var(--dilute-color) 10%);
   border: 2px solid var(--border-color);
   padding: 6px 6px;
   color: var(--text-on-background-color);
   margin: 2px;
+  border-radius: 8px;
+
+  &:hover,
+  &:focus {
+    background: color-mix(in srgb, var(--background-color), var(--dilute-color) 20%);
+  }
 }
 
 svg.icon {

crates/frontend/public/templates/pages/user.html

@@ -1,6 +1,10 @@
 {% extends "layouts/default.html" %}
 
 {% block imports %}
+<template id="data-rustical-user">{{ user|json }}</template>
+<script>
+window.rusticalUser = JSON.parse(document.querySelector('#data-rustical-user').innerHTML)
+</script>
 <script type="module" src="/frontend/assets/js/create-calendar-form.mjs" async></script>
 <script type="module" src="/frontend/assets/js/create-addressbook-form.mjs" async></script>
 <script type="module" src="/frontend/assets/js/delete-button.mjs" async></script>

crates/store/src/auth/principal.rs

@@ -25,6 +25,7 @@ pub struct Principal {
     pub displayname: Option<String>,
     #[serde(default)]
     pub principal_type: PrincipalType,
+    #[serde(skip_serializing)]
     pub password: Option<Secret<String>>,
     #[serde(default)]
     pub memberships: Vec<String>,

crates/store_sqlite/src/principal_store.rs

@@ -206,7 +206,7 @@ impl AuthenticationProvider for SqlitePrincipalStore {
                 None,
                 None,
                 Params {
-                    rounds: 100,
+                    rounds: 10,
                     ..Default::default()
                 },
                 &salt,

docs/setup/client.md

@@ -0,0 +1,60 @@
+# Client Setup
+
+## Common
+
+Following resources are available.
+
+```
+/.well-known/caldav
+# CalDAV root
+/caldav
+# Principal home
+/caldav/principal/<user_id>
+# Calendar home
+/caldav/principal/<user_id>/<calendar_id>
+/caldav/principal/<user_id>/_birthdays_<addressbook_id>
+```
+
+```
+/.well-known/carddav
+# CardDAV root
+/carddav
+# Principal home
+/carddav/principal/<user_id>
+# Addressbook home
+/carddav/principal/<user_id>/<addressbook_id>
+```
+
+### Authentication
+
+Authenticate with HTTP Basic authentication using your user id and a generated app token.
+
+## DAVx5
+
+You can set up DAVx5 through the Nextcloud login flow. Collections including group collections will automatically be discovered.
+
+## Apple Calendar
+
+You can download a configuration profile from the frontend in the app token section.
+
+**Limitation**: Group collections are not automatically discovered, for these you need to set up separate CalDAV configurations using the corresponding principal homes (but your own user id).
+
+## Evolution
+
+Set up a collection account in the account settings.
+
+**Limitation**: Group collections are not discovered. It seems as if currently you have to add each group collection manually.
+
+## Home Assistant CalDAV integration
+
+As URL specify
+
+```
+https://<your-host>/.well-known/caldav
+```
+
+For goup collections explicitly specify
+
+```
+https://<your-host>/caldav/principal/<principal>
+```

mkdocs.yml

@@ -68,6 +68,7 @@ nav:
   - Installation:
       - installation/index.md
       - Configuration: installation/configuration.md
+  - Client Setup: setup/client.md
   - OpenID Connect: setup/oidc.md
   - Developers:
       - developers/index.md