![]() 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 |
|---|
There is a separate page listing the signature systems submitted to eBATS so far, and another page reporting measurements of those systems. Note that the eBATS project also includes public-key key-encapsulation mechanisms, encryption systems, and Diffie–Hellman systems.
The top-level directory name crypto_sign is required; it distinguishes signatures from other operations benchmarked by SUPERCOP, such as crypto_stream and crypto_dh.
The second-level directory name square2048 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 signature systems must be placed into different second-level directories, even if they are part of the same "family" of systems. For example, crypto_sign/ecdonaldp224 is separate from crypto_sign/ecdonaldp256. One submission tarball can include several signature systems 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_sign/square2048/ref might be a reference implementation, crypto_sign/square2048/smith/little might be John Smith's little-endian implementation, and crypto_sign/square2048/smith/sse3 might be John Smith's SSE3-optimized implementation. One submission tarball can include several implementations.
After choosing the implementation name crypto_sign/square2048/ref, create a directory by that name. Inside the crypto_sign/square2048/ref directory, create a file named api.h with three lines
#define CRYPTO_SECRETKEYBYTES 256
#define CRYPTO_PUBLICKEYBYTES 85
#define CRYPTO_BYTES 128
indicating that your software uses a 256-byte (2048-bit) secret key,
an 85-byte (680-bit) public key,
and at most 128 bytes of overhead in a signed message compared to the original message.
Next, inside the crypto_sign/square2048/ref directory, create a file named sign.c that defines the following three functions:
#include "crypto_sign.h"
int crypto_sign_keypair(
unsigned char *pk,
unsigned char *sk
)
{
...
... the code for your Square2048 implementation goes here,
... generating public key pk[0],pk[1],...
... and secret key sk[0],sk[1],...
...
return 0;
}
int crypto_sign(
unsigned char *sm,unsigned long long *smlen,
const unsigned char *m,unsigned long long mlen,
const unsigned char *sk
)
{
...
... the code for your Square2048 implementation goes here,
... generating a signed message sm[0],sm[1],...,sm[*smlen-1]
... from original message m[0],m[1],...,m[mlen-1]
... under secret key sk[0],sk[1],...
...
return 0;
}
int crypto_sign_open(
unsigned char *m,unsigned long long *mlen,
const unsigned char *sm,unsigned long long smlen,
const unsigned char *pk
)
{
...
... the code for your Square2048 implementation goes here,
... verifying a signed message sm[0],sm[1],...,sm[smlen-1]
... under public key pk[0],pk[1],...
... and producing original message m[0],m[1],...,m[*mlen-1]
...
return 0;
}
Your functions must have exactly the prototypes shown here.
For example,
the keypair function must have
an unsigned char pointer for the public-key output
and then an unsigned char pointer for the secret-key output.
Your functions must return 0 to indicate success,
-1 to indicate verification failure,
or other negative numbers to indicate other failures (e.g., out of memory).
You can use names other than sign.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_sign.h for any file referring to the crypto_sign_* functions. The file crypto_sign.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 square2048-ref-3.01a.tar.gz that contains your crypto_sign/square2048/ref/api.h, crypto_sign/square2048/ref/sign.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.