xref: /freebsd-src/crypto/libecc/src/examples/hash/mdc2.h (revision f0865ec9906d5a18fa2a3b61381f22ce16e606ad)

/*
 *  Copyright (C) 2021 - This file is part of libecc project
 *
 *  Authors:
 *      Ryad BENADJILA <ryadbenadjila@gmail.com>
 *      Arnaud EBALARD <arnaud.ebalard@ssi.gouv.fr>
 *
 *  This software is licensed under a dual BSD and GPL v2 license.
 *  See LICENSE file at the root folder of the project.
 */
#ifndef __MDC2_H__
#define __MDC2_H__

/* Include libec for useful types and macros */
#include <libecc/libec.h>

#define MDC2_STATE_SIZE   16
#define MDC2_BLOCK_SIZE   8
#define MDC2_DIGEST_SIZE  16
#define MDC2_DIGEST_SIZE_BITS  128

#define MDC2_HASH_MAGIC ((word_t)(0x8296527183648310ULL))
#define MDC2_HASH_CHECK_INITIALIZED(A, ret, err) \
	MUST_HAVE((((void *)(A)) != NULL) && ((A)->magic == MDC2_HASH_MAGIC), ret, err)

/* Padding types as described in the informative appendix of
 * ISO-IEC-10118-2-1994
 */
typedef enum {
	ISOIEC10118_TYPE1 = 0,
	ISOIEC10118_TYPE2 = 1,
} padding_type;

typedef struct {
	/* Number of bytes processed */
	u64 mdc2_total;
	/* Internal state */
	u8 mdc2_state[MDC2_STATE_SIZE];
	/* Internal buffer to handle updates in a block */
	u8 mdc2_buffer[MDC2_BLOCK_SIZE];
	/* Initialization magic value */
	word_t magic;
	/* Padding type, as per ISO-IEC-10118-2-1994 */
	padding_type padding;
} mdc2_context;

ATTRIBUTE_WARN_UNUSED_RET int mdc2_set_padding_type(mdc2_context *ctx,
							padding_type p);

/* Init hash function. Returns 0 on success, -1 on error. */
ATTRIBUTE_WARN_UNUSED_RET int mdc2_init(mdc2_context *ctx);

ATTRIBUTE_WARN_UNUSED_RET int mdc2_update(mdc2_context *ctx, const u8 *input, u32 ilen);

/* Finalize. Returns 0 on success, -1 on error.*/
ATTRIBUTE_WARN_UNUSED_RET int mdc2_final(mdc2_context *ctx, u8 output[MDC2_DIGEST_SIZE]);

/*
 * Scattered version performing init/update/finalize on a vector of buffers
 * 'inputs' with the length of each buffer passed via 'ilens'. The function
 * loops on pointers in 'inputs' until it finds a NULL pointer. The function
 * returns 0 on success, -1 on error.
 */
ATTRIBUTE_WARN_UNUSED_RET int mdc2_scattered(const u8 **inputs, const u32 *ilens,
		      u8 output[MDC2_DIGEST_SIZE], padding_type p);

/*
 * Scattered version performing init/update/finalize on a vector of buffers
 * 'inputs' with the length of each buffer passed via 'ilens'. The function
 * loops on pointers in 'inputs' until it finds a NULL pointer. The function
 * returns 0 on success, -1 on error.
 */
ATTRIBUTE_WARN_UNUSED_RET int mdc2_scattered_padding1(const u8 **inputs, const u32 *ilens,
		      u8 output[MDC2_DIGEST_SIZE]);

/*
 * Scattered version performing init/update/finalize on a vector of buffers
 * 'inputs' with the length of each buffer passed via 'ilens'. The function
 * loops on pointers in 'inputs' until it finds a NULL pointer. The function
 * returns 0 on success, -1 on error.
 */
ATTRIBUTE_WARN_UNUSED_RET int mdc2_scattered_padding2(const u8 **inputs, const u32 *ilens,
		      u8 output[MDC2_DIGEST_SIZE]);
/*
 * Single call version performing init/update/final on given input.
 * Returns 0 on success, -1 on error.
 */
ATTRIBUTE_WARN_UNUSED_RET int mdc2(const u8 *input, u32 ilen, u8 output[MDC2_DIGEST_SIZE], padding_type p);

/*
 * Single call version performing init/update/final on given input.
 * Returns 0 on success, -1 on error.
 */
ATTRIBUTE_WARN_UNUSED_RET int mdc2_padding1(const u8 *input, u32 ilen, u8 output[MDC2_DIGEST_SIZE]);

/*
 * Single call version performing init/update/final on given input.
 * Returns 0 on success, -1 on error.
 */
ATTRIBUTE_WARN_UNUSED_RET int mdc2_padding2(const u8 *input, u32 ilen, u8 output[MDC2_DIGEST_SIZE]);

#endif /* __MDC2_H__ */