106 lines
2.5 KiB
C
106 lines
2.5 KiB
C
/*
|
|
* Copyright (C) 2016 Andreas Steffen
|
|
* HSR Hochschule fuer Technik Rapperswil
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation; either version 2 of the License, or (at your
|
|
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
|
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* for more details.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup xof xof
|
|
* @{ @ingroup crypto
|
|
*/
|
|
|
|
#ifndef XOF_H_
|
|
#define XOF_H_
|
|
|
|
typedef enum ext_out_function_t ext_out_function_t;
|
|
typedef struct xof_t xof_t;
|
|
|
|
#include <library.h>
|
|
|
|
/**
|
|
* Extendable Output Functions.
|
|
*/
|
|
enum ext_out_function_t {
|
|
XOF_UNDEFINED,
|
|
/** FIPS 202 */
|
|
XOF_SHAKE_128,
|
|
/** FIPS 202 */
|
|
XOF_SHAKE_256,
|
|
/** RFC 2437 PKCS#1 */
|
|
XOF_MGF1_SHA1,
|
|
/** RFC 2437 PKCS#1 */
|
|
XOF_MGF1_SHA256,
|
|
/** RFC 2437 PKCS#1 */
|
|
XOF_MGF1_SHA512,
|
|
};
|
|
|
|
/**
|
|
* enum name for ext_out_function_t.
|
|
*/
|
|
extern enum_name_t *ext_out_function_names;
|
|
|
|
/**
|
|
* Generic interface for pseudo-random-functions.
|
|
*/
|
|
struct xof_t {
|
|
|
|
/**
|
|
* Generates pseudo random bytes and writes them in the buffer.
|
|
*
|
|
* @param out_len number of output bytes requested
|
|
* @param buffer pointer where the generated bytes will be written
|
|
* @return TRUE if bytes generated successfully
|
|
*/
|
|
bool (*get_bytes)(xof_t *this, size_t out_len,
|
|
uint8_t *buffer) __attribute__((warn_unused_result));
|
|
|
|
/**
|
|
* Generates pseudo random bytes and allocate space for them.
|
|
*
|
|
* @param out_len number of output bytes requested
|
|
* @param chunk chunk which will hold generated bytes
|
|
* @return TRUE if bytes allocated and generated successfully
|
|
*/
|
|
bool (*allocate_bytes)(xof_t *this, size_t out_len,
|
|
chunk_t *chunk) __attribute__((warn_unused_result));
|
|
|
|
/**
|
|
* Get the output block size
|
|
*
|
|
* @return block size in bytes
|
|
*/
|
|
size_t (*get_block_size)(xof_t *this);
|
|
|
|
/**
|
|
* Get the recommended minimum seed size
|
|
*
|
|
* @return seed size in bytes
|
|
*/
|
|
size_t (*get_seed_size)(xof_t *this);
|
|
|
|
/**
|
|
* Set the key for this xof_t object.
|
|
*
|
|
* @param sed seed to set
|
|
* @return TRUE if XOF initialized with seed successfully
|
|
*/
|
|
bool (*set_seed)(xof_t *this,
|
|
chunk_t seed) __attribute__((warn_unused_result));
|
|
|
|
/**
|
|
* Destroys a xof object.
|
|
*/
|
|
void (*destroy)(xof_t *this);
|
|
};
|
|
|
|
#endif /** XOF_H_ @}*/
|