Merge branch 'main' into feat/214-Dataspace-Discovery-Service-handle-…

…multiple-EDC-Urls-received-for-BPN # Conflicts: # CHANGELOG.md
eclipse-tractusx · Jan 26, 2024 · 9a53cfd · 9a53cfd
2 parents 90995dd + e7a1d01
commit 9a53cfd
Show file tree

Hide file tree

Showing 22 changed files with 1,166 additions and 825 deletions.
diff --git a/.config/owasp-suppressions.xml b/.config/owasp-suppressions.xml
@@ -28,4 +28,11 @@
         <packageUrl regex="true">^pkg:maven/org\.graalvm\.sdk/graal\-sdk@.*$</packageUrl>
         <vulnerabilityName>CVE-2023-22006</vulnerabilityName>
     </suppress>
+    <suppress>
+        <notes><![CDATA[
+        Only used in tests.
+        ]]></notes>
+        <packageUrl regex="true">^pkg:maven/com.jayway.jsonpath/[email protected]$</packageUrl>
+        <vulnerabilityName>CVE-2023-51074</vulnerabilityName>
+    </suppress>
 </suppressions>
diff --git a/.gitignore b/.gitignore
@@ -62,3 +62,11 @@ local/testing/api-tests/__pycache__/
 
 ### Cucumber ###
 /irs-cucumber-tests/report.json
+
+### Local documentation build ###
+node_modules
+docs/src/diagram-replacer/generated-adocs
+docs/src/diagram-replacer/package-lock.json
+docs/src/diagram-replacer/package.json
+docs/src/diagram-replacer/plantuml.jar
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,6 +2,16 @@
 
 Thanks for your interest in this project.
 
+# Table of Contents
+1. [Project description](#project-description)
+2. [Developer resources](#developer-resources)
+3. [Eclipse Development Process](#eclipse-development-process)
+4. [Eclipse Contributor Agreement](#eclipse-contributor-agreement)
+5. [General contribution to the project](#general-contribution-to-the-project)
+6. [Contributing as a Consultant](#contributing-as-a-consultant)
+7. [Contributing as a Developer](#contributing-as-a-developer)
+9. [Contact](#contact)
+
 ## Project description
 
 The companies involved want to increase the automotive industry's
@@ -53,7 +63,7 @@ fulfills the DCO's requirement that you sign-off on your contributions.
 For more information, please see the Eclipse Committer Handbook:
 https://www.eclipse.org/projects/handbook/#resources-commit
 
-# Eclipse Dependency License Check
+## Eclipse Dependency License Check
 
 In case of new dependencies or version updates, it might be necessary to have the new library checked and accepted by the Eclipse foundation. Do create new tickets for this, you can use this command:
 ```
@@ -62,6 +72,45 @@ mvn org.eclipse.dash:license-tool-plugin:license-check -Ddash.iplab.token=$ECLIP
 
 For more information on the tool and how to acquire the token, check https://github.com/eclipse/dash-licenses.
 
+## General contribution to the project
+
+
+## Contributing as a Consultant
+
+### Conceptual work and specification guidelines
+1. The prerequisite for a concept is always a github issue that defines the business value and the acceptance criteria that are to be implemented with the concept
+2. Copy and rename directory /docs/#000-concept-name-template /docs/#<DDD>-<target-name>
+3. Copy file /docs/Concept_TEMPLATE.md into new directory  /docs/#<DDD>-<target-name>
+
+### Diagrams
+PlantUML and Mermaid is used for conceptual work.
+https://mermaid.js.org/
+https://plantuml.com/
+
+
+#### PlantUML 
+default skinparam for plantUml diagrams 
+````
+@startuml
+skinparam monochrome true
+skinparam shadowing false
+skinparam linetype ortho
+skinparam defaultFontName "Architects daughter"
+autonumber "<b>[000]"
+
+@enduml
+````
+
+####  Mermaid
+Default header for mermaid sequence diagrams
+````
+sequenceDiagram
+    %%{init: {'theme': 'dark', 'themeVariables': { 'fontSize': '15px'}}}%%
+    autonumber
+ ````   
+
+## Contributing as a Developer
+
 ### Commit messages
 The commit messages have to match a pattern in the form of:  
 ``< type >(scope):[<Ticket_ID>] < description >``  
@@ -80,11 +129,13 @@ cp local/development/commit-msg .git/hooks/commit-msg && chmod 500 .git/hooks/co
 
 For further information please see https://github.com/hazcod/semantic-commit-hook
 
-## Code formatting 
+### Code formatting 
 Please use the following code formatter: [.idea/codeStyles](.idea/codeStyles)
 
+
 ## Contact
 
 Contact the project developers via the project's "dev" list.
 
 * https://accounts.eclipse.org/mailing-list/tractusx-dev
+* Eclipse Matrix Chat https://chat.eclipse.org/#/room/#tractusx-irs:matrix.eclipse.org
diff --git a/DEPENDENCIES b/DEPENDENCIES
diff --git a/charts/irs-helm/CHANGELOG.md b/charts/irs-helm/CHANGELOG.md
@@ -5,6 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Added configuration parameters `oauth2.semantics.clientId`,`oauth2.semantics.clientSecret`, `oauth2.discovery.clientId`,`oauth2.discovery.clientSecret`, `oauth2.bpdm.clientId`,`oauth2.bpdm.clientSecret`
+
+### Removed
+- Removed configuration parameters `oauth2.clientId`,`oauth2.clientSecret`, `portal.oauth2.clientId`,`portal.oauth2.clientSecret`
 
 ## [6.13.0] - 2024-01-15
 - Update IRS version to 4.4.0

diff --git a/charts/irs-helm/templates/configmap-spring-app-config.yaml b/charts/irs-helm/templates/configmap-spring-app-config.yaml
@@ -56,16 +56,21 @@ data:
         oauth2:
           client:
             registration:
-              common:
-                client-id: "${OAUTH2_CLIENT_ID}" # taken from secret ENV
-                client-secret: "${OAUTH2_CLIENT_SECRET}" # taken from secret ENV
-              portal:
-                client-id: ${PORTAL_OAUTH2_CLIENT_ID} # taken from secret ENV
-                client-secret: ${PORTAL_OAUTH2_CLIENT_SECRET} # taken from secret ENV
+              semantics:
+                client-id: "${SEMANTICS_OAUTH2_CLIENT_ID}" # taken from secret ENV
+                client-secret: "${SEMANTICS_OAUTH2_CLIENT_SECRET}" # taken from secret ENV
+              discovery:
+                client-id: ${DISCOVERY_OAUTH2_CLIENT_ID} # taken from secret ENV
+                client-secret: ${DISCOVERY_OAUTH2_CLIENT_SECRET} # taken from secret ENV
+              bpdm:
+                client-id: ${BPDM_OAUTH2_CLIENT_ID} # taken from secret ENV
+                client-secret: ${BPDM_OAUTH2_CLIENT_SECRET} # taken from secret ENV
             provider:
-              common:
+              semantics:
                 token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }}
-              portal:
+              discovery:
+                token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }}
+              bpdm:
                 token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }}
 
     digitalTwinRegistry:
@@ -129,7 +134,7 @@ data:
       irs:
         url: {{ tpl (.Values.irsUrl | default "") . | quote }}
       discovery:
-        oAuthClientId: {{ .Values.discovery.oAuthClientId | default "portal" }}
+        oAuthClientId: {{ .Values.discovery.oAuthClientId | default "discovery" }}
         {{- if .Values.ess.mockEdcResult }}
         mockEdcResult:
         {{- tpl (toYaml .Values.ess.mockEdcResult) . | nindent 10 }}

diff --git a/charts/irs-helm/templates/deployment.yaml b/charts/irs-helm/templates/deployment.yaml
@@ -81,26 +81,36 @@ spec:
                 secretKeyRef:
                   name: {{ template "irs.secretName" . }}
                   key: minioPassword
-            - name: OAUTH2_CLIENT_ID
+            - name: SEMANTICS_OAUTH2_CLIENT_ID
               valueFrom:
                 secretKeyRef:
                   name: {{ template "irs.secretName" . }}
-                  key: clientId
-            - name: OAUTH2_CLIENT_SECRET
+                  key: semanticsId
+            - name: SEMANTICS_OAUTH2_CLIENT_SECRET
               valueFrom:
                 secretKeyRef:
                   name: {{ template "irs.secretName" . }}
-                  key: clientSecret
-            - name: PORTAL_OAUTH2_CLIENT_ID
+                  key: semanticsSecret
+            - name: DISCOVERY_OAUTH2_CLIENT_ID
               valueFrom:
                 secretKeyRef:
                   name: {{ template "irs.secretName" . }}
-                  key: portalClientId
-            - name: PORTAL_OAUTH2_CLIENT_SECRET
+                  key: discoveryClientId
+            - name: DISCOVERY_OAUTH2_CLIENT_SECRET
               valueFrom:
                 secretKeyRef:
                   name: {{ template "irs.secretName" . }}
-                  key: portalClientSecret
+                  key: discoveryClientSecret
+            - name: BPDM_OAUTH2_CLIENT_ID
+              valueFrom:
+                secretKeyRef:
+                  name: {{ template "irs.secretName" . }}
+                  key: bpdmClientId
+            - name: BPDM_OAUTH2_CLIENT_SECRET
+              valueFrom:
+                secretKeyRef:
+                  name: {{ template "irs.secretName" . }}
+                  key: bpdmClientSecret
             - name: EDC_API_KEY_SECRET
               valueFrom:
                 secretKeyRef:

diff --git a/charts/irs-helm/templates/secrets.yaml b/charts/irs-helm/templates/secrets.yaml
@@ -35,10 +35,12 @@ type: Opaque
 data:
   minioUser: {{ .Values.minioUser | default "minio" | b64enc | quote }}
   minioPassword: {{ .Values.minioPassword | default "minioPass" | b64enc | quote }}
-  clientId: {{ .Values.oauth2.clientId | default "clientId" | b64enc | quote }}
-  clientSecret: {{ .Values.oauth2.clientSecret | default "clientSecret" | b64enc | quote }}
-  portalClientId: {{ .Values.portal.oauth2.clientId | default "portalClientId" | b64enc | quote }}
-  portalClientSecret: {{ .Values.portal.oauth2.clientSecret | default "portalClientSecret" | b64enc | quote }}
+  semanticsId: {{ .Values.oauth2.semantics.clientId | default "semanticsId" | b64enc | quote }}
+  semanticsSecret: {{ .Values.oauth2.semantics.clientSecret | default "semanticsSecret" | b64enc | quote }}
+  discoveryClientId: {{ .Values.oauth2.discovery.clientId | default "discoveryClientId" | b64enc | quote }}
+  discoveryClientSecret: {{ .Values.oauth2.discovery.clientSecret | default "discoveryClientSecret" | b64enc | quote }}
+  bpdmClientId: {{ .Values.oauth2.bpdm.clientId | default "bpdmClientId" | b64enc | quote }}
+  bpdmClientSecret: {{ .Values.oauth2.bpdm.clientSecret | default "bpdmClientSecret" | b64enc | quote }}
   edcApiSecret: {{ .Values.edc.controlplane.apikey.secret | toString | default "" | b64enc | quote }}
   {{- if .Values.grafana.enabled }}
   grafanaUser: {{ .Values.grafana.user | default "grafana" | b64enc | quote }}

diff --git a/charts/irs-helm/values.yaml b/charts/irs-helm/values.yaml
@@ -152,13 +152,16 @@ minioUser: "minio"  # <minio-username>
 minioPassword:  # <minio-password>
 minioUrl: "http://{{ .Release.Name }}-minio:9000"
 oauth2:
-  clientId:  # <oauth2-client-id>
-  clientSecret:  # <oauth2-client-secret>
   clientTokenUri:  # <oauth2-token-uri>
-portal:
-  oauth2:
-    clientId:  # <portal-client-id>
-    clientSecret:  # <portal-client-secret>
+  semantics:
+    clientId:  # <semantics-client-id>
+    clientSecret:  # <semantics-client-secret>
+  discovery:
+    clientId:  # <discovery-client-id>
+    clientSecret:  # <discovery-client-secret>
+  bpdm:
+    clientId:  # <bpdm-client-id>
+    clientSecret:  # <bpdm-client-secret>
 edc:
   controlplane:
     endpoint:
@@ -207,7 +210,7 @@ edc:
     cacheTTL: PT24H  # Time to live for ConnectorEndpointService for fetchConnectorEndpoints method cache
 
 discovery:
-  oAuthClientId: portal  # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client
+  oAuthClientId: discovery  # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client
 
 ess:
   edc: