1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
|
/* SPDX-FileCopyrightText: 2025 Greenbone AG
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef _GVM_STREAMVALIDATOR_H
#define _GVM_STREAMVALIDATOR_H
#include <stdio.h>
#define GVM_STREAM_VALIDATOR_NO_SIZE ((size_t) - 1)
/**
* @file
* @brief Data stream validation headers.
*/
typedef enum
{
/** An internal error ocurred. */
GVM_STREAM_VALIDATOR_INTERNAL_ERROR = -1,
/** Action successful / data is valid. */
GVM_STREAM_VALIDATOR_OK = 0,
/** Not enough data received. */
GVM_STREAM_VALIDATOR_DATA_TOO_SHORT = 1,
/** Too much data received. */
GVM_STREAM_VALIDATOR_DATA_TOO_LONG,
/** Syntax error in hash string (not using "algo:hex" format). */
GVM_STREAM_VALIDATOR_INVALID_HASH_SYNTAX,
/** Invalid or unsupported hash algorithm. */
GVM_STREAM_VALIDATOR_INVALID_HASH_ALGORITHM,
/** Hash value is not valid.
* (e.g. not hexadecimal or length does not match algorithm) */
GVM_STREAM_VALIDATOR_INVALID_HASH_VALUE,
/** Hash of received data does not match the expected hash */
GVM_STREAM_VALIDATOR_HASH_MISMATCH
} gvm_stream_validator_return_t;
/**
* @brief Pointer to an opaque stream validator data structure.
*/
typedef struct gvm_stream_validator *gvm_stream_validator_t;
const char *gvm_stream_validator_return_str (gvm_stream_validator_return_t);
gvm_stream_validator_return_t
gvm_stream_validator_new (const char *, gvm_stream_validator_t *);
gvm_stream_validator_return_t
gvm_stream_validator_with_size_new (const char *, size_t,
gvm_stream_validator_t *);
void gvm_stream_validator_rewind (gvm_stream_validator_t);
void gvm_stream_validator_free (gvm_stream_validator_t);
gvm_stream_validator_return_t
gvm_stream_validator_write (gvm_stream_validator_t, const char *, size_t);
gvm_stream_validator_return_t gvm_stream_validator_end (gvm_stream_validator_t);
#endif /* not _GVM_STREAMVALIDATOR_H */
|