Lightweight Cryptography Primitives
 All Data Structures Files Functions Variables Typedefs Macros Pages
Macros | Functions | Variables
pyjamask.h File Reference

Pyjamask authenticated encryption algorithm. More...

#include "aead-common.h"

Go to the source code of this file.

Macros

#define PYJAMASK_128_KEY_SIZE   16
 Size of the key for Pyjamask-128-AEAD.
 
#define PYJAMASK_128_TAG_SIZE   16
 Size of the authentication tag for Pyjamask-128-AEAD.
 
#define PYJAMASK_128_NONCE_SIZE   12
 Size of the nonce for Pyjamask-128-AEAD.
 
#define PYJAMASK_96_KEY_SIZE   16
 Size of the key for Pyjamask-96-AEAD.
 
#define PYJAMASK_96_TAG_SIZE   12
 Size of the authentication tag for Pyjamask-96-AEAD.
 
#define PYJAMASK_96_NONCE_SIZE   8
 Size of the nonce for Pyjamask-96-AEAD.
 

Functions

int pyjamask_128_aead_encrypt (unsigned char *c, unsigned long long *clen, const unsigned char *m, unsigned long long mlen, const unsigned char *ad, unsigned long long adlen, const unsigned char *nsec, const unsigned char *npub, const unsigned char *k)
 Encrypts and authenticates a packet with Pyjamask-128-AEAD. More...
 
int pyjamask_128_aead_decrypt (unsigned char *m, unsigned long long *mlen, unsigned char *nsec, const unsigned char *c, unsigned long long clen, const unsigned char *ad, unsigned long long adlen, const unsigned char *npub, const unsigned char *k)
 Decrypts and authenticates a packet with Pyjamask-128-AEAD. More...
 
int pyjamask_96_aead_encrypt (unsigned char *c, unsigned long long *clen, const unsigned char *m, unsigned long long mlen, const unsigned char *ad, unsigned long long adlen, const unsigned char *nsec, const unsigned char *npub, const unsigned char *k)
 Encrypts and authenticates a packet with Pyjamask-96-AEAD. More...
 
int pyjamask_96_aead_decrypt (unsigned char *m, unsigned long long *mlen, unsigned char *nsec, const unsigned char *c, unsigned long long clen, const unsigned char *ad, unsigned long long adlen, const unsigned char *npub, const unsigned char *k)
 Decrypts and authenticates a packet with Pyjamask-96-AEAD. More...
 

Variables

aead_cipher_t const pyjamask_128_cipher
 Meta-information block for the Pyjamask-128-AEAD cipher.
 
aead_cipher_t const pyjamask_96_cipher
 Meta-information block for the Pyjamask-96-AEAD cipher.
 

Detailed Description

Pyjamask authenticated encryption algorithm.

Pyjamask AEAD is a family of authenticated encryption algorithms that are built around the Pyjamask-128 and Pyjamask-96 block ciphers in OCB mode. Pyjamask-128-AEAD has a 128-bit key, a 96-bit nonce, and a 128-bit authentication tag. Pyjamask-96-AEAD has a 128-bit key, a 64-bit nonce, and a 96-bit authentication tag.

References: https://pyjamask-cipher.github.io/

Function Documentation

int pyjamask_128_aead_decrypt ( unsigned char *  m,
unsigned long long *  mlen,
unsigned char *  nsec,
const unsigned char *  c,
unsigned long long  clen,
const unsigned char *  ad,
unsigned long long  adlen,
const unsigned char *  npub,
const unsigned char *  k 
)

Decrypts and authenticates a packet with Pyjamask-128-AEAD.

Parameters
mBuffer to receive the plaintext message on output.
mlenReceives the length of the plaintext message on output.
nsecSecret nonce - not used by this algorithm.
cBuffer that contains the ciphertext and authentication tag to decrypt.
clenLength of the input data in bytes, which includes the ciphertext and the 16 byte authentication tag.
adBuffer that contains associated data to authenticate along with the packet but which does not need to be encrypted.
adlenLength of the associated data in bytes.
npubPoints to the public nonce for the packet which must be 12 bytes in length.
kPoints to the 16 bytes of the key to use to decrypt the packet.
Returns
0 on success, -1 if the authentication tag was incorrect, or some other negative number if there was an error in the parameters.
See Also
pyjamask_128_aead_encrypt()
int pyjamask_128_aead_encrypt ( unsigned char *  c,
unsigned long long *  clen,
const unsigned char *  m,
unsigned long long  mlen,
const unsigned char *  ad,
unsigned long long  adlen,
const unsigned char *  nsec,
const unsigned char *  npub,
const unsigned char *  k 
)

Encrypts and authenticates a packet with Pyjamask-128-AEAD.

Parameters
cBuffer to receive the output.
clenOn exit, set to the length of the output which includes the ciphertext and the 16 byte authentication tag.
mBuffer that contains the plaintext message to encrypt.
mlenLength of the plaintext message in bytes.
adBuffer that contains associated data to authenticate along with the packet but which does not need to be encrypted.
adlenLength of the associated data in bytes.
nsecSecret nonce - not used by this algorithm.
npubPoints to the public nonce for the packet which must be 12 bytes in length.
kPoints to the 16 bytes of the key to use to encrypt the packet.
Returns
0 on success, or a negative value if there was an error in the parameters.
See Also
pyjamask_128_aead_decrypt()
int pyjamask_96_aead_decrypt ( unsigned char *  m,
unsigned long long *  mlen,
unsigned char *  nsec,
const unsigned char *  c,
unsigned long long  clen,
const unsigned char *  ad,
unsigned long long  adlen,
const unsigned char *  npub,
const unsigned char *  k 
)

Decrypts and authenticates a packet with Pyjamask-96-AEAD.

Parameters
mBuffer to receive the plaintext message on output.
mlenReceives the length of the plaintext message on output.
nsecSecret nonce - not used by this algorithm.
cBuffer that contains the ciphertext and authentication tag to decrypt.
clenLength of the input data in bytes, which includes the ciphertext and the 12 byte authentication tag.
adBuffer that contains associated data to authenticate along with the packet but which does not need to be encrypted.
adlenLength of the associated data in bytes.
npubPoints to the public nonce for the packet which must be 8 bytes in length.
kPoints to the 16 bytes of the key to use to decrypt the packet.
Returns
0 on success, -1 if the authentication tag was incorrect, or some other negative number if there was an error in the parameters.
See Also
pyjamask_96_aead_encrypt()
int pyjamask_96_aead_encrypt ( unsigned char *  c,
unsigned long long *  clen,
const unsigned char *  m,
unsigned long long  mlen,
const unsigned char *  ad,
unsigned long long  adlen,
const unsigned char *  nsec,
const unsigned char *  npub,
const unsigned char *  k 
)

Encrypts and authenticates a packet with Pyjamask-96-AEAD.

Parameters
cBuffer to receive the output.
clenOn exit, set to the length of the output which includes the ciphertext and the 12 byte authentication tag.
mBuffer that contains the plaintext message to encrypt.
mlenLength of the plaintext message in bytes.
adBuffer that contains associated data to authenticate along with the packet but which does not need to be encrypted.
adlenLength of the associated data in bytes.
nsecSecret nonce - not used by this algorithm.
npubPoints to the public nonce for the packet which must be 8 bytes in length.
kPoints to the 16 bytes of the key to use to encrypt the packet.
Returns
0 on success, or a negative value if there was an error in the parameters.
See Also
pyjamask_96_aead_decrypt()