(feat): Added SHA 256 & 512 Algorithm

Author: N3v1

Sources/CryptoSwiftWrapper/CryptoSwiftWrapper.h

@@ -18,4 +18,12 @@
 //                                                                            //
 //===----------------------------------------------------------------------===//
 
+#ifndef CryptoSwiftWrapper_h
+#define CryptoSwiftWrapper_h
+
 #include "CryptoSwiftWrapper/cyfn.h"
+#include "CryptoSwiftWrapper/sha256.h"
+#include "CryptoSwiftWrapper/sha512.h"
+#include "CryptoSwiftWrapper/sha.h"
+
+#endif /* CryptoSwiftWrapper_h */

Sources/CryptoSwiftWrapper/Documentation.docc/CYErrors.md

@@ -8,18 +8,42 @@ The CYErrors constants provide a standardized way to handle errors encountered d
 
 ### Error Codes
 
-#### `CY_ERR_GENKEY` (-100)
+#### `CY_ERR_GENKEY` (-1)
 
 Error code indicating key generation failure.
 
-#### `CY_ERR_ENCR` (-101)
+#### `CY_ERR_ENCR` (-2)
 
 Error code indicating encryption failure.
 
-#### `CY_ERR_DECR` (-102)
+#### `CY_ERR_DECR` (-3)
 
 Error code indicating decryption failure.
 
-#### `CY_ERR_INIT` (-103)
+#### `CY_ERR_INIT` (-4)
 
 Error code indicating initialization failure.
+
+#### `CY_ERR_SHA256_NULL_PTR` (-6)
+
+Error code indicating a null pointer error in SHA256 operations.
+
+#### `CY_ERR_SHA256_INVALID_LEN` (-7)
+
+Error code indicating an invalid length error in SHA256 operations.
+
+#### `SHA512_NULL_INPUT` (-8)
+
+Error code indicating null input parameter in SHA512 operations.
+
+#### `SHA512_NULL_OUTPUT` (-9)
+
+Error code indicating null output parameter in SHA512 operations.
+
+#### `SHA512_MEMORY_ERROR` (-10)
+
+Error code indicating memory allocation failure in SHA512 operations.
+
+#### `SHA512_INVALID_LENGTH` (-11)
+
+Error code indicating invalid input length in SHA512 operations.

Sources/CryptoSwiftWrapper/Documentation.docc/Documentation.md

@@ -40,3 +40,7 @@ Prefer CryptoSwiftWrapper for its simplicity and integration with Swift. It abst
 
 - ``encrypt_data(plaintext:plaintext_len:key:iv:ciphertext:)``
 - ``decrypt_data(ciphertext:ciphertext_len:key:iv:tag:tag_len:plaintext:)``
+
+### SHA 256 & 512
+
+- <doc:SHA_IMPL>

Sources/CryptoSwiftWrapper/Documentation.docc/SHA_IMPL.md

@@ -0,0 +1,32 @@
+# SHA Algorithm Implementation
+
+Implementing SHA hashing algorithm functions in both C and Swift
+
+## Overview
+
+The SHA-256 and SHA-512 algorithms are implemented in C within this package to provide robust cryptographic hashing functionalities. These algorithms ensure data integrity and security through their respective 256-bit and 512-bit hash outputs.
+
+### Key Components
+
+- **Constants and Macros:** The implementations utilize predefined constants and macros for bitwise operations and block processing, enhancing efficiency and clarity in the code.
+- **Message Schedule Processing:** Both algorithms employ a message schedule structure (`SHA256_Message_Schedule` and `SHA512_Message_Schedule`) to manage data flow and perform iterative hash computations over data blocks.
+
+- **Compression Function:** The `sha256_compress` and `sha512_compress` functions handle the core compression steps, combining message schedule data with current state values to produce updated hash values.**
+
+- **Error Handling:** Custom error codes (`SHA512_NULL_INPUT`, `SHA512_NULL_OUTPUT`, `SHA512_MEMORY_ERROR`, `SHA512_INVALID_LENGTH`, etc.) are defined to manage exceptional scenarios like null inputs, memory allocation failures, and invalid data lengths.
+
+These SHA implementations are integrated into larger systems requiring secure hash computations, such as cryptographic protocols, digital signatures, and data integrity verification mechanisms. They provide essential tools for ensuring data confidentiality and authenticity in software applications.
+
+### Background
+SHA-256 is a widely-used cryptographic hash function that generates a 256-bit hash value, ensuring data integrity and security in various applications. Implemented efficiently in C, it employs bitwise operations and constants to process data blocks, providing robust hashing capabilities.
+
+Whereas SHA-256 is more often used SHA-512 is a stronger variant of SHA-256, producing a 512-bit hash value. Its implementation in C utilizes similar principles but operates on larger data blocks, enhancing security and resistance to cryptographic attacks. It supports applications requiring higher security standards and larger hash outputs.
+
+@Comment {
+### Implementation
+
+@TabNavigator {
+    @Tab("Swift") {}
+    @Tab("C") {}
+}
+}

Sources/CryptoSwiftWrapper/include/sha.h

@@ -0,0 +1,29 @@
+//===-- CryptoSwiftWrapper/include/sha.h - Bridging ------------  -*- C -*-===//
+//                                                                            //
+// This source file is part of the Scribble Foundation open source project    //
+//                                                                            //
+// Copyright (c) 2024 ScribbleLabApp. and the ScribbleLab project authors     //
+// Licensed under Apache License v2.0 with Runtime Library Exception          //
+//                                                                            //
+// You may not use this file except in compliance with the License.           //
+// You may obtain a copy of the License at                                    //
+//                                                                            //
+//      http://www.apache.org/licenses/LICENSE-2.0                            //
+//                                                                            //
+// 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.                                             //
+//                                                                            //
+//===----------------------------------------------------------------------===//
+
+// This is a bridging header for SHA 256 and 512 implementations
+
+#ifndef sha_h
+#define sha_h
+
+#include "sha256.h"
+#include "sha512.h"
+
+#endif /* sha_h */

Sources/CryptoSwiftWrapper/include/sha256.h

@@ -0,0 +1,29 @@
+//===-- CryptoSwiftWrapper/include/sha256.h - Bridging ---------  -*- C -*-===//
+//                                                                            //
+// This source file is part of the Scribble Foundation open source project    //
+//                                                                            //
+// Copyright (c) 2024 ScribbleLabApp. and the ScribbleLab project authors     //
+// Licensed under Apache License v2.0 with Runtime Library Exception          //
+//                                                                            //
+// You may not use this file except in compliance with the License.           //
+// You may obtain a copy of the License at                                    //
+//                                                                            //
+//      http://www.apache.org/licenses/LICENSE-2.0                            //
+//                                                                            //
+// 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.                                             //
+//                                                                            //
+//===----------------------------------------------------------------------===//
+
+// This is a bridging header for sha256.h to be usable from "CryptoSwiftWrapper/sha256.h"
+
+#ifndef sha256_h
+#define sha256_h
+
+// Include the original _cyfn/sha256.h header
+#include "_cyfn/sha256.h"
+
+#endif /* sha256_h */

Sources/CryptoSwiftWrapper/include/sha512.h

@@ -0,0 +1,29 @@
+//===-- CryptoSwiftWrapper/include/sha512.h - Bridging ---------  -*- C -*-===//
+//                                                                            //
+// This source file is part of the Scribble Foundation open source project    //
+//                                                                            //
+// Copyright (c) 2024 ScribbleLabApp. and the ScribbleLab project authors     //
+// Licensed under Apache License v2.0 with Runtime Library Exception          //
+//                                                                            //
+// You may not use this file except in compliance with the License.           //
+// You may obtain a copy of the License at                                    //
+//                                                                            //
+//      http://www.apache.org/licenses/LICENSE-2.0                            //
+//                                                                            //
+// 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.                                             //
+//                                                                            //
+//===----------------------------------------------------------------------===//
+
+// This is a bridging header for sha256.h to be usable from "CryptoSwiftWrapper/sha512.h"
+
+#ifndef sha512_h
+#define sha512_h
+
+// Include the original _cyfn/sha512.h header
+#include "_cyfn/sha512.h"
+
+#endif /* sha512_h */

Sources/_cyfn/cyfn.h

@@ -56,11 +56,11 @@
 #define AES_KEY_SIZE 256
 #define AES_BLOCK_SIZE 16
 
-#define CY_ERR_GENKEY -100          ///< Error code indicating key generation failure.
-#define CY_ERR_ENCR -101            ///< Error code indicating encryption failure.
-#define CY_ERR_DECR -102            ///< Error code indicating decryption failure.
-#define CY_ERR_INIT -103            ///< Error code indicating initialization failure.
-#define CY_ERR_OSSL -104            ///< Error code indicating an OpenSSL error.
+#define CY_ERR_GENKEY -1            ///< Error code indicating key generation failure.
+#define CY_ERR_ENCR -2              ///< Error code indicating encryption failure.
+#define CY_ERR_DECR -3              ///< Error code indicating decryption failure.
+#define CY_ERR_INIT -4              ///< Error code indicating initialization failure.
+#define CY_ERR_OSSL -5              ///< Error code indicating an OpenSSL error.
 
 #ifdef __cplusplus
 extern "C" {

Sources/_cyfn/cyfnBridging.h

@@ -0,0 +1,15 @@
+//
+//  Header.h
+//  
+//
+//  Created by Nevio Hirani on 17.07.24.
+//
+
+#ifndef cyfnBridging_h
+#define cyfnBridging_h
+
+#include "cyfn.h"
+#include "sha256.h"
+#include "sha512.h"
+
+#endif /* cyfnBridging_h */

Sources/_cyfn/module.modulemap

@@ -1,5 +1,5 @@
 
 module _cyfn {
-    header "cyfn.h"
+    header "cyfnBridging.h"
     export *
 }