build: merge main into dev #561

Reviewed-By: Evelyn Gurschler <[email protected]>
eclipse-tractusx · Mar 5, 2024 · 3377db8 · 3377db8
2 parents 7a16e00 + 54576b7
commit 3377db8
Show file tree

Hide file tree

Showing 20 changed files with 180 additions and 222 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/FILEHEADER.md b/FILEHEADER.md
@@ -12,4 +12,12 @@ Every time you create a new file or edit a file that you created and doesn't yet
 
 Currently the following templates are available:
 * cx_header_default
-* cx_header_with_#
+* cx_header_with_#
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-backend
diff --git a/README.md b/README.md
@@ -1,21 +1,26 @@
-# Catena-X Portal Backend
+[![LeadingRepository](https://img.shields.io/badge/Leading_Repository-Portal-blue)](https://github.com/eclipse-tractusx/portal)
 
-This repository contains the backend code for the Catena-X Portal written in C#.
+# Portal Backend
 
-The Catena-X Portal application consists of
+This repository contains the backend code for the Portal written in C#.
 
-* [portal-frontend](https://github.com/eclipse-tractusx/portal-frontend),
-* [portal-frontend-registration](https://github.com/eclipse-tractusx/portal-frontend-registration),
-* [portal-assets](https://github.com/eclipse-tractusx/portal-assets) and
-* [portal-backend](https://github.com/eclipse-tractusx/portal-backend).
+The Portal application consists of
 
-![Tag](https://img.shields.io/static/v1?label=&message=LeadingRepository&color=green&style=flat) The helm chart for installing the Catena-X Portal is available in the [portal](https://github.com/eclipse-tractusx/portal) repository.
+- [portal-frontend](https://github.com/eclipse-tractusx/portal-frontend),
+- [portal-frontend-registration](https://github.com/eclipse-tractusx/portal-frontend-registration),
+- [portal-shared-components](https://github.com/eclipse-tractusx/portal-shared-components),
+- [portal-assets](https://github.com/eclipse-tractusx/portal-assets) and
+- [portal-backend](https://github.com/eclipse-tractusx/portal-backend).
 
-The Catena-X Portal is designed to work with the [Catena-X IAM](https://github.com/eclipse-tractusx/portal-iam).
+The helm chart for installing the Portal is available in the [portal](https://github.com/eclipse-tractusx/portal) repository.
+
+Please refer to the `docs` directory of the [portal-assets](https://github.com/eclipse-tractusx/portal-assets) repository for the overarching user and developer documentation of the Portal application.
+
+The Portal is designed to work with the [IAM](https://github.com/eclipse-tractusx/portal-iam).
 
 ## How to build and run
 
-Install [the .NET 7.0 SDK](https://www.microsoft.com/net/download).
+Install the [.NET 7.0 SDK](https://www.microsoft.com/net/download).
 
 Run the following command from the CLI:
 
@@ -34,31 +39,17 @@ dotnet run
 
 This application provides container images for demonstration purposes.
 
-### DockerHub
-
-* [portal-registration-service](https://hub.docker.com/r/tractusx/portal-registration-service)
-* [portal-administration-service](https://hub.docker.com/r/tractusx/portal-administration-service)
-* [portal-marketplace-app-service](https://hub.docker.com/r/tractusx/portal-marketplace-app-service)
-* [portal-services-service](https://hub.docker.com/r/tractusx/portal-services-service)
-* [portal-notification-service](https://hub.docker.com/r/tractusx/portal-notification-service)
-* [portal-processes-worker](https://hub.docker.com/r/tractusx/portal-processes-worker)
-* [portal-portal-migrations](https://hub.docker.com/r/tractusx/portal-portal-migrations)
-* [portal-provisioning-migrations](https://hub.docker.com/r/tractusx/portal-provisioning-migrations)
-* [portal-maintenance-service](https://hub.docker.com/r/tractusx/portal-maintenance-service)
-
-### Base images
-
-mcr.microsoft.com/dotnet/aspnet:7.0-alpine:
-
-* Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.17/amd64/Dockerfile)
-* GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
-* DockerHub: [https://hub.docker.com/_/microsoft-dotnet-aspnet](https://hub.docker.com/_/microsoft-dotnet-aspnet)
-
-mcr.microsoft.com/dotnet/runtime:7.0-alpine:
-
-* Dockerfile: [mcr.microsoft.com/dotnet/runtime:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/7.0/alpine3.17/amd64/Dockerfile)
-* GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
-* DockerHub: [https://hub.docker.com/_/microsoft-dotnet-runtime](https://hub.docker.com/_/microsoft-dotnet-runtime)
+See Docker notice files for more information:
+
+* [portal-registration-service](./docker/notice-registration-service.md)
+* [portal-administration-service](./docker/notice-administration-service.md)
+* [portal-marketplace-app-service](./docker/notice-marketplace-app-service.md)
+* [portal-services-service](./docker/notice-services-service.md)
+* [portal-notification-service](./docker/notice-notification-service.md)
+* [portal-processes-worker](./docker/notice-processes-worker.md)
+* [portal-portal-migrations](./docker/notice-portal-migrations.md)
+* [portal-provisioning-migrations](./docker/notice-provisioning-migrations.md)
+* [portal-maintenance-service](./docker/notice-maintenance-service.md)
 
 ## Notice for Nuget Packages
 

diff --git a/docker/notice-administration-service.md b/docker/notice-administration-service.md
@@ -13,7 +13,7 @@ __Portal Administration Service__
 
 __Used base images__
 
-- Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.17/amd64/Dockerfile)
+- Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.19/amd64/Dockerfile)
 - GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
 - DockerHub: [https://hub.docker.com/_/microsoft-dotnet-aspnet](https://hub.docker.com/_/microsoft-dotnet-aspnet)
 

diff --git a/docker/notice-iam-seeding.md b/docker/notice-iam-seeding.md
@@ -13,7 +13,7 @@ __Portal IAM Seeding job__
 
 __Used base images__
 
-- Dockerfile: [mcr.microsoft.com/dotnet/runtime:6.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/6.0/alpine3.17/amd64/Dockerfile)
+- Dockerfile: [mcr.microsoft.com/dotnet/runtime:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/7.0/alpine3.19/amd64/Dockerfile)
 - GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
 - DockerHub: [https://hub.docker.com/_/microsoft-dotnet-runtime](https://hub.docker.com/_/microsoft-dotnet-runtime)
 

diff --git a/docker/notice-maintenance-service.md b/docker/notice-maintenance-service.md
@@ -13,7 +13,7 @@ __Portal Checklist Worker__
 
 __Used base images__
 
-- Dockerfile: [mcr.microsoft.com/dotnet/runtime:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/7.0/alpine3.17/amd64/Dockerfile)
+- Dockerfile: [mcr.microsoft.com/dotnet/runtime:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/7.0/alpine3.19/amd64/Dockerfile)
 - GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
 - DockerHub: [https://hub.docker.com/_/microsoft-dotnet-runtime](https://hub.docker.com/_/microsoft-dotnet-runtime)
 

diff --git a/docker/notice-marketplace-app-service.md b/docker/notice-marketplace-app-service.md
@@ -13,7 +13,7 @@ __Portal Administration Service__
 
 __Used base images__
 
-- Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.17/amd64/Dockerfile)
+- Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.19/amd64/Dockerfile)
 - GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
 - DockerHub: [https://hub.docker.com/_/microsoft-dotnet-aspnet](https://hub.docker.com/_/microsoft-dotnet-aspnet)
 

diff --git a/docker/notice-notification-service.md b/docker/notice-notification-service.md
@@ -13,7 +13,7 @@ __Portal Administration Service__
 
 __Used base images__
 
-- Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.17/amd64/Dockerfile)
+- Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.19/amd64/Dockerfile)
 - GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
 - DockerHub: [https://hub.docker.com/_/microsoft-dotnet-aspnet](https://hub.docker.com/_/microsoft-dotnet-aspnet)
 

diff --git a/docker/notice-portal-migrations.md b/docker/notice-portal-migrations.md
@@ -13,7 +13,7 @@ __Portal Checklist Worker__
 
 __Used base images__
 
-- Dockerfile: [mcr.microsoft.com/dotnet/runtime:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/7.0/alpine3.17/amd64/Dockerfile)
+- Dockerfile: [mcr.microsoft.com/dotnet/runtime:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/7.0/alpine3.19/amd64/Dockerfile)
 - GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
 - DockerHub: [https://hub.docker.com/_/microsoft-dotnet-runtime](https://hub.docker.com/_/microsoft-dotnet-runtime)
 

diff --git a/docker/notice-processes-worker.md b/docker/notice-processes-worker.md
@@ -13,7 +13,7 @@ __Portal Checklist Worker__
 
 __Used base images__
 
-- Dockerfile: [mcr.microsoft.com/dotnet/runtime:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/7.0/alpine3.17/amd64/Dockerfile)
+- Dockerfile: [mcr.microsoft.com/dotnet/runtime:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/7.0/alpine3.19/amd64/Dockerfile)
 - GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
 - DockerHub: [https://hub.docker.com/_/microsoft-dotnet-runtime](https://hub.docker.com/_/microsoft-dotnet-runtime)
 

diff --git a/docker/notice-provisioning-migrations.md b/docker/notice-provisioning-migrations.md
@@ -13,7 +13,7 @@ __Portal Checklist Worker__
 
 __Used base images__
 
-- Dockerfile: [mcr.microsoft.com/dotnet/runtime:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/7.0/alpine3.17/amd64/Dockerfile)
+- Dockerfile: [mcr.microsoft.com/dotnet/runtime:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/runtime/7.0/alpine3.19/amd64/Dockerfile)
 - GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
 - DockerHub: [https://hub.docker.com/_/microsoft-dotnet-runtime](https://hub.docker.com/_/microsoft-dotnet-runtime)
 

diff --git a/docker/notice-registration-service.md b/docker/notice-registration-service.md
@@ -13,7 +13,7 @@ __Portal Administration Service__
 
 __Used base images__
 
-- Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.17/amd64/Dockerfile)
+- Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.19/amd64/Dockerfile)
 - GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
 - DockerHub: [https://hub.docker.com/_/microsoft-dotnet-aspnet](https://hub.docker.com/_/microsoft-dotnet-aspnet)
 

diff --git a/docker/notice-services-service.md b/docker/notice-services-service.md
@@ -13,7 +13,7 @@ __Portal Administration Service__
 
 __Used base images__
 
-- Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.17/amd64/Dockerfile)
+- Dockerfile: [mcr.microsoft.com/dotnet/aspnet:7.0-alpine](https://github.com/dotnet/dotnet-docker/blob/main/src/aspnet/7.0/alpine3.19/amd64/Dockerfile)
 - GitHub project: [https://github.com/dotnet/dotnet-docker](https://github.com/dotnet/dotnet-docker)
 - DockerHub: [https://hub.docker.com/_/microsoft-dotnet-aspnet](https://hub.docker.com/_/microsoft-dotnet-aspnet)
 

diff --git a/docs/nuget/update-nuget-packages.md b/docs/nuget/update-nuget-packages.md
@@ -81,3 +81,11 @@ To update the version of a specific package:
 ```
 
 NUGET_API_KEY is the key generated on nuget.org. The last command should only be executed within the github action [nuget-package-push](/.github/workflows/nuget-package-push.yml)
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-backend
diff --git a/scripts/check-dependencies.md b/scripts/check-dependencies.md
@@ -7,3 +7,11 @@ This workflow uses the executable jar in the download directory.
 In order to update the executable jar run the following command from the root directory:
 
     curl -L --output ./scripts/download/org.eclipse.dash.licenses-1.0.2.jar 'https://repo.eclipse.org/service/local/artifact/maven/redirect?r=dash-licenses&g=org.eclipse.dash&a=org.eclipse.dash.licenses&v=1.0.2'
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-backend
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -20,6 +20,6 @@
 <Project>
   <PropertyGroup>
     <VersionPrefix>1.8.0</VersionPrefix>
-    <VersionSuffix>RC7</VersionSuffix>
+    <VersionSuffix></VersionSuffix>
   </PropertyGroup>
 </Project>
diff --git a/src/keycloak/Keycloak.Library/Models/Clients/ClientConfig.cs b/src/keycloak/Keycloak.Library/Models/Clients/ClientConfig.cs
@@ -2,8 +2,8 @@
  * MIT License
  *
  * Copyright (c) 2019 Luk Vermeulen
- * Copyright (c) 2021, 2023 BMW Group AG
- * Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2021, 2024 BMW Group AG
+ * Copyright (c) 2021, 2024 Contributors to the Eclipse Foundation
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -46,4 +46,7 @@ public class ClientConfig
     public string? FriendlyName { get; set; }
     [JsonProperty("attribute.name")]
     public string? AttributeName { get; set; }
+
+    [JsonProperty("user.session.note")]
+    public string? UserSessionNote { get; set; }
 }
diff --git a/src/keycloak/Keycloak.Library/Models/ProtocolMappers/Config.cs b/src/keycloak/Keycloak.Library/Models/ProtocolMappers/Config.cs
@@ -2,8 +2,8 @@
  * MIT License
  *
  * Copyright (c) 2019 Luk Vermeulen
- * Copyright (c) 2021, 2023 BMW Group AG
- * Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2021, 2024 BMW Group AG
+ * Copyright (c) 2021, 2024 Contributors to the Eclipse Foundation
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -64,4 +64,7 @@ public class Config
     public string? IncludedClientAudience { get; set; }
     [JsonProperty("multivalued")]
     public string? Multivalued { get; set; }
+
+    [JsonProperty("user.session.note")]
+    public string? UserSessionNote { get; set; }
 }
diff --git a/src/keycloak/Keycloak.Seeding/BusinessLogic/ClientsUpdater.cs b/src/keycloak/Keycloak.Seeding/BusinessLogic/ClientsUpdater.cs
@@ -232,5 +232,6 @@ private static bool CompareClientProtocolMapperConfig(ClientConfig config, IRead
         config.ClaimName == update.GetValueOrDefault("claim.name") &&
         config.JsonTypelabel == update.GetValueOrDefault("jsonType.label") &&
         config.FriendlyName == update.GetValueOrDefault("friendly.name") &&
-        config.AttributeName == update.GetValueOrDefault("attribute.name");
+        config.AttributeName == update.GetValueOrDefault("attribute.name") &&
+        config.UserSessionNote == update.GetValueOrDefault("user.session.note");
 }
diff --git a/src/keycloak/Keycloak.Seeding/BusinessLogic/ProtocolMappersUpdater.cs b/src/keycloak/Keycloak.Seeding/BusinessLogic/ProtocolMappersUpdater.cs
@@ -1,6 +1,6 @@
 /********************************************************************************
- * Copyright (c) 2021, 2023 BMW Group AG
- * Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation
+ * Copyright (c) 2021, 2024 BMW Group AG
+ * Copyright (c) 2021, 2024 Contributors to the Eclipse Foundation
  *
  * See the NOTICE file(s) distributed with this work for additional
  * information regarding copyright ownership.
@@ -63,7 +63,8 @@ private static Config CreateProtocolMapperConfig(IReadOnlyDictionary<string, str
             UserAttributeRegion = update.GetValueOrDefault("user.attribute.region"),
             UserAttributeLocality = update.GetValueOrDefault("user.attribute.locality"),
             IncludedClientAudience = update.GetValueOrDefault("included.client.audience"),
-            Multivalued = update.GetValueOrDefault("multivalued")
+            Multivalued = update.GetValueOrDefault("multivalued"),
+            UserSessionNote = update.GetValueOrDefault("user.session.note"),
         };
 
     private static bool CompareProtocolMapperConfig(Config config, IReadOnlyDictionary<string, string> update) =>
@@ -83,5 +84,6 @@ private static bool CompareProtocolMapperConfig(Config config, IReadOnlyDictiona
             config.UserAttributeRegion == update.GetValueOrDefault("user.attribute.region") &&
             config.UserAttributeLocality == update.GetValueOrDefault("user.attribute.locality") &&
             config.IncludedClientAudience == update.GetValueOrDefault("included.client.audience") &&
-            config.Multivalued == update.GetValueOrDefault("multivalued");
+            config.Multivalued == update.GetValueOrDefault("multivalued") &&
+            config.UserSessionNote == update.GetValueOrDefault("user.session.note");
 }