Add custom return code handler for initialization call

Author: ReneeVandervelde

multiplatform-crypto-libsodium-bindings/src/commonMain/kotlin/com.ionspin.kotlin.crypto/GeneralLibsodiumException.kt

@@ -2,7 +2,7 @@ package com.ionspin.kotlin.crypto
 
 import com.ionspin.kotlin.crypto.util.isLibsodiumSuccessCode
 
-class GeneralLibsodiumException : RuntimeException("Libsodium reported error! Returned value was -1") {
+class GeneralLibsodiumException(message: String) : RuntimeException(message) {
     companion object {
         /**
          * Throws a [GeneralLibsodiumException] if the return code is not
@@ -12,7 +12,7 @@ class GeneralLibsodiumException : RuntimeException("Libsodium reported error! Re
          */
         fun Int.ensureLibsodiumSuccess() {
             if (!isLibsodiumSuccessCode()) {
-                throw GeneralLibsodiumException()
+                throw GeneralLibsodiumException("Libsodium reported error! Returned value was -1")
             }
         }
     }

multiplatform-crypto-libsodium-bindings/src/commonMain/kotlin/com.ionspin.kotlin.crypto/LibsodiumInitializer.kt

@@ -10,3 +10,21 @@ expect object LibsodiumInitializer {
 
     fun initializeWithCallback(done: () -> (Unit))
 }
+
+/**
+ * Ensures a successful response from the Libsodium init call.
+ *
+ * The init call has a slightly different return pattern, documented as:
+ *
+ *     sodium_init() returns 0 on success, -1 on failure, and 1 if the library had already been initialized.
+ *
+ * This function will throw if anything other than 0 or 1 is returned.
+ */
+internal fun Int.ensureInitSuccess() {
+    when (this) {
+        0, 1 -> {
+            // no-op: both successful responses
+        }
+        else -> throw GeneralLibsodiumException("Libsodium initialization failed with code: $this")
+    }
+}

multiplatform-crypto-libsodium-bindings/src/jvmMain/kotlin/com/ionspin/kotlin/crypto/LibsodiumInitializer.kt

@@ -50,13 +50,13 @@ actual object LibsodiumInitializer {
     lateinit var sodiumJna : JnaLibsodiumInterface
     actual suspend fun initialize() {
         sodiumJna = loadLibrary()
-        sodiumJna.sodium_init().ensureLibsodiumSuccess()
+        sodiumJna.sodium_init().ensureInitSuccess()
         isPlatformInitialized = true
     }
 
     actual fun initializeWithCallback(done: () -> Unit) {
         sodiumJna = loadLibrary()
-        sodiumJna.sodium_init().ensureLibsodiumSuccess()
+        sodiumJna.sodium_init().ensureInitSuccess()
         isPlatformInitialized = true
         done()
     }

multiplatform-crypto-libsodium-bindings/src/nativeMain/kotlin/com/ionspin/kotlin/crypto/LibsodiumInitializer.kt

@@ -12,15 +12,15 @@ actual object LibsodiumInitializer {
 
     actual suspend fun initialize() {
         if (isPlatformInitialized.compareAndSet(0, 1)) {
-            sodium_init().ensureLibsodiumSuccess()
+            sodium_init().ensureInitSuccess()
         }
 
 
     }
 
     actual fun initializeWithCallback(done: () -> Unit) {
         if (isPlatformInitialized.compareAndSet(0, 1)) {
-            sodium_init().ensureLibsodiumSuccess()
+            sodium_init().ensureInitSuccess()
         }
         done()
     }