Commit Graph

4771 Commits

Author SHA1 Message Date
Pascal Bleser
e1bd8e285f groupware: add suppliers support for object changes 2026-07-01 14:57:32 +02:00
Pascal Bleser
943d5dc462 groupware: rename supplier implementations files 2026-07-01 14:57:32 +02:00
Pascal Bleser
d3d2f045f5 groupware: add support for multi-supplier getting a Contact by ID 2026-07-01 14:57:32 +02:00
Pascal Bleser
7ed065ddfe groupware: fix query objects in a container with multiple suppliers
* by adding a predicate that can analyze a filter and inform the
   template methods whether the filter is applicable for that supplier
   or not

 * this fixed /groupware/accounts/.../addressbooks/.../contacts
2026-07-01 14:57:32 +02:00
Pascal Bleser
02e53fe110 groupware: introduce temporary configuration property GROUPWARE_ENABLE_MOCK_DATA that controls whether the mock addressbook and mock contacts should be injected or not; default is false/disabled since it is not fully functional yet 2026-07-01 14:57:32 +02:00
Pascal Bleser
15cedb747a groupware: remove middleware.RealIP, as it has been deprecated and we currently do not have a use for it 2026-07-01 14:57:31 +02:00
Pascal Bleser
acb8a00929 groupware: update developer guide
* add instructions and container to create a key and certificate pair
   for the built-in IDM LDAP as we need it to listen on LDAPS for
   Stalwart, which has been disabled by default with
   https://github.com/opencloud-eu/opencloud/pull/2880

 * add environment variables to point to the certificates

 * update services/groupware/DEVELOPERS.md with up-to-date instructions,
   using Stalwart 0.16
2026-07-01 14:57:31 +02:00
Pascal Bleser
c545d362e9 groupware: minor fix for the mock addressbook supplier 2026-07-01 14:57:31 +02:00
Pascal Bleser
d1afd75370 groupware: fix unit tests 2026-07-01 14:57:31 +02:00
Pascal Bleser
5fd6f96ad6 groupware: add tracking of backend call durations
* add new configuration setting GROUPWARE_SEND_DURATIONS_RESPONSE
   (defaults to false)

 * keep track of lists of durations of backend calls

 * when enabled, report them as response headers Durations (human
   readable) and Durations-Nanos (as raw nanosecond values for machine
   consumption)
2026-07-01 14:57:31 +02:00
Pascal Bleser
55424b6317 groupware: add strongly typed aliases for AccountId, PrincipalId and SupplierId
Purpose is to make APIs and parameters easier to understand, since plain
strings are used all over the place for all sorts of identifiers.
2026-07-01 14:57:31 +02:00
Pascal Bleser
15d708fa37 groupware: refactoring for pagination and support for multiple query suppliers
* refactor APIs in JMAP and Groupware in order to implement pagination
   across multiple accountIds and multiple suppliers (currently
   implemented using a mock supplier for contacts)

 * requires go 1.26 due to use of self-reflecting generics type
   constraints

 * still missing: query criteria and sorting parameters

 * still missing: multi-accountId support for emails

 * errors are now all just 'error' in the APIs, instead of the
   specialized implementations, and are interpreted dynamically where
   necessary in order to transform them into HTTP responses

 * remove position, anchor, anchorOffset as individual query parameters
   as we now only support a 'next=...' token for subsequent pages
   (except in emails for now), and use jmap.QueryParams instead; those
   tokens have a header character for the format, followed by a JSON
   encoded QueryParams map, all wrapped into base62 to make it clearer
   that it is meant to be an opaque token, and not a parameter clients
   should tinker with or construct themselves

 * introduce QueryParamsSupplier as an interface to provide QueryParams
   for various scenarios (single supplier, multiple supplier, ...) per
   accountId

 * implement multi-supplier template methods slist and squery
2026-07-01 14:57:31 +02:00
Pascal Bleser
e3febe95f7 groupware: API documentation updates 2026-07-01 14:57:31 +02:00
Pascal Bleser
dfd8677b93 groupware: refactor responses to a jmap.Response object
* in the JMAP API as well as in several places in the Groupware
   framework, use a single jmap.Response[T] object to return the
   payload, the language, the session state and the etag/state instead
   of individual multi-valued return values
2026-07-01 14:57:31 +02:00
Pascal Bleser
65b050200f groupware: omit "position" when "anchor" is specified in queries
* the "position" attribute is always set to 0 when using an anchor for
   pagination, but it does not accurately reflect the position and thus
   we decided to remove the attribute from the resulting object for
   clarity

 * omit "canCalculateChanges" attribute when its value is "true", which
   is going to be the case in 100% of calls against Stalwart
2026-07-01 14:57:31 +02:00
Pascal Bleser
b0341139e1 groupware: add support for anchor and anchor offset pagination
* add query parameters 'anchor' and 'offset':
   - anchor is an object identifier
   - offset is a numeric offset relative to the anchor
2026-07-01 14:57:31 +02:00
Pascal Bleser
c8a02f5c9b groupware: fix use of ?limit=0
* JMAP query limit of 0 is synonymous with "no limit", but we actually
   want to be able to perform queries without any results, for cases
   where we only want to count the total number of objects, and also
   because it makes more sense semantically

 * introduce query parameter validation checks, in order to only allow
   query parameters that are actually supported, which is going to be
   useful during development of clients
2026-07-01 14:57:31 +02:00
Pascal Bleser
4c789391ed groupware: add documentation for SearchResultsTemplate + update pnpm 2026-07-01 14:57:31 +02:00
Pascal Bleser
9d428ca27e groupware: rename 'offset' to 'position' to be consistent with the JMAP specification 2026-07-01 14:57:31 +02:00
Pascal Bleser
2863d7f474 groupware: fix getall template result type: []T instead of RESP 2026-07-01 14:57:31 +02:00
Pascal Bleser
a50e1ab891 groupware: documentation changes after API generator updates for the use of template functions 2026-07-01 14:57:31 +02:00
Pascal Bleser
ec1049cd89 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-01 14:57:31 +02:00
Pascal Bleser
c5239d7410 groupware: add endpoints to patch addressbooks, contacts, calendars, events 2026-07-01 14:57:31 +02:00
Pascal Bleser
b40f878630 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-01 14:57:31 +02:00
Pascal Bleser
ff51e34254 groupware: refactor for conciseness
* introduce jmap.Context to hold multiple parameters and shorten
   function calls

 * introduce SearchResultsTemplate
2026-07-01 14:57:31 +02:00
Pascal Bleser
d1d88a5f9e 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-01 14:57:31 +02:00
Pascal Bleser
d0cba2efd1 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-01 14:57:31 +02:00
Pascal Bleser
9991e07d97 groupware: add GetIdentityChanges 2026-07-01 14:57:31 +02:00
Pascal Bleser
69ea093ac7 groupware: bump @redocly/cli 2.24.0 -> 2.25.2 2026-07-01 14:57:31 +02:00
Pascal Bleser
0e63a21752 groupware: add changes support for quotas, identities, submissions 2026-07-01 14:57:30 +02:00
Pascal Bleser
ef631ccdad groupware: framework refactorings + add support for /changes + add /objects 2026-07-01 14:57:30 +02:00
Pascal Bleser
928f60bd32 groupware: pollute code with NOSONAR comments, and make a little more use of JMAP API templates 2026-07-01 14:57:30 +02:00
Pascal Bleser
0d44b5d07e groupware: docs: add a quick copy-pastable block for running ldapsearch 2026-07-01 14:57:30 +02:00
Pascal Bleser
fc14a9a82d groupware: upgrade redocly to 2.24.0 2026-07-01 14:57:30 +02:00
Pascal Bleser
fa244b9316 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-01 14:57:30 +02:00
Pascal Bleser
7e4124ad94 groupware: upgrade redocly/cli 2.20.0 -> 2.24.0 2026-07-01 14:57:30 +02:00
Pascal Bleser
8298c63b8c groupware: clarify the ContactCard situation 2026-07-01 14:57:30 +02:00
Pascal Bleser
839296d73d groupware: add contact sorting query parameter and fix default sorting (must use updated instead of name) 2026-07-01 14:57:30 +02:00
Pascal Bleser
133345193a groupware: sort contacts in addressbook by name 2026-07-01 14:57:30 +02:00
Pascal Bleser
5f508bcde6 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-01 14:57:30 +02:00
Pascal Bleser
8b58e45dda groupware: upgrade redocly/cli 2.15.1 -> 2.20.2 2026-07-01 14:57:30 +02:00
Pascal Bleser
9e6ebf6442 groupware: minor logging improvements to the session cache 2026-07-01 14:57:30 +02:00
Pascal Bleser
a26e7f483c 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-01 14:57:30 +02:00
Pascal Bleser
732fed70c2 groupware: remove remnants of go-swagger documentation, since we are switching to using our own tool instead 2026-07-01 14:57:30 +02:00
Pascal Bleser
12f919b5f0 groupware: add jscontact examples, and move them to jmap/model_examples.go to avoid dependency recursion 2026-07-01 14:57:30 +02:00
Pascal Bleser
3e1904bbdf groupware: use the OIDC client ID 'web' instead of 'groupware' 2026-07-01 14:57:30 +02:00
Pascal Bleser
f097fe9a39 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-01 14:57:30 +02:00
Pascal Bleser
b37306623c groupware: update DEVELOPERS.md based on Jörn's feedback 2026-07-01 14:57:30 +02:00
Pascal Bleser
b3d0087158 auth-api: deal with errors properly in NewService 2026-07-01 14:57:30 +02:00
Pascal Bleser
db98532789 groupware: bump redocly/cli from 2.14.6 to 2.15.1 2026-07-01 14:57:30 +02:00