Merge pull request #68 from privacyidea/67-update-poll-transaction-function

67 update poll transaction function

Author: lukasmatusiewicz

src/main/java/org/privacyidea/ChallengeStatus.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2024 NetKnights GmbH - lukas.matusiewicz@netknights.it
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License here:
+ * <a href="http://www.apache.org/licenses/LICENSE-2.0">License</a>
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.privacyidea;
+
+public enum ChallengeStatus
+{
+    accept, declined, pending, none
+}

src/main/java/org/privacyidea/JSONParser.java

@@ -129,11 +129,11 @@ public PIResponse parsePIResponse(String serverResponse)
         if (result != null)
         {
             String r = getString(result, AUTHENTICATION);
-            for (AuthenticationStatus en : AuthenticationStatus.values())
+            for (AuthenticationStatus as: AuthenticationStatus.values())
             {
-                if (en.toString().equals(r))
+                if (as.toString().equals(r))
                 {
-                    response.authentication = en;
+                    response.authentication = as;
                 }
             }
             response.status = getBoolean(result, STATUS);
@@ -174,6 +174,15 @@ else if ("interactive".equals(modeFromResponse))
             response.type = getString(detail, TYPE);
             response.otpLength = getInt(detail, OTPLEN);
 
+            String r = getString(detail, CHALLENGE_STATUS);
+            for (ChallengeStatus cs: ChallengeStatus.values())
+            {
+                if (cs.toString().equals(r))
+                {
+                    response.challengeStatus = cs;
+                }
+            }
+
             JsonArray arrMessages = detail.getAsJsonArray(MESSAGES);
             if (arrMessages != null)
             {

src/main/java/org/privacyidea/PIConstants.java

@@ -50,6 +50,7 @@ private PIConstants()
     public static final String PASSWORD = "password";
     public static final String PASS = "pass";
     public static final String SERIAL = "serial";
+    public static final String CHALLENGE_STATUS = "challenge_status";
     public static final String TYPE = "type";
     public static final String TRANSACTION_ID = "transaction_id";
     public static final String REALM = "realm";

src/main/java/org/privacyidea/PIResponse.java

@@ -36,6 +36,7 @@ public class PIResponse
     public List<Challenge> multiChallenge = new ArrayList<>();
     public String transactionID = "";
     public String serial = "";
+    public ChallengeStatus challengeStatus = ChallengeStatus.none;
     public String image = "";
     public int id = 0;
     public String jsonRPCVersion = "";

src/main/java/org/privacyidea/PrivacyIDEA.java

@@ -229,17 +229,17 @@ public PIResponse triggerChallenges(String username, Map<String, String> headers
      * Poll for status of the given transaction ID once.
      *
      * @param transactionID transaction ID to poll for
-     * @return the status value, true or false
+     * @return the challenge status or "ChallengeStatus.none" if error
      */
-    public boolean pollTransaction(String transactionID)
+    public ChallengeStatus pollTransaction(String transactionID)
     {
         Objects.requireNonNull(transactionID, "TransactionID is required!");
 
         Map<String, String> params = new LinkedHashMap<>();
         params.put(TRANSACTION_ID, transactionID);
         String response = runRequestAsync(ENDPOINT_POLLTRANSACTION, params, Collections.emptyMap(), false, GET);
         PIResponse piresponse = this.parser.parsePIResponse(response);
-        return piresponse.value;
+        return piresponse.challengeStatus;
     }
 
     /**

src/test/java/org/privacyidea/TestPollTransaction.java

@@ -18,6 +18,8 @@
 
 import java.util.List;
 import java.util.concurrent.TimeUnit;
+
+import org.jetbrains.annotations.NotNull;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
@@ -111,19 +113,27 @@ public void testPushSynchronous() throws InterruptedException
 
         assertEquals(2, initialResponse.messages.size());
 
-        // Set the server up to respond to the polling requests twice with false
-        setPollTransactionResponse(false, 2);
+        // Set the server up to respond to the polling requests twice with "pending"
+        setPollTransactionResponse(ChallengeStatus.pending, 2);
 
-        // Polling is controlled by the code using the sdk
+        // Polling is controlled by the code using the java-client
         for (int i = 0; i < 2; i++)
         {
-            assertFalse(privacyIDEA.pollTransaction(initialResponse.transactionID));
+            assertEquals(privacyIDEA.pollTransaction(initialResponse.transactionID), ChallengeStatus.pending);
             Thread.sleep(500);
         }
 
-        // Set the server to respond with true
-        setPollTransactionResponse(true, 1);
-        assertTrue(privacyIDEA.pollTransaction(initialResponse.transactionID));
+        // Set the server to respond with "declined"
+        setPollTransactionResponse(ChallengeStatus.declined, 1);
+        assertEquals(privacyIDEA.pollTransaction(initialResponse.transactionID), ChallengeStatus.declined);
+
+        // Set the server to respond with "accept"
+        setPollTransactionResponse(ChallengeStatus.accept, 1);
+        assertEquals(privacyIDEA.pollTransaction(initialResponse.transactionID), ChallengeStatus.accept);
+
+        // Set the server to respond with "none" by not including or invalid challenge_status parameter
+        setPollTransactionResponse(ChallengeStatus.none, 1);
+        assertEquals(privacyIDEA.pollTransaction(initialResponse.transactionID), ChallengeStatus.none);
 
         // Now the transaction has to be finalized manually
         setFinalizationResponse(initialResponse.transactionID);
@@ -148,25 +158,39 @@ private void setFinalizationResponse(String transactionID)
                                        .withBody(Utils.foundMatchingChallenge()));
     }
 
-    private void setPollTransactionResponse(boolean value, int times)
+    private void setPollTransactionResponse(ChallengeStatus challengeStatus, int times)
     {
-        String val = value ? "true" : "false";
+        String challengeStatusParameter = getChallengeStatusParameter(challengeStatus);
         mockServer.when(HttpRequest.request()
                                    .withMethod("GET")
                                    .withPath("/validate/polltransaction")
                                    .withQueryStringParameter("transaction_id", "02659936574063359702"), Times.exactly(times))
                   .respond(HttpResponse.response()
-                                       .withBody("{\n" + "    \"id\": 1,\n" + "    \"jsonrpc\": \"2.0\",\n" +
-                                                 "    \"result\": {\n" + "        \"status\": true,\n" +
-                                                 "        \"value\": " + val + "\n" + "    },\n" +
-                                                 "    \"time\": 1589446811.1909237,\n" +
-                                                 "    \"version\": \"privacyIDEA 3.2.1\",\n" +
-                                                 "    \"versionnumber\": \"3.2.1\",\n" +
-                                                 "    \"signature\": \"rsa_sha256_pss:\"\n" + "}")
+                                       .withBody("{\n\"id\": 1,\n\"jsonrpc\": \"2.0\",\n" + challengeStatusParameter +
+                                                 "\"result\": {\n\"status\": true\n},\n\"time\": 1589446811.1909237,\n\"version\": \"privacyIDEA 3.2.1\",\n" +
+                                                 "\"versionnumber\": \"3.2.1\",\n\"signature\": \"rsa_sha256_pss:\"\n}")
                                        .withDelay(TimeUnit.MILLISECONDS, 50));
     }
 
+    private static @NotNull String getChallengeStatusParameter(ChallengeStatus challengeStatus)
+    {
+        String challengeStatusParameter = "";
+        if (challengeStatus == ChallengeStatus.accept)
+        {
+            challengeStatusParameter = "\"detail\": {\n\"challenge_status\": \"accept\"\n},\n";
+        }
+        else if (challengeStatus == ChallengeStatus.declined)
+        {
+            challengeStatusParameter = "\"detail\": {\n\"challenge_status\": \"declined\"\n},\n";
 
+        }
+        else if (challengeStatus == ChallengeStatus.pending)
+        {
+            challengeStatusParameter = "\"detail\": {\n\"challenge_status\": \"pending\"\n},\n";
+        }
+        return challengeStatusParameter;
+    }
+    
     @After
     public void tearDown()
     {