Add an example for algorithm Ascon-Hash256

Author: helkoulak

hash/Ascon-Hash256.c

@@ -0,0 +1,116 @@
+/* Ascon-Hash256.c
+ *
+ * Copyright (C) 2006-2020 wolfSSL Inc.
+ *
+ * This file is part of wolfSSL.
+ *
+ * wolfSSL is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * wolfSSL is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
+ */
+
+
+#ifdef NO_INLINE
+    #include <wolfssl/wolfcrypt/misc.h>
+#endif
+#include <wolfssl/options.h>
+#include <wolfssl/wolfcrypt/settings.h>
+#include <wolfssl/ssl.h>
+#include <wolfssl/wolfcrypt/ascon.h>
+
+#ifdef HAVE_ASCON
+void usage(void)
+{
+    printf("./Ascon-Hash256 <file to hash>\n");
+    exit(-99);
+}
+#endif
+
+void free_mem(wc_AsconHash256 *asconHash, byte *hash, byte *rawInput, FILE *inputStream) {
+    fclose(inputStream);
+    free(rawInput);
+    free(hash);
+    wc_AsconHash256_Free(asconHash);
+}
+
+int main(int argc, char** argv)
+{
+    int ret = -1;
+#ifdef HAVE_ASCON
+    wc_AsconHash256* asconHash = NULL;
+    byte*  hash = NULL;
+    byte*  rawInput = NULL;
+    FILE* inputStream = NULL;
+    char* fName = NULL;
+    int fileLength = 0;
+
+    if (argc < 2)
+        usage();
+    fName = argv[1];
+    printf("Hash input file %s\n", fName);
+
+    inputStream = fopen(fName, "rb");
+    if (inputStream == NULL) {
+        printf("ERROR: Unable to open file\n");
+        return -1;
+    }
+
+    /* find length of the file */
+    fseek(inputStream, 0, SEEK_END);
+    fileLength = (int) ftell(inputStream);
+    fseek(inputStream, 0, SEEK_SET);
+
+    /* Create and initialize hash context */
+    asconHash = wc_AsconHash256_New();
+    if (asconHash == NULL) {
+        printf("ERROR: Unable to create the hash context\n");
+    }
+
+    hash = (byte*) malloc(ASCON_HASH256_SZ);
+    if (hash == NULL) {
+        printf("ERROR: Unable to allocate space for hash value\n");
+    }
+
+    rawInput = (byte*) malloc(fileLength);
+    if (rawInput == NULL) {
+        printf("ERROR: Unable to allocate space for raw input\n");
+    }
+
+    /* Read input file into a byte array*/
+    ret = fread(rawInput, 1, fileLength, inputStream);
+    if (ret != fileLength) {
+        printf("ERROR: Failed to read the size of input file\n");
+    }
+
+    ret = wc_AsconHash256_Update(asconHash, rawInput, fileLength);
+    if (ret != 0) {
+        printf("ERROR: Hash update failed\n");
+    }
+
+    ret = wc_AsconHash256_Final(asconHash, hash);
+    if (ret != 0) {
+        printf("ERROR: Hash operation failed");
+    }
+    else {
+        printf("Hash result is: ");
+        for (int i = 0; i < ASCON_HASH256_SZ; i++)
+            printf("%02x", hash[i]);
+        printf("\n");
+    }
+
+    free_mem(asconHash, hash, rawInput, inputStream);
+#else
+    printf("Please enable Ascon-Hash256 (--enable-ascon --enable-experimental) in wolfCrypt\n");
+#endif
+    return ret;
+}

hash/README.md

@@ -37,6 +37,16 @@ LIBS+=$(STATIC_LIB)
 
 ## Usage
 
+### `Ascon-hash`
+
+This example shows how to hash an input file using Ascon-Hash256.
+
+```
+./Ascon-Hash256 input.txt
+Hash input file input.txt
+Hash result is: cfef206d17eff5187fe5b5451326d5489eab2d65fe71faab84a6d9300ef7c6f8
+```
+
 ### `sha256-hash`
 
 This example shows how to hash an input file using SHA-256.