Changelog

For documentation on how to update this changelog, please see changelog_updates.md.

Unreleased - YYYY-MM-DD

Overview

Detailed Changes

Major

Minor

Patch

Known issues

Deployment Migration Notes

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:{{ version }}
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:{{ version }}
Catalog Crawler CE: ghcr.io/sovity/catalog-crawler-ce:{{ CE VERSION }}
Sovity EDC CE: {{ CE Release Link }}

[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] - 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

[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: v10.3.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] - 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.

Known issues

Deployment Migration Notes

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] - 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.

Minor

Changed Broker to Catalog crawler on the dashboard and in the system stability report
Data offer amounts now differentiate "On Request" Data Offers
Differentiate live and on request data offers in card and detail dialog UI

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.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

[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] - 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] - 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

[v2.1.2] - 2024-03-22

Overview

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

Detailed Changes

Patch

Fixed the placeholder for the connector Frontend URL (#86)
Fixed connectors not showing on operator's "All connectors" list (#119)
Fixed an issue with connector URLs not being validated correctly in the UI (#115)
Fixed MDS logo & footer (in compact view) (#57)
Fixed text overlapping on fullscreen pages (#80)
Fixed text overlapping in the registration form (#120)
Fixed an issue where clicking "back to application" on the logout confirmation page would not properly cancel the logout process (#8)
Fixed an issue where clicking "Data Offers" without having a registered connector would redirect the user to a wrong page (#44)
Fixed an issue where an error would be displayed during login under certain circumstances (#107)
Fixed an issue where deleting the last user of an organization would delete the organization but leave the user in an invalid state (#45)
Fixed the dashboard for non-authority users (#118)
Dashboard: Changed the component uptime duration to be shown next to the status instead of showing it in a tooltip (#62)
Changed the Keycloak custom theme for login and logout pages #113
Changed the Keycloak realm ID to mds-portal (#139)
Changed the Access Token Lifespan to one minute (#111)
Changed error messages on the registration form to be more user-friendly (#106)
Updated user documentation to reflect the current version (#5)
Added legal notices to the login page (#79)
Added tooltips explaining user roles (#76)

Known issues

Due to the change of the Keycloak realm name, some auth-related URLs might be outdated in your browser. If you run into this issue. please clear your browser cache and hard-reload the page.
Login and first-login related Keycloak pages may look broken. This will be fixed in the next release.

Deployment Migration Notes

Keycloak
- Change realm ID and name
  - Realm settings > General > Realm ID: mds-portal
  - Realm settings > General > Display name: MDS Portal
- Change the configuration for the oauth2-proxy client
  - Clients > oauth2-proxy > Settings > Home URL: /oauth2/sign_in
- Set Access Token Lifespan to 1 minute (Realm Settings -> Tokens -> Access Token Lifespan)
- Replace MDS theme with the new version

Auth Proxy

Copy the contents from resources to a directory the OAuth2 proxy can access (CUSTOM_TEMPLATES_DIR)

Environment variables

# Changed
OAUTH2_PROXY_OIDC_ISSUER_URL: https://[KC_FQDN]/realms/mds-portal
OAUTH2_PROXY_COOKIE_REFRESH: 30s
OAUTH2_PROXY_CUSTOM_TEMPLATES_DIR: [CUSTOM_TEMPLATES_DIR]

Portal Backend

Environment variables

# Changed
# Base URL of the OIDC server (Keycloak). Must contain the '/realms/{realm}' part of the URL
quarkus.oidc.auth-server-url: https://[KC_FQDN]/realms/mds-portal
# Keycloak Admin Client: Realm
quarkus.keycloak.admin-client.realm: mds-portal

Portal Frontend

Environment variables

# Changed
# Auth Proxy: Logout URL (please replace ALL placeholders: [EXAMPLE])
AUTHORITY_PORTAL_FRONTEND_LOGOUT_URL: https://[AP_FQDN]/oauth2/sign_out?rd=https%3A%2F%2F[KC_FQDN]%2Frealms%2Fmds-portal%2Fprotocol%2Fopenid-connect%2Flogout%3Fclient_id%3Doauth2-proxy%26post_logout_redirect_uri%3Dhttps%253A%252F%252F[AP_FQDN]

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:2.1.2
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:2.1.2
Broker Server: 4.0.0

[v2.1.1] - 2024-03-14

Overview

First bugfix release for version 2.1.0.

Detailed Changes

Patch

Fixed the dashboard not reloading when switching deployment environments
Fixed an error with input validation that prevented the use of upper-case letters in zip codes (#21)
Fixed an error with provisioning CaaS breaking the dashboard (#27)
Fixed the text being cut off in the connector self-hosting instructions (#97)
Fixed inconsistent placeholder values for privacy policy and legal notice links (#41)
Fixed favicon and page titles being not aligned with breadcrumbs ([#48])
Fixed misleading UptimeKuma endpoint documentation (#96)
Fixed components being displayed as online when UptimeKuma is unreachable
Fixed Authority Users not being able to invite participants (#65)
Fixed the organization address being displayed incorrectly (#101)
Fixed styling, removed hover effect on unclickable avatar components (#99)
Fixed the display of user roles missing spaces between words (#100)
Fixed certificate generation failing when using special characters (#84)
Changed the order of industry select options (#22)
Changed the logo to redirect to MDS home (#64)
Changed the wording of the reset password functionality (#51)
Renamed "All Data Offers" to "Data Catalogue" (#52)
Adjusted the ordering of users in the organization details page (#98)
Adjusted the ordering of organizations in the organization overview page (#49)
Added a character limit to most input fields (128 characters) (#17)
Added missing variables to show "hide/show" icon in reset password keycloak page (#93)
Added a notification when the user clicks on a copy button (#24)
Added asterisks to highlight required fields on registration (#7)
Certificate generation: Added a notice below the generate button (#94)
Removed "Control Center" from breadcrumb path to improve UX (#54)
Restricted user re-/deactivation to appropriate statuses (#82)
Cleaned up the repository for open-source release:
- Removed internal tools and utilities
- Rebased the entire history to remove secrets and unrelated code
- Cleaned up dead links
- Adjusted the release issue template

Known issues

Deployment Migration Notes

Keycloak
- Replace MDS theme with the new version

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:2.1.1
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:2.1.1
Broker Server: 3.5.0

[v2.1.0] - 2024-03-04

Overview

Final feature release for the first Go-Live of the MDS.

Detailed Changes

Minor

Dashboard Page: Component Status Overview
Dashboard Page: Connector Status Overview
Dashboard Page: CSV Reports: Connectors, Users, Data Offers, System Stability
Control Center: Edit Own Organization Details Page
Control Center: Edit Own User Details Page
Improved User Profiles slightly by reordering items
Improved Organization Profiles slightly by reordering items
Organization field "industry" was added
Organization field "business unit" is now mandatory
Renamed MDS Authority Portal occurrences to MDS Portal
Footer: Added Legal Notice link
Footer: Added Copyright Notice

Patch

Improved Menus and Navigation
Improved User Profiles by reordering items, icons and showing more information
Improved Organization Profiles slightly by reordering items, icons and showing more information
Improved Connector Detail Pages slightly by reordering items, icons and showing more information
Some pages, that did not have the footer before, have it now
User Onboarding: Fix Privacy Policy Check not positioned correctly
Organization Onboarding: Fix approve/reject buttons showing when organization is still invited or onboarding
Multiple layouting, responsiveness and styling fixes
Fix: 404 page not working
Changed the CaaS curator from the organization's main contact to the user requesting the CaaS

Known issues

Deployment Migration Notes

Portal Frontend

Environment Variables

# Added
# Authority Portal Legal Notice URL
AUTHORITY_PORTAL_FRONTEND_LEGAL_NOTICE_URL: https://mobility-dataspace.eu/legal-notice

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:2.1.0
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:2.1.0
Broker: 3.5.0

[v2.0.0] - 2024-02-27

Overview

Major release, containing a UI rework and several new features.

Detailed Changes

Major

Redesigned the entire Portal UI
- Redesigned connector overview pages
- Added detail panes for connectors, organizations & users
- Redesigned registration and onboarding processes for organizations & users
- Added a new "unauthenticated page", registration now happens in the Authority Portal without Keycloak.
- Redesigned authority participant management Section
- Redesigned the landing page to display information provided by MDS
Added a feature to request a Connector-as-a-Service from the sovity portal
Upgraded Keycloak to version 23.0.4

Minor

Users are now able to edit their information
Organization admins can now edit their organization's information
Updated processes to be compatible with the new Broker API
Changed the connector registration flow
- Registration now fails when attempting to use a certificate that is already in use
- Registration no longer fails when an error occurs while registering it to the Broker
- Connectors now regularly try to re-register to Broker if previous attempts failed
- Connector URLs can now be configured independently
Updated the organization member list to display more details
Connector status is now displayed in real-time
Added the ability for organization & authority admins to delete users
Added a link to own organization's data offers in the sidebar
Renamed participant roles:
- Participant Admin -> Admin
- Participant Curator -> Key User
- Participant User -> User
Operator admins can now access an overview of all connectors and have the ability to delete them
Privacy policy link is now displayed on all pages and required to be accepted during registration flows
Updated catalog link to redirect to the correct broker url based on environment
Improved displaying of the user roles
Now showing registration status in organization user details title bar

Patch

Roles of invited users are now set correctly
Fixed displaying of long organization titles in detail view

Known issues

Deployment Migration Notes

Keycloak
- Replace MDS theme with the new version
- Keycloak IAM needs to be upgraded to version 23.0.4

Portal Backend

Added environment variables

# CaaS Portal API Client Auth
# will be provided by sovity
quarkus.oidc-client.sovity.auth-server-url: https://[CAAS_KC_FQDN]/realms/[REALM]
quarkus.oidc-client.sovity.client-id: [CAAS_CLIENT_ID]
quarkus.oidc-client.sovity.credentials.secret: [CAAS_CLIENT_SECRET]
# CaaS Portal URL
authority-portal.caas.sovity.url: https://[CAAS_PORTAL_FQDN]

# CaaS Limit: Amount of free sovity CaaS per participant
authority-portal.caas.sovity.limit-per-mdsid: 1

# Uptime Kuma Configuration
authority-portal.kuma.metrics-url: https://[UPTIME_KUMA_FQDN]
authority-portal.kuma.api-key: [UPTIME_KUMA_API_KEY]
# Description of a component in Uptime Kuma (ENVIRONMENT: test, prod, etc.; COMPONENT: broker, daps, logging-house)
authority-portal.deployment.environments.{ENVIRONMENT}.{COMPONENT}.kuma-name:
  [KUMA_NAME]

# Logging House URL (ENVIRONMENT: test, prod, etc.)
authority-portal.deployment.environments.{ENVIRONMENT}.logging-house.url: https://[LOGGING_HOUSE_FQDN]

Removed environment variables
- ~~authority-portal.connectors.url.frontend~~
- ~~authority-portal.connectors.url.management~~
- ~~authority-portal.connectors.url.endpoint~~

Portal Frontend

Added environment variables

# Auth Proxy: Login URL (with redirect to the Authority Portal)
AUTHORITY_PORTAL_FRONTEND_LOGIN_URL: https://[AP_FQDN]/oauth2/start?rd=https%3A%2F%2F[AP_FQDN]
# MDS Dashboard iFrame URL
AUTHORITY_PORTAL_FRONTEND_IFRAME_URL: https://mobility-dataspa-5n9px2qi7r.live-website.com/mds-news
# MDS Privacy Policy URL
AUTHORITY_PORTAL_FRONTEND_PRIVACY_POLICY_URL: https://mobility-dataspace.online/privacy-policy-mds-portal

Connectors now have configurable URLs for the Frontend, Endpoint and Management API. Please check existing connectors for their correct URLs. If needed, remove affected connectors and re-register them with a correct URL configuration.
The infrastructure was changed in a way that the Portal Frontend is now publicly reachable to enable participant self-registration.
- UI Requests: Internet -> Caddy 8080 -> Frontend
- Backend Requests: Internet -> Caddy 8080 -> Auth Proxy -> Caddy 8081 -> Backend

Caddy

The Caddy configuration needs to be updated, as it now serves as the main entry point for the Authority Portal.
Added environment variable OAUTH_PROXY_UPSTREAM_HOST: [Auth Proxy service]

Modified Caddyfile

Configuration for :8080

: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}
}

Configuration for :8081

:8081 {
    reverse_proxy {$BACKEND_UPSTREAM_HOST}:8080 {
        header_up Authorization "Bearer {header.X-Forwarded-Access-Token}"
    }
}

The productive deployment guide contains the full file.

Auth Proxy

Environment variables

# Added
OAUTH2_PROXY_API_ROUTES: "^/api/"

# Changed
OAUTH2_PROXY_UPSTREAMS: http://[Caddy service]:8081/
OAUTH2_PROXY_SKIP_AUTH_ROUTES: "^(/oauth2|/api/registration)"

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:2.0.0
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:2.0.0
Broker Server: 3.4.0

[v0.3.3] - 2024-02-15

Overview

Bug- and styling fixes. Also fixes the user documentation.

Detailed Changes

Patch

Bugfixes

Remove existing OTP configurations when resetting a user's password

Styling

Changed wording on connector registration pages and added additional information regarding URL configuration
Changed wording on the landing page for rejected users
Fixed registration page responsiveness

Documentation

Adjusted user documentation to fit the current version of the component

Known issues

After logout, if the user leaves the login page and returns to the "previous" login page using the browser's back button, an error will be displayed upon a login attempt. The user can still log in using the appropriate button displayed on the error page

Deployment Migration Notes

Keycloak IAM
- Set OTP reset policy to "Remove all" (Authentication -> Flows -> reset credentials -> Reset OTP -> Gear Icon)
- To temporarily disable self-registration of participants go to: Realm Settings -> Login -> User Registration (deactivate switch)

For further information check out our Productive Deployment Guide.

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:0.3.3
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:0.3.3
Broker Server: 3.3.0

[v0.3.2] - 2024-01-26

Overview

Added overview of all registered connectors in the Authority Section and fixed several bugs.

Detailed Changes

Patch

Bugfixes

Fixed an issue where the user could register multiple connectors with identical data
Fixed an issue where the user could still access the portal after logout
Fixed an issue where rejected users would be shown a blank screen
Service partners can now provide connectors again
Addressed security issues
- Updated dependencies
- Upgraded Keycloak to version 22.0.2

Other

Added an overview of all registered connectors in the Authority Section

Documentation

Moved some lines in the Productive Deployment Guide to the correct location

Known issues

After logout, if the user leaves the login page and returns to the "previous" login page using the browser's back button, an error will be displayed upon a login attempt. The user can still log in using the appropriate button displayed on the error page

Deployment Migration Notes

Keycloak IAM needs to be upgraded to version 22.0.2

For further information check out our Productive Deployment Guide.

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:0.3.2
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:0.3.2
Broker Server: 3.2.0

[v0.3.1] - 2024-01-22

Overview

Detailed Changes

Patch Release for DB migrations.

Patch

Fixed an issue with DB migrations, causing deployments on older DB states to fail
Fixed an issue where rejected users getting to be redirected to blank screen

Deployment Migration Notes

For further information check out our Productive Deployment Guide.

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:0.3.1
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:0.3.1
Broker Server: 3.2.0

[v0.3.0] - 2024-01-19

Overview

Added central component management, fixed multiple bugs and pushing organization metadata to Broker.

Detailed Changes

Minor

Operator Admins can now manage central dataspace components and add them to the DAPS
Now pushing organization metadata to MDS Brokers (Dependency from Broker development)
Removed the ability to provide connectors for Authority roles
Improved the invitation & confirmation e-mail templates
Added product documentation: Registration processes, roles and rights, user onboarding

Patch

Bugfixes

Fixed an issue with the environment switcher
Fixed an issue where users could not be re-invited after failing to confirm their registration in time
Fixed Connector URLs not being validated
Fixed an issue where the user got stuck in Keycloak after registration/login
Fixed an issue where the scroll bar would not appear

Styling

Reworded texts on landing page

Deployment Migration Notes

Portal Backend
- Added an environment variable authority-portal.invitation.expiration: 43200
- Added an environment variable authority-portal.base-url: https://authority-portal.my-org.com
- The authority-portal-client in Keycloak needs to be updated with new configuration
  - Root URL: same as the environment variable authority-portal.base-url
  - Home URL: same as the root URL
Keycloak
- Replace MDS theme with new version
- Select new email template (Realm Settings -> Themes -> Email theme)

For further information check out our Productive Deployment Guide.

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:0.3.0
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:0.3.0
Broker Server: 3.2.0

[v0.2.1] - 2024-01-09

Overview

Patch release, regarding bugfixes and styling issues.

Detailed Changes

Patch

Bugfixes

Fix role management system (Application roles)
Include subject and authority key identifier in generated certificates
Sign certificates with SHA256 instead of default SHA1
Fixed URL mapping for broker interactions
Fix bug during connector deletion

Styling

Split address field into street, house no., zip and city during organization registration
Changed links to legal documents to english versions

Deployment Migration Notes

Portal Backend
- Add environment variable authority-portal.connectors.url.frontend: /
- Add environment variable authority-portal.connectors.url.management: /api/management
- Add environment variable authority-portal.connectors.url.endpoint: /api/dsp

For further information check out our Productive Deployment Guide.

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:0.2.1
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:0.2.1
Broker Server: 3.1.0

[v0.2.0] - 2023-12-18

Overview

Reworked initial deployment guide, fixed many bugs and styling issues.

Detailed Changes

Minor

Added a health check endpoint backend:8080/q/health
Updated Connector form to generate self-signed certificates instead of key pairs

Patch

Bugfixes

Hardened the first user registration to prevent duplicate users
Hardened user invitation to prevent duplicate users
Fixed the registration form not showing validation messages.
Fixed a bug causing white screens on session expiration
Fixed a bug causing errors on logout
Fixed "Remember me" not working
Fixed an issue with updating user roles
Fixed calculation of the highest user role, shown below the username in the sidebar
Fixed a bug where users can submit Organization profile without confirming they are eligible to create profile
Refactored breadcrumbs to distinguish between clickable and non-clickable steps

Styling

Made Inter and Material Icon Fonts locally available
Redesigned the footer section
Fixed an issue with sidebar elements getting cropped out
Fixed cursor design, when hovering over items that are not clickable
Improved mobile responsiveness on login and registration page
Fixed styling issues on the OTP verification form page
Binding username issue on user profile page fixed
Updated overall Keycloak theme styling misalignment
Replaced "Registered On" by "Created On" at the user profile page

Documentation

Added an internal dev deployment to Sirius with E2E tests for automated set-up.
Reworked Initial Productive Deployment Guide that further materializes the interactions with the Auth Proxy.

Deployment Migration Notes

Please check out the reworked Initial Deployment Guide.
- Please check if everything is configured as intended.
Keycloak
- Replace MDS theme with new version
- Add "Remember me" settings (Realm settings > Sessions)
  - SSO Session Idle Remember Me: 7 days
  - SSO Session Max Remember Me: 7 days
OAuth2 Proxy
- Add environment variable OAUTH2_PROXY_COOKIE_REFRESH: 4m (Access Token Lifespan - 1 minute)
- Add environment variable OAUTH2_PROXY_COOKIE_EXPIRE: 30m (Client Session Idle / SSO Session Idle)

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:0.2.0
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:0.2.0
Broker Server: 3.1.0

[v0.1.2] - 2023-12-08

Overview

Patch release for EDC 0.2.x Broker.

Patch

Adjusted Broker URL for Broker version 3.1.0

Deployment Migration Notes

No special migration steps required.

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:0.1.2
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:0.1.2
Broker Server: 3.1.0

[v0.1.1] - 2023-11-09

Overview

Patch release, adding missing buttons.

Detailed Changes

Patch

Added button for user de-/reactivation on the user details page
Added button for user invitation on the organization details page

Deployment Migration Notes

Upgrade Authority Portal to this version
- Shut down current version
- Restart with new images

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:0.1.1
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:0.1.1
Broker Server: 1.2.0

[v0.1.0] - 2023-10-31

Overview

Second Authority Portal MVP Release, providing extended features, mainly to enable participant management.

Detailed Changes

Major

Added invitation of new participating organizations
Added invitation of new users to an organization (Frontend missing)
Added user deactivation (Frontend missing)
Added support for multiple deployment environments

Minor

Added possibility to change user roles
Added unregistering of own (company intern) connectors
Updated organization detail page to show statistics for Authority Admins
Updated organization detail page to show more information (including user list)
Added user detail pages
Added possibility to generate a connector certificate in browser
Added button with link to the invite new users page

Deployment Migration Notes

Upgrade Broker to version 1.2.0
Upgrade Authority Portal to this version
- Shut down current version
- Restart with new images

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:0.1.0
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:0.1.0
Broker Server: 1.2.0

[v1.0.0] - 2023-09-29

Overview

Initial Authority Portal MVP Release with a minimalistic feature set.

Important

The versioning scheme was changed after this release, so semantically this version is equivalent to a v0.0.1.

Detailed Changes

Major

Implemented an Authority Portal MVP
- User registration process via Keycloak
- Organization registration process
- Organization review process
- Connector registration for own and other organization(s)
- Roles and respective permissions
  - Authority Admin
  - Authority User
  - Participant Admin
  - Participant Curator
  - Participant User
  - Service Partner Admin
  - Operator Admin (not yet used)

Deployment Migration Notes

Please view the Deployment Section in the README.md for initial deployment instructions.

Compatible Versions

Authority Portal Backend Docker Image: ghcr.io/sovity/authority-portal-backend:1.0.0
Authority Portal Frontend Docker Image: ghcr.io/sovity/authority-portal-frontend:1.0.0

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Changelog

Unreleased - YYYY-MM-DD

Overview

Detailed Changes

Major

Minor

Patch

Known issues

Deployment Migration Notes

Compatible Versions

[v4.1.2] - 2024-09-26

Overview

Detailed Changes

Patch

Known issues

Deployment Migration Notes

Compatible Versions

[v4.1.1] - 2024-09-18

Overview

Detailed Changes

Patch

Deployment Migration Notes

Compatible Versions

[v4.1.0] - 2024-09-04

Overview

Detailed Changes

Minor

Deployment Migration Notes

Compatible Versions

[v4.0.0] - 2024-08-20

Overview

Detailed Changes

Major

Minor

Patch

Deployment Migration Notes

Backend

Frontend

Compatible Versions

[v3.1.0] - 2024-07-24

Overview

Detailed Changes

Minor

Patch

Known issues

Deployment Migration Notes

Compatible Versions

[v3.0.0] - 2024-07-15

Overview

Detailed Changes

Major

Minor

Patch

Deployment Migration Notes

Compatible Versions

[v2.3.1] - 2024-09-06

Overview

Patch

Compatible Versions

[v2.3.0] - 2024-05-13

Overview

Detailed Changes

Minor

Patch

Known issues

Deployment Migration Notes

Compatible Versions

[v2.2.1] - 2024-04-11

Overview

Detailed Changes

Patch

Known issues

Deployment Migration Notes

Compatible Versions