Commit Graph

22476 Commits

Author SHA1 Message Date
Pascal Bleser
996bc858c7 docs(groupware): fix basepath in OpenAPI, /groupware instead of /groupware/groupware 2025-12-09 09:15:38 +01:00
Viktor Scharf
b369f8b415 fixed connection reset issue. adapted make file to generate swagger docs on mac 2025-12-09 09:15:38 +01:00
Pascal Bleser
7587c54e4e groupware: improve jmap integration tests
* use gofakeit instead of loremipsum, as it can also fake images for
   attachments

 * random emails for testing: generate threads, add attachments
2025-12-09 09:15:38 +01:00
Pascal Bleser
e6abc2d8ff groupware: rewrite JMAP integration test to be more reusable, and upgrade Stalwart container to 0.13.4 2025-12-09 09:15:38 +01:00
Pascal Bleser
0052d6fc4f groupware: upgrade Stalwart in devtools from 0.13.2 to 0.13.4
* changes from 0.13.4:
   - JMAP: Protocol layer rewrite for zero-copy deserialization and
     architectural improvements.
   - IMAP: Unbounded memory allocation in request parser
     (CVE-2025-61600)
   - IMAP: Wrong permission checked for GETACL.
   - JMAP: References to previous method fail when there are no results
     (stalwartlabs#1507).
   - JMAP: Enforce quota checks on Blob/copy.
   - JMAP: Mailbox/get fails without accountId argument (stalwartlabs#1936).
   - JMAP: Do not return invalidProperties when email update doesn't
     contain changes (stalwartlabs#1139)
   - iTIP: Include date properties in REPLY (stalwartlabs#2102).
   - OIDC: Do not set username field if it is the same as the email field.
   - Telemetry: Fix calculateMetrics housekeeper task (stalwartlabs#2155).
   - Directory: Always use rsplit to extract the domain part from email
     addresses.

  * changes from 0.13.3:
   - CLI: Health checks
   - WebDAV: Assisted discovery v2
   - iTIP: Do not send a REPLY when deleting an event that was not
     accepted.
   - iTIP: Include event details in REPLY messages (stalwart#2102).
   - iTIP: Add organizer to iMIP replies if missing to deal with MS
     Exchange 2010 bug.
   - OIDC: Do not overwrite locally defined aliases (stalwart#2065).
   - HTTP: Scan ban should only be triggered by HTTP parse errors.
   - HTTP: Skip scanner fail2ban checks when the proxy client IP can't
     be parsed (stalwart#2121).
   - JMAP: Do not allow roles to be removed from system mailboxes
     (stalwart#1977).
   - JMAP WS: Fix panic when using invalid server url.
   - SMTP: Do no send EHLO twice when STARTTLS is unavailable
     (stalwart#2050).
   - IMAP: Allow ENABLE UTF8 in IMAPrev1.
   - IMAP: Include administer permission in ACL responses.
   - IMAP: Add owner rights to ACL get responses.
   - IMAP: Do not auto-train Bayes when moving messages from Junk to
     Trash.
   - IMAP/ManageSieve: Increase maximum quoted argument size
     (stalwart#2039).
   - CalDAV: Limit recurrence expansions in calendar reports
     (CVE-2025-59045).
   - WebDAV: Do not fix percent encoding on WebDAV FS (stalwart#2036).
2025-12-09 09:15:38 +01:00
Pascal Bleser
2343e7fa83 groupware: add bootstrapping on / with quotas for all accounts 2025-12-09 09:15:38 +01:00
Pascal Bleser
d95b9a8e8f groupware: add /quota for all accounts 2025-12-09 09:15:38 +01:00
Pascal Bleser
a5701ceb83 groupware: improve instructions in DEVELOPER.md 2025-12-09 09:15:38 +01:00
Pascal Bleser
d79f0b3829 groupware: update @redocly/cli: 2.2.2 -> 2.3.0 2025-12-09 09:15:38 +01:00
Pascal Bleser
abb57193ff groupware: add quota API + add support for Accept-Language and Content-Language 2025-12-09 09:15:37 +01:00
Pascal Bleser
01b4a1f751 groupware: minor improvements to the DEVELOPER.md 2025-12-09 09:15:37 +01:00
Pascal Bleser
17b281cadf groupware: add flag to currently ignore session capability checks for calendars, contacts and tasks, as those are not implemented in Stalwart yet; will need to remove it in the future 2025-12-09 09:15:37 +01:00
Pascal Bleser
f4f24664ad groupware: add JMAP capability checking (in part: for contacts, calendars, tasks) 2025-12-09 09:15:37 +01:00
Pascal Bleser
101f38dd0b /auth: add SkipXAccessToken:true 2025-12-09 09:15:37 +01:00
Pascal Bleser
ebd51dba3b groupware: add mock endpoints for tasklists and tasks 2025-12-09 09:15:37 +01:00
Pascal Bleser
ed488b5a01 groupware: implement JMAP Task specification 2025-12-09 09:15:37 +01:00
Pascal Bleser
2c6ff6cd9e groupware: more mock data, added missing JMAP types 2025-12-09 09:15:37 +01:00
Pascal Bleser
eeccb56d19 groupware: add mock endpoints for addressbooks and contacts 2025-12-09 09:15:37 +01:00
Pascal Bleser
04b038a129 opencloud_full: also keep the 'Trace-Id' HTTP header 2025-12-09 09:15:37 +01:00
Pascal Bleser
09f69c5a62 implement JSCalendar (RFC 8984) 2025-12-09 09:15:37 +01:00
Pascal Bleser
85fed11797 services/groupware/DEVELOPER.md: adapt to new path for the opencloud_full deployment 2025-12-09 09:15:37 +01:00
Pascal Bleser
0e3e9607c3 JSContact: refactored after full test coverage, stronger typing for enumerations 2025-12-09 09:15:37 +01:00
Pascal Bleser
e2c9350ea1 Implement JSContact (RFC9553) Model
* add pkg/jscontact with the implementation of the RFC9553 data model

 * add JMAP Calendar session capabilities support in pkg/jmap
2025-12-09 09:15:37 +01:00
Pascal Bleser
5cc98f0792 Docker Compose Groupware improvements
* made a few changes in order to further simplify the setup for
   developers of the Groupware backend

 * add STALWART_DOMAIN to deployments/examples/opencloud_full/.env

 * adapt the Stalwart configuration file to not set server.hostname and,
   instead, pick it up from /etc/hostname, which is set by Docker
   Compose as we can use default values for STALWART_DOMAIN there, in an
   analogous fashion to the other containers in that project

 * add config/keycloak/clients/groupware.json to avoid requiring manual
   configuration of Keycloak via the admin web UI

 * Stalwart container:
   - listen for SMTPS on :1465
   - remove the stalwart-logs volume, not needed (logs are going to
     stdout)

 * updated services/groupware/DEVELOPER.md:
   - refer to a variable OCDIR to make instructions more copy-pasteable
   - remove manual Keycloak configuration section as it is now obsolete,
     replaced by provisioning a configuration file instead
2025-12-09 09:15:37 +01:00
Pascal Bleser
4fee45379b start websocket implementation, add endpoint for email summaries
* feat(groupware): start implementing JMAP websocket support for push
   notifications (unfinished)

 * groupware: add GetLatestEmailsSummaryForAllAccounts

 * add new vendored dependency: github.com/gorilla/websocket

 * jmap: add QueryEmailSummaries

 * openapi: start adding examples

 * openapi: add new tooling for api-examples.yaml injection

 * apidoc-process.ts: make it more typescript-y

 * bump @redocly/cli from 2.0.8 to latest 2.2.0
2025-12-09 09:15:37 +01:00
Pascal Bleser
2ea8afeb74 feat(groupware): add WebsocketEndpoint to the JMAP Session 2025-12-09 09:15:37 +01:00
Pascal Bleser
c4a16e3e9a refactor(groupware): just use a function for the attachment picker
Minor: be more Go idiomatic: just use a function to pick the attachment
from an Email's attachment list instead of using an interface with
multiple iplementation structs.
2025-12-09 09:15:37 +01:00
Pascal Bleser
a65a59b2d0 groupware: improved attachment APIs
* feat(groupware): add /accounts/{}/emails/{}/attachments

 * feat(groupware): add
   /accounts/{}/emails/{}/attachments?partId=&name=&blobId=
2025-12-09 09:15:37 +01:00
Pascal Bleser
21ea094d99 jmap: modify GetBlob -> GetBlobMetadata
* fix(jmap): fix bug where CommandBlobUpload was used instead of
   CommandBlobGet in GetBlob (now GetBlobMetadata)

 * we currently don't need a variant of BlobGetCommand that also
   retrieves the content of the blob, instead we only use it for
   retrieving metadata about it
2025-12-09 09:15:37 +01:00
Pascal Bleser
431a5ab3de fix(groupware): update DEVELOPER.md imap-filler usage since it was updated to use flags instead of environment variables 2025-12-09 09:15:37 +01:00
Pascal Bleser
1d94e3811e docs(groupware): more developer instructions 2025-12-09 09:15:37 +01:00
Pascal Bleser
3cb78ed31b more updates to the Groupware DEVELOPER.md 2025-12-09 09:15:37 +01:00
Pascal Bleser
d54e27dcdf docs(groupware): add configuration instructions to DEVELOPER.md 2025-12-09 09:15:37 +01:00
Pascal Bleser
c31d7c57bb fix(groupware): fix JMAP error handling
* the JMAP error handling was not working properly, fixed it and added
   error definitions accordingly

 * add operations to retrieve mailbox roles and mailboxes by role for
   all accounts
2025-12-09 09:15:37 +01:00
Pascal Bleser
3026ddb255 refactor(groupware): rename "Messages" to "Email" everywhere
There was really no reason to go with "Messages" as far as the
vocabulary of the Groupware API goes, since the objects those APIs serve
are "Emails", to stick with the wording of the JMAP specification.
2025-12-09 09:15:37 +01:00
Pascal Bleser
c4fb13b263 refactor(groupware): use a function for multi-account method call IDs
* introduce a function 'mcid' to assemble method call IDs per account
   instead of doing that inline in each function, in case the rules for
   doing so change in the future
2025-12-09 09:15:37 +01:00
Pascal Bleser
df21fdf2e2 docs(groupware): add services/groupware/DEVELOPER.md 2025-12-09 09:15:37 +01:00
Pascal Bleser
6224ded8b5 refactor(groupware): add max requests check
* move jmap.request() to jmap.Client.request() and pass the Session
   and a Logger to introduce checking the number of methodCalls within a
   request not exceeding the limit of the Session, as well as error
   handling and logging there instead of in each caller

 * a few bugfixes:
   - add a few missing Send() calls in logs
   - correct the response tag matching for
     GetMailboxChangesForMultipleAccounts
   - fix typo in Identity.ReplyTo json serialization rune
   - fix response tag in pkg/jmap/testdata/mailboxes1.json after
     changing them to be prefixed by the accountId
2025-12-09 09:15:37 +01:00
Pascal Bleser
0da72cf346 groupware: minor typo fixes 2025-12-09 09:15:37 +01:00
Pascal Bleser
aab08dd3de chore(groupware): add launcher for OC + containers for services
* add a launcher for running OpenCloud from within VSCode, but using
   third-party services that are running within the docker compose
   'full' example setup
2025-12-09 09:15:37 +01:00
Pascal Bleser
f470462ead feat(groupware): add fetching all mailboxes for all accounts
* add URL to retrieve all the mailboxes for all the accounts of a user,
   as a first use-case for an all-accounts operation, as
   /accounts/all/mailboxes

 * add URL to retrieve mailbox changes for all the mailboxes of all the
   accounts of a user, as a first use-case for an all-accounts
   operation, as /accounts/all/mailboxes/changes

 * change the defaultAccountId from '*' to '_', as '*' rather indicates
   "all" than "default", and we might want to use that for "all
   accounts" operations in the future

 * refactor(groupware): remove the accountId parameter from the logger()
   function, as it is not used anyways, but also confusing for
   operations that support multiple account ids
2025-12-09 09:15:37 +01:00
Pascal Bleser
62cace14fe docs(groupware): OpenAPI improvements
* refactor some pkg/jmap and groupware methods to make more sense from
   an API point-of-view

 * add path parameter documentation, but automate it by injecting their
   definition into the OpenAPI YAML tree that is extracted from the
   source code using go-swagger as it is too cumbersome, repetitive and
   error-prine to document them in the source code; wrote a TypeScript
   file apidoc-process.ts to do so

 * add generating an offline HTML file for the OpenAPI documentation
   using redocly, and injecting a favicon into the resulting HTML; wrote
   a TypeScript file apidoc-postprocess-html.ts to do so
2025-12-09 09:15:37 +01:00
Pascal Bleser
a8c2beac3a test(groupware): add testcontainers based jmap test
* adds pkg/jmap/jmap_integration_test.go

 * uses ghcr.io/stalwartlabs/stalwart:v0.13.2-alpine

 * can be disabled by setting one of the following environment
   variables, in the same fashion as ca0493b28
   - CI=woodpecker
   - CI_SYSTEM_NAME=woodpecker
   - USE_TESTCONTAINERS=false

 * dependencies:
   - bump github.com/go-test/deep from 1.1.0 to 1.1.1
   - add github.com/cention-sany/utf7
   - add github.com/dustinkirkland/golang-petname
   - add github.com/emersion/go-imap/v2
   - add github.com/emersion/go-message
   - add github.com/emersion/go-sasl
   - add github.com/go-crypt/crypt
   - add github.com/go-crypt/x
   - add github.com/gogs/chardet
   - add github.com/inbucket/html2text
   - add github.com/jhilleryerd/enmime/v2
   - add github.com/ssor/bom
   - add gopkg.in/loremipsum.v1
2025-12-09 09:15:37 +01:00
Pascal Bleser
1b732b8bff refactor(groupware): session cache and DNS autodiscovery
* move the logging of the username and session state away from pkg/jmap
   and into services/groupware

 * introduce more decoupling for the session cache, as well as moving
   the implementation into groupware_session.go
2025-12-09 09:15:37 +01:00
Pascal Bleser
33cc3365ee groupware: add DNS auto-discovery (currently disabled, needs testing) 2025-12-09 09:15:37 +01:00
Pascal Bleser
3e48284295 add a .gitignore entry for debug binaries built by VSCode when running OpenCloud 2025-12-09 09:15:37 +01:00
Pascal Bleser
c9a4bb94cd groupware: session handling improvements
* remove the baseurl from the JMAP client configuration, and pass it to
   the session retrieval functions instead, as that is really the only
   place where it is relevant, and we gain flexibility to discover that
   session URL differently in the future without having to touch the
   JMAP client

 * move the default account identifier handling from the JMAP package to
   the Groupware one, as it really has nothing to do with JMAP itself,
   and is an opinionated feature of the Groupware REST API instead

 * add an event listener interface for JMAP events to be more flexible
   and universal, typically for metrics that are defined on the API
   level that uses the JMAP client

 * add errors for when default accounts cannot be determined

 * split groupware_framework.go into groupware_framework.go,
   groupware_request.go and groupware_response.go

 * move the accountId logging into the Groupware level instead of JMAP
   since it can also be relevant to other operations that might be
   worthy of logging before the JMAP client is even invoked
2025-12-09 09:15:37 +01:00
Pascal Bleser
3ac4bcfeeb groupware: fix debug server, was missing a lot of configuration options and was binding to :80 2025-12-09 09:15:37 +01:00
Pascal Bleser
58583a66bb docs(groupware): add Groupware related ADRs 2025-12-09 09:15:37 +01:00
Pascal Bleser
1d6433f1c9 refactor(groupware): logging and metrics improvements
* some minor code refactorings to improve logging and metrics

 * more code documentation
2025-12-09 09:15:37 +01:00