{"id":27396863,"url":"https://github.com/kristapsdz/kcaldav","last_synced_at":"2025-04-14T00:48:30.790Z","repository":{"id":86151250,"uuid":"52641728","full_name":"kristapsdz/kcaldav","owner":"kristapsdz","description":"a simple, safe, and minimal CalDAV server","archived":false,"fork":false,"pushed_at":"2023-11-26T00:04:52.000Z","size":1063,"stargazers_count":71,"open_issues_count":3,"forks_count":11,"subscribers_count":6,"default_branch":"master","last_synced_at":"2023-11-26T01:24:51.088Z","etag":null,"topics":["bchs","caldav","caldav-server"],"latest_commit_sha":null,"homepage":"https://kristaps.bsd.lv/kcaldav","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kristapsdz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-02-27T00:28:55.000Z","updated_at":"2023-11-26T01:25:05.430Z","dependencies_parsed_at":"2023-11-11T19:30:14.843Z","dependency_job_id":"be1b0311-3679-4d97-be9e-7b47919d505b","html_url":"https://github.com/kristapsdz/kcaldav","commit_stats":null,"previous_names":[],"tags_count":28,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristapsdz%2Fkcaldav","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristapsdz%2Fkcaldav/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristapsdz%2Fkcaldav/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kristapsdz%2Fkcaldav/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kristapsdz","download_url":"https://codeload.github.com/kristapsdz/kcaldav/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248804768,"owners_count":21164131,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bchs","caldav","caldav-server"],"created_at":"2025-04-14T00:48:30.114Z","updated_at":"2025-04-14T00:48:30.785Z","avatar_url":"https://github.com/kristapsdz.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introduction\n\n**kcaldav** is a simple, safe, and minimal CalDAV server running on the\n[BCHS](https://learnbchs.org) software stack.\n\nTo keep up to date with the current stable release of **kcaldav**, visit\nhttps://kristaps.bsd.lv/kcaldav.  The website also contains canonical\ninstallation, deployment, examples, and usage documentation.\n\n# Installation\n\nYou'll need a C compiler ([gcc](https://gcc.gnu.org/) or\n[clang](https://clang.llvm.org/)), [zlib](https://zlib.net) (*zlib* or\n*zlib-dev* for some package managers),\n[libexpat](https://libexpat.github.io/) (*libexpat-dev*),\n[kcgi](https://kristaps.bsd.lv/kcgi), [sqlite3](https://sqlite3.org)\n(*libsqlite3-dev*), and BSD make (*bmake* for some managers) for\nbuilding.\n\nBegin by cloning or downloading.  Then configure with `./configure`,\ncompile with `make` (BSD make, so it may be `bmake` on your system),\nthen `make install` (or use `sudo` or `doas`, if applicable). \n\nIf not done yet, optionally create a *Makefile.local* to override values\nin [Makefile](Makefile) for your target file-system.\n\n```sh\n./configure\nmake install\nmake installcgi\n```\n\nThe database hasn't updated in a long, long time, so there are no\nspecial commands for updating it.  When updates do happen, I'll work out\na process for doing so.\n\nA common idiom for installing on Linux is to use\n[libbsd](https://libbsd.freedesktop.org/wiki/) as noted in the\n[oconfigure](https://github.com/kristapsdz/oconfigure) documentation:\n\n```\nCFLAGS=$(pkg-config --cflags libbsd-overlay) \\\n    ./configure LDFLAGS=$(pkg-config --libs libbsd-overlay)\nmake\nmake install\n```\n\n# Deployment\n\nTo create the database for initial use (or to manage it), follow \n[kcaldav.passwd(1)](man/kcaldav.passwd.in.1).\n\nIf errors occur during operation, see\n[kcaldav.conf.5](man/kcaldav.conf.5) for how to configure the system for\nmore debugging information.\n\n# Regression and fuzzing\n\nTo contribute to **kcaldav**, write regression tests!\n\nRight now, the regression suite only parses valid iCalendar files from\n[ical4j](https://github.com/ical4j/ical4j), but in no way makes sure\nthat the information has been properly parsed.  Same with the CalDAV\ntests.  To run these:\n\n```sh\nmake regress\n```\n\nA major missing component is a series of regression tests that actually\nmakes sure that parsed content is sane.\n\nMost of the critical infrastructure can also be run through \n[AFL](https://lcamtuf.coredump.cx/afl/).  To do this, run:\n\n```sh\nmake clean\nmake afl CC=afl-clang\n```\n\nOr use `afl-gcc` instead---it shouldn't matter.  This installs AFL-built\nbinaries into the *afl* directory.  To run these on the iCalendar\nlibrary:\n\n```sh\ncd ical\nsh ./dict.sh # Generates dictionary files.\nafl-fuzz -i in -x dict -o out -- ../test-ical @@\n```\n\nFor CalDAV:\n\n```sh\ncd caldav\nafl-fuzz -i in -o out -- ../test-caldav @@\n```\n\nI'd love for more tests on the server infrastructure itself, but am not\nsure how to effect this properly.\n\n# Sources\n\nThe source code is laid out fairly consistently and easily.\n\nThe centre of the system is in *libkcaldav.a*, which contains both the\nCalDAV and iCalendar functions in [libkcaldav.h](libkcaldav.h).  It's\nimplemented by [ical.c](ical.c) and [caldav.c](caldav.c).\n\nThe database interface is [db.h](db.h), manipulating the schema in\n[kcaldav.sql](kcaldav.sql).  This is used by server and by the\nbuilt programs and manages users, collections, resources, proxies, etc.\nIt internally uses the [libkcaldav.h](libkcaldav.h) functions.  It is\nimplemented in [db.c](db.c).\n\nThe built programs are the command-line utility\n[kcaldav.passwd(1)](man/kcaldav.passwd.in.1) and CGI server \n[kcaldav(8)](man/kcaldav.in.8).\n\nThe CGI server is described in [server.h](server.h) and implemented by\nthe majority of the source code files with entry point\n[kcaldav.c](kcaldav.c]).\n\nThe command-line utility is the standalone\n[kcaldav.passwd.c](kcaldav.passwd.c).\n\nThe portability glue throughout the system (e.g., `HAVE_xxx` macros,\n*config.h*, etc.) is managed by\n[oconfigure](https://github.com/kristapsdz/oconfigure).\n\n# License\n\nAll sources use the ISC (like OpenBSD) license.\nSee the [LICENSE.md](LICENSE.md) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkristapsdz%2Fkcaldav","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkristapsdz%2Fkcaldav","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkristapsdz%2Fkcaldav/lists"}