Lightweight Cryptography Primitives
 All Data Structures Files Functions Variables Typedefs Macros Pages
subterranean.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2020 Southern Storm Software, Pty Ltd.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef LWCRYPTO_SUBTERRANEAN_H
24 #define LWCRYPTO_SUBTERRANEAN_H
25 
26 #include "aead-common.h"
27 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
52 #define SUBTERRANEAN_KEY_SIZE 16
53 
57 #define SUBTERRANEAN_TAG_SIZE 16
58 
62 #define SUBTERRANEAN_NONCE_SIZE 16
63 
67 #define SUBTERRANEAN_HASH_SIZE 32
68 
73 
78 
82 typedef union
83 {
84  unsigned char state[40];
85  unsigned long long align;
88 
111  (unsigned char *c, unsigned long long *clen,
112  const unsigned char *m, unsigned long long mlen,
113  const unsigned char *ad, unsigned long long adlen,
114  const unsigned char *nsec,
115  const unsigned char *npub,
116  const unsigned char *k);
117 
141  (unsigned char *m, unsigned long long *mlen,
142  unsigned char *nsec,
143  const unsigned char *c, unsigned long long clen,
144  const unsigned char *ad, unsigned long long adlen,
145  const unsigned char *npub,
146  const unsigned char *k);
147 
162  (unsigned char *out, const unsigned char *in, unsigned long long inlen);
163 
173 
184  (subterranean_hash_state_t *state, const unsigned char *in,
185  unsigned long long inlen);
186 
196  (subterranean_hash_state_t *state, unsigned char *out);
197 
198 #ifdef __cplusplus
199 }
200 #endif
201 
202 #endif
void subterranean_hash_init(subterranean_hash_state_t *state)
Initializes the state for a Subterranean hashing operation.
Definition: subterranean.c:201
Meta-information about an AEAD cipher.
Definition: aead-common.h:185
Definitions that are common across AEAD schemes.
int subterranean_hash(unsigned char *out, const unsigned char *in, unsigned long long inlen)
Hashes a block of input data with Subterranean.
Definition: subterranean.c:185
aead_cipher_t const subterranean_cipher
Meta-information block for the Subterranean cipher.
Definition: subterranean.c:27
Meta-information about a hash algorithm that is related to an AEAD.
Definition: aead-common.h:204
void subterranean_hash_finalize(subterranean_hash_state_t *state, unsigned char *out)
Returns the final hash value from a Subterranean hashing operation.
Definition: subterranean.c:219
unsigned long long align
Definition: subterranean.h:85
int subterranean_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 Subterranean.
Definition: subterranean.c:116
aead_hash_algorithm_t const subterranean_hash_algorithm
Meta-information block for the SUBTERRANEAN hash algorithm.
Definition: subterranean.c:37
int subterranean_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 Subterranean.
Definition: subterranean.c:51
void subterranean_hash_update(subterranean_hash_state_t *state, const unsigned char *in, unsigned long long inlen)
Updates a Subterranean state with more input data.
Definition: subterranean.c:207
State information for the Subterreaan incremental hash mode.
Definition: subterranean.h:82