internal-subterranean.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Southern Storm Software, Pty Ltd.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#ifndef LW_INTERNAL_SUBTERRANEAN_H
#define LW_INTERNAL_SUBTERRANEAN_H

#include "internal-util.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct
{
    uint32_t x[9];      
} subterranean_state_t;

void subterranean_round(subterranean_state_t *state);

void subterranean_blank(subterranean_state_t *state);

#define subterranean_duplex_0(state) \
    do { \
        subterranean_round((state)); \
        (state)->x[0] ^= 2; /* padding for an empty block */ \
    } while (0)

void subterranean_absorb_1(subterranean_state_t *state, unsigned char data);

#define subterranean_duplex_1(state, data) \
    do { \
        subterranean_round((state)); \
        subterranean_absorb_1((state), (data)); \
    } while (0)

void subterranean_absorb_word(subterranean_state_t *state, uint32_t x);

#define subterranean_duplex_word(state, x) \
    do { \
        subterranean_round((state)); \
        subterranean_absorb_word((state), (x)); \
    } while (0)

#define subterranean_duplex_4(state, data) \
    do { \
        subterranean_duplex_word((state), (data)); \
        (state)->x[8] ^= 1; \
    } while (0)

void subterranean_duplex_n
    (subterranean_state_t *state, const unsigned char *data, unsigned len);

uint32_t subterranean_extract(subterranean_state_t *state);

void subterranean_absorb
    (subterranean_state_t *state, const unsigned char *data,
     unsigned long long len);

void subterranean_squeeze
    (subterranean_state_t *state, unsigned char *data, unsigned len);

#ifdef __cplusplus
}
#endif

#endif