From 56ee7d7b065e436c43803148ac41be1ca0dfd87e Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Tue, 9 Jul 2024 14:29:22 +0200
Subject: [PATCH] Add new SOPGPException types related to hardware modules

---
 .../kotlin/sop/exception/SOPGPException.kt    | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/sop-java/src/main/kotlin/sop/exception/SOPGPException.kt b/sop-java/src/main/kotlin/sop/exception/SOPGPException.kt
index 2473258..bc9131f 100644
--- a/sop-java/src/main/kotlin/sop/exception/SOPGPException.kt
+++ b/sop-java/src/main/kotlin/sop/exception/SOPGPException.kt
@@ -305,4 +305,36 @@ abstract class SOPGPException : RuntimeException {
             const val EXIT_CODE = 89
         }
     }
+
+    /**
+     * The sop implementation supports some form of hardware-backed secret keys, but could not
+     * identify the hardware device.
+     */
+    class NoHardwareKeyFound : SOPGPException {
+        constructor() : super()
+
+        constructor(errorMsg: String) : super(errorMsg)
+
+        override fun getExitCode(): Int = EXIT_CODE
+
+        companion object {
+            const val EXIT_CODE = 97
+        }
+    }
+
+    /**
+     * The sop implementation tried to use a hardware-backed secret key, but the cryptographic
+     * hardware refused the operation for some reason other than a bad PIN or password.
+     */
+    class HardwareKeyFailure : SOPGPException {
+        constructor() : super()
+
+        constructor(errorMsg: String) : super(errorMsg)
+
+        override fun getExitCode(): Int = EXIT_CODE
+
+        companion object {
+            const val EXIT_CODE = 101
+        }
+    }
 }