v4.1.2

[v4.1.2] - 2024-09-26

Overview

MDS 2.2 Hotfix

Detailed Changes

Patch

• Docs describe how to locally self-generate X.509 certificates (#192)
• Fixed configuration not applying properly after a version upgrade (#322)

Known issues

• Users are not redirected to the correct URL after login (#324)

Deployment Migration Notes

No special migration steps required

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:4.1.2
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:4.1.2
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.4.1
• Sovity EDC CE: v10.4.1

v4.1.1

[v4.1.1] - 2024-09-18

Overview

Quality of Life improvements

Detailed Changes

Patch

• Adjusted the table header on the Organization overview page (#286)
• Adjusted data source availability naming in the CSV report (#283)
  • LIVE -> Available
  • ON_REQUEST -> On Request
• Changed the error message on user/organization invite failures to be more descriptive (#290)
• Fixed UI issues after deleting the last user of an organization (#289)

Deployment Migration Notes

No special migration steps required

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:4.1.1
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:4.1.1
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.4.0
• Sovity EDC CE: v10.4.0

v2.3.1

[v2.3.1] - 2024-09-06

Overview

Hotfix release for MDS 2.1

Patch

• Dashboard now displays component uptimes correctly

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:2.3.1
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:2.3.1
• Broker Server: 4.2.0

v4.1.0

[v4.1.0] - 2024-09-04

Overview

Quality of Life improvements

Detailed Changes

Minor

• Added auto refresh for pages with connectors every 30 seconds

Deployment Migration Notes

No special migration steps required

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:4.1.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:4.1.0
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.3.0
• Sovity EDC CE: https://github.com/sovity/edc-ce/releases/tag/v10.3.0

v4.0.0

[v4.0.0] - 2024-08-20

Overview

This release introduces support for UI branding configuration, adds improvements to the process of registering connectors for service providers and fixes several minor issues.
Check the deployment migration notes to ensure that you configured everything correctly.

Detailed Changes

Major

• The portal now supports multiple theme configurations

Minor

• Catalog
  • Added copyable contact email and subject fields in the data offer detail dialog
  • Organization filter is no longer split into ID and name
  • Connector filter is no longer split into ID and endpoint
  • Removed dataspace filter when only one dataspace is configured
• Service provider
  • Service providers can now provide connectors using a Connector JWKS URL instead of a certificate (#272)
  • The configuration summary after registering a connector now shows the value for EDC_OAUTH_CLIENT_ID
• Added a message on the CaaS request page to inform the user in case the feature is not configured

Patch

• Fixed user not being redirected to the correct URL after login (#280)
• Fixed the close button on the self-hosted/CaaS connector choice page (#258)
• Fixed Dashboard showing uptimes of over 100% (#262)
• Organization list: Data offer and connector counts now show the correct numbers according to the active environment (#255)
• Fixed provider organization ID not showing up on CaaS connectors (#206)
  • Keep in mind that sovity needs to be registered in the portal for the ID to show up.
  • Already registered connectors will be updated automatically, this process can take up to 24 hours
• Fixed the close button on the self-hosted/CaaS connector choice page (#258)
• Adjusted connector status naming for more consistency (#270)
  • RUNNING (CaaS) -> ONLINE
  • STOPPED (CaaS) -> OFFLINE
  • DEAD -> OFFLINE
• Breadcrumbs now show "Catalogue" properly when using the MDS theme
• Removed requirement for an environment with ID test

Deployment Migration Notes

Read the deployment migration notes carefully if you want to retain the portal's current behavior.
If you configure the optional variables incorrectly, you might end up with an inconsistent configuration.

Backend

Environment variable changes:

• Renamed variables:
  • authority-portal.caas.sovity.limit-per-mdsid to authority-portal.caas.sovity.limit-per-organization
• New optional configuration variables - the values assigned here are the ones you should use to retain the current behavior:

  • # Organization ID configuration (example: prefix: MDS & length: 4 would generate Ids in the format MDSL1234XX)
    # The 'L' stands for 'Legal' and is added automatically after the prefix - the last 2 characters are the checksum
    authority-portal.organization.id.prefix: "MDS"
    authority-portal.organization.id.length: "4"

• New mandatory configuration variables:

  • # Enables the client to connect to the CaaS service. If you weren't provided credentials for the feature by sovity, set this to false
    quarkus.oidc-client.sovity.client-enabled: true

Frontend

Environment variable changes:

• New mandantory configuration variables - the values assigned here are the ones you should use to retain the current behavior:

  • # UI Branding profile
    AUTHORITY_PORTAL_FRONTEND_ACTIVE_PROFILE: mds-open-source
    # Short Dataspace name, used in some explanatory texts
    AUTHORITY_PORTAL_FRONTEND_DATASPACE_SHORT_NAME: MDS
    # Portal name displayed in various texts
    AUTHORITY_PORTAL_FRONTEND_PORTAL_DISPLAY_NAME: "MDS Portal"

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:4.0.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:4.0.0
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.2.0
• Sovity EDC CE: 10.2.0

v3.1.0

[v3.1.0] - 2024-07-24

Overview

MDS 2.2 release

Detailed Changes

Minor

• Data offers now have their own URLs and are sharable
• Complex policy support for the catalog browser

Patch

• Fixed some styling issues in the Data Catalog #238
• Fixed deployment environment not syncing in URLs for the catalog
• Fixed keycloak not redirecting to the correct page after login.

Deployment Migration Notes

No special migration steps required.

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:3.1.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:3.1.0
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:10.0.0
• Sovity EDC CE: 10.0.0

v3.0.0

[v3.0.0] - 2024-07-15

Overview

MDS 2.2 intermediate release

Detailed Changes

Major

• The Data Catalog (formerly known as Broker) is now integrated into the Authority Portal and can be accessed via the sidebar.

  Detailed Description

  What’s New?

  Seamless Integration: Now, you can use both the Authority Portal and Data Catalog from the same place. This means you won’t be navigated away from the Authority Portal when you want to use the Data Catalog, like before.

  Why This Matters?

  • Improved User Experience: Enjoy a smoother, more intuitive journey with our integrated solution.
  • Exclusive Access: The Data Catalog is now exclusively available to your Data Space members, enhancing the value of their membership and ensuring your users get the most out of your services. Access to the Data Catalog requires registered membership to your Data Space.

Minor

• Changed Broker to Catalog crawler on the dashboard and in the system stability report
• Data offer amounts now differentiate "On Request" Data Offers

Patch

• Input fields containing only whitespaces are now properly validated and an appropriate error message is shown #193
• Component uptime now displays up to '30+ days' #211
• Relaxed zipcode validation to allow less than 5 characters #224

Deployment Migration Notes

• All brokers can be undeployed including their databases.
• Keycloak
  • Keycloak IAM must be updated to version 24.0.4. Follow the Keycloak upgrade guide for more information.
• Portal Backend
  • Following environment variables have been added and must be configured for each environment

    • # Time after which offline data offers are hidden from the Data Catalog
      authority-portal.deployment.environments.{environmentId}.data-catalog.hide-offline-data-offers-after: 15m
      
      # Default page size for the Data Catalog
      authority-portal.deployment.environments.{environmentId}.data-catalog.catalog-page-page-size: 10
      
      # Kuma name for the catalog crawler
      authority-portal.deployment.environments.{environmentId}.data-catalog.kuma-name: broker  
      
      # Environment Connector-Dataspace association
      # Allows certain connectors to be associated as partnered data spaces
      # Required: Default Dataspace name
      authority-portal.deployment.environments.test.data-catalog.dataspace-names.default: MDS
      # Optional: Additional connectors to be given a dataspace name
      authority-portal.deployment.environments.test.data-catalog.dataspace-names.connectorIds."MDSL1234XX.C1234XX": Mobilithek

  • Following environment variables have been removed and can be removed from the configuration

    • # the broker has been removed, as the catalog is now a part of the authority portal
      authority-portal.deployment.environments.{environmentId}.broker.url: ...
      authority-portal.deployment.environments.{environmentId}.broker.admin-api-key: ... 
      authority-portal.deployment.environments.{environmentId}.broker.api-key: ...
      authority-portal.deployment.environments.{environmentId}.broker.kuma-name: ...

• The Broker as a stand-alone deployment unit has been removed in favor of the Catalog Crawler.
  • Any broker's database is not required anymore and can be undeployed.
  • A Catalog Crawler must be deployed for each environment to fill the catalog with live data.
  • Just like the broker, the Catalog Crawler is a modified EDC connector. As such, it can only fetch the catalogs from connectors registered in the same DAPS environment.
  • There is a dedicated Catalog Crawler Productive Deployment Guide
  • Running Uptime Kuma instances must be reconfigured to track the status of the catalog crawler instead of the Broker.
  • While the Catalog Crawler is similar to the broker, please note, that many environment variables have been renamed or removed. It is recommended to do a fresh deployment using the deployment guide.

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:3.0.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:3.0.0
• Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:9.0.0
• Sovity EDC CE: 9.0.0

v2.3.0

[v2.3.0] - 2024-05-13

Overview

This release includes fixes for several minor issues and security vulnerabilities.

Detailed Changes

Minor

• Changed connector status DEAD to OFFLINE in UI responses (#184)

Patch

• Fixed the connector status missing in the CSV reports (#190)
• Fixed naming of EDC variable in instructions (#195)
• Fixed error message for already existing CaaS subdomains (#196)
• Removed possibility to provide a connector for oneself as a Service Partner (#191)
• Added an environment variable to enable configuration of the support page URL. See deployment migration notes. (#203)

Known issues

• The provider shown in details of CaaS connectors is currently misformatted (#206)

Deployment Migration Notes

• Added environment variables
  • Portal Frontend

    # Support page URL
    AUTHORITY_PORTAL_FRONTEND_SUPPORT_URL: https://support.mobility-dataspace.eu

  • Keycloak

    # Privacy policy and legal notice URLs
    KEYCLOAK_PRIVACY_POLICY_URL: https://mobility-dataspace.online/privacy-policy-mds-portal
    KEYCLOAK_LEGAL_NOTICE_URL: https://mobility-dataspace.eu/legal-notice

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:2.3.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:2.3.0
• Broker Server: 4.2.0

v2.2.1

[v2.2.1] - 2024-04-11

Overview

This release addresses several security issues and adds minor improvements to the Authority Portal.

Detailed Changes

Patch

• Fixed "Provided Connectors" view for Service Partners (#172)
• Fixed red fields in organization create page (#122)
• Fixed wrong path after onboarding (#103)
• Fixed yellow inactive sidebar item (#123)
• Fixed vulnerability from CVE-2024-2700
• Adjusted headers for improved security (#176)
• Adjusted Keycloak SSL settings for improved security (#183)
• Adjusted documentation (#181)

Known issues

Deployment Migration Notes

• Keycloak
  • Change SSL settings
    • Realm settings > General > Require SSL: All requests
• Caddy
  • Headers to improve security are now set
  • Modified Caddyfile:

  # UI Requests: Internet -> Caddy 8080 -> Frontend
  # Backend Requests: Internet -> Caddy 8080 -> Auth Proxy -> Caddy 8081 -> Backend
  
  :8080 {
    map {path} {target_host} {target_port} {
      ~^/api/.*      {$AUTH_PROXY_UPSTREAM_HOST}   8080
      ~^/oauth2/.*   {$AUTH_PROXY_UPSTREAM_HOST}   8080
      default        {$FRONTEND_UPSTREAM_HOST}     8080
    }
  
    reverse_proxy {target_host}:{target_port} {
      header_down -Gap-Auth
    }
  
    # Set security headers for UI responses
    header {
      X-Frame-Options "DENY"
      +Content-Security-Policy "frame-ancestors 'none'"
    }
  
    # Set security headers for API responses
    header /api/* {
      X-Content-Type-Options nosniff
      +Content-Security-Policy "script-src 'none'"
      +Cache-Control "no-store"
    }
  
    # Set Cache-Control for UI assets
    header /assets/* {
      +Cache-Control "public, max-age=2592000, immutable"
    }
  }
  
  # Caddy 8081 -> Backend
  # We need this second block because the auth proxy
  # does not pass the token on the right header due to
  # kubernetes conventions.
  :8081 {
    reverse_proxy {$BACKEND_UPSTREAM_HOST}:8080 {
      header_up Authorization "Bearer {header.X-Forwarded-Access-Token}"
    }
  }
  

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:2.2.1
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:2.2.1
• Broker Server: 4.1.1

v2.2.0

[v2.2.0] - 20240-04-02

Overview

This release addresses several issues and adds minor improvements to the Authority Portal.

Detailed Changes

Minor

• Enable users to delete themselves (#127)
• Added an API endpoint to set the backend log level during runtime: https://[AP_FQDN]/api/config/log-level?level=[LOG_LEVEL] (#2)
  • x-api-key header must be set correctly to access this endpoint
  • Example:

  curl -X PUT 'https://authority-portal.example.com/api/config/log-level?level=DEBUG' --header 'x-api-key: uYtR_wNsvXU4EbV9GioACnj!NHML_HRX'

Patch

• Fixed user being able to skip to the final step without submitting in multiple components (#121)
• Fixed Keycloak notifications, OTP pages (#146), (#151)
• Fixed provided connectors' statuses missing on the dashboard (#138)
• Fixed "Hosted By Name" column in Connector CSV report (#149)
• Fixed wrong Users and Roles path #150
• Fixed phone number and description validators (#161)
• Fixed Page not found for "MyUsers" route (#163)
• Fixed logo in Keycloak Theme being cut off (#165)
• Fixed wording in "Reset Password" email (#116)
• Fixed wording in "Provide Central Component" form (#112)
• Adjusted wording in the sidebar menu (#117)
• Adjusted documentation (#159)

Deployment Migration Notes

• Portal Backend
  • Environment variables

  # Added
  # API key to protect config endpoints, like /api/config/log-level
  authority-portal.config.api-key: [API_KEY]

• Auth Proxy
  • Environment variables

  # Changed
  OAUTH2_PROXY_SKIP_AUTH_ROUTES: "^(/oauth2|/api/registration|/api/config)"

• Keycloak
  • Replace MDS theme with the new version

Compatible Versions

• Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:2.2.0
• Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:2.2.0
• Broker Server: 4.1.0