AESError is now AES.Error

Author: Fernando Fernandes

Sources/AESCryptable/AES.swift

@@ -43,7 +43,7 @@ public struct AES {
     public init(keyString: String) throws {
 
         guard keyString.count == kCCKeySizeAES256 else {
-            throw AESError.invalidKeySize
+            throw AES.Error.invalidKeySize
         }
 
         self.key = Data(keyString.utf8)

Sources/AESCryptable/AESCryptable.swift

@@ -33,7 +33,7 @@ extension AES: Cryptable {
                         guard let keyBytesBaseAddress = keyBytes.baseAddress,
                             let dataToEncryptBytesBaseAddress = dataToEncryptBytes.baseAddress,
                             let bufferBytesBaseAddress = bufferBytes.baseAddress else {
-                                throw AESError.encryptionFailed
+                                throw Error.encryptionFailed
                         }
 
                         let cryptStatus: CCCryptorStatus = CCCrypt( // Stateless, one-shot encrypt operation
@@ -51,13 +51,13 @@ extension AES: Cryptable {
                         )
 
                         guard cryptStatus == CCCryptorStatus(kCCSuccess) else {
-                            throw AESError.encryptionFailed
+                            throw Error.encryptionFailed
                         }
                     }
                 }
             }
         } catch {
-            throw AESError.encryptionFailed
+            throw Error.encryptionFailed
         }
 
         let encryptedData: Data = buffer[..<(numberBytesEncrypted + ivSize)]
@@ -81,7 +81,7 @@ extension AES: Cryptable {
                         guard let keyBytesBaseAddress = keyBytes.baseAddress,
                             let dataToDecryptBytesBaseAddress = dataToDecryptBytes.baseAddress,
                             let bufferBytesBaseAddress = bufferBytes.baseAddress else {
-                                throw AESError.encryptionFailed
+                                throw Error.encryptionFailed
                         }
 
                         let cryptStatus: CCCryptorStatus = CCCrypt( // Stateless, one-shot encrypt operation
@@ -99,19 +99,19 @@ extension AES: Cryptable {
                         )
 
                         guard cryptStatus == CCCryptorStatus(kCCSuccess) else {
-                            throw AESError.decryptionFailed
+                            throw Error.decryptionFailed
                         }
                     }
                 }
             }
         } catch {
-            throw AESError.encryptionFailed
+            throw Error.encryptionFailed
         }
 
         let decryptedData: Data = buffer[..<numberBytesDecrypted]
 
         guard let decryptedString = String(data: decryptedData, encoding: .utf8) else {
-            throw AESError.dataToStringFailed
+            throw Error.dataToStringFailed
         }
 
         return decryptedString

Sources/AESCryptable/AESError.swift

@@ -9,6 +9,29 @@
 import Foundation
 import CommonCrypto
 
+// MARK: - Public Extension
+
+public extension AES {
+
+    /// Encapsulates errors that may occur during AES encrypt / decrypt operations.
+    ///
+    /// - invalidKeySize: The given key `String` count isn't equal to `kCCKeySizeAES256`.
+    /// - emptyStringToEncrypt: The given `String` to encrypt is empty.
+    /// - generateRandomIVFailed: Could not generate a random `iv` via `SecRandomCopyBytes(_:_:_:)`.
+    /// - encryptDataFailed: `CCCryptorStatus` was different than `kCCSuccess` during an encryption operation.
+    /// - stringToDataFailed: Failed to convert `String` into `Data` via `data(using:allowLossyConversion:)`.
+    /// - decryptDataFailed: `CCCryptorStatus` was different than `kCCSuccess` during a decryption operation.
+    /// - dataToStringFailed: Failed to convert `Data` into `String`. E.g.: via `String.init(bytes:encoding:)`.
+    enum Error: Swift.Error {
+        case invalidKeySize
+        case emptyStringToEncrypt
+        case generateRandomIVFailed
+        case encryptionFailed
+        case decryptionFailed
+        case dataToStringFailed
+    }
+}
+
 // MARK: - Internal Extension
 
 internal extension AES {
@@ -23,7 +46,7 @@ internal extension AES {
         try data.withUnsafeMutableBytes { dataBytes in
 
             guard let dataBytesBaseAddress = dataBytes.baseAddress else {
-                throw AESError.generateRandomIVFailed
+                throw Error.generateRandomIVFailed
             }
 
             let status: Int32 = SecRandomCopyBytes(
@@ -33,7 +56,7 @@ internal extension AES {
             )
 
             guard status == 0 else {
-                throw AESError.generateRandomIVFailed
+                throw Error.generateRandomIVFailed
             }
         }
     }

Sources/AESCryptable/AESExtension.swift

@@ -7,7 +7,7 @@ final class AESTests: XCTestCase {
         do {
             let _ = try AES(keyString: "banana")
         } catch {
-            guard let aesError = error as? AESError else {
+            guard let aesError = error as? AES.Error else {
                 XCTFail("Unexpected error: \(error)")
                 return
             }
@@ -30,7 +30,7 @@ final class AESTests: XCTestCase {
             let aes = try AES(keyString: "C_5};5fHV(v3M&h{m]6h_p[z[4h@ZWM$")
             let _ = try aes.encrypt(stringToEncrypt)
         } catch {
-            guard let aesError = error as? AESError else {
+            guard let aesError = error as? AES.Error else {
                 XCTFail("Unexpected error: \(error)")
                 return
             }
@@ -75,7 +75,7 @@ final class AESTests: XCTestCase {
             let _ = try aesIncorrectKey.decrypt(encryptedData)
 
         } catch {
-            guard let aesError = error as? AESError else {
+            guard let aesError = error as? AES.Error else {
                 XCTFail("Unexpected error: \(error)")
                 return
             }