feat: exchange cloud ID #4417

redblom · 2025-04-08T09:08:25Z

~~This is a work in progress~~
This PR implements #4416

redblom · 2025-04-08T16:12:23Z

General layout plan:

dedicated button to send an invite to a remote user - below 'New contact' button
dedicated button on cloud ID component for existing remote contacts that have no cloud ID set
new sent invites will be displayed in the left panel - with a revoke option

Status:

invite accept dialog route implemented

github-actions · 2025-04-23T02:47:00Z

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

(If you believe you should not receive this message, you can add yourself to the blocklist.)

codecov · 2025-04-24T07:46:03Z

Codecov Report

❌ Patch coverage is 1.10865% with 446 lines in your changes missing coverage. Please review.
✅ Project coverage is 1.84%. Comparing base (c98a2da) to head (5b7820f).

Files with missing lines	Patch %	Lines
src/views/Contacts.vue	0.00%	90 Missing ⚠️
src/components/Properties/PropertyCloudId.vue	0.00%	72 Missing ⚠️
src/components/Ocm/OcmInvitesList.vue	0.00%	53 Missing ⚠️
src/components/Ocm/Wayf.vue	0.00%	44 Missing ⚠️
src/store/ocminvites.js	10.41%	42 Missing and 1 partial ⚠️
src/components/Ocm/OcmInviteDetails.vue	0.00%	41 Missing ⚠️
src/components/AppContent/OcmInvitesContent.vue	0.00%	33 Missing ⚠️
src/components/Ocm/OcmInviteForm.vue	0.00%	18 Missing ⚠️
src/components/AppNavigation/RootNavigation.vue	0.00%	14 Missing ⚠️
src/components/Ocm/OcmInvitesListItem.vue	0.00%	13 Missing ⚠️
... and 5 more

❗ There is a different number of reports uploaded between BASE (c98a2da) and HEAD (5b7820f). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (c98a2da) HEAD (5b7820f)

2 1

Additional details and impacted files

@@             Coverage Diff             @@
##               main   #4417      +/-   ##
===========================================
- Coverage     10.76%   1.84%   -8.93%     
===========================================
  Files           128     113      -15     
  Lines          6512    6082     -430     
  Branches       1191    1270      +79     
===========================================
- Hits            701     112     -589     
- Misses         5690    5847     +157     
- Partials        121     123       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

ChristophWurst · 2025-04-25T13:28:47Z

Thanks for the contribution, @redblom!

The features relies on an implementation of the Invitation Workflow (see https://github.com/sara-nl/nc-collaboration).

Is there any way this could work without introducing an app dependency?

redblom · 2025-04-29T10:04:32Z

Thanks for the contribution, @redblom!

The features relies on an implementation of the Invitation Workflow (see https://github.com/sara-nl/nc-collaboration).

Is there any way this could work without introducing an app dependency?

Short answer: No, that is to say, the actual cloud ID exchange is not a responsibility of the contacts app but the contacts app (the cloud ID field) is a logical place where to have this option (as per earlier discussion with the Design Team).
The feature actually depends on the implementation of OCM /invite-accepted. This is currently in the process of being implemented for nextcloud server core (nextcloud/server#51113) so cloud ID exchange can become an integral part of nextcloud. Up until then there should be an app present implementing this.
The idea is to make the option not visible to the user when the platform can not do the actual cloud ID exchange (by configuration).
(so the best answer is: yes, when cloud ID exchange has become an integral part of nextcloud :)

ChristophWurst · 2025-04-30T14:55:42Z

Thanks for the clarification

redblom · 2025-09-19T15:07:45Z

Do we want to 'cc' the invitation email to the sender as well (by default or configurable) ? Eg. in case the receiver loses the invitation mail it would allow the sender to simply resend the invitation from the email client instead of having to create a new one (and revoke the old one) from the contacts app. * Another (possible future) option would be a resend button on the invitation details page.

I think a "resend button" makes sense, maybe along with a check box that is unchecked by default to send the invitation to the sender as well.

We do not persist the optional personal message with the invite. So that's lost for a resend. But in order to correlate to the previously sent invite, what we can do is to use a new message like:
"This is a copy of an invite send to you previously by $initiatorDisplayName on $sendDate"

Fwiw I prefer this to persisting the message.

mickenordin · 2025-09-25T14:15:43Z

Adding some screenshots here to show you what it looks like, this is the dialog for adding a new invitation:

This is what it looks like after it is sent:

This is the default Where-Are-You-From page, when no federation has been configured

This is what the WAYF-page looks like with a federation configured:

It is also possible to add multiple federations:

This is what the type-to-search feature looks like:

mickenordin · 2025-09-25T14:27:10Z

Thanks for the contribution, @redblom!

The features relies on an implementation of the Invitation Workflow (see https://github.com/sara-nl/nc-collaboration).

Is there any way this could work without introducing an app dependency?

All the necessary plumbing is in Nextcloud 32.0.0.0rc4 so no external apps needed anymore.

redblom · 2025-10-29T15:39:01Z

@ArtificialOwl could you give it a go, the review.

ArtificialOwl

quick review, not fully complete, but already some elements to rework

ArtificialOwl · 2025-11-17T16:32:44Z

lib/WayfProvider.php

+	 * @return string the WAYF login page endpoint
+	 */
+	public function getWayfEndpoint(): string {
+		$wayfEndpoint = 'https://' . $this->federatedInvitesService->getProviderFQDN() . '/apps/' . Application::APP_ID . self::WAYF_ROUTE;


there is a possibility that contacts is installed in /custom_apps/, not sure this endpoint would 100% work

ArtificialOwl · 2025-11-17T19:09:27Z

lib/WayfProvider.php

+
+	public function getMeshProvidersFromCache(): array {
+		$json = $this->appConfig->getValueString(Application::APP_ID, 'federations_cache');
+		$data = json_decode($json, true);


you can use getValueArray() / setValueArray() and set the config value as lazy

ArtificialOwl · 2025-11-17T21:05:12Z

lib/IWayfProvider.php

+ * Interface IWayfProvider.
+ *
+ */
+interface IWayfProvider {


it does not feel like an interface is really needed

ArtificialOwl · 2025-11-17T21:06:08Z

lib/Command/DisableOcmInvites.php

+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$isAlreadyDisabled = $this->appConfig->getValueBool('contacts', 'ocm_invites_enabled') === false;


getValueBool is already a boolean, no need for comparaison

ArtificialOwl · 2025-11-17T21:08:28Z

lib/Command/DisableOcmInvites.php

+		}
+
+		$this->appConfig->setValueBool('contacts', 'ocm_invites_enabled', false);
+		$this->appConfig->deleteKey('core', 'ocm_invite_accept_dialog');


might be better to use OC\Core\AppInfo\ConfigLexicon::OCM_INVITE_ACCEPT_DIALOG despite being from private OC\

ArtificialOwl · 2025-11-17T21:14:52Z

lib/Service/FederatedInvitesService.php

+
+	public function isOcmInvitesEnabled():bool {
+		$val = $this->appConfig->getValueBool(Application::APP_ID, 'ocm_invites_enabled', FederatedInvitesService::OCM_INVITES_ENABLED_BY_DEFAULT);
+		$boolval = (is_string($val) ? filter_var($val, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE) : (bool)$val);


getValueBool() will always returns boolean

ArtificialOwl · 2025-11-17T21:16:15Z

lib/Controller/FederatedInvitesController.php

+	 * @return JSONResponse
+	 */
+	#[NoAdminRequired]
+	#[NoCSRFRequired]


why no CSRF ? is the endpoint to be requested from a remote instance ?

ArtificialOwl · 2025-11-17T21:17:21Z

lib/Controller/FederatedInvitesController.php

+	#[NoAdminRequired]
+	#[NoCSRFRequired]
+	public function deleteInvite(string $token): JSONResponse {
+		if (!isset($token)) {


I have the feeling $token is always set

ArtificialOwl · 2025-11-17T21:20:16Z

lib/Cron/UpdateOcmProviders.php

+		$data = $this->wayfProvider->getMeshProviders();
+		$data['expires'] = time() + $this->expire_time;
+		$json = json_encode($data);
+		$this->appConfig->setValueString(Application::APP_ID, 'federations_cache', $json);


as said somewhere else, use setValueArray() and set it as lazy

ArtificialOwl · 2025-11-17T21:24:19Z

lib/Db/FederatedInviteMapper.php

+/**
+ * @template-extends QBMapper<FederatedInvite>
+ */
+class FederatedInviteMapper extends DbFederatedInviteMapper {


not a huge fan of this,
if the DB is created and managed from cloud_federation_api, could this request be also integrated to the app, and calling an API from the cloud_federation_api to select/update/delete data from/to database ?

Do I understand correctly that you propose to specify a db layer API/interface in cloud_federation_api and let the contacts app implement that? Meaning that cloud_federation_api can only access the db (and be functional) if there is an app implementing the API (the contacts app in this case)?

…ion workflow see https://github.com/cs3org/OCM-API/blob/v1.2.1/IETF-RFC.md Features: - Button to invite remote users to exchange cloudIDs. - Button to manually accept invite to exchange cloudIDs. - WAYF page allowing the receiver of the invite to open and accept the invitation. - Listing of open invitations. - Option to resend, revoke open invitations. Signed-off-by: antoonp <[email protected]> Co-authored-by: Micke Nordin <[email protected]>

IWayfProvider is redundant.

Use core config lexicon.

Signed-off-by: Antoon P. <[email protected]>

redblom requested review from GVodyanov, SebastianKrupinski and hamza221 as code owners April 8, 2025 09:08

hamza221 assigned redblom Apr 8, 2025

hamza221 added enhancement New feature or request 2. developing Work in progress labels Apr 8, 2025

hamza221 marked this pull request as draft April 8, 2025 09:14

hamza221 added this to the v7.1.0 milestone Apr 10, 2025

redblom force-pushed the invite-for-cloudid-exchange branch from ea81812 to 7c0eaa0 Compare April 10, 2025 20:45

github-actions bot added the feedback-requested label Apr 23, 2025

hamza221 modified the milestones: v7.1.0, v7.2.0 Apr 28, 2025

redblom force-pushed the invite-for-cloudid-exchange branch 2 times, most recently from 0112a78 to e7c2604 Compare April 30, 2025 14:32

ChristophWurst requested review from ArtificialOwl and removed request for GVodyanov, SebastianKrupinski and hamza221 May 15, 2025 12:09

redblom force-pushed the invite-for-cloudid-exchange branch 5 times, most recently from 76d6df3 to ca42433 Compare June 18, 2025 14:33

redblom force-pushed the invite-for-cloudid-exchange branch from ca42433 to 62ce0c2 Compare June 26, 2025 08:21

mickenordin mentioned this pull request Sep 19, 2025

feat(OCM-Invites): Enable the invitesAcceptedDialog nextcloud/server#55182

Closed

redblom force-pushed the invite-for-cloudid-exchange branch from 632955b to 5b7820f Compare September 19, 2025 10:11

redblom force-pushed the invite-for-cloudid-exchange branch 3 times, most recently from 9f0bca4 to 55647b8 Compare September 25, 2025 12:36

redblom changed the title ~~[WIP] exchange cloud ID~~ feat: exchange cloud ID Sep 26, 2025

redblom marked this pull request as ready for review September 26, 2025 08:20

redblom force-pushed the invite-for-cloudid-exchange branch from 55647b8 to 20fc781 Compare September 26, 2025 08:52

ChristophWurst added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Sep 26, 2025

redblom force-pushed the invite-for-cloudid-exchange branch 3 times, most recently from e51a605 to 153fdb1 Compare October 3, 2025 09:39

redblom force-pushed the invite-for-cloudid-exchange branch from 3fba972 to f9574de Compare October 13, 2025 16:16

redblom force-pushed the invite-for-cloudid-exchange branch from 26a76f8 to 2272c9f Compare October 29, 2025 15:05

ArtificialOwl reviewed Nov 17, 2025

View reviewed changes

antoonp and others added 8 commits November 20, 2025 16:14

Revert messed up rebase.

f57cdf3

Handle possible different app root url's.

335c299

IWayfProvider is redundant.

Get/Set config value as array and lazy.

b1eba22

Fix redundant bool conversion.

29792a6

Use core config lexicon.

Use CSRF check where relevant.

e730dea

Remove redundant parameter check.

0b6c5e9

Fix messed up rebase.

86027f9

redblom force-pushed the invite-for-cloudid-exchange branch from 069d061 to 86027f9 Compare November 20, 2025 15:48

Merge branch 'main' into invite-for-cloudid-exchange

379d9a3

Signed-off-by: Antoon P. <[email protected]>

feat: exchange cloud ID #4417

Are you sure you want to change the base?

feat: exchange cloud ID #4417

Conversation

redblom commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

redblom commented Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Apr 23, 2025

Uh oh!

codecov bot commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ChristophWurst commented Apr 25, 2025

Uh oh!

redblom commented Apr 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChristophWurst commented Apr 30, 2025

Uh oh!

redblom commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mickenordin commented Sep 25, 2025

Uh oh!

mickenordin commented Sep 25, 2025

Uh oh!

redblom commented Oct 29, 2025

Uh oh!

ArtificialOwl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

redblom Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

redblom commented Apr 8, 2025 •

edited

Loading

redblom commented Apr 8, 2025 •

edited

Loading

codecov bot commented Apr 24, 2025 •

edited

Loading

redblom commented Apr 29, 2025 •

edited

Loading

redblom commented Sep 19, 2025 •

edited

Loading

redblom Nov 20, 2025 •

edited

Loading