Implements a feature to support the Submodel-based RBAC rules backend for the remaining components #574

mdanish98 · 2024-12-23T10:15:07Z

Description of Changes

Implements a feature to support the Submodel-based RBAC rules backend. This also includes the management of RBAC rules dynamically using the Submodel API. It separates the backend into InMemory and Submodel-based.

Similar to the already implemented module #407

The remaining modules except the AAS Discovery are implemented in this PR.

BaSyx Configuration for Testing

These extra configurations are required along with the current authorization configurations to configure the newly implemented feature:

basyx.feature.authorization.rules.backend=Submodel
basyx.feature.authorization.rules.backend.submodel.authorization.endpoint=<Endpoint of the Security Submodel>
basyx.feature.authorization.rules.backend.submodel.authorization.token-endpoint=<Token Endpoint>
basyx.feature.authorization.rules.backend.submodel.authorization.grant-type = <CLIENT_CREDENTIALS> or <PASSWORD>
basyx.feature.authorization.rules.backend.submodel.authorization.client-id=<client-id>
basyx.feature.authorization.rules.backend.submodel.authorization.client-secret=<client-secret>
basyx.feature.authorization.rules.backend.submodel.authorization.username=<username>
basyx.feature.authorization.rules.backend.submodel.authorization.password=<password>

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

aaronzi

Thank you for the PR. I added some remarks and questions.

aaronzi · 2025-01-08T14:48:36Z

...ment/feature/authorization/rbac/backend/submodel/AasEnvironmentTargetInformationAdapter.java

@@ -0,0 +1,134 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors


Suggested change

* Copyright (C) 2024 the Eclipse BaSyx Authors

* Copyright (C) 2025 the Eclipse BaSyx Authors

aaronzi · 2025-01-08T14:52:42Z

...ment/feature/authorization/rbac/backend/submodel/AasEnvironmentTargetInformationAdapter.java

+	public SubmodelElementCollection adapt(TargetInformation targetInformation) {
+
+		if (targetInformation instanceof AasTargetInformation)
+			return new AasTargetInformationAdapter().adapt(targetInformation);
+
+		if (targetInformation instanceof SubmodelTargetInformation)
+			return new SubmodelTargetInformationAdapter().adapt(targetInformation);
+
+		if (targetInformation instanceof ConceptDescriptionTargetInformation)
+			return new CDTargetInformationAdapter().adapt(targetInformation);
+
+		SubmodelElementCollection targetInformationSMC = new DefaultSubmodelElementCollection.Builder().idShort("targetInformation").build();
+
+		SubmodelElementList aasId = new DefaultSubmodelElementList.Builder().idShort("aasIds").build();
+		SubmodelElementList submodelId = new DefaultSubmodelElementList.Builder().idShort("submodelIds").build();
+		Property typeProperty = new DefaultProperty.Builder().idShort("@type").value("aas-environment").build();
+
+		List<SubmodelElement> aasIds = ((AasEnvironmentTargetInformation) targetInformation).getAasIds().stream().map(this::transform).collect(Collectors.toList());
+		List<SubmodelElement> submodelIds = ((AasEnvironmentTargetInformation) targetInformation).getSubmodelIds().stream().map(this::transform).collect(Collectors.toList());
+		aasId.setValue(aasIds);
+		submodelId.setValue(submodelIds);
+
+		targetInformationSMC.setValue(Arrays.asList(aasId, submodelId, typeProperty));
+
+		return targetInformationSMC;
+	}


You are handling ConceptDescriptionTargetInformation in L67-68 but in L72-73 you are only creating lists for aasIds and submodelIds. Are conceptDescriptionIds missing here?

aaronzi · 2025-01-08T14:53:26Z

...n/basyx/aasenvironment/feature/authorization/AasEnvironmentTargetInformationAdapterTest.java

@@ -0,0 +1,184 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors


Suggested change

* Copyright (C) 2024 the Eclipse BaSyx Authors

* Copyright (C) 2025 the Eclipse BaSyx Authors

aaronzi · 2025-01-08T14:55:19Z

...iptionrepository/feature/authorization/rbac/backend/submodel/CDTargetInformationAdapter.java

@@ -0,0 +1,114 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors


Suggested change

* Copyright (C) 2024 the Eclipse BaSyx Authors

* Copyright (C) 2025 the Eclipse BaSyx Authors

aaronzi · 2025-01-08T14:56:00Z

...iptionrepository/feature/authorization/rbac/backend/submodel/CDTargetInformationAdapter.java

+		SubmodelElementList aasId = new DefaultSubmodelElementList.Builder().idShort("conceptDescriptionIds").build();
+		Property typeProperty = new DefaultProperty.Builder().idShort("@type").value("concept-description").build();
+
+		List<SubmodelElement> aasIds = ((ConceptDescriptionTargetInformation) targetInformation)


Suggested change

List<SubmodelElement> aasIds = ((ConceptDescriptionTargetInformation) targetInformation)

List<SubmodelElement> cdIds = ((ConceptDescriptionTargetInformation) targetInformation)

aaronzi · 2025-01-08T14:58:54Z

...basyx/conceptdescriptionrepository/feature/authorization/CDTargetInformationAdapterTest.java

@@ -0,0 +1,161 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors


Suggested change

* Copyright (C) 2024 the Eclipse BaSyx Authors

* Copyright (C) 2025 the Eclipse BaSyx Authors

aaronzi · 2025-01-08T14:59:16Z

...ry/feature/authorization/rbac/backend/submodel/SubmodelRegistryTargetInformationAdapter.java

@@ -0,0 +1,101 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors


Suggested change

* Copyright (C) 2024 the Eclipse BaSyx Authors

* Copyright (C) 2025 the Eclipse BaSyx Authors

aaronzi · 2025-01-08T14:59:38Z

...lregistry/regression/feature/authorization/SubmodelRegistryTargetInformationAdapterTest.java

@@ -0,0 +1,155 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors


Suggested change

* Copyright (C) 2024 the Eclipse BaSyx Authors

* Copyright (C) 2025 the Eclipse BaSyx Authors

aaronzi · 2025-01-08T15:00:05Z

...repository/feature/authorization/rbac/backend/submodel/SubmodelTargetInformationAdapter.java

@@ -0,0 +1,109 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors


Suggested change

* Copyright (C) 2024 the Eclipse BaSyx Authors

* Copyright (C) 2025 the Eclipse BaSyx Authors

aaronzi · 2025-01-08T15:02:04Z

...win/basyx/submodelrepository/feature/authorization/SubmodelTargetInformationAdapterTest.java

@@ -0,0 +1,173 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors


Suggested change

* Copyright (C) 2024 the Eclipse BaSyx Authors

* Copyright (C) 2025 the Eclipse BaSyx Authors

mdanish98 added 21 commits September 19, 2024 15:59

Adds dynamic RBAC to SM/CD Rep, SM Reg, and AAS Environment

f30ffaf

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Reverts GitHub CI

f0bb5d1

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Attempts CI fix

af3ebe8

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Reverts GitHub CI

8afbe17

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Reverts GitHub CI

10f6622

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Adds shading plugin

4f0819e

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Adds dependency to parent pom

a72c3d1

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Excludes SM dependencies

86c6675

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Fixes the TargetInfoAdapter Bean in Aas Env

2b14d93

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Adds filtering options in Authorization

76d8012

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Fixes Keycloak issues

9d3ab3c

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Reverts BaSyx Realm

b3c3deb

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Fixes import issues in SM Registry

6ac4276

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Fixes app.prop of aas env

a1eb3c8

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Fixes CI

1327e88

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Fixes AAS and SM Reg tests

934ae77

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Allows swagger ui api endpoint without auth

089dc40

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Allows swagger ui api endpoint without auth

5ff95bf

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Allows Swagger API without authorization

5c7836a

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

Merge remote-tracking branch 'upstream/main' into feature/dyn-rbac-sm-cd

ea161c8

Refactors classes

84f7be8

Signed-off-by: Mohammad Ghazanfar Ali Danish <[email protected]>

mdanish98 mentioned this pull request Dec 23, 2024

Dynamic RBAC Management for SM/CD/AAS Discovery and Submodel Registry #568

Open

mdanish98 marked this pull request as ready for review January 8, 2025 10:15

aaronzi self-requested a review January 8, 2025 10:43

aaronzi requested changes Jan 8, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implements a feature to support the Submodel-based RBAC rules backend for the remaining components #574

Implements a feature to support the Submodel-based RBAC rules backend for the remaining components #574

mdanish98 commented Dec 23, 2024

aaronzi left a comment

aaronzi Jan 8, 2025

aaronzi Jan 8, 2025

aaronzi Jan 8, 2025

aaronzi Jan 8, 2025

aaronzi Jan 8, 2025

aaronzi Jan 8, 2025

aaronzi Jan 8, 2025

aaronzi Jan 8, 2025

aaronzi Jan 8, 2025

aaronzi Jan 8, 2025

		@@ -0,0 +1,134 @@
		/*******************************************************************************
		* Copyright (C) 2024 the Eclipse BaSyx Authors

	* Copyright (C) 2024 the Eclipse BaSyx Authors
	* Copyright (C) 2025 the Eclipse BaSyx Authors

		@@ -0,0 +1,184 @@
		/*******************************************************************************
		* Copyright (C) 2024 the Eclipse BaSyx Authors

		@@ -0,0 +1,114 @@
		/*******************************************************************************
		* Copyright (C) 2024 the Eclipse BaSyx Authors

	List<SubmodelElement> aasIds = ((ConceptDescriptionTargetInformation) targetInformation)
	List<SubmodelElement> cdIds = ((ConceptDescriptionTargetInformation) targetInformation)

		@@ -0,0 +1,161 @@
		/*******************************************************************************
		* Copyright (C) 2024 the Eclipse BaSyx Authors

		@@ -0,0 +1,101 @@
		/*******************************************************************************
		* Copyright (C) 2024 the Eclipse BaSyx Authors

		@@ -0,0 +1,155 @@
		/*******************************************************************************
		* Copyright (C) 2024 the Eclipse BaSyx Authors

		@@ -0,0 +1,109 @@
		/*******************************************************************************
		* Copyright (C) 2024 the Eclipse BaSyx Authors

		@@ -0,0 +1,173 @@
		/*******************************************************************************
		* Copyright (C) 2024 the Eclipse BaSyx Authors

Implements a feature to support the Submodel-based RBAC rules backend for the remaining components #574

Are you sure you want to change the base?

Implements a feature to support the Submodel-based RBAC rules backend for the remaining components #574

Conversation

mdanish98 commented Dec 23, 2024

Description of Changes

BaSyx Configuration for Testing

aaronzi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment