47 implement token enrollment via validatecheck (#52)

lukasmatusiewicz · web-flow · commit 7280def6b9a9 · 2023-01-13T14:34:42.000+01:00
* Update challenge and consts with image

* implement imgs

* Update the tests

* Update WebAuthn.java

* Update PIResponse.java

* Make possible to get the challenge's image

* Update TestWebAuthn.java

* Update TestU2F.java

* Update tests

* Update JSONParser.java

* rm redundant function

* Update pom.xml

* get the image from each challenge

* Test to get the image

* Update TestWebAuthn.java

* update tests

* parse the client_mode

* optimize imports
diff --git a/pom.xml b/pom.xml
@@ -23,7 +23,6 @@
                     <skipTests>false</skipTests>
                 </configuration>
             </plugin>
-
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
@@ -45,7 +44,6 @@
                     </execution>
                 </executions>
             </plugin>
-
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
@@ -55,7 +53,6 @@
                     <target>1.8</target>
                 </configuration>
             </plugin>
-
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
@@ -86,26 +83,22 @@
             <version>4.13.2</version>
             <scope>test</scope>
         </dependency>
-
         <dependency>
             <groupId>com.squareup.okhttp3</groupId>
             <artifactId>okhttp</artifactId>
             <version>4.10.0</version>
         </dependency>
-
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
-            <version>2.10</version>
+            <version>2.10.1</version>
         </dependency>
-
         <dependency>
             <groupId>org.mock-server</groupId>
             <artifactId>mockserver-netty-no-dependencies</artifactId>
             <version>5.14.0</version>
             <scope>test</scope>
         </dependency>
-
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-simple</artifactId>
diff --git a/src/main/java/org/privacyidea/Challenge.java b/src/main/java/org/privacyidea/Challenge.java
@@ -22,15 +22,17 @@ public class Challenge
 {
     private final List<String> attributes = new ArrayList<>();
     private final String serial;
+    private final String client_mode;
     private final String message;
-    private final String image;
     private final String transaction_id;
     private final String type;
+    private final String image;
 
-    public Challenge(String serial, String message, String image, String transaction_id, String type)
+    public Challenge(String serial, String message, String client_mode, String image, String transaction_id, String type)
     {
         this.serial = serial;
         this.message = message;
+        this.client_mode = client_mode;
         this.image = image;
         this.transaction_id = transaction_id;
         this.type = type;
@@ -50,6 +52,7 @@ public String getMessage()
     {
         return message;
     }
+    public String getClientMode() { return client_mode; }
 
     public String getImage() { return image.replaceAll("\"", ""); }
 
diff --git a/src/main/java/org/privacyidea/Endpoint.java b/src/main/java/org/privacyidea/Endpoint.java
@@ -26,14 +26,11 @@
 import javax.net.ssl.SSLSocketFactory;
 import javax.net.ssl.TrustManager;
 import javax.net.ssl.X509TrustManager;
-
-import okhttp3.Call;
 import okhttp3.Callback;
 import okhttp3.FormBody;
 import okhttp3.HttpUrl;
 import okhttp3.OkHttpClient;
 import okhttp3.Request;
-import okhttp3.internal.connection.RealCall;
 
 import static org.privacyidea.PIConstants.GET;
 import static org.privacyidea.PIConstants.HEADER_USER_AGENT;
diff --git a/src/main/java/org/privacyidea/JSONParser.java b/src/main/java/org/privacyidea/JSONParser.java
@@ -12,20 +12,19 @@
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Objects;
 
 import static org.privacyidea.PIConstants.ASSERTIONCLIENTEXTENSIONS;
 import static org.privacyidea.PIConstants.ATTRIBUTES;
 import static org.privacyidea.PIConstants.AUTHENTICATION;
 import static org.privacyidea.PIConstants.AUTHENTICATORDATA;
 import static org.privacyidea.PIConstants.CLIENTDATA;
+import static org.privacyidea.PIConstants.CLIENT_MODE;
 import static org.privacyidea.PIConstants.CODE;
 import static org.privacyidea.PIConstants.CREDENTIALID;
 import static org.privacyidea.PIConstants.DETAIL;
 import static org.privacyidea.PIConstants.ERROR;
 import static org.privacyidea.PIConstants.ID;
 import static org.privacyidea.PIConstants.IMAGE;
-import static org.privacyidea.PIConstants.IMG;
 import static org.privacyidea.PIConstants.INFO;
 import static org.privacyidea.PIConstants.JSONRPC;
 import static org.privacyidea.PIConstants.MAXFAIL;
@@ -229,23 +228,24 @@ else if ("interactive".equals(modeFromResponse))
                                                         .getAsJsonObject();
                     String serial = getString(challenge, SERIAL);
                     String message = getString(challenge, MESSAGE);
-                    String image = getItemFromAttributes(IMG, challenge).replaceAll("\"", "");
+                    String clientmode = getString(challenge, CLIENT_MODE);
+                    String image = getString (challenge, IMAGE);
                     String transactionid = getString(challenge, TRANSACTION_ID);
                     String type = getString(challenge, TYPE);
 
                     if (TOKEN_TYPE_WEBAUTHN.equals(type))
                     {
                         String webAuthnSignRequest = getItemFromAttributes(WEBAUTHN_SIGN_REQUEST, challenge);
-                        response.multichallenge.add(new WebAuthn(serial, message, image, transactionid, webAuthnSignRequest));
+                        response.multichallenge.add(new WebAuthn(serial, message, clientmode, image, transactionid, webAuthnSignRequest));
                     }
                     else if (TOKEN_TYPE_U2F.equals(type))
                     {
                         String u2fSignRequest = getItemFromAttributes(U2F_SIGN_REQUEST, challenge);
-                        response.multichallenge.add(new U2F(serial, message, image, transactionid, u2fSignRequest));
+                        response.multichallenge.add(new U2F(serial, message, clientmode, image, transactionid, u2fSignRequest));
                     }
                     else
                     {
-                        response.multichallenge.add(new Challenge(serial, message, image, transactionid, type));
+                        response.multichallenge.add(new Challenge(serial, message, clientmode, image, transactionid, type));
                     }
                 }
             }
diff --git a/src/main/java/org/privacyidea/PIConfig.java b/src/main/java/org/privacyidea/PIConfig.java
@@ -15,9 +15,6 @@
  */
 package org.privacyidea;
 
-import java.util.ArrayList;
-import java.util.List;
-
 class PIConfig
 {
     String serverURL = "";
diff --git a/src/main/java/org/privacyidea/PIConstants.java b/src/main/java/org/privacyidea/PIConstants.java
@@ -64,8 +64,8 @@ private PIConstants()
     public static final String TOKEN = "token";
     public static final String PREFERRED_CLIENT_MODE = "preferred_client_mode";
     public static final String MESSAGE = "message";
+    public static final String CLIENT_MODE = "client_mode";
     public static final String IMAGE = "image";
-    public static final String IMG = "img";
     public static final String MESSAGES = "messages";
     public static final String MULTI_CHALLENGE = "multi_challenge";
     public static final String ATTRIBUTES = "attributes";
diff --git a/src/main/java/org/privacyidea/PIResponse.java b/src/main/java/org/privacyidea/PIResponse.java
@@ -107,14 +107,6 @@ public List<String> triggeredTokenTypes()
                              .collect(Collectors.toList());
     }
 
-    /**
-     * @return a list of challenges that were triggered or an empty list if none were triggered
-     */
-    public List<Challenge> multiChallenge()
-    {
-        return multichallenge;
-    }
-
     /**
      * Get all WebAuthn challenges from the multi_challenge.
      *
diff --git a/src/main/java/org/privacyidea/PrivacyIDEA.java b/src/main/java/org/privacyidea/PrivacyIDEA.java
@@ -44,7 +44,6 @@
 import static org.privacyidea.PIConstants.POST;
 import static org.privacyidea.PIConstants.REALM;
 import static org.privacyidea.PIConstants.SERIAL;
-import static org.privacyidea.PIConstants.IMAGE;
 import static org.privacyidea.PIConstants.TRANSACTION_ID;
 import static org.privacyidea.PIConstants.TYPE;
 import static org.privacyidea.PIConstants.USER;
diff --git a/src/main/java/org/privacyidea/U2F.java b/src/main/java/org/privacyidea/U2F.java
@@ -19,9 +19,9 @@ public class U2F extends Challenge
 {
     private final String signRequest;
 
-    public U2F(String serial, String message, String image, String transaction_id, String signRequest)
+    public U2F(String serial, String message, String client_mode, String image, String transaction_id, String signRequest)
     {
-        super(serial, message, image, transaction_id, PIConstants.TOKEN_TYPE_U2F);
+        super(serial, message, client_mode, image, transaction_id, PIConstants.TOKEN_TYPE_U2F);
         this.signRequest = signRequest;
     }
 
diff --git a/src/main/java/org/privacyidea/WebAuthn.java b/src/main/java/org/privacyidea/WebAuthn.java
@@ -15,16 +15,13 @@
  */
 package org.privacyidea;
 
-import java.util.Collections;
-import java.util.Map;
-
 public class WebAuthn extends Challenge
 {
     private final String signRequest;
 
-    public WebAuthn(String serial, String message, String image, String transaction_id, String signRequest)
+    public WebAuthn(String serial, String message, String client_mode, String image, String transaction_id, String signRequest)
     {
-        super(serial, message, image, transaction_id, PIConstants.TOKEN_TYPE_WEBAUTHN);
+        super(serial, message, client_mode, image, transaction_id, PIConstants.TOKEN_TYPE_WEBAUTHN);
         this.signRequest = signRequest;
     }
 
diff --git a/src/test/java/org/privacyidea/TestPollTransaction.java b/src/test/java/org/privacyidea/TestPollTransaction.java
@@ -64,7 +64,7 @@ public void testPushSynchronous() throws InterruptedException
                                     "        \"transaction_id\": \"02659936574063359702\",\n" + "        \"type\": \"hotp\"\n" +
                                     "      },\n" + "      {\n" + "        \"attributes\": null,\n" +
                                     "        \"message\": \"Please confirm the authentication on your mobile device!\",\n" +
-                                    "        \"serial\": \"PIPU0001F75E\",\n" +
+                                    "        \"serial\": \"PIPU0001F75E\",\n" + "        \"image\": \"dataimage\",\n" +
                                     "        \"transaction_id\": \"02659936574063359702\",\n" + "        \"type\": \"push\"\n" +
                                     "      }\n" + "    ],\n" + "    \"serial\": \"PIPU0001F75E\",\n" +
                                     "    \"threadid\": 140040525666048,\n" + "    \"transaction_id\": \"02659936574063359702\",\n" +
@@ -79,7 +79,7 @@ public void testPushSynchronous() throws InterruptedException
         PIResponse initialResponse = privacyIDEA.validateCheck(username, null);
 
         // Check the triggered challenges - the other things are already tested in org.privacyidea.TestOTP
-        List<Challenge> challenges = initialResponse.multiChallenge();
+        List<Challenge> challenges = initialResponse.multichallenge;
 
         Challenge hotpChallenge = challenges.stream().filter(c -> c.getSerial().equals("OATH00020121")).findFirst()
                                             .orElse(null);
@@ -100,6 +100,19 @@ public void testPushSynchronous() throws InterruptedException
         assertEquals("push", pushChallenge.getType());
         assertTrue(pushChallenge.getAttributes().isEmpty());
 
+        String imagePush = "";
+        for (Challenge c : challenges)
+        {
+            if ("push".equals(c.getType()))
+            {
+                if (!c.getImage().isEmpty())
+                {
+                    imagePush = c.getImage();
+                }
+            }
+        }
+        assertEquals("dataimage", imagePush);
+
         List<String> triggeredTypes = initialResponse.triggeredTokenTypes();
         assertTrue(triggeredTypes.contains("push"));
         assertTrue(triggeredTypes.contains("hotp"));
diff --git a/src/test/java/org/privacyidea/TestRollout.java b/src/test/java/org/privacyidea/TestRollout.java
@@ -134,7 +134,7 @@ public void testRolloutViaValidateCheck()
         privacyIDEA = PrivacyIDEA.newBuilder("https://127.0.0.1:1080", "test").sslVerify(false)
                                  .logger(new PILogImplementation()).build();
 
-        String img = "data:image/png;base64,iVBdgfgsdfgRK5CYII=";
+        String image = "data:image/png;base64,iVBdgfgsdfgRK5CYII=";
 
         String response = "{\"detail\":{" + "\"attributes\":null," + "\"message\":\"BittegebenSieeinenOTP-Wertein:\"," +
                           "\"image\": \"data:image/png;base64,iVBdgfgsdfgRK5CYII=\",\n" +
@@ -156,7 +156,7 @@ public void testRolloutViaValidateCheck()
         String username = "testuser";
         PIResponse responseValidateCheck = privacyIDEA.validateCheck(username, "");
 
-        assertEquals(img, responseValidateCheck.image);
+        assertEquals(image, responseValidateCheck.image);
     }
 
     @After
diff --git a/src/test/java/org/privacyidea/TestTriggerChallenge.java b/src/test/java/org/privacyidea/TestTriggerChallenge.java
@@ -15,6 +15,7 @@
  */
 package org.privacyidea;
 
+import java.util.List;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
@@ -52,7 +53,8 @@ public void testTriggerChallengeSuccess()
                           "\"messages\":[\"BittegebenSieeinenOTP-Wertein:\"]," + "\"multi_challenge\":[{" +
                           "\"attributes\":null," + "\"message\":\"BittegebenSieeinenOTP-Wertein:\"," +
                           "\"serial\":\"TOTP00021198\"," + "\"transaction_id\":\"16734787285577957577\"," +
-                          "\"type\":\"totp\"}]," + "\"serial\":\"TOTP00021198\"," + "\"threadid\":140050885818112," +
+                          "\"image\":\"dataimage\"," + "\"type\":\"totp\"}]," +
+                          "\"serial\":\"TOTP00021198\"," + "\"threadid\":140050885818112," +
                           "\"transaction_id\":\"16734787285577957577\"," +
                           "\"transaction_ids\":[\"16734787285577957577\"]," + "\"type\":\"totp\"}," + "\"id\":1," +
                           "\"jsonrpc\":\"2.0\"," + "\"result\":{" + "\"status\":true," + "\"value\":false}," +
@@ -103,6 +105,20 @@ public void testTriggerChallengeSuccess()
         // result
         assertTrue(responseTriggerChallenge.status);
         assertFalse(responseTriggerChallenge.value);
+
+        List<Challenge> challenges = responseTriggerChallenge.multichallenge;
+        String imageTOTP = "";
+        for (Challenge c : challenges)
+        {
+            if ("totp".equals(c.getType()))
+            {
+                if (!c.getImage().isEmpty())
+                {
+                    imageTOTP = c.getImage();
+                }
+            }
+        }
+        assertEquals("dataimage", imageTOTP);
     }
 
     @Test
diff --git a/src/test/java/org/privacyidea/TestU2F.java b/src/test/java/org/privacyidea/TestU2F.java
@@ -27,11 +27,9 @@
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 import static org.privacyidea.PIConstants.TOKEN_TYPE_U2F;
-import static org.privacyidea.PIConstants.TOKEN_TYPE_WEBAUTHN;
 
 public class TestU2F
 {
@@ -101,7 +99,7 @@ public void testTriggerU2F()
         assertTrue(response.status);
         assertFalse(response.value);
 
-        Optional<Challenge> opt = response.multiChallenge().stream()
+        Optional<Challenge> opt = response.multichallenge.stream()
                                           .filter(challenge -> TOKEN_TYPE_U2F.equals(challenge.getType()))
                                           .findFirst();
         if (opt.isPresent())
diff --git a/src/test/java/org/privacyidea/TestValidateCheckSerial.java b/src/test/java/org/privacyidea/TestValidateCheckSerial.java
@@ -15,7 +15,6 @@
  */
 package org.privacyidea;
 
-import java.util.Collections;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
diff --git a/src/test/java/org/privacyidea/TestWebAuthn.java b/src/test/java/org/privacyidea/TestWebAuthn.java
@@ -120,12 +120,13 @@ public void testTriggerWebAuthn()
                 "      \"Please confirm with your WebAuthn token (Yubico U2F EE Serial 61730834)\"\n" + "    ],\n" +
                 "    \"multi_challenge\": [\n" + "      {\n" + "        \"attributes\": {\n" +
                 "          \"hideResponseInput\": true,\n" +
-                "          \"img\": \"static/img/FIDO-U2F-Security-Key-444x444.png\",\n" +
                 "          \"webAuthnSignRequest\": " + webauthnrequest + "        },\n" +
-                "        \"message\": \"Please confirm with your WebAuthn token (Yubico U2F EE Serial 61730834)\",\n" +
-                "        \"serial\": \"WAN00025CE7\",\n" + "        \"transaction_id\": \"16786665691788289392\",\n" +
-                "        \"type\": \"webauthn\"\n" + "      }\n" + "    ],\n" + "    \"serial\": \"WAN00025CE7\",\n" +
-                "    \"threadid\": 140040275289856,\n" + "    \"transaction_id\": \"16786665691788289392\",\n" +
+                "          \"image\": \"static/img/FIDO-U2F-Security-Key-444x444.png\",\n" +
+                "          \"client_mode\": \"webauthn\",\n" +
+                "          \"message\": \"Please confirm with your WebAuthn token (Yubico U2F EE Serial 61730834)\",\n" +
+                "          \"serial\": \"WAN00025CE7\",\n" + "        \"transaction_id\": \"16786665691788289392\",\n" +
+                "          \"type\": \"webauthn\"\n" + "      }\n" + "    ],\n" + "    \"serial\": \"WAN00025CE7\",\n" +
+                "    \"threadid\": 140040275289856,\n"  + "    \"transaction_id\": \"16786665691788289392\",\n" +
                 "    \"transaction_ids\": [\n" + "      \"16786665691788289392\"\n" + "    ],\n" +
                 "    \"type\": \"webauthn\"\n" + "  },\n" + "  \"id\": 1,\n" + "  \"jsonrpc\": \"2.0\",\n" +
                 "  \"result\": {\n" + "    \"authentication\": \"CHALLENGE\",\n" + "    \"status\": true,\n" +
@@ -139,7 +140,7 @@ public void testTriggerWebAuthn()
 
         PIResponse response = privacyIDEA.validateCheck(username, pass);
 
-        Optional<Challenge> opt = response.multiChallenge().stream()
+        Optional<Challenge> opt = response.multichallenge.stream()
                                           .filter(challenge -> TOKEN_TYPE_WEBAUTHN.equals(challenge.getType()))
                                           .findFirst();
         assertTrue(opt.isPresent());
@@ -152,6 +153,7 @@ public void testTriggerWebAuthn()
             String trimmedRequest = webauthnrequest.replaceAll("\n", "").replaceAll(" ", "");
             assertEquals(trimmedRequest, b.signRequest());
             assertEquals("static/img/FIDO-U2F-Security-Key-444x444.png", b.getImage());
+            assertEquals("webauthn", b.getClientMode());
         }
         else
         {

Original file line number	Diff line number	Diff line change
`@@ -22,15 +22,17 @@ public class Challenge`
`22`	`22`	`{`
`23`	`23`	`private final List<String> attributes = new ArrayList<>();`
`24`	`24`	`private final String serial;`
	`25`	`+ private final String client_mode;`
`25`	`26`	`private final String message;`
`26`		`- private final String image;`
`27`	`27`	`private final String transaction_id;`
`28`	`28`	`private final String type;`
	`29`	`+ private final String image;`
`29`	`30`
`30`		`- public Challenge(String serial, String message, String image, String transaction_id, String type)`
	`31`	`+ public Challenge(String serial, String message, String client_mode, String image, String transaction_id, String type)`
`31`	`32`	`{`
`32`	`33`	`this.serial = serial;`
`33`	`34`	`this.message = message;`
	`35`	`+ this.client_mode = client_mode;`
`34`	`36`	`this.image = image;`
`35`	`37`	`this.transaction_id = transaction_id;`
`36`	`38`	`this.type = type;`
`@@ -50,6 +52,7 @@ public String getMessage()`
`50`	`52`	`{`
`51`	`53`	`return message;`
`52`	`54`	`}`
	`55`	`+ public String getClientMode() { return client_mode; }`
`53`	`56`
`54`	`57`	`public String getImage() { return image.replaceAll("\"", ""); }`
`55`	`58`
Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,6 @@`
`15`	`15`	`*/`
`16`	`16`	`package org.privacyidea;`
`17`	`17`
`18`		`-import java.util.ArrayList;`
`19`		`-import java.util.List;`
`20`		`-`
`21`	`18`	`class PIConfig`
`22`	`19`	`{`
`23`	`20`	`String serverURL = "";`
Original file line number	Diff line number	Diff line change
`@@ -107,14 +107,6 @@ public List<String> triggeredTokenTypes()`
`107`	`107`	`.collect(Collectors.toList());`
`108`	`108`	`}`
`109`	`109`
`110`		`- /**`
`111`		`- * @return a list of challenges that were triggered or an empty list if none were triggered`
`112`		`- */`
`113`		`- public List<Challenge> multiChallenge()`
`114`		`- {`
`115`		`- return multichallenge;`
`116`		`- }`
`117`		`-`
`118`	`110`	`/**`
`119`	`111`	`* Get all WebAuthn challenges from the multi_challenge.`
`120`	`112`	`*`
Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,9 @@ public class U2F extends Challenge`
`19`	`19`	`{`
`20`	`20`	`private final String signRequest;`
`21`	`21`
`22`		`- public U2F(String serial, String message, String image, String transaction_id, String signRequest)`
	`22`	`+ public U2F(String serial, String message, String client_mode, String image, String transaction_id, String signRequest)`
`23`	`23`	`{`
`24`		`- super(serial, message, image, transaction_id, PIConstants.TOKEN_TYPE_U2F);`
	`24`	`+ super(serial, message, client_mode, image, transaction_id, PIConstants.TOKEN_TYPE_U2F);`
`25`	`25`	`this.signRequest = signRequest;`
`26`	`26`	`}`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -15,16 +15,13 @@`
`15`	`15`	`*/`
`16`	`16`	`package org.privacyidea;`
`17`	`17`
`18`		`-import java.util.Collections;`
`19`		`-import java.util.Map;`
`20`		`-`
`21`	`18`	`public class WebAuthn extends Challenge`
`22`	`19`	`{`
`23`	`20`	`private final String signRequest;`
`24`	`21`
`25`		`- public WebAuthn(String serial, String message, String image, String transaction_id, String signRequest)`
	`22`	`+ public WebAuthn(String serial, String message, String client_mode, String image, String transaction_id, String signRequest)`
`26`	`23`	`{`
`27`		`- super(serial, message, image, transaction_id, PIConstants.TOKEN_TYPE_WEBAUTHN);`
	`24`	`+ super(serial, message, client_mode, image, transaction_id, PIConstants.TOKEN_TYPE_WEBAUTHN);`
`28`	`25`	`this.signRequest = signRequest;`
`29`	`26`	`}`
`30`	`27`