update README and inc file

Author: Xor-el

HashLib/src/Include/HashLibFPC.inc

@@ -12,9 +12,9 @@
 (* &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& *)
 
 {$IFDEF FPC}
-  // FPC 3.0.0 and Above
-  {$IF FPC_FULLVERSION < 30000}
-     {$MESSAGE ERROR 'This Library requires FreePascal 3.0.0 or higher.'}
+  // FPC 3.2.2 and Above
+  {$IF FPC_FULLVERSION < 30202}
+     {$MESSAGE ERROR 'This Library requires FreePascal 3.2.2 or higher.'}
   {$IFEND}
 
   {$IFDEF ENDIAN_BIG}

README.md

@@ -1,153 +1,236 @@
-HashLib4Pascal: Hashing for Modern Object Pascal [![License](http://img.shields.io/badge/license-MIT-green.svg)](https://github.com/Xor-el/HashLib4Pascal/blob/master/LICENSE)
-========================================
+# HashLib4Pascal
 
-``HashLib4Pascal`` is an Object Pascal hashing library released under the permissive [MIT License](https://github.com/Xor-el/HashLib4Pascal/blob/master/LICENSE) which provides an easy to use interface for computing hashes and checksums of data. It also supports state based (incremental) hashing.
+[![Build Status](https://github.com/Xor-el/HashLib4Pascal/actions/workflows/make.yml/badge.svg)](https://github.com/Xor-el/HashLib4Pascal/actions/workflows/make.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Xor-el/HashLib4Pascal/blob/master/LICENSE)
+[![Delphi](https://img.shields.io/badge/Delphi-2010%2B-red.svg)](https://www.embarcadero.com/products/delphi)
+[![FreePascal](https://img.shields.io/badge/FreePascal-3.2.2%2B-blue.svg)](https://www.freepascal.org/)
 
-``HashLib4Pascal's`` goal is to be the best option for hashing in Object Pascal by offering various hashing primitives via an easy to use API to Object Pascal developers.
+HashLib4Pascal is a comprehensive hashing library for Object Pascal, providing an easy-to-use interface for computing hashes, checksums, MACs, KDFs, and XOFs with support for state-based (incremental) hashing, released under the permissive [MIT License](LICENSE).
 
-Development is coordinated on [GitHub](https://github.com/Xor-el/HashLib4Pascal) and contributions are welcome. If you need help, please open an issue [here](https://github.com/Xor-el/HashLib4Pascal/issues).
+## Table of Contents
 
+- [Features](#features)
+- [Available Algorithms](#available-algorithms)
+- [Getting Started](#getting-started)
+- [Quick Examples](#quick-examples)
+- [Running Tests](#running-tests)
+- [Contributing](#contributing)
+- [Other Implementations](#other-implementations)
+- [Tip Jar](#tip-jar)
+- [License](#license)
 
-**Build Status**
-[![Build Status](https://github.com/Xor-el/HashLib4Pascal/actions/workflows/make.yml/badge.svg)](https://github.com/Xor-el/HashLib4Pascal/actions/workflows/make.yml)
+## Features
+
+- **Extensive hash coverage** -- CRC (all standard variants from CRC3 to CRC64), non-cryptographic (Murmur, XXHash, SipHash, etc.), and cryptographic (SHA-2, SHA-3, Blake2, Blake3, and more)
+- **State-based (incremental) hashing** -- feed data in chunks via `TransformBytes` / `TransformString`, then finalize with `TransformFinal`
+- **One-shot convenience** -- `ComputeString`, `ComputeBytes`, `ComputeFile`, `ComputeStream` for single-call hashing
+- **Password hashing / KDFs** -- Argon2 (2i/2d/2id), Scrypt, PBKDF2-HMAC
+- **MACs** -- HMAC (all supported hashes), KMAC (128/256), Blake2BMAC, Blake2SMAC
+- **Extendable output functions (XOFs)** -- Shake, CShake, Blake2X, KMACXOF, Blake3XOF
+- **Cloneable state** -- clone any hash instance mid-computation for parallel/divergent processing
+- **Cross-platform** -- Delphi and FreePascal on Windows, Linux, macOS, and more
+
+## Available Algorithms
+
+<details>
+<summary>Checksums</summary>
+
+#### CRC
+`All CRC variants from CRC3 to CRC64`
+
+#### Other
+`Adler32`
+
+</details>
+
+<details>
+<summary>Non-Cryptographic Hash Functions</summary>
 
-Available Algorithms
-----------------------------------------
+#### 32-bit
+`AP` | `BKDR` | `Bernstein` | `Bernstein1` | `DEK` | `DJB` | `ELF` | `FNV` | `FNV1a` | `Jenkins3` | `JS` | `Murmur2` | `MurmurHash3_x86_32` | `OneAtTime` | `PJW` | `Rotating` | `RS` | `SDBM` | `ShiftAndXor` | `SuperFast` | `XXHash32`
 
- ### Hashes
-----------------------------------------
-##### Cyclic Redundancy Checks
+#### 64-bit
+`FNV64` | `FNV1a64` | `Murmur2_64` | `SipHash2_4` | `XXHash64`
 
-* `All CRC Variants from CRC3 to CRC64` 
+#### 128-bit
+`SipHash128_2_4` | `MurmurHash3_x86_128` | `MurmurHash3_x64_128`
 
-##### Checksums
+</details>
 
-* `Adler32`
+<details>
+<summary>Cryptographic Hash Functions</summary>
 
-##### Non-Cryptographic Hash Functions 
-----------------------------------------
+| Family | Variants |
+|---|---|
+| MD | MD2, MD4, MD5 |
+| SHA-0 | SHA-0 |
+| SHA-1 | SHA-1 |
+| SHA-2 | 224, 256, 384, 512, 512-224, 512-256 |
+| SHA-3 | 224, 256, 384, 512 |
+| Keccak | 224, 256, 288, 384, 512 |
+| Blake2B | 160, 256, 384, 512 |
+| Blake2S | 128, 160, 224, 256 |
+| Blake2BP | Blake2BP |
+| Blake2SP | Blake2SP |
+| Blake3 | Blake3 |
+| GOST | 34.11-94, R 34.11-2012 (256, 512) |
+| Grindahl | 256, 512 |
+| HAS160 | HAS160 |
+| RIPEMD | 128, 160, 256, 320 |
+| Tiger | 128, 160, 192 (Rounds 3, 4, 5) |
+| Tiger2 | 128, 160, 192 (Rounds 3, 4, 5) |
+| Snefru | 128, 256 |
+| Haval | 128, 160, 192, 224, 256 (Rounds 3, 4, 5) |
+| Panama | Panama |
+| RadioGatun | RadioGatun32, RadioGatun64 |
+| WhirlPool | WhirlPool |
 
-###### 32 bit hashes
+</details>
 
-* `AP` `BKDR` `Bernstein` `Bernstein1` `DEK` `DJB` `ELF` `FNV` 
+<details>
+<summary>Key Derivation Functions</summary>
 
-* `FNV1a` `JS` `Jenkins3` `Murmur2` `MurmurHash3_x86_32` `OneAtTime`
+#### Password Hashing
+`PBKDF2-HMAC` | `Argon2 (2i, 2d, 2id)` | `Scrypt`
 
-*  `PJW` `RS` `Rotating` `SDBM` `ShiftAndXor` `SuperFast` `XXHash32`
+</details>
 
-###### 64 bit hashes
+<details>
+<summary>MACs</summary>
 
-* `FNV64` `FNV1a64` `Murmur2_64` `SipHash2_4` `XXHash64`
+`HMAC (all supported hashes)` | `KMAC (128, 256)` | `Blake2BMAC` | `Blake2SMAC`
 
-###### 128 bit hashes
+</details>
 
-* `MurmurHash3_x86_128` `MurmurHash3_x64_128` 
+<details>
+<summary>XOF (Extendable Output Functions)</summary>
 
-##### Cryptographic Hash Functions 
-----------------------------------------
+`Shake (128, 256)` | `CShake (128, 256)` | `Blake2XS` | `Blake2XB` | `KMAC128XOF` | `KMAC256XOF` | `Blake3XOF`
 
- * `MD2`
+</details>
 
- * `MD4`
+## Getting Started
 
- * `MD5`
+### Prerequisites
 
- * `SHA-0`
+| Compiler | Minimum Version |
+|---|---|
+| Delphi | 2010 or later |
+| FreePascal | 3.2.2 or later |
 
- * `SHA-1`
+### Installation
 
- * `SHA-2 (224, 256, 384, 512, 512-224, 512-256)`
+#### Delphi
 
- * `GOST 34.11-94`
+1. Open and install the package: `HashLib/src/Packages/Delphi/HashLib4PascalPackage.dpk`
+2. Add the `HashLib/src` subdirectories to your project's search path.
 
- * `GOST R 34.11-2012 (AKA Streebog) (256, 512)`
- 
- * `Grindahl (256, 512)`
- 
- * `Has160`
+#### FreePascal / Lazarus
 
- * `RIPEMD (128, 160, 256, 256, 320)`
+1. Open and install the package: `HashLib/src/Packages/FPC/HashLib4PascalPackage.lpk`
 
- * `Tiger (128, 160, 192 (Rounds 3, 4, 5))` 
+## Quick Examples
 
- * `Tiger2 (128, 160, 192 (Rounds 3, 4, 5))` 
- 
- * `Snefru (128, 256)`
- 
- * `Haval (128, 160, 192, 224, 256 (Rounds 3, 4, 5))`
- 
- * `Panama`
- 
- * `RadioGatun (RadioGatun32, RadioGatun64)`
+### SHA-256 Hash
 
- * `WhirlPool`
+```pascal
+uses
+  SysUtils, HlpHashFactory;
 
- * `Blake2B (160, 256, 384, 512)`
- 
- * `Blake2S (128, 160, 224, 256)`
+var
+  LHash: String;
+begin
+  LHash := THashFactory.TCrypto.CreateSHA2_256()
+    .ComputeString('Hello HashLib4Pascal', TEncoding.UTF8)
+    .ToString();
 
- * `SHA-3 (224, 256, 384, 512)`
- 
- * `Keccak (224, 256, 288, 384, 512)`
+  WriteLn(LHash);
+end;
+```
 
- * `Blake2BP`
+### Incremental (Streaming) Hash
 
- * `Blake2SP`
+```pascal
+uses
+  SysUtils, HlpIHash, HlpHashFactory;
 
- * `Blake3`
+var
+  LHashInstance: IHash;
+begin
+  LHashInstance := THashFactory.TCrypto.CreateBlake2B_256();
+  LHashInstance.Initialize();
 
-### Key Derivation Functions
-----------------------------------------
+  LHashInstance.TransformString('chunk one', TEncoding.UTF8);
+  LHashInstance.TransformString('chunk two', TEncoding.UTF8);
+  LHashInstance.TransformString('chunk three', TEncoding.UTF8);
 
-###### Password Hashing Schemes (Password Based Key Derivation Functions)
+  WriteLn(LHashInstance.TransformFinal().ToString());
+end;
+```
 
-----------------------------------------
+### HMAC
 
-* `PBKDF2`
- 
-* `Argon2 (2i, 2d and 2id variants)`
+```pascal
+uses
+  SysUtils, HlpIHashInfo, HlpHashFactory, HlpConverters;
 
-* `Scrypt`
+var
+  LHMAC: IHMAC;
+begin
+  LHMAC := THashFactory.THMAC.CreateHMAC(
+    THashFactory.TCrypto.CreateSHA2_256(),
+    TConverters.ConvertStringToBytes('secret key', TEncoding.UTF8));
 
-### MAC
-----------------------------------------
+  WriteLn(LHMAC.ComputeString('message', TEncoding.UTF8).ToString());
+end;
+```
 
-* `HMAC (all supported hashes)`
+### Scrypt KDF
 
-* `KMAC (KMAC128, KMAC256)`
+```pascal
+uses
+  SysUtils, HlpIHashInfo, HlpHashFactory, HlpConverters;
 
-* `Blake2MAC (Blake2BMAC, Blake2SMAC)`
+var
+  LDerivedKey: TBytes;
+begin
+  LDerivedKey := TKDF.TPBKDF_Scrypt.CreatePBKDF_Scrypt(
+    TConverters.ConvertStringToBytes('password', TEncoding.UTF8),
+    TConverters.ConvertStringToBytes('salt', TEncoding.UTF8),
+    1024, 8, 1)
+    .GetBytes(32);
 
-### XOF (Extendable Output Function)
-----------------------------------------
+  WriteLn(TConverters.ConvertBytesToHexString(LDerivedKey));
+end;
+```
 
-* `Shake (Shake-128, Shake-256)`
+## Running Tests
 
-* `CShake (CShake-128, CShake-256)`
+Tests use **DUnit** (Delphi) and **FPCUnit** (FreePascal).
 
-* `Blake2X (Blake2XS, Blake2XB)`
+- **Delphi:** Open `HashLib.Tests/Delphi.Tests/HashLib.Tests.dpr` in the IDE and run.
+- **FreePascal / Lazarus:** Open `HashLib.Tests/FreePascal.Tests/HashLib.Tests.lpi` in the IDE and run.
 
-* `KMACXOF (KMAC128XOF, KMAC256XOF)`
+## Contributing
 
-* `Blake3XOF`
+Contributions are welcome. Please open an [issue](https://github.com/Xor-el/HashLib4Pascal/issues) for bug reports or feature requests, and submit pull requests.
 
-### Supported Compilers
-----------------------------------------
+## Other Implementations
 
-* `FreePascal 3.0.0+`
+If you want implementations in other languages, you can check out these:
 
-* `Delphi 2010+`
+- [HashLib4CPP](https://github.com/ron4fun/HashLib4CPP) by Mbadiwe Nnaemeka Ronald
 
-### Other Implementations
-----------------------------------------
+## Tip Jar
 
-If you want implementations in other languages, you can check out these
+If you find this library useful and would like to support its continued development, tips are greatly appreciated! 🙏
 
-* [HashLib4CPP](https://github.com/ron4fun/HashLib4CPP) by Mbadiwe Nnaemeka Ronald
+| Cryptocurrency | Wallet Address |
+|---|---|
+| <img src="https://raw.githubusercontent.com/spothq/cryptocurrency-icons/master/32/icon/btc.png" width="20" alt="Bitcoin" /> **Bitcoin (BTC)** | `bc1quqhe342vw4ml909g334w9ygade64szqupqulmu` |
+| <img src="https://raw.githubusercontent.com/spothq/cryptocurrency-icons/master/32/icon/eth.png" width="20" alt="Ethereum" /> **Ethereum (ETH)** | `0x53651185b7467c27facab542da5868bfebe2bb69` |
+| <img src="https://raw.githubusercontent.com/spothq/cryptocurrency-icons/master/32/icon/sol.png" width="20" alt="Solana" /> **Solana (SOL)** | `BPZHjY1eYCdQjLecumvrTJRi5TXj3Yz1vAWcmyEB9Miu` |
 
-### Tip Jar
-----------------------------------------
+## License
 
-* :dollar: **Bitcoin**: `1MhFfW7tDuEHQSgie65uJcAfJgCNchGeKf`
-* :euro: **Ethereum**: `0x6c1DC21aeC49A822A4f1E3bf07c623C2C1978a98`
-* :pound: **Pascalcoin**: `345367-40`
+HashLib4Pascal is released under the [MIT License](LICENSE).