feat(ocm): add wayf specific /discover and /federations endpoints to sciencemesh package #393

MahdiBaghbani · 2025-10-27T05:57:10Z

Although this PR is referenced under cs3org/OCM-STA#1, it is not directly part of the STA funded work. However, since the changes are closely related and beneficial to OCM, I decided to port them here as well for consistency.

Description

This PR implements WAYF (Where Are You From) specific discovery endpoints for the ScienceMesh package, enabling dynamic OCM provider discovery and federation management. The implementation follows the OCM Discovery 1.2 specification.

Technical

Things I've added to Reva

/sciencemesh/federations endpoint: Lists available federations and their associated servers
/sciencemesh/federations endpoint: Enables active discovery of OCM providers and their capabilities
Automatic InviteAcceptDialog discovery: Dynamically retrieves invitation handling URLs from remote providers
Federation configuration support: Loads federation data from configurable JSON files
Legacy endpoint fallback: Maintains compatibility with older OCM discovery implementations

Code changes

New OCM Client internal/http/services/ocmd/client.go: HTTP client for OCM provider discovery with timeout and TLS configuration
WAYF Handler internal/http/services/sciencemesh/wayf.go: Core logic for federation management and provider discovery
Updated routing internal/http/services/sciencemesh/sciencemesh.go: Added new endpoints and configuration options
OCM Discovery 1.2 compliance internal/http/services/wellknown/ocm.go: Updated API version and added InviteAcceptDialog support

…sciencemesh package Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

butonic

Awesome! I know you have this on draft, but I wanted to understand this and get involved early.

internal/http/services/sciencemesh/wayf.go

internal/http/services/ocmd/client.go

internal/http/services/wellknown/ocm.go

butonic · 2025-10-29T09:57:31Z

internal/http/services/sciencemesh/wayf.go

+	ocmClient := ocmd.NewClient(10*time.Second, false)
+
+	log.Debug().Str("domain", domain).Msg("Attempting OCM discovery")
+	disco, err := ocmClient.Discover(ctx, domain)


hm. domain is taken from the request. and the /discover endpoint is unprotected. That allows anyone to make a GET /.well-known/ocm and GET /ocm-provider request to any host. even internal ones. We need to check if the requested host is in the list of configured federations?

Yes, so the idea is if Alice invited Bob and Bob cannot find it's home EFSS server name in Alice's WAYF page, he could enter his domain in the UI to be redirected to his EFSS.

Here is a demo with my modified GUI of OpenCloud (will open PR after fixing some corners):
opencloud-to-ocis.webm

I initially considered implementing it entirely on the client side, but that approach would conflict with CSRF protection mechanisms

internal/http/services/ocmd/client.go

Co-authored-by: Jörn Friedrich Dreyer <jfd@butonic.de> Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

Instead of creating a client each time a function is called, create client once Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

Co-authored-by: Giuseppe Lo Presti <giuseppe.lopresti@cern.ch> Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

@glpatcern

@glpatcern recommendations moved types to spec.go used directory urls instead of a file Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

@glpatcern

as per @glpatcern recommendations Also return 404 if the remote EFSS doesn't provide an inviteAcceptDialog Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

butonic · 2025-11-26T17:13:03Z

@dragonchaser this PR adds missing enpoints for the current OCM spec. Since you digested that yesterday, can you give it a review?

Signed-off-by: Christian Richter <c.richter@opencloud.eu>

MahdiBaghbani · 2025-11-29T18:54:03Z

Thanks for the acceptance! 🥳

I just have a question about:

reva/internal/http/services/ocmd/client.go

Lines 96 to 111 in 700f617

    
           resp, err := c.client.Do(req) 
        
           defer func() { 
        
           	if resp != nil && resp.Body != nil { 
        
           		_ = resp.Body.Close() 
        
           	} 
        
           }() 
        
           if err != nil { 
        
           	return nil, errors.Wrap(err, "error doing OCM discovery request") 
        
           } 
        
           defer func(body io.ReadCloser) { 
        
           	err := body.Close() 
        
           	if err != nil { 
        
           		log.Warn().Err(err).Msg("error closing response body") 
        
           	} 
        
           }(resp.Body)

@dragonchaser did I made a mistake on placing the body closer under err check?

feat(ocm): add wayf specific /discover and /federations endpoints to …

92a415b

…sciencemesh package Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

This was referenced Oct 27, 2025

Implement WAYF UI with integration of one or more Directory Services, following the current Nextcloud developments cs3org/OCM-STA#1

Closed

feat(ocm): add WAYF configuration for reva OCM service opencloud-eu/opencloud#1714

Merged

MahdiBaghbani marked this pull request as draft October 28, 2025 13:14

butonic reviewed Oct 29, 2025

View reviewed changes

internal/http/services/ocmd/client.go Outdated Show resolved Hide resolved

MahdiBaghbani mentioned this pull request Oct 30, 2025

feat(ocm): implement WAYF page and enhance invitation workflow opencloud-eu/web#1486

Open

MahdiBaghbani and others added 5 commits November 1, 2025 09:00

add: @butonic recommendations

ede4ab5

Co-authored-by: Jörn Friedrich Dreyer <jfd@butonic.de> Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

fix: OCM client configurability

e7a9109

Instead of creating a client each time a function is called, create client once Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

add: capability

44cf78e

Co-authored-by: Giuseppe Lo Presti <giuseppe.lopresti@cern.ch> Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

add: ocm spec appendix C compliance

1d661b9

@glpatcern recommendations moved types to spec.go used directory urls instead of a file Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

add: use standard libraries for url manipulation

3dfa96e

as per @glpatcern recommendations Also return 404 if the remote EFSS doesn't provide an inviteAcceptDialog Signed-off-by: Mahdi Baghbani <mahdi-baghbani@azadehafzar.io>

MahdiBaghbani marked this pull request as ready for review November 18, 2025 11:44

butonic added this to OpenCloud Team Board Nov 26, 2025

github-project-automation bot moved this to Qualification in OpenCloud Team Board Nov 26, 2025

butonic added Type:Bug Type:Enhancement and removed Type:Bug labels Nov 26, 2025

add missing body close

b45fa51

Signed-off-by: Christian Richter <c.richter@opencloud.eu>

dragonchaser force-pushed the opencloud/feature-ocm-wayf branch from 8397299 to b45fa51 Compare November 27, 2025 10:35

butonic approved these changes Nov 27, 2025

View reviewed changes

dragonchaser approved these changes Nov 27, 2025

View reviewed changes

dragonchaser merged commit b517260 into opencloud-eu:main Nov 27, 2025
19 checks passed

github-project-automation bot moved this from Qualification to Done in OpenCloud Team Board Nov 27, 2025

openclouders mentioned this pull request Nov 27, 2025

🎉 Release 2.40.0 #437

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(ocm): add wayf specific /discover and /federations endpoints to sciencemesh package #393

feat(ocm): add wayf specific /discover and /federations endpoints to sciencemesh package #393

Uh oh!

MahdiBaghbani commented Oct 27, 2025

Uh oh!

butonic left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

butonic Oct 29, 2025

Uh oh!

MahdiBaghbani Oct 29, 2025

Uh oh!

MahdiBaghbani Oct 29, 2025

Uh oh!

Uh oh!

butonic commented Nov 26, 2025

Uh oh!

Uh oh!

MahdiBaghbani commented Nov 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat(ocm): add wayf specific /discover and /federations endpoints to sciencemesh package #393

feat(ocm): add wayf specific /discover and /federations endpoints to sciencemesh package #393

Uh oh!

Conversation

MahdiBaghbani commented Oct 27, 2025

Description

Technical

Code changes

Uh oh!

butonic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

butonic Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

MahdiBaghbani Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

MahdiBaghbani Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

butonic commented Nov 26, 2025

Uh oh!

Uh oh!

MahdiBaghbani commented Nov 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants