README.md

   1 % ![](img/mhash384/MHash-384.jpg)
   2 MHash-384
   3 % Simple fast portable secure hashing library
   4
   5 # Introduction
   6
   7 **MHash-384** is a fast, portable and secure hashing library, released under the *MIT license*.
   8
   9 The MHash-384 core library has been written in plain **C**, and the CLI front-end has been written in **C++**. The core library provides a simple "stream processing" API, that is available in two flavors: a plain C99 version and an *object-oriented* C++ wrapper. Either way, the MHash-384 library produces hash values with a fixed length of 384 bits (48 bytes).
  10
  11 MHash-384 supports a wide range of compilers, including MSVC++, GCC, MinGW/Cygwin, Clang/LLVM and Intel C++. It also runs on many platforms, including Windows, Linux, BSD and Solaris. Furthermore, the MHash-384 library has already been *ported* to various other programming languages, including **Java**, **Microsoft.NET**, **Python** as well as **Delphi**.
  12
  13
  14 # Quick Start Guide
  15
  16 In order to use the *MHash-384* library, simply include the header file `mhash384.h` in your code:
  17
  18         #include <mhash384.h>
  19
  20 ## Example for C language
  21
  22 If you source code is written in **C**, use the **`mhash384_t`** struct and the **`mhash384_XYZ()`** functions:
  23
  24         /*variables*/
  25         uint8_t buffer[BUFFSIZE];
  26         size_t len;
  27         uint8_t result[MHASH384_SIZE];
  28         mhash384_t mhash384;
  29
  30         /*initialization*/
  31         mhash384_init(&mhash384);
  32
  33         /*input data processing*/
  34         while(more_data())
  35         {
  36                 len = read_data(buffer, BUFFSIZE);
  37                 mhash384_update(&mhash384, buffer, len);
  38         }
  39
  40         /*finalization*/
  41         mhash384_final(&mhash384, result);
  42
  43 ## Example for C++ language
  44
  45 Or, if you source code is written in **C++**, use the provided **`MHash384`** wrapper class:
  46
  47         /*instance*/
  48         MHash384 mhash384;
  49
  50         /*input data processing*/
  51         while(more_data())
  52         {
  53                 const std::vector<uint8_t> buffer = read_data();
  54                 mhash384.update(buffer);
  55         }
  56
  57         /*finalization*/
  58         const uint8_t *result = mhash384.finish();
  59
  60
  61 # Command-line Usage
  62
  63 MHash-384 comes with a simple "standalone" command-line application, similar to the `sha1sum` or`sha256sum` utilities.
  64
  65 ## Synopsis
  66
  67 The MHash-384 command-line application takes a number of optional options followed by an one or more input files.
  68
  69 If **no** input file is specified, input will be read from standard input (*stdin*).
  70
  71 The digest will be written to the standard output (*stdout*). Diagnostic message are written to the standard error (*stderr*).
  72
  73         mhash384 [OPTIONS] [<FILE_1> <FILE_2> ... <FILE_N>]
  74
  75 ## Options
  76
  77 MHash-384 supports the following options:
  78
  79 * **`--keep-going`**
  80   Try to proceed with the remaining files, if a file has failed (e.g. access denied or file not found).
  81   Only applicable, if *multiple* files have been specified. Default behavior is to abort immediately when a file has failed.
  82
  83 * **`--short`**
  84   Print the digest in *short* format (**no** file names). Default format prints the digest followed by the file name.
  85
  86 * **`--lower-case`**
  87   Print the digest in *lower-case* letters. Default format prints the digest in *upper-case* letters.
  88   This option can **only** be used with the default *Hex* (hexadecimal) output format.
  89
  90 * **`--base64`**
  91   Print the digest in [**Base64**](https://en.wikipedia.org/wiki/Base64) (RFC-4648) format. Default prints the digest in [**Hex**](https://en.wikipedia.org/wiki/Hexadecimal) (hexadecimal) output format.
  92   This option **must not** be combined with the `--base85` option, for obvious reasons.
  93
  94 * **`--base85`**
  95   Print the digest in [**Base85**](https://en.wikipedia.org/wiki/Ascii85) (Ascii85) format. Default prints the digest in [**Hex**](https://en.wikipedia.org/wiki/Hexadecimal) (hexadecimal) output format.
  96   This option **must not** be combined with the `--base64` option, for obvious reasons.
  97
  98 * **`--help`**
  99   Print the help screen (manpage) and exit program.
 100
 101 * **`--version`**
 102   Print the program version (plus some build information) and exit program.
 103
 104 * **`--self-test`**
 105   Run self-test and exit program. This will process various standard test vectors and validate the resulting hashes.
 106   *Note:* Some test vectors contain very long inputs, therefore the computation can take a while to complete!
 107
 108 * **`--stress`**
 109   Enable stress test mode. This will process all test strings from the specified input file, expecting one string *per line*.
 110   All computed hash values are added to an `std::unordered_set`, thus checking for possible collisions.
 111
 112 * **`--benchmark`**
 113   Measure the overall time required for the operation. If specified, output the total amount of time elapsed, in seconds.
 114
 115 ## Output Format
 116
 117 In default operation mode, MHash-384 writes one line per input file to the standard output:
 118
 119         <HASH_VALUE> [SPACE SPACE <FILE_NAME>]
 120
 121 The format of the hash value is either [**Hex**](https://en.wikipedia.org/wiki/Hexadecimal) (hexadecimal) or [**Base64**](https://en.wikipedia.org/wiki/Base64) (RFC-4648), depending on the specified options.
 122
 123 Also, the file name will be printed, unless "short" format was requested. File names *may* contain a path!
 124
 125 #### Sample output {-}
 126
 127         BD41A203A61FE74178A8D507...33E553FD1569ED733C52BE8B  debian-7.9.0-amd64-DVD-1.iso
 128         EE328DDD4E116165252F1FF8...11729801097C51FB61D20184  debian-7.9.0-i386-DVD-1.iso
 129         A8B2007537867BDA0C18A264...45A1379AB8B4A77F9D8C8B24  debian-10.0.0-amd64-DVD-1.iso
 130
 131 ## Exit Code
 132
 133 On success, *zero* is returned. On error or user interruption, a *non-zero* error code is returned.
 134
 135 Note that, with "keep going" mode enabled, the exit code reflects whether *at least* one file was processed successfully.
 136
 137 ## Examples
 138
 139 Compute MHash-384 hash of a single file:
 140
 141         mhash384 "C:\Images\debian-8.3.0-amd64-DVD-1.iso"
 142
 143 Compute MHash-384 hash of *two* files:
 144
 145         mhash384 "C:\Images\debian-8.3.0-amd64-DVD-1.iso" "C:\Images\debian-8.3.0-i386-DVD-1.iso"
 146
 147 Compute MHash-384 hash of *multiple* files, using wildcard expansion ([globbing](https://en.wikipedia.org/wiki/Glob_(programming))):
 148
 149         mhash384 "C:\Images\*.iso"
 150
 151 Compute MHash-384 hash from data passed directly via [pipeline](https://en.wikipedia.org/wiki/Pipeline_(Unix)):
 152
 153         dd if=/dev/urandom bs=100 count=1 | mhash384
 154
 155
 156 # API Specification
 157
 158 ## Global definitions
 159
 160 Global definitions for both, the C and C++, API's.
 161
 162 ### MHASH384_SIZE
 163
 164 The size of the final MHash-384 hash value (digest), in bytes. This value is qual to `48U`.
 165
 166 ### MHASH384_WORDS
 167
 168 The number of words per MHash-384 hash. Each word has a size of 64 bits (`uint64_t`). This value is qual to `6U`.
 169
 170 ## API for C language
 171
 172 All functions described in the following are *reentrant* and *thread-safe*. A single thread may compute multiple MHash-384 hashes in an "interleaved" fashion, provided that a separate MHash-384 context is used for each ongoing hash computation. Multiple threads may compute multiple MHash-384 hashes in parallel, provided that each thread uses its own separate MHash-384 context; *no* synchronization is required. However, sharing the same MHash-384 context between multiple threads is **not** safe in the general case. If the same MHash-384 context needs to be accessed from multiple threads, then the threads need to be synchronized explicitly (e.g. via Mutex lock), ensuring that all access to the shared context is rigorously serialized!
 173
 174 ### mhash384_t
 175
 176         typedef struct mhash384_t;
 177
 178 The MHash-384 context. It represents all state of an ongoing MHash-384 hash computation. Each MHash-384 hash computation needs a corresponding MHash-384 context. It is possible to re-use an MHash-384 context for multiple MHash-384 hash computations, provided that those hash computations are strictly serialized. If multiple MHash-384 hash computations need to be performed in an "interleaved" fashion, each ongoing hash computation needs to use its own separate MHash-384 context. In any case, the memory for the `mhash384_t` instance(s) must be allocated by the calling application. If the MHash-384 context was allocated on the heap space, the calling application also is responsible for freeing up that memory.
 179
 180 *Note:* Applications should treat this data-type as *opaque*, i.e. the application **must not** access the fields of the struct directly!
 181
 182 ### mhash384_init()
 183
 184         void mhash384_init(mhash384_t *const ctx);
 185
 186 Set up the MHash-384 hash computation. This function initializes the MHash-384 context; it prepares the state for the upcoming hash computation. The application is required to call this function *once* for each MHash-384 hash computation. The function must to be called ***before*** any input data can be processed in a specific MHash-384 context! The application may call this function again, on the same MHash-384 context, which will *reset* that context and start a new hash computation.
 187
 188 *Parameters:*
 189
 190 * `mhash384_t *ctx`
 191   Pointer to the MHash-384 context of type `mhash384_t` that will be initialized (reset) by this operation.
 192   *Note:* The MHash-384 library does **not** allocate the required memory; it must be allocated by the calling application!
 193
 194 ### mhash384_update()
 195
 196         void mhash384_update(mhash384_t *const ctx, const uint8_t *const data_in, const size_t len);
 197
 198 Process next chunk of input data. This function performs the actual MHash-384 hash computation, in an incremental way. The function processes the next **N** bytes of input data and updates the MHash-384 context (`mhash384_t`) accordingly. The application is supposed to call this function in a loop, with the *same* MHash-384 context, until all input has been processed.
 199
 200 *Parameters:*
 201
 202 * `mhash384_t *ctx`
 203   Pointer to the hash computation state of type `mhash384_t` that will be updated by this operation.
 204
 205 * `const uint8_t *data_in`
 206   Pointer to the input data to be processed by this operation. The input data needs to be located in one continuous block of memory. The given pointer specifies the *base address*, i.e. the address of the *first* byte to be processed.
 207   *Note:* Formally, the input data is defined as an array of byte (`uint8_t`). Nonetheless, *any* kind of input data can be processed, by applying the proper *typecast* operator. For numeric values, the platform's [endianness](https://en.wikipedia.org/wiki/Endianness) applies!
 208
 209 * `size_t len`
 210   The *length* of the input data to be processed, *in bytes*. Specify `sizeof(T) * count` for data types **T** other than byte.
 211   *Note:* All *bytes* in the range from `data_in[0]` up to and including `data_in[len-1]` will be processed as input.
 212
 213 ### mhash384_final()
 214
 215         void mhash384_final(mhash384_t *const ctx, uint8_t *const digest_out);
 216
 217 Retrieve final hash value. This function completes the MHash-384 hash computation and returns the computed hash value. The function finalizes the MHash-384 context (`mhash384_t`) and writes the resulting hash value to the output buffer. Once this function has been called, the corresponding MHash-384 context will be in an ***undefined*** state, until it is [reset](#mhash384_init)!
 218
 219 *Parameters:*
 220
 221 * `mhash384_t *ctx`
 222   Pointer to the hash computation state of type `mhash384_t` that will be finalized by this operation.
 223   *Note:* The MHash-384 library does **not** free this memory; it may need to be freed up by the calling application!
 224
 225 * `uint8_t *digest_out`
 226   Pointer to the memory block where the final MHash-384 hash (digest) is to be stored. This memory needs to be allocated by the calling application! The size of the MHash-384 hash value, in bytes, is equal to `MHASH384_SIZE`.
 227   *Note:* All *bytes* ranging from `digest_out[0]` up to and including `digest_out[MHASH384_SIZE-1]` will be overwritten!
 228
 229 ### mhash384_compute()
 230
 231         void mhash384_compute(uint8_t *const digest_out, const uint8_t *const data_in, const size_t len);
 232
 233 Compute hash value at once. This is a convenience function that can be used to compute an MHash-384 hash value with just a single invocation. The function processes a block of **N** input bytes and writes the resulting hash value to the output buffer. This function does *not* required the caller to provide an MHash-384 context; it internally uses a "transient" context. Anyway, this function is fully thread-safe. Naturally, this function is *only* applicable where *all* input data is available at once.
 234
 235 *Parameters:*
 236
 237 * `uint8_t *digest_out`
 238   Pointer to the memory block where the final MHash-384 hash (digest) is to be stored. This memory needs to be allocated by the calling application! This size of the MHash-384 hash value, in bytes, is equal to `MHASH384_SIZE`.
 239   *Note:* All *bytes* ranging from `digest_out[0]` up to and including `digest_out[MHASH384_SIZE-1]` will be overwritten!
 240
 241 * `const uint8_t *data_in`
 242   Pointer to the input data to be processed by this operation. The input data needs to be located in one continuous block of memory. The given pointer specifies the *base address*, i.e. the address of the *first* byte to be processed.
 243   *Note:* Formally, the input data is defined as an array of byte (`uint8_t`). Nonetheless, *any* kind of input data can be processed, by applying the proper *typecast* operator. For numeric values, the platform's [endianness](https://en.wikipedia.org/wiki/Endianness) applies!
 244
 245 * `size_t len`
 246   The *length* of the input data to be processed, *in bytes*. Specify `sizeof(T) * count` for data types **T** other than byte.
 247   *Note:* All *bytes* in the range from `data_in[0]` up to and including `data_in[len-1]` will be processed as input.
 248
 249 ### mhash384_version()
 250
 251         void mhash384_version (uint16_t *const major, uint16_t *const minor, uint16_t *const patch);
 252
 253 Retrieve version information. This function returns the current version of the MHash-384 library.
 254
 255 *Parameters:*
 256
 257 * `uint16_t *major`
 258   Pointer to a variable of type `uint16_t` where the *major* version of the MHash-384 library will be stored.
 259
 260 * `uint16_t *minor`
 261   Pointer to a variable of type `uint16_t` where the *minor* version of the MHash-384 library will be stored.
 262
 263 * `uint16_t *patch`
 264   Pointer to a variable of type `uint16_t` where the *patch* level of the MHash-384 library will be stored.
 265
 266 ### mhash384_selftest()
 267
 268         bool mhash384_selftest(void);
 269
 270 Self-test routine. This function runs the built-in self-test of the MHash-384 library; intended for debugging purposes.
 271
 272 *Return value:*
 273
 274 * Returns `true`, if the self-test completed successfully; returns `false`, if any problems have been detected.
 275
 276 ## API for C++ language
 277
 278 For the C++ langauge, the **`MHash384`** class is provided, as a convenience wrapper around the C-API. All functions of the `MHash384` class are *reentrant* and *thread-safe*. A single thread may compute multiple MHash-384 hashes in an "interleaved" fashion, provided that a separate `MHash384` instance (object) is used for each ongoing hash computation. Multiple threads may compute multiple MHash-384 hashes in parallel, provided that each thread uses its own separate `MHash384` instance; *no* synchronization is required. However, sharing the same `MHash384` instance between multiple threads is **not** safe in the general case. If the same `MHash384` instance needs to be accessed from multiple threads, then the threads need to be synchronized explicitly (e.g. via Mutex lock), ensuring that all access to the shared instance is rigorously serialized!
 279
 280 ### MHash384()
 281
 282         MHash384(void)
 283
 284 Constructor. Creates a new `MHash384` instance (object) and prepares the state for the upcoming hash computation. Each instance *internally* maintains the corresponding MHash-384 context. The application is required to create a separate `MHash384` instance for each ongoing MHash-384 hash computation; it is possible to re-use an `MHash384` instance for multiple MHash-384 hash computations, provided that those hash computations are strictly serialized.
 285 *Note:* The application is required to allocate the memory for the `MHash384` instance. If the instance was allocated on the heap (*dynamic* storage duration), the application is also required to explicitly destroy the instance, when no longer needed.
 286
 287 ### MHash384::update() [1]
 288
 289         void MHash384::update(const std::uint8_t *const data, const size_t len)
 290
 291 Process next chunk of input data. This function performs the actual MHash-384 hash computation, in an incremental way. The function processes the next **N** bytes of input data and updates the internal MHash-384 context accordingly. The application is supposed to call this function in a loop, on the *same* `MHash384` instance, until all input has been processed.
 292
 293 *Parameters:*
 294
 295 * `const uint8_t *data_in`
 296   Pointer to the input data to be processed by this operation. The input data needs to be located in one continuous block of memory. The given pointer specifies the *base address*, i.e. the address of the *first* byte to be processed.
 297   *Note:* Formally, the input data is defined as an array of byte (`uint8_t`). Nonetheless, *any* kind of input data can be processed, by applying the proper *typecast* operator. For numeric values, the platform's [endianness](https://en.wikipedia.org/wiki/Endianness) applies!
 298
 299 * `size_t len`
 300   The *length* of the input data to be processed, *in bytes*. Specify `sizeof(T) * count` for data types **T** other than byte.
 301   *Note:* All *bytes* in the range from `data_in[0]` up to and including `data_in[len-1]` will be processed as input.
 302
 303 ### MHash384::update() [2]
 304
 305         template<size_t size>
 306         void MHash384::update(const std::array<std::uint8_t, size> &data)
 307
 308 A convenience overload of the [`MHash384::update()`](#mhash384update-1) function, which processes an `std::array<uint8_t, N>` as input.
 309
 310 *Parameters:*
 311
 312 * `const std::array<uint8_t, N> &data`
 313   Read-only reference to the `std::array<uint8_t, N>` containing the input data to be processed.
 314   *Note:* All bytes in the range from `data[0]` up to and including `data[data.size()-1]` will be processed as input.
 315
 316 ### MHash384::update() [3]
 317
 318         void MHash384::update(const std::vector<std::uint8_t> &data)
 319
 320 A convenience overload of the [`MHash384::update()`](#mhash384update-1) function, which processes an `std::vector<uint8_t>` as input.
 321
 322 *Parameters:*
 323
 324 * `const std::vector<std::uint8_t> &data`
 325   Read-only reference to the `std::vector<uint8_t>` containing the input data to be processed.
 326   *Note:* All bytes in the range from `data[0]` up to and including `data[data.size()-1]` will be processed as input.
 327
 328 ### MHash384::update() [4]
 329
 330         void MHash384::update(const std::string &text)
 331
 332 A convenience overload of the [`MHash384::update()`](#mhash384update-1) function, which processes an `std::string` as input.
 333
 334 *Parameters:*
 335
 336 * `const std::string &text`
 337   Read-only reference to the `std::string` containing the input data to be processed.
 338   *Note:* All characters in the range from `text[0]` up to and including `text[text.length()-1]` will be processed as input. Each character in the `std::string` is processed as a *byte* value, disregarding any specific character encoding.
 339
 340 ### MHash384::update() [5]
 341
 342         void MHash384::update(const char *const text)
 343
 344 A convenience overload of the [`MHash384::update()`](#mhash384update-1) function, which processes a NULL-terminated C string as input.
 345
 346 *Parameters:*
 347
 348 * `const char *const text`
 349   Read-only pointer to the first character of the NULL-terminated string to be processed.
 350   *Note:* All characters in the range from `text[0]` up to and including `text[strlen(text)-1]` will be processed as input. Each character in the C string is processed as a *byte* value, disregarding any specific character encoding.
 351
 352 ### MHash384::update() [6]
 353
 354         template<typename element_type>
 355         void MHash384::update(const element_type *const address);
 356
 357 A convenience overload of the [`MHash384::update()`](#mhash384update-1) function, which processes an object designated by a pointer.
 358
 359 *Parameters:*
 360
 361 * `const element_type *const address`
 362   Read-only pointer to the target object to be processed.
 363   *Note:* The given object is processed as a byte-sequence, like a POD; all bytes in the range from `address[0]` up to and including `address[sizeof(element_type)-1]` will be processed as input.
 364
 365 ### MHash384::update() [7]
 366
 367         template<typename element_type>
 368         void MHash384::update(const element_type &element);
 369
 370 A convenience overload of the [`MHash384::update()`](#mhash384update-1) function, which processes an object designated by a reference.
 371
 372 *Parameters:*
 373
 374 * `const element_type &element`
 375   Read-only reference to the target object to be processed.
 376   *Note:* The given object is processed as a byte-sequence, like a POD; all bytes in the range from `addr[0]` up to and including `addr[sizeof(element_type)-1]` with `addr = std::addressof(element)` will be processed as input.
 377
 378 ### MHash384::update() [8]
 379
 380         template<typename iterator_type>
 381         void MHash384::update(const iterator_type &first, const iterator_type &last)
 382
 383 A convenience overload of the [`MHash384::update()`](#mhash384update-1) function, which processes a sequence of elements via iterators.
 384
 385 *Parameters:*
 386
 387 * `const iterator_type &first`
 388   Read-only reference to the iterator designating the *first* element to be processed.
 389   *Note:* All elements in the range from `*first` up to but excluding `*last` will be processed as input. Each element in this range is processed as a byte-sequence, like a POD, assuming a size of `sizeof(iterator_type::value_type)`.
 390
 391 * `const iterator_type &last`
 392   Read-only reference to the iterator designating the element just after the *last* element to be processed.
 393   *Note:* All elements in the range from `*first` up to but excluding `*last` will be processed as input. Each element in this range is processed as a byte-sequence, like a POD, assuming a size of `sizeof(iterator_type::value_type)`.
 394
 395 ### MHash384::finish()
 396
 397         const std::uint8_t *MHash384::finish(void)
 398
 399 Retrieve final hash value. This function completes the MHash-384 hash computation. The function finalizes the internal MHash-384 context, if it was not finalized yet, and returns a pointer to the buffer containing the resulting hash value. Once this function has been called, the `MHash384` instance remains in the *finalized* state, until it is [reset](#mhash384reset).
 400
 401 ***Warning:*** Trying to process more input data while the `MHash384` instance is in *finalized* state will throw an exception!
 402
 403 *Return value:*
 404
 405 * Returns a read-only pointer to the internal buffer containing the final hash value; this buffer is owned by the `MHash384` instance. The size of the MHash-384 hash value, in bytes, is equal to `MHASH384_SIZE`.
 406   *Note:* This pointer remains valid only until the `MHash384` instance is [reset](#mhash384reset) or destroyed. If the hash value needs to be retained after the instance was reset/destroyed, the application must copy the hash value to a separate buffer!
 407
 408 ### MHash384::reset()
 409
 410         void MHash384::reset(void)
 411
 412 Reset the MHash-384 hash computation. This function re-initializes the internal MHash-384 context, thus starting a new MHash-384 hash computation. It is **not** necessary to explicitly call this function on a new `MHash384` instance; it is called implicitly by the constructor. However, it is possible to re-use an existing `MHash384` instance for multiple (strictly serialized) MHash-384 hash computations, by calling this function in between each pair of consecutive hash computations.
 413
 414
 415 # Supported platforms
 416
 417 MHash-384 has been tested to successfully build and run on (at least) the following platforms:
 418
 419 ## C/C++ library and CLI front-end
 420
 421 * **Microsoft Windows (x84/x64)**
 422     - Microsoft Visual C++, version 16.00 (Visual Studio 2010) or newer
 423     - Mingw-w64 (from MSYS2), tested with version 8.0.0, using GCC 9.2.0 or Clang 9.0.0
 424     - MinGW (mingw.org), tested with version 5.3.2, using GCC 8.2.0
 425     - Cygwin, tested with version 3.1.2 (x64), using GCC 7.4.0 or Clang 8.0.1
 426
 427 * **Linux/GNU (x86/x64)**
 428     - Ubuntu, tested with version 16.04 (Xenial), using GCC 5.4.0 or Clang 3.8.0
 429     - CentOS/Red Hat Enterprise Linux, tested with version 8.1, using GCC 8.3.1 or Clang 8.0.1
 430     - Manjaro, tested with version 18.1.5, using GCC 9.2.0 or Clang 9.0.1
 431     - openSUSE (Leap), tested with version 15.1, using GCC 7.5.0 or Clang 7.0.1
 432
 433 * **BSD-Family (x86/x64)**
 434     - FreeBSD, tested with TrueOS version 18.12, using GCC 7.4.0 or Clang 7.0.1
 435     - OpenBSD, tested with version 6.6, using GCC 8.2.0 or Clang 8.0.1
 436
 437 * **Solaris (x86/x64)**
 438     - OpenSolaris/Illumos, tested with OpenIndiana version 2019.10, using GCC 9.2.0
 439
 440 ## Ports to other lanuguages
 441
 442 * **Java**
 443     - Java SE 8, tested with OpenJDK Runtime Environment 1.8.0_242
 444     - Java SE 11, tested with OpenJDK Runtime Environment 11.0.5
 445
 446 * **.NET Framework**
 447     - Microsoft.NET Framework 4.5 (or newer), tested with Visual Studio 2019 (version 15.9.20)
 448     - Mono, tested with Mono C# Compiler version 5.18.0 (Ubuntu 19.10)
 449
 450 * **Python**
 451     - CPython 3.x, tested with version 3.8.1
 452     - PyPy (Python 3.6 compatible), tested with version 7.3.0, highly recommended for improved performance!
 453
 454 * **Delphi (Object Pascal)**
 455     - Bordland Delphi, tested with Delphi 7.1 (DCC 15.00)
 456     - Lazarus/Free Pascal, tested with Lazarus 2.06 (Free Pascal Compiler 3.04)
 457
 458
 459 # Build instructions
 460
 461 The MHash-384 C/C++ library and CLI front-end can be built using (at least) one of the following build systems:
 462
 463 ## Microsoft Visual C++
 464
 465 MHash-384 can be built for the Windows platform using the **Microsoft Visual C++** compiler, version 16.00 or later.
 466
 467 The provided project/solution files should build successfully with *Visual Studio 2010* or later. However, be aware that it may be necessary to adjust the "Platform Toolset" to your specific version of Visual Studio in all projects! Build configurations are available for both, *32-Bit* (`Win32`) and *64-Bit* (`x64`) Windows, but the 64-Bit flavor is recommended for best performance.
 468
 469 Note: You can download the latest version of the Visual Studio "Community" edition for free from the [official web-site](https://visualstudio.microsoft.com/).
 470
 471 ### Command-line usage
 472
 473 Building MHash-384 from the developer command prompt is supported via the MSBuild tool:
 474
 475     MSBuild.exe /property:Configuration=Release /property:Platform=x64 /target:Rebuild "MHash384.sln"
 476
 477 ## GNU  C/C++ compiler
 478
 479 MHash-384 can be built using the **GNU  C/C++ compiler (GCC)**, version 4.8 or later, or any GCC-compatible compiler, such as Clang/LLVM, on a wide range of platforms; supported platforms include Linux, the BSD family, Solaris and Windows.
 480
 481 The provided makefiles should build successfully with GNUmake on any supported platform. GNUmake is the default `make` implementation on Linux/GNU, but may need to be installed separately and invoked as `gmake` on BSD and Solaris. GCC or a GCC-compatible compiler (e.g. Clang/LLVM) is available out-of-the-box on most supported platforms; otherwise it can usually be installed from the system's package manager. Please see the documentation of your specific distribution for details!
 482
 483 ### Command-line usage
 484
 485 In order to build MHash-384, simply run **`make`** from the MHash-384 base directory, for example:
 486
 487     $ make CXX=clang++ MARCH=x86-64 MTUNE=intel STATIC=1
 488
 489 ### Make file parameters
 490
 491 The following options can be used to tweak the behavior of the provided makefiles:
 492
 493 * **`MARCH`**: Generate machine code for the specified CPU type, see [*-march*](https://gcc.gnu.org/onlinedocs/gcc-9.2.0/gcc/x86-Options.html#index-march-14) for details (default is `native`)
 494 * **`MTUNE`**: Tune the generated machine code for the specified CPU type, see [*-mtune*](https://gcc.gnu.org/onlinedocs/gcc-9.2.0/gcc/x86-Options.html#index-mtune-16) for details (default is `native`)
 495 * **`STATIC`**: If set to `1`, link with *static* CRT libraries; otherwise link with *shared* CRT libraries (default is `0`)
 496 * **`DEBUG`**: If set to `1`, generate a binary suitable for debugging; otherwise generate an optimized binary (default is `0`)
 497 * **`CXX`**: The C++ compiler to be used (default is *system-specific*, e.g. `g++` or `clang++`)
 498 * **`AR`**: The archiver to be used (default is *system-specific*, usually `ar`)
 499 * **`STRIP`**: The strip program to be used (default is `strip`)
 500 * **`WNDRS`**: The Windows resource compiler to be used, used on Cygwin and MinGW only (default is `windres`)
 501 * **`TAR`**: The tarball program to be used (default is `tar`)
 502 * **`SANITIZE`**: Instrument the binary with the specified sanitizer, e.g. `address` to enable [*AddressSanitizer*](https://gcc.gnu.org/onlinedocs/gcc-9.2.0/gcc/Instrumentation-Options.html#index-fsanitize_003daddress) (*no* default)
 503
 504 ### Windows support
 505
 506 It is possible to build MHash-384 with GCC or Clang/LLVM on the Windows platform thanks to [Cygwin](https://www.cygwin.com/) or [MinGW/MSYS](http://www.mingw.org/wiki/msys). However, if you want to build with GCC or Clang/LLVM on Windows nowadays, then it is *highly recommended* to use [**MSYS2**](https://www.msys2.org/) in conjunction with [**Mingw-w64**](http://mingw-w64.org/) – even for 32-Bit targets! The “old” Mingw.org (Mingw32) project is considered *deprecated*.
 507
 508 Just follow the basic **MSYS2** setup procedure, as described on the [official web-site](https://github.com/msys2/msys2/wiki/MSYS2-installation), then install Mingw-w64:
 509
 510     pacman -S base-devel mingw-w64-i686-toolchain mingw-w64-x86_64-toolchain
 511
 512
 513 # License
 514
 515 **MHash-384 - Simple fast portable secure hashing library**
 516 **&copy; 2016-2020 LoRd_MuldeR [&lt;mulder2@gmx.de&gt;](mailto:mulder2@gmx.de)**
 517
 518         Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 519         and associated documentation files (the "Software"), to deal in the Software without
 520         restriction, including without limitation the rights to use, copy, modify, merge, publish,
 521         distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
 522         Software is furnished to do so, subject to the following conditions:
 523
 524         The above copyright notice and this permission notice shall be included in all copies or
 525         substantial portions of the Software.
 526
 527         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 528         BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 529         NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 530         DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 531         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 532
 533 <https://opensource.org/licenses/MIT>
 534
 535
 536 # Version History
 537
 538 ## Version 2.0.0 [????-??-??]
 539
 540 * Initial release of the 2.x development cycle
 541
 542 &nbsp;
 543
 544 [■](https://www.youtube.com/watch?v=dng06ZqI4Ss)