Merge pull request #113 from algolia/feature/apikey-remaining-validity

getSecuredApiKeyRemainingValidity

Author: q-litzler

src/commonMain/kotlin/com/algolia/search/client/ClientSearch.kt

@@ -3,13 +3,11 @@ package com.algolia.search.client
 import com.algolia.search.configuration.*
 import com.algolia.search.dsl.requestOptionsBuilder
 import com.algolia.search.endpoint.*
+import com.algolia.search.helper.decodeBase64
 import com.algolia.search.helper.encodeBase64
 import com.algolia.search.helper.sha256
 import com.algolia.search.helper.toAPIKey
-import com.algolia.search.model.APIKey
-import com.algolia.search.model.ApplicationID
-import com.algolia.search.model.IndexName
-import com.algolia.search.model.LogType
+import com.algolia.search.model.*
 import com.algolia.search.model.apikey.SecuredAPIKeyRestriction
 import com.algolia.search.model.response.ResponseAPIKey
 import com.algolia.search.model.response.ResponseBatches
@@ -173,5 +171,26 @@ public class ClientSearch private constructor(
 
             return "$hash$restrictionString".encodeBase64().toAPIKey()
         }
+
+        /**
+         * Gets how many milliseconds are left before the secured API key expires.
+         *
+         * @param apiKey The secured API Key to check.
+         * @return Milliseconds left before the secured API key expires.
+         * @throws IllegalArgumentException if [apiKey] doesn't have a [SecuredAPIKeyRestriction.validUntil].
+         */
+        public fun getSecuredApiKeyRemainingValidity(apiKey: APIKey): Long {
+            val decoded = apiKey.raw.decodeBase64()
+            val pattern = Regex("validUntil=(\\d+)")
+            val match = pattern.find(decoded)
+
+            return if (match != null) {
+                val timestamp = match.groupValues[1].toLong()
+
+                timestamp - Time.getCurrentTimeMillis()
+            } else {
+                throw IllegalArgumentException("The Secured API Key doesn't have a validUntil parameter.");
+            }
+        }
     }
 }

src/commonMain/kotlin/com/algolia/search/helper/Hashing.kt

@@ -3,4 +3,6 @@ package com.algolia.search.helper
 
 internal expect fun String.sha256(key: String): String
 
-internal expect fun String.encodeBase64(): String
+internal expect fun String.encodeBase64(): String
+
+internal expect fun String.decodeBase64(): String

src/commonMain/kotlin/com/algolia/search/model/apikey/APIKey.kt

@@ -0,0 +1,13 @@
+package com.algolia.search.model.apikey
+
+import com.algolia.search.client.ClientSearch
+import com.algolia.search.model.APIKey
+
+
+public fun APIKey.getSecuredApiKeyRemainingValidity(): Long {
+    return ClientSearch.getSecuredApiKeyRemainingValidity(this)
+}
+
+public fun APIKey.generateSecuredAPIKey(restriction: SecuredAPIKeyRestriction): APIKey {
+    return ClientSearch.generateAPIKey(this, restriction)
+}

src/commonTest/kotlin/suite/TestSecuredAPIKey.kt

@@ -3,13 +3,18 @@ package suite
 import clientAdmin1
 import clientSearch
 import com.algolia.search.client.ClientSearch
+import com.algolia.search.model.APIKey
+import com.algolia.search.model.IndexName
 import com.algolia.search.model.Time
 import com.algolia.search.model.apikey.SecuredAPIKeyRestriction
+import com.algolia.search.model.apikey.generateSecuredAPIKey
+import com.algolia.search.model.apikey.getSecuredApiKeyRemainingValidity
 import com.algolia.search.model.task.TaskStatus
 import com.algolia.search.serialize.KeyObjectID
 import io.ktor.client.features.ResponseException
 import kotlinx.serialization.json.json
 import runBlocking
+import shouldBeTrue
 import shouldEqual
 import shouldFailWith
 import kotlin.test.BeforeTest
@@ -53,4 +58,36 @@ internal class TestSecuredAPIKey {
             }
         }
     }
+
+    @Test
+    fun expiredKey() {
+        val restrictions = SecuredAPIKeyRestriction(
+            validUntil = Time.getCurrentTimeMillis() - 600,
+            restrictIndices = listOf(IndexName("index"))
+        )
+        val key = APIKey("parentKey").generateSecuredAPIKey(restrictions)
+
+        (key.getSecuredApiKeyRemainingValidity() < 0).shouldBeTrue()
+    }
+
+    @Test
+    fun validKey() {
+        val restrictions = SecuredAPIKeyRestriction(
+            validUntil = Time.getCurrentTimeMillis() + 600,
+            restrictIndices = listOf(IndexName("index"))
+        )
+        val key = APIKey("parentKey").generateSecuredAPIKey(restrictions)
+
+        (key.getSecuredApiKeyRemainingValidity() > 0).shouldBeTrue()
+    }
+
+    @Test
+    fun remainingValidityParameter() {
+        val restrictions = SecuredAPIKeyRestriction(
+            restrictIndices = listOf(IndexName("index"))
+        )
+        val key = APIKey("parentKey").generateSecuredAPIKey(restrictions)
+
+        shouldFailWith<IllegalArgumentException> { key.getSecuredApiKeyRemainingValidity() }
+    }
 }

src/jvmMain/kotlin/com/algolia/search/helper/Hashing.kt

@@ -19,4 +19,8 @@ internal actual fun String.sha256(key: String): String {
 
 internal actual fun String.encodeBase64(): String {
     return String(Base64.getEncoder().encode(toByteArray()))
+}
+
+internal actual fun String.decodeBase64(): String {
+    return String(Base64.getDecoder().decode(this))
 }