dovenest

dovenest/server/tests/api_pim.rs
api_pim.rs
⎇
Raw
1//! CalDAV and CardDAV: discovery, collections, properties and objects.
2
3mod common;
4
5use axum::http::{Method, StatusCode};
6use common::*;
7use pimdav::xml::{self, APPLE, CALDAV, CALSERVER, CARDDAV, DAV, Name};
8use serde_json::json;
9use xmltree::Element;
10
11const ALICE: &str = "alice";
12const PW: &str = "alice12345";
13
14async fn setup() -> (Env, String) {
15 let env = Env::new().await;
16 let admin = env.admin().await;
17 create_user(&admin, ALICE, PW, &[]).await;
18 (env, basic(ALICE, PW))
19}
20
21async fn req(
22 env: &Env,
23 verb: &str,
24 path: &str,
25 auth: &str,
26 extra: &[(&str, &str)],
27 body: &str,
28) -> Resp {
29 let mut headers = vec![("authorization", auth)];
30 headers.extend_from_slice(extra);
31 Client::new(env.app.clone())
32 .raw(
33 Method::from_bytes(verb.as_bytes()).unwrap(),
34 path,
35 &headers,
36 body.as_bytes().to_vec(),
37 )
38 .await
39}
40
41fn propfind_body(props: &[(&str, &str)]) -> String {
42 let props: String = props
43 .iter()
44 .map(|(ns, l)| format!("<{l} xmlns=\"{ns}\"/>"))
45 .collect();
46 format!("<d:propfind xmlns:d=\"DAV:\"><d:prop>{props}</d:prop></d:propfind>")
47}
48
49/// `href -> [(status, property element)]` of a multistatus.
50fn parse_multistatus(r: &Resp) -> Vec<(String, Vec<(u16, Element)>)> {
51 assert_eq!(r.status, StatusCode::MULTI_STATUS, "{}", r.text());
52 let root = Element::parse(r.body.as_slice()).unwrap();
53 xml::elements(&root)
54 .map(|resp| {
55 let href = xml::text(xml::child(resp, DAV, "href").unwrap());
56 let props = xml::elements(resp)
57 .filter(|e| Name::of(e).is(DAV, "propstat"))
58 .flat_map(|ps| {
59 let code: u16 = xml::text(xml::child(ps, DAV, "status").unwrap())
60 .split(' ')
61 .nth(1)
62 .unwrap()
63 .parse()
64 .unwrap();
65 let prop = xml::child(ps, DAV, "prop").unwrap();
66 xml::elements(prop)
67 .map(move |p| (code, p.clone()))
68 .collect::<Vec<_>>()
69 })
70 .collect();
71 (href, props)
72 })
73 .collect()
74}
75
76/// The property of `href` with status 200.
77fn prop(
78 ms: &[(String, Vec<(u16, Element)>)],
79 href: &str,
80 ns: &str,
81 local: &str,
82) -> Option<Element> {
83 ms.iter()
84 .find(|(h, _)| h == href)
85 .unwrap_or_else(|| panic!("no response for {href}"))
86 .1
87 .iter()
88 .find(|(code, p)| *code == 200 && Name::of(p).is(ns, local))
89 .map(|(_, p)| p.clone())
90}
91
92fn prop_text(
93 ms: &[(String, Vec<(u16, Element)>)],
94 href: &str,
95 ns: &str,
96 local: &str,
97) -> Option<String> {
98 prop(ms, href, ns, local).map(|p| xml::text(&p))
99}
100
101fn hrefs_of(p: &Element) -> Vec<String> {
102 xml::elements(p).map(xml::text).collect()
103}
104
105fn error_condition(r: &Resp) -> Name {
106 let root = Element::parse(r.body.as_slice()).unwrap_or_else(|_| panic!("{}", r.text()));
107 assert!(Name::of(&root).is(DAV, "error"), "{}", r.text());
108 Name::of(xml::elements(&root).next().unwrap())
109}
110
111const HOME: &str = "/pim/calendars/alice/";
112const CAL: &str = "/pim/calendars/alice/default/";
113const BOOK: &str = "/pim/addressbooks/alice/default/";
114
115fn event(uid: &str, summary: &str) -> String {
116 format!(
117 "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//t//EN\r\nBEGIN:VEVENT\r\nUID:{uid}\r\nDTSTAMP:20260101T000000Z\r\nDTSTART:20260101T100000Z\r\nSUMMARY:{summary}\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
118 )
119}
120
121#[tokio::test]
122async fn discovery() {
123 let (env, auth) = setup().await;
124
125 let r = req(&env, "PROPFIND", "/pim/", "", &[], "").await;
126 assert_eq!(r.status, StatusCode::UNAUTHORIZED);
127 assert!(r.header("www-authenticate").is_some());
128
129 let r = req(&env, "PROPFIND", "/.well-known/caldav", &auth, &[], "").await;
130 assert_eq!(r.status, StatusCode::MOVED_PERMANENTLY);
131 assert_eq!(r.header("location").as_deref(), Some("/pim/"));
132
133 // A Basic login spelled in another case still gets the stored spelling.
134 let body = propfind_body(&[(DAV, "current-user-principal")]);
135 let r = req(
136 &env,
137 "PROPFIND",
138 "/pim/",
139 &basic("ALICE", PW),
140 &[("depth", "0")],
141 &body,
142 )
143 .await;
144 let ms = parse_multistatus(&r);
145 let p = prop(&ms, "/pim/", DAV, "current-user-principal").unwrap();
146 assert_eq!(hrefs_of(&p), ["/pim/principals/alice/"]);
147
148 let body = propfind_body(&[
149 (CALDAV, "calendar-home-set"),
150 (CARDDAV, "addressbook-home-set"),
151 (CALDAV, "calendar-user-address-set"),
152 (DAV, "displayname"),
153 (DAV, "no-such-prop"),
154 ]);
155 let r = req(
156 &env,
157 "PROPFIND",
158 "/pim/principals/alice/",
159 &auth,
160 &[("depth", "0")],
161 &body,
162 )
163 .await;
164 let ms = parse_multistatus(&r);
165 let p = "/pim/principals/alice/";
166 assert_eq!(
167 hrefs_of(&prop(&ms, p, CALDAV, "calendar-home-set").unwrap()),
168 [HOME]
169 );
170 assert_eq!(
171 hrefs_of(&prop(&ms, p, CARDDAV, "addressbook-home-set").unwrap()),
172 ["/pim/addressbooks/alice/"]
173 );
174 let addresses = hrefs_of(&prop(&ms, p, CALDAV, "calendar-user-address-set").unwrap());
175 assert_eq!(addresses[0], "mailto:alice@filebrowser.invalid");
176 assert!(addresses[2].starts_with("urn:uuid:"));
177 assert_eq!(
178 prop_text(&ms, p, DAV, "displayname").as_deref(),
179 Some(ALICE)
180 );
181 assert!(
182 ms[0]
183 .1
184 .iter()
185 .any(|(c, e)| *c == 404 && Name::of(e).is(DAV, "no-such-prop"))
186 );
187
188 // An app password works as well.
189 let admin = login(&env, ALICE, PW).await;
190 let r = admin
191 .post_json("/api/auth/app-passwords", &json!({ "name": "phone" }))
192 .await;
193 let secret = r.json()["secret"].as_str().unwrap().to_string();
194 let r = req(
195 &env,
196 "PROPFIND",
197 "/pim/",
198 &basic("x", &secret),
199 &[("depth", "0")],
200 "",
201 )
202 .await;
203 assert_eq!(r.status, StatusCode::MULTI_STATUS);
204
205 let r = req(&env, "OPTIONS", "/pim/", &auth, &[], "").await;
206 assert!(r.header("dav").unwrap().contains("calendar-access"));
207}
208
209#[tokio::test]
210async fn homes_list_the_default_collections() {
211 let (env, auth) = setup().await;
212 let r = req(&env, "PROPFIND", HOME, &auth, &[("depth", "1")], "").await;
213 let ms = parse_multistatus(&r);
214 assert_eq!(ms.len(), 2, "{}", r.text());
215 let rt = prop(&ms, CAL, DAV, "resourcetype").unwrap();
216 assert!(xml::child(&rt, CALDAV, "calendar").is_some());
217 assert_eq!(
218 prop_text(&ms, CAL, DAV, "displayname").as_deref(),
219 Some("Calendar")
220 );
221 let comps = prop(&ms, CAL, CALDAV, "supported-calendar-component-set").unwrap();
222 let comps: Vec<_> = xml::elements(&comps)
223 .map(|c| c.attributes["name"].clone())
224 .collect();
225 assert_eq!(comps, ["VEVENT", "VTODO"]);
226 assert!(prop_text(&ms, CAL, CALSERVER, "getctag").is_some());
227 assert!(
228 prop_text(&ms, CAL, DAV, "sync-token")
229 .unwrap()
230 .starts_with("urn:")
231 );
232
233 let r = req(
234 &env,
235 "PROPFIND",
236 "/pim/addressbooks/alice/",
237 &auth,
238 &[("depth", "1")],
239 "",
240 )
241 .await;
242 let ms = parse_multistatus(&r);
243 let rt = prop(&ms, BOOK, DAV, "resourcetype").unwrap();
244 assert!(xml::child(&rt, CARDDAV, "addressbook").is_some());
245
246 let r = req(&env, "PROPFIND", HOME, &auth, &[("depth", "infinity")], "").await;
247 assert_eq!(r.status, StatusCode::FORBIDDEN);
248 assert!(error_condition(&r).is(DAV, "propfind-finite-depth"));
249}
250
251#[tokio::test]
252async fn other_users_are_off_limits() {
253 let (env, auth) = setup().await;
254 for path in ["/pim/principals/admin/", "/pim/calendars/admin/default/"] {
255 let r = req(&env, "PROPFIND", path, &auth, &[("depth", "0")], "").await;
256 assert_eq!(r.status, StatusCode::FORBIDDEN, "{path}");
257 }
258}
259
260#[tokio::test]
261async fn make_and_patch_collections() {
262 let (env, auth) = setup().await;
263 let work = "/pim/calendars/alice/work/";
264 let body = r##"<c:mkcalendar xmlns:d="DAV:" xmlns:c="urn:ietf:params:xml:ns:caldav" xmlns:i="http://apple.com/ns/ical/">
265 <d:set><d:prop>
266 <d:displayname>Work</d:displayname>
267 <i:calendar-color>#00ff00</i:calendar-color>
268 <c:supported-calendar-component-set><c:comp name="VTODO"/></c:supported-calendar-component-set>
269 </d:prop></d:set></c:mkcalendar>"##;
270 let r = req(&env, "MKCALENDAR", work, &auth, &[], body).await;
271 assert_eq!(r.status, StatusCode::CREATED, "{}", r.text());
272 let r = req(&env, "MKCALENDAR", work, &auth, &[], "").await;
273 assert_eq!(r.status, StatusCode::METHOD_NOT_ALLOWED);
274
275 let r = req(&env, "PROPFIND", work, &auth, &[("depth", "0")], "").await;
276 let ms = parse_multistatus(&r);
277 assert_eq!(
278 prop_text(&ms, work, DAV, "displayname").as_deref(),
279 Some("Work")
280 );
281 assert_eq!(
282 prop_text(&ms, work, APPLE, "calendar-color").as_deref(),
283 Some("#00ff00")
284 );
285 let ctag = prop_text(&ms, work, CALSERVER, "getctag").unwrap();
286
287 // One bad property fails the whole request, and nothing is created.
288 let bad = body.replace("VTODO", "VCARD");
289 let r = req(
290 &env,
291 "MKCALENDAR",
292 "/pim/calendars/alice/bad/",
293 &auth,
294 &[],
295 &bad,
296 )
297 .await;
298 assert_eq!(r.status, StatusCode::FORBIDDEN);
299 assert!(r.text().contains("mkcalendar-response"), "{}", r.text());
300 let r = req(
301 &env,
302 "PROPFIND",
303 "/pim/calendars/alice/bad/",
304 &auth,
305 &[("depth", "0")],
306 "",
307 )
308 .await;
309 assert_eq!(r.status, StatusCode::NOT_FOUND);
310
311 // A plain MKCOL cannot make a calendar, an extended one makes an address book.
312 let r = req(&env, "MKCOL", "/pim/calendars/alice/plain/", &auth, &[], "").await;
313 assert_eq!(r.status, StatusCode::FORBIDDEN);
314 let mkcol = r#"<d:mkcol xmlns:d="DAV:" xmlns:card="urn:ietf:params:xml:ns:carddav"><d:set><d:prop>
315 <d:resourcetype><d:collection/><card:addressbook/></d:resourcetype>
316 <d:displayname>Friends</d:displayname></d:prop></d:set></d:mkcol>"#;
317 let r = req(
318 &env,
319 "MKCOL",
320 "/pim/addressbooks/alice/friends/",
321 &auth,
322 &[],
323 mkcol,
324 )
325 .await;
326 assert_eq!(r.status, StatusCode::CREATED, "{}", r.text());
327
328 let patch = r#"<d:propertyupdate xmlns:d="DAV:" xmlns:c="urn:ietf:params:xml:ns:caldav">
329 <d:set><d:prop><d:displayname>Job</d:displayname><c:calendar-description>Tasks</c:calendar-description></d:prop></d:set>
330 </d:propertyupdate>"#;
331 let r = req(&env, "PROPPATCH", work, &auth, &[], patch).await;
332 let ms = parse_multistatus(&r);
333 assert!(ms[0].1.iter().all(|(c, _)| *c == 200));
334 let r = req(&env, "PROPFIND", work, &auth, &[("depth", "0")], "").await;
335 let ms = parse_multistatus(&r);
336 assert_eq!(
337 prop_text(&ms, work, DAV, "displayname").as_deref(),
338 Some("Job")
339 );
340 assert_eq!(
341 prop_text(&ms, work, CALDAV, "calendar-description").as_deref(),
342 Some("Tasks")
343 );
344 assert_ne!(prop_text(&ms, work, CALSERVER, "getctag").unwrap(), ctag);
345
346 let patch = r#"<d:propertyupdate xmlns:d="DAV:"><d:set><d:prop>
347 <d:displayname>Never</d:displayname><d:getetag>x</d:getetag></d:prop></d:set></d:propertyupdate>"#;
348 let r = req(&env, "PROPPATCH", work, &auth, &[], patch).await;
349 let ms = parse_multistatus(&r);
350 let codes: Vec<u16> = ms[0].1.iter().map(|(c, _)| *c).collect();
351 assert_eq!(codes, [424, 403]);
352 let r = req(&env, "PROPFIND", work, &auth, &[("depth", "0")], "").await;
353 let ms = parse_multistatus(&r);
354 assert_eq!(
355 prop_text(&ms, work, DAV, "displayname").as_deref(),
356 Some("Job")
357 );
358
359 let r = req(&env, "DELETE", work, &auth, &[], "").await;
360 assert_eq!(r.status, StatusCode::NO_CONTENT);
361 let r = req(&env, "PROPFIND", work, &auth, &[("depth", "0")], "").await;
362 assert_eq!(r.status, StatusCode::NOT_FOUND);
363}
364
365#[tokio::test]
366async fn calendar_objects() {
367 let (env, auth) = setup().await;
368 let obj = format!("{CAL}a.ics");
369
370 let r = req(
371 &env,
372 "PUT",
373 &obj,
374 &auth,
375 &[("if-none-match", "*")],
376 &event("a", "One"),
377 )
378 .await;
379 assert_eq!(r.status, StatusCode::CREATED, "{}", r.text());
380 let etag = r.header("etag").unwrap();
381
382 let r = req(&env, "GET", &obj, &auth, &[], "").await;
383 assert_eq!(r.status, StatusCode::OK);
384 assert_eq!(r.text(), event("a", "One"));
385 assert_eq!(r.header("etag"), Some(etag.clone()));
386 assert!(
387 r.header("content-type")
388 .unwrap()
389 .starts_with("text/calendar")
390 );
391 let r = req(&env, "HEAD", &obj, &auth, &[], "").await;
392 assert_eq!(r.status, StatusCode::OK);
393 assert!(r.body.is_empty());
394
395 let r = req(
396 &env,
397 "PUT",
398 &obj,
399 &auth,
400 &[("if-none-match", "*")],
401 &event("a", "Two"),
402 )
403 .await;
404 assert_eq!(r.status, StatusCode::PRECONDITION_FAILED);
405 let r = req(
406 &env,
407 "PUT",
408 &obj,
409 &auth,
410 &[("if-match", "\"stale\"")],
411 &event("a", "Two"),
412 )
413 .await;
414 assert_eq!(r.status, StatusCode::PRECONDITION_FAILED);
415
416 let before = parse_multistatus(&req(&env, "PROPFIND", CAL, &auth, &[("depth", "0")], "").await);
417 let r = req(
418 &env,
419 "PUT",
420 &obj,
421 &auth,
422 &[("if-match", &etag)],
423 &event("a", "Two"),
424 )
425 .await;
426 assert_eq!(r.status, StatusCode::NO_CONTENT);
427 let new_etag = r.header("etag").unwrap();
428 assert_ne!(new_etag, etag);
429 let after = parse_multistatus(&req(&env, "PROPFIND", CAL, &auth, &[("depth", "1")], "").await);
430 assert_ne!(
431 prop_text(&before, CAL, DAV, "sync-token"),
432 prop_text(&after, CAL, DAV, "sync-token")
433 );
434 assert_eq!(prop_text(&after, &obj, DAV, "getetag"), Some(new_etag));
435
436 // The UID is already stored under another name.
437 let r = req(
438 &env,
439 "PUT",
440 &format!("{CAL}b.ics"),
441 &auth,
442 &[],
443 &event("a", "Dup"),
444 )
445 .await;
446 assert_eq!(r.status, StatusCode::FORBIDDEN);
447 assert!(error_condition(&r).is(CALDAV, "no-uid-conflict"));
448 assert!(r.text().contains(&obj), "{}", r.text());
449
450 let journal = event("j", "x").replace("VEVENT", "VJOURNAL");
451 let cases = [
452 ("not a calendar".to_string(), "valid-calendar-data"),
453 (
454 event("m", "x").replace("VERSION:2.0", "VERSION:2.0\r\nMETHOD:PUBLISH"),
455 "valid-calendar-object-resource",
456 ),
457 (journal, "supported-calendar-component"),
458 ];
459 for (body, cond) in cases {
460 let r = req(&env, "PUT", &format!("{CAL}x.ics"), &auth, &[], &body).await;
461 assert_eq!(r.status, StatusCode::FORBIDDEN, "{cond}");
462 assert!(error_condition(&r).is(CALDAV, cond), "{cond}: {}", r.text());
463 }
464
465 let r = req(
466 &env,
467 "PUT",
468 "/pim/calendars/alice/nope/x.ics",
469 &auth,
470 &[],
471 &event("x", "x"),
472 )
473 .await;
474 assert_eq!(r.status, StatusCode::CONFLICT);
475
476 let r = req(
477 &env,
478 "DELETE",
479 &obj,
480 &auth,
481 &[("if-match", "\"stale\"")],
482 "",
483 )
484 .await;
485 assert_eq!(r.status, StatusCode::PRECONDITION_FAILED);
486 let r = req(&env, "DELETE", &obj, &auth, &[], "").await;
487 assert_eq!(r.status, StatusCode::NO_CONTENT);
488 let r = req(&env, "DELETE", &obj, &auth, &[], "").await;
489 assert_eq!(r.status, StatusCode::NOT_FOUND);
490
491 let r = req(&env, "REPORT", CAL, &auth, &[], "").await;
492 assert_eq!(r.status, StatusCode::FORBIDDEN);
493}
494
495#[tokio::test]
496async fn address_objects() {
497 let (env, auth) = setup().await;
498 let card = "BEGIN:VCARD\r\nVERSION:3.0\r\nUID:c1\r\nFN:Bob\r\nN:;Bob;;;\r\nEND:VCARD\r\n";
499 let r = req(&env, "PUT", &format!("{BOOK}c1.vcf"), &auth, &[], card).await;
500 assert_eq!(r.status, StatusCode::CREATED, "{}", r.text());
501 let r = req(&env, "GET", &format!("{BOOK}c1.vcf"), &auth, &[], "").await;
502 assert_eq!(r.text(), card);
503 assert!(r.header("content-type").unwrap().starts_with("text/vcard"));
504
505 let r = req(&env, "PUT", &format!("{BOOK}c2.vcf"), &auth, &[], card).await;
506 assert!(error_condition(&r).is(CARDDAV, "no-uid-conflict"));
507 let r = req(
508 &env,
509 "PUT",
510 &format!("{BOOK}c3.vcf"),
511 &auth,
512 &[],
513 &event("e", "x"),
514 )
515 .await;
516 assert!(error_condition(&r).is(CARDDAV, "valid-address-data"));
517}
518
519#[tokio::test]
520async fn deleting_the_last_calendar_brings_a_new_default() {
521 let (env, auth) = setup().await;
522 let r = req(&env, "DELETE", CAL, &auth, &[], "").await;
523 assert_eq!(r.status, StatusCode::NO_CONTENT);
524 let r = req(&env, "PROPFIND", HOME, &auth, &[("depth", "1")], "").await;
525 let ms = parse_multistatus(&r);
526 assert!(ms.iter().any(|(h, _)| h == CAL));
527}
528
529#[tokio::test]
530async fn deleting_a_user_deletes_their_collections() {
531 let env = Env::new().await;
532 let admin = env.admin().await;
533 create_user(&admin, ALICE, PW, &[]).await;
534 let auth = basic(ALICE, PW);
535 let r = req(
536 &env,
537 "PUT",
538 &format!("{CAL}a.ics"),
539 &auth,
540 &[],
541 &event("a", "x"),
542 )
543 .await;
544 assert_eq!(r.status, StatusCode::CREATED);
545 let id = user_id(&admin, ALICE).await;
546 let r = admin.delete(&format!("/api/admin/users/{id}")).await;
547 assert_eq!(r.status, StatusCode::OK, "{}", r.text());
548 let db = &env.state.db;
549 assert!(
550 db.pim_collections(id, server::db::PimKind::Calendar)
551 .await
552 .unwrap()
553 .is_empty()
554 );
555}
556