Ascon examples by helkoulak · Pull Request #573 · wolfSSL/wolfssl-examples

helkoulak · 2026-04-27T14:25:14Z

Two examples that show how to use the algorithms Ascon-Hash256 and Ascon-AEAD128

Fix typos No need to input key size as the size for ascon AEAD algorithm is fixed Add an example for algorithm Ascon-Hash256

Copilot

Pull request overview

This PR adds two new usage examples for Ascon algorithms in the examples repository: one for hashing with Ascon-Hash256 and one for file encryption/decryption with Ascon-AEAD128, along with README/Makefile support so users can build and run them.

Changes:

Add hash/Ascon-Hash256.c and document how to run it in hash/README.md.
Add a new crypto/ascon/ example (ascon-file-encrypt.c) with a local Makefile and README.md.
Link the new Ascon crypto example docs from crypto/README.md.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
hash/README.md	Documents running the new Ascon hashing example.
hash/Ascon-Hash256.c	New Ascon-Hash256 file hashing example program.
crypto/ascon/ascon-file-encrypt.c	New Ascon-AEAD128 file encrypt/decrypt example program.
crypto/ascon/README.md	Build/run instructions for the Ascon file encryption example.
crypto/ascon/Makefile	Builds the Ascon file encryption example.
crypto/README.md	Adds a link to the new `crypto/ascon` documentation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

helkoulak · 2026-04-28T17:47:27Z

I will fix those errors ASAP. Thanks.

dgarske · 2026-05-05T18:50:42Z

Hi @helkoulak thanks for this example. I don't see you setup as a contributor. Please email support at wolfssl dot com and reference this pull request. We will send you an agreement that we need signed. In the email please include your location and a bit more about your project and interest in Ascon and our project. Also if its commercial or open source or academic.

Thanks,
David Garske, wolfSSL

helkoulak · 2026-05-06T14:55:31Z

Hi @helkoulak thanks for this example. I don't see you setup as a contributor. Please email support at wolfssl dot com and reference this pull request. We will send you an agreement that we need signed. In the email please include your location and a bit more about your project and interest in Ascon and our project. Also if its commercial or open source or academic.

Thanks, David Garske, wolfSSL

Thank you David for the instructions. I will contact support ASAP.

dgarske · 2026-05-06T17:02:24Z

Contributor agreement on file. Thank you @helkoulak

dgarske · 2026-05-07T21:39:57Z

@julek-wolfssl please review . Merge when you are happy with it.

julek-wolfssl

Please add crypto/ascon/ascon-file-encrypt to .gitignore. Everything looks nice but just needs more error handling.

julek-wolfssl · 2026-05-26T17:13:34Z

+    fseek(inFile, 0, SEEK_SET);
+
+    byte* input = malloc(BLOCK_SIZE);
+    byte* output = malloc(inFileLength);


Let's write in BLOCK_SIZE chunks too. On error we should delete the file.

The output still uses a inFileLength buffer.

julek-wolfssl · 2026-06-01T14:16:26Z

+        goto cleanup;
+    }
+
+    for (int i = 0; i < BLOCK_SIZE; i += BLOCK_SIZE) {


Suggested change

for (int i = 0; i < BLOCK_SIZE; i += BLOCK_SIZE) {

for (int i = 0; i < fileLength; i += BLOCK_SIZE) {

julek-wolfssl · 2026-06-01T14:38:17Z

+    fseek(inFile, 0, SEEK_SET);
+
+    byte* input = malloc(BLOCK_SIZE);
+    byte* output = malloc(inFileLength);


The output still uses a inFileLength buffer.

julek-wolfssl · 2026-06-01T14:38:45Z

+/*
+ * Encrypts a file using Ascon
+ */
+int AsconEncrypt(wc_AsconAEAD128* ascon, byte* key, int size, FILE* inFile, FILE* outFile)


Delete the output file on error.

julek-wolfssl · 2026-06-01T14:38:53Z

+/*
+ * Decrypts a file using Ascon
+ */
+int AsconDecrypt(wc_AsconAEAD128* ascon, byte* key, int size, FILE* inFile, FILE* outFile)


Delete the output file on error.

julek-wolfssl · 2026-06-01T14:44:50Z

+    }
+
+    // Error out on no valid password.
+    if (strlen(key) == 1) {


Strip the trailing newline here to match aes-file-encrypt.c:289, and this check then becomes == 0.

julek-wolfssl · 2026-06-01T15:04:00Z

+    int length = 0;
+
+    fseek(inFile, 0, SEEK_END);
+    length = ftell(inFile);


Also long so as to not truncate.

julek-wolfssl · 2026-06-01T15:04:36Z

+
+4)  Running 'make clean' will delete the executable as well as any created
+    files. Making sure that the only files left are 'ascon-file-encrypt.c',
+    'Makefile', and 'README'.


Suggested change

'Makefile', and 'README'.

'Makefile', and 'README.md'.

julek-wolfssl · 2026-06-01T15:04:58Z

@@ -0,0 +1,485 @@
+/* ascon-file-encrypt.c
+ *
+ * Copyright (C) 2006-2020 wolfSSL Inc.


update to 2026

julek-wolfssl · 2026-06-01T15:05:06Z

@@ -0,0 +1,134 @@
+/* Ascon-Hash256.c
+ *
+ * Copyright (C) 2006-2020 wolfSSL Inc.


update to 2026

julek-wolfssl · 2026-06-01T15:06:23Z

+#endif
+#include <wolfssl/options.h>
+#include <wolfssl/wolfcrypt/settings.h>
+#include <wolfssl/ssl.h>


Suggested change

#include <wolfssl/ssl.h>

Two examples for Ascon-AEAD128 and Ascon-Hash256

d000810

Fix typos No need to input key size as the size for ascon AEAD algorithm is fixed Add an example for algorithm Ascon-Hash256

helkoulak force-pushed the ascon-examples branch from 09fa582 to d000810 Compare April 27, 2026 15:24

julek-wolfssl self-assigned this Apr 28, 2026

julek-wolfssl requested a review from Copilot April 28, 2026 11:24

Copilot started reviewing on behalf of julek-wolfssl April 28, 2026 11:25 View session

Copilot AI reviewed Apr 28, 2026

View reviewed changes

julek-wolfssl assigned helkoulak and unassigned julek-wolfssl Apr 28, 2026

dgarske assigned wolfSSL-Bot Apr 28, 2026

helkoulak added 2 commits May 1, 2026 08:33

Fixes for ascon-file-encrypt

ae042f1

Fixes for Ascon-Hash256

09d5072

helkoulak removed their assignment May 5, 2026

dgarske assigned helkoulak May 5, 2026

dgarske unassigned helkoulak May 6, 2026

dgarske assigned julek-wolfssl May 7, 2026

dgarske requested a review from julek-wolfssl May 7, 2026 21:40

julek-wolfssl unassigned wolfSSL-Bot May 21, 2026

julek-wolfssl requested changes May 21, 2026

View reviewed changes

Comment thread crypto/ascon/ascon-file-encrypt.c Outdated

Comment thread crypto/ascon/ascon-file-encrypt.c Outdated

Comment thread crypto/ascon/ascon-file-encrypt.c Outdated

Comment thread crypto/ascon/ascon-file-encrypt.c Outdated

Comment thread crypto/ascon/ascon-file-encrypt.c

julek-wolfssl requested changes May 21, 2026

View reviewed changes

Comment thread hash/Ascon-Hash256.c Outdated

Comment thread hash/Ascon-Hash256.c Outdated

Comment thread hash/Ascon-Hash256.c Outdated

julek-wolfssl assigned helkoulak and unassigned julek-wolfssl May 21, 2026

helkoulak added 2 commits May 26, 2026 00:41

Fixes for ascon-file-encrypt

d36f572

Fixes for ascon-hash256

e7d781e

helkoulak requested a review from julek-wolfssl May 25, 2026 23:13

dgarske assigned wolfSSL-Bot May 26, 2026

dgarske assigned julek-wolfssl and unassigned helkoulak May 26, 2026

julek-wolfssl requested changes May 26, 2026

View reviewed changes

julek-wolfssl assigned helkoulak and unassigned wolfSSL-Bot and julek-wolfssl May 26, 2026

helkoulak added 3 commits May 29, 2026 23:29

More fixes for ascon file encrypt

c2a0ec1

Fix input len at cleanup

6ffa7ea

Use goto instead of while loop

04329e4

helkoulak requested a review from julek-wolfssl May 29, 2026 22:07

julek-wolfssl requested changes Jun 1, 2026

View reviewed changes

	for (int i = 0; i < BLOCK_SIZE; i += BLOCK_SIZE) {
	for (int i = 0; i < fileLength; i += BLOCK_SIZE) {

Conversation

helkoulak commented Apr 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

helkoulak commented Apr 28, 2026

Uh oh!

dgarske commented May 5, 2026

Uh oh!

helkoulak commented May 6, 2026

Uh oh!

dgarske commented May 6, 2026

Uh oh!

dgarske commented May 7, 2026

Uh oh!

julek-wolfssl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants