VAMPIRE

eBACS: ECRYPT Benchmarking of Cryptographic Systems


ECRYPT II
General information: Introduction eBASH eBASC eBAEAD eBATS SUPERCOP XBX Computers Arch
How to submit new software: Tips hash stream aead dh kem encrypt sign
List of primitives measured: lwc sha3 hash stream lwc caesar aead dh kem encrypt sign
Measurements: lwc sha3 hash stream lwc caesar aead dh kem encrypt sign
List of subroutines: verify decode encode sort core hashblocks xof scalarmult

Call for public-key Diffie–Hellman secret-sharing software for benchmarking

Are you a designer or implementor of a Diffie–Hellman function? Would you like your software professionally benchmarked on many computers, producing stable, reliable, verifiable timings that reflect the performance that Diffie–Hellman users will see? This page explains how to submit your software to the eBATS project. Formal submission requirements have been kept to a minimum, but your software needs to follow a few naming conventions so that it can be benchmarked by SUPERCOP.

There is a separate page listing the Diffie–Hellman functions submitted so far, and another page reporting measurements of those functions. Note that the eBATS project also includes public-key signature systems, key-encapsulation mechanisms, and encryption systems.

Example for designers: submitting the XTR-512 system

Let's say you're the designer of XTR-512, a Diffie–Hellman system with a 1536-bit private key, a 512-bit public key, and a 512-bit shared secret, and you want to submit your XTR-512 software to eBATS. Your submission can be as simple as two files, crypto_dh/xtr512/ref/api.h and crypto_dh/xtr512/ref/dh.c. Here is an explanation of what these files contain and what additional options you have.

The top-level directory name crypto_dh is required; it distinguishes Diffie–Hellman functions from other operations benchmarked by SUPERCOP, such as crypto_hash and crypto_sign.

The second-level directory name xtr512 should be a lowercase version of your system's name. Please omit dashes, dots, slashes, and other punctuation marks; the directory name should consist solely of digits (0123456789) and lowercase ASCII letters (abcdefghijklmnopqrstuvwxyz).

Different Diffie–Hellman functions must be placed into different second-level directories, even if they are part of the same "family" of functions. For example, crypto_dh/nistp256 is separate from crypto_dh/nistp224. One submission tarball can include several Diffie–Hellman functions in separate directories. Directory names may be changed by the eBATS managers to resolve conflicts or confusion.

The third-level directory name ref is up to you. Different implementations must be placed into different third-level directories. You can use subdirectories here; for example, crypto_dh/xtr512/ref might be a reference implementation, crypto_dh/xtr512/smith/little might be John Smith's little-endian implementation, and crypto_dh/xtr512/smith/sse3 might be John Smith's SSE3-optimized implementation. One submission tarball can include several implementations.

After choosing the implementation name crypto_dh/xtr512/ref, create a directory by that name. Inside the crypto_dh/xtr512/ref directory, create a file named api.h with three lines

     #define CRYPTO_SECRETKEYBYTES 192
     #define CRYPTO_PUBLICKEYBYTES 64
     #define CRYPTO_BYTES 64
indicating that your software uses a 192-byte (1536-bit) secret key, a 64-byte (512-bit) public key, and a 64-byte (512-bit) shared secret.

Next, inside the crypto_dh/xtr512/ref directory, create a file named dh.c that defines a crypto_dh function and a crypto_dh_keypair function:

     #include "crypto_dh.h"

     int crypto_dh_keypair(
       unsigned char *pk,
       unsigned char *sk
     )
     {
       ... 
       ... the code for your XTR-512 implementation goes here,
       ... generating public key pk[0],pk[1],...
       ... and secret key sk[0],sk[1],...
       ...
       return 0;
     }
     
     int crypto_dh(
       unsigned char *out,
       const unsigned char *pk,
       const unsigned char *sk
     )
     {
       ... 
       ... the code for your XTR-512 implementation goes here,
       ... generating shared secret out[0],out[1],...
       ... from public key pk[0],pk[1],...
       ... and secret key sk[0],sk[1],...
       ...
       return 0;
     }
Your functions must have exactly the prototypes shown here. The keypair function must have an unsigned char pointer for the public-key output and an unsigned char pointer for the secret-key output. The other function must have an unsigned char pointer for the shared-secret output, a const unsigned char pointer for the public-key input, and a const unsigned char pointer for the secret-key input. Your functions must return 0 to indicate success, or a negative number to indicate failure (e.g., out of memory).

You can use names other than dh.c. You can split your code across several files *.c defining various auxiliary functions; the files will be automatically compiled together. You must include crypto_dh.h for any file referring to the crypto_dh_* functions. The file crypto_dh.h is not something for you to write or submit; it is created automatically by SUPERCOP. See the SUPERCOP tips for more advice and options.

Finally, create a tarball such as xtr512-ref-3.01a.tar.gz that contains your crypto_dh/xtr512/ref/api.h, crypto_dh/xtr512/ref/dh.c, etc. Put the tarball on the web, and send the URL to the eBACS/eBATS/eBASC/eBASH mailing list with a note requesting inclusion in SUPERCOP and subsequent benchmarking.

Version

This is version 2020.08.01 of the call-dh.html web page. This web page is in the public domain.