Commit Graph

4771 Commits

Author SHA1 Message Date
Pascal Bleser
04d2745945 groupware: documentation changes after API generator updates for the use of template functions 2026-07-09 14:30:13 +02:00
Pascal Bleser
2d01001093 groupware: refactoring using function templates
* adds creating addressbooks, calendars, mailboxes

 * adds deleting mailbox, event, identity

 * adds modifying an email

 * introduce template functions for the Groupware API in templates.go,
   and use those in route function implementations whenever possible

 * add capability checking for mail, quota, blobs

 * adds Changes interface

 * adds JmapResponse interface
2026-07-09 14:30:13 +02:00
Pascal Bleser
2d8b830b87 groupware: add endpoints to patch addressbooks, contacts, calendars, events 2026-07-09 14:30:13 +02:00
Pascal Bleser
116d1bce4a groupware: refactoring: pass object type instead of namespaces
* make the JMAP internal API a bit more future-proof by passing
   ObjectType objects instead of the JMAP namespaces

 * remove the new attempt to contain operations even further using the
   Factory objects

 * move CalendarEvent operations to its own file, like everything else

 * fix email tests

 * ignore WS error when closing an already closed connection
2026-07-09 14:30:13 +02:00
Pascal Bleser
b73c317708 groupware: refactor for conciseness
* introduce jmap.Context to hold multiple parameters and shorten
   function calls

 * introduce SearchResultsTemplate
2026-07-09 14:30:13 +02:00
Pascal Bleser
1cafc9e918 groupware: model refactoring, introducing typed interfaces and Foo
* move ContactCard from jscontact to jmap, as it is actually a JMAP
   specification item, but also was causing too many issues with
   circular references from jscontact -> jmap

 * introduce Foo, Idable, GetRequest, GetResponse, etc... types and
   generics

 * first attempt at a Foo factory type for Mailboxes, needs to be
   expanded to further minimize repetition

 * add more specialized template functions to avoid repetition

 * introduce ChangesTemplate[T] for *Changes structs
2026-07-09 14:30:12 +02:00
Pascal Bleser
1e05d91893 groupware: add addressbook and calendar creation APIs
* add Groupware APIs for creating and deleting addressbooks

 * add Groupware APIs for creating and deleting calendars

 * add JMAP APIs for creating and deleting addressbooks, calendars

 * add JMAP APIs to retrieve Principals

 * fix API tagging

 * move addressbook JMAP APIs into its own file

 * move addressbook Groupware APIs into its own file
2026-07-09 14:15:53 +02:00
Pascal Bleser
7a7140d9a8 groupware: add GetIdentityChanges 2026-07-09 14:15:53 +02:00
Pascal Bleser
dc596f7e55 groupware: bump @redocly/cli 2.24.0 -> 2.25.2 2026-07-09 14:15:53 +02:00
Pascal Bleser
e8ada10fdb groupware: add changes support for quotas, identities, submissions 2026-07-09 14:15:53 +02:00
Pascal Bleser
c921133c28 groupware: framework refactorings + add support for /changes + add /objects 2026-07-09 14:15:52 +02:00
Pascal Bleser
3eae25b26a groupware: pollute code with NOSONAR comments, and make a little more use of JMAP API templates 2026-07-09 14:15:52 +02:00
Pascal Bleser
a78c70f785 groupware: docs: add a quick copy-pastable block for running ldapsearch 2026-07-09 14:15:52 +02:00
Pascal Bleser
a5ade45d92 groupware: upgrade redocly to 2.24.0 2026-07-09 14:15:52 +02:00
Pascal Bleser
c84ca32508 groupware: refactor contactcard changes, and Request framework
* implement ContactCard retrieval endpoint for syncing

 * re-implement that endpoint for Email too

 * fix the Mailbox changes endpoint to actually return changes about
   Mailboxes, and not about Emails

 * when querying the diff of Mailboxes without any prior state, return
   an error since the result is not what one would expect

 * introduce the 'changes' API tag and group

 * refactor the successful response functions to consistently return an
   object type and object state whenever possible

 * move the syncing endpoints under /accounts/*/changes/ for better
   clarity, e.g. /changes/emails instead of /emails/mailbox/*/changes
2026-07-09 14:15:52 +02:00
Pascal Bleser
f39d859525 groupware: upgrade redocly/cli 2.20.0 -> 2.24.0 2026-07-09 14:15:52 +02:00
Pascal Bleser
88e81191b2 groupware: clarify the ContactCard situation 2026-07-09 14:15:52 +02:00
Pascal Bleser
87724e21ab groupware: add contact sorting query parameter and fix default sorting (must use updated instead of name) 2026-07-09 14:15:52 +02:00
Pascal Bleser
bab55316b0 groupware: sort contacts in addressbook by name 2026-07-09 14:15:52 +02:00
Pascal Bleser
cdcd959a89 groupware: fix typos and minor issues
- fix a bunch of minor issues and typos that were found using GoLand
   and gosec

 - add a gosec Makefile target for Groupware related files, in
   services/groupware/Makefile

 - enable checking JMAP session capabilities for events and contacts,
   and only enable skipping that check for tasks until those are
   implemented in Stalwart as well

 - fix a CWE-190 (integer overflow or wraparound) found by gosec

 - consistently use struct references for methods of Groupware and
   Request, instead of mixing up references and copies

 - always log errors when unable to register a Prometheus metric
2026-07-09 14:15:52 +02:00
Pascal Bleser
24d78dd3f6 groupware: upgrade redocly/cli 2.15.1 -> 2.20.2 2026-07-09 14:15:52 +02:00
Pascal Bleser
ff455670cb groupware: minor logging improvements to the session cache 2026-07-09 14:15:52 +02:00
Pascal Bleser
5b2e8d13eb groupware: add OIDC authentication support between Groupware backend and Stalwart
* re-implement the auth-api service to authenticate Reva tokens
   following the OIDC Userinfo endpoint specification

 * pass the context where necessary and add an authenticator interface
   to the JMAP HTTP driver, in order to select between master
   authentication (which is used when GROUPWARE_JMAP_MASTER_USERNAME and
   GROUPWARE_JMAP_MASTER_PASSWORD are both set) and OIDC token
   forwarding through bearer auth

 * add Stalwart directory configuration "idmoidc" which uses the
   OpenCloud auth-api service API (/auth/) to validate the token it
   received as bearer auth from the Groupware backend's JMAP client,
   using it as an OIDC Userinfo endpoint

 * implement optional additional shared secret to secure the Userinfo
   service, as an additional path parameter
2026-07-09 14:15:52 +02:00
Pascal Bleser
4fd6912967 groupware: remove remnants of go-swagger documentation, since we are switching to using our own tool instead 2026-07-09 14:15:52 +02:00
Pascal Bleser
1806a61bb2 groupware: add jscontact examples, and move them to jmap/model_examples.go to avoid dependency recursion 2026-07-09 14:15:52 +02:00
Pascal Bleser
bf5882fbad groupware: use the OIDC client ID 'web' instead of 'groupware' 2026-07-09 14:15:52 +02:00
Pascal Bleser
0fd87e7d9b groupware: as suggested in the review PR 1994, remove all filename prefixes that match the package (groupware_xyz.go -> xyz.go), for groupware, jmap, jscontact, jscalendar 2026-07-09 14:15:52 +02:00
Pascal Bleser
716da112ba groupware: update DEVELOPERS.md based on Jörn's feedback 2026-07-09 14:15:52 +02:00
Pascal Bleser
bfbded45e2 auth-api: deal with errors properly in NewService 2026-07-09 14:15:52 +02:00
Pascal Bleser
1d8303ca6d groupware: bump redocly/cli from 2.14.6 to 2.15.1 2026-07-09 14:15:52 +02:00
Pascal Bleser
a31dd1d4c9 groupware: also update DEVELOPER.md with new OpenAPI documentation generation tooling 2026-07-09 14:15:52 +02:00
Pascal Bleser
f5eafeee10 groupware: update README to new API documentation generation process, and remove defunct files 2026-07-09 14:15:52 +02:00
Pascal Bleser
6df2143b23 groupware: more API examples 2026-07-09 14:15:52 +02:00
Pascal Bleser
1eaed23b25 groupware: change Makefile to use groupware-apidocs instead of go-swagger 2026-07-09 14:15:52 +02:00
Pascal Bleser
c72b9d82a5 update redocly 2.14.5 -> 2.14.6 2026-07-09 14:15:52 +02:00
Pascal Bleser
3423df533f groupware: migrate to cobra instead of urfave 2026-07-09 14:15:52 +02:00
Pascal Bleser
b0a1a60904 groupware: update pnpm 10.28.0 -> 10.28.1 2026-07-09 14:15:52 +02:00
Pascal Bleser
f16df72672 API documentation changes for groupware-apidocs
* add example generator infrastructure, with some examples for pkg/jmap
   and pkg/groupware, with more needing to be done

 * alter the apidoc Makefile to stop using go-swagger but, instead, use
   the openapi.yml file that must be dropped into that directory using
   groupware-apidocs (will improve the integration there later)

 * add Makefile target to generate examples

 * bump redocly from 2.4.0 to 2.14.5

 * introduce Request.PathParam() and .PathParamDoc() to improve API
   documentation, as well as future-proofing

 * improve X-Request-ID and Trace-Id header handling in the middleware
   by logging it safely when an error occurs in the middleware
2026-07-09 14:15:52 +02:00
Pascal Bleser
8b3bbbe558 groupware: shift some attributes of the Groupware object around, in defaults and config sub-structures 2026-07-09 14:15:52 +02:00
Pascal Bleser
0529845b46 groupware: add description and version annotations for env configuration properties 2026-07-09 14:15:52 +02:00
Pascal Bleser
f0ff78ac49 groupware: add retrieving and adding mailboxIds for drafts and sent if they are missing 2026-07-09 14:15:52 +02:00
Pascal Bleser
299d123cd2 groupware: refactor response objects to take a list of accountIds 2026-07-09 14:15:52 +02:00
Pascal Bleser
0b9c6803aa groupware: fix missing casting to jmap.State after changes in pkg/jmap 2026-07-09 14:15:52 +02:00
Pascal Bleser
07d8b6b6b7 groupware, auth-api: remove tracing and tracing configuration 2026-07-09 14:15:52 +02:00
Pascal Bleser
b300576907 groupware: JMAP WS push notifications support 2026-07-09 14:15:51 +02:00
Pascal Bleser
d7b22d6439 groupware: fix email summaries and allow negative offsets
* fix a bug in how email summaries are flattened across multiple
   accounts, which was previous resulting in empty email objects

 * allow negative offset in email pagination

 * make all /emails endpoints return emails without bodies
2026-07-09 14:15:51 +02:00
Pascal Bleser
59efce827e groupware: response payload /groupware/accounts/{id}/emails should be without email bodies 2026-07-09 14:15:51 +02:00
Pascal Bleser
cdb2ae6102 groupware: add Object-Type and Account-Id response headers
* implement Request.AllAccountIds() to generalize the fetching (and
   uniqifying) of all account IDs, which will allow us to implement
   things such as "subscribed" accounts, or limiting the number of
   accounts in one request

 * add Account-Id response header

 * add Object-Type response header
2026-07-09 14:15:51 +02:00
Pascal Bleser
52b4a5a739 groupware: feature test improvements and upgrade to Stalwart 0.14.1
* upgrade Stalwart image for devtools/full to 0.14.1

 * re-assert which features are implemented or not in 0.14.1

 * refactor the integration tests yet again to make it clearer and
   easier to see those "features-or-not"

 * get rid of old tests that are now better covered by integration tests

 * rewrite how we compare expected and actual objects in integration
   tests, finally having found a way to ignore the @type attribute
   properly instead of having to mutate all objects to remove it
2026-07-09 14:15:51 +02:00
Pascal Bleser
e994a9315f groupware: finalize JMAP events integration test, with multiple changes to the model to conform with draft-ietf-calext-jscalendarbis-10 and fields that are currently not implemented in Stalwart 2026-07-09 14:15:51 +02:00