docs: deprecate DAPS module (#4538)

* docs: deprecate DAPS module * pr remark
eclipse-edc · Oct 10, 2024 · 48cee15 · 48cee15
1 parent 5bc8a21
commit 48cee15
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 0 deletions.
diff --git a/docs/developer/decision-records/2024-10-10-daps-deprecation/README.md b/docs/developer/decision-records/2024-10-10-daps-deprecation/README.md
@@ -0,0 +1,14 @@
+# DAPS module deprecation
+
+## Decision
+
+We will stop publishing DAPS related module.
+
+## Rationale
+
+Shifting toward decentralized identity model though the adoption of Decentralized Claims Protocol as the protocol to be
+used, makes DAPS obsolete, and maintaining it is an unneeded effort by the EDC committer group.
+
+## Approach
+
+The `oauth2-daps` has been deprecated in EDC version 0.10.0 and it  be removed without further warnings in the subsequent versions.
diff --git a/docs/developer/decision-records/README.md b/docs/developer/decision-records/README.md
@@ -64,3 +64,5 @@
 - [2024-09-25 Multiple Protocol Versions](./2024-09-25-multiple-protocol-versions)
 - [2024-10-02 Clustered data-plane](./2024-10-02-clustered-data-plane/)
 - [2024-10-06 Typed Policy Scopes through Contexts](./2024-10-05-typed-policy-context)
+- [2024-10-10 DAPS module deprecation](./2024-10-10-daps-deprecation)
+
diff --git a/...uth2/oauth2-core/src/main/java/org/eclipse/edc/iam/oauth2/identity/Oauth2ServiceImpl.java b/...uth2/oauth2-core/src/main/java/org/eclipse/edc/iam/oauth2/identity/Oauth2ServiceImpl.java
@@ -42,7 +42,10 @@
 
 /**
  * Implements the OAuth2 client credentials flow and bearer token validation.
+ *
+ * @deprecated will be removed in the next versions.
  */
+@Deprecated(since = "0.10.0")
 public class Oauth2ServiceImpl implements IdentityService {
 
     private static final String GRANT_TYPE = "client_credentials";

diff --git a/...n/iam/oauth2/oauth2-daps/src/main/java/org/eclipse/edc/iam/oauth2/daps/DapsExtension.java b/...n/iam/oauth2/oauth2-daps/src/main/java/org/eclipse/edc/iam/oauth2/daps/DapsExtension.java
@@ -25,8 +25,11 @@
 
 /**
  * Provides specialization of Oauth2 extension to interact with DAPS instance
+ *
+ * @deprecated will be removed in the next versions.
  */
 @Extension(value = DapsExtension.NAME)
+@Deprecated(since = "0.10.0")
 public class DapsExtension implements ServiceExtension {
 
     public static final String NAME = "DAPS";
@@ -45,6 +48,7 @@ public String name() {
 
     @Override
     public void initialize(ServiceExtensionContext context) {
+        context.getMonitor().warning("The extension %s has been deprecated, please switch to a decentralized implementation".formatted(NAME));
         jwtDecoratorRegistry.register(OAUTH_2_DAPS_TOKEN_CONTEXT, new DapsJwtDecorator());
     }
 

diff --git a/...am/oauth2/oauth2-daps/src/main/java/org/eclipse/edc/iam/oauth2/daps/DapsJwtDecorator.java b/...am/oauth2/oauth2-daps/src/main/java/org/eclipse/edc/iam/oauth2/daps/DapsJwtDecorator.java
@@ -17,6 +17,7 @@
 import org.eclipse.edc.spi.iam.TokenParameters;
 import org.eclipse.edc.token.spi.TokenDecorator;
 
+@Deprecated(since = "0.10.0")
 public class DapsJwtDecorator implements TokenDecorator {
 
     @Override

diff --git a/.../oauth2/oauth2-daps/src/main/java/org/eclipse/edc/iam/oauth2/daps/DapsTokenDecorator.java b/.../oauth2/oauth2-daps/src/main/java/org/eclipse/edc/iam/oauth2/daps/DapsTokenDecorator.java
@@ -20,7 +20,10 @@
 
 /**
  * Token decorator that sets the {@code scope} claim on the token that is used on DSP request egress
+ *
+ * @deprecated will be removed in the upcoming versions.
  */
+@Deprecated(since = "0.10.0")
 public class DapsTokenDecorator implements TokenDecorator {
     private final String scope;