d84b79d358
The QCryptoHashAlgorithm enum is defined in the crypto/hash.h header. In the future some QAPI types will want to reference the hash enums, so move the enum definition into QAPI too. Reviewed-by: Eric Blake <eblake@redhat.com> Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
194 lines
6.1 KiB
C
194 lines
6.1 KiB
C
/*
|
|
* QEMU Crypto hash algorithms
|
|
*
|
|
* Copyright (c) 2015 Red Hat, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
#ifndef QCRYPTO_HASH_H__
|
|
#define QCRYPTO_HASH_H__
|
|
|
|
#include "qemu-common.h"
|
|
#include "qapi/error.h"
|
|
|
|
/* See also "QCryptoHashAlgorithm" defined in qapi/crypto.json */
|
|
|
|
/**
|
|
* qcrypto_hash_supports:
|
|
* @alg: the hash algorithm
|
|
*
|
|
* Determine if @alg hash algorithm is supported by the
|
|
* current configured build.
|
|
*
|
|
* Returns: true if the algorithm is supported, false otherwise
|
|
*/
|
|
gboolean qcrypto_hash_supports(QCryptoHashAlgorithm alg);
|
|
|
|
|
|
/**
|
|
* qcrypto_hash_digest_len:
|
|
* @alg: the hash algorithm
|
|
*
|
|
* Determine the size of the hash digest in bytes
|
|
*
|
|
* Returns: the digest length in bytes
|
|
*/
|
|
size_t qcrypto_hash_digest_len(QCryptoHashAlgorithm alg);
|
|
|
|
/**
|
|
* qcrypto_hash_bytesv:
|
|
* @alg: the hash algorithm
|
|
* @iov: the array of memory regions to hash
|
|
* @niov: the length of @iov
|
|
* @result: pointer to hold output hash
|
|
* @resultlen: pointer to hold length of @result
|
|
* @errp: pointer to uninitialized error object
|
|
*
|
|
* Computes the hash across all the memory regions
|
|
* present in @iov. The @result pointer will be
|
|
* filled with raw bytes representing the computed
|
|
* hash, which will have length @resultlen. The
|
|
* memory pointer in @result must be released
|
|
* with a call to g_free() when no longer required.
|
|
*
|
|
* Returns: 0 on success, -1 on error
|
|
*/
|
|
int qcrypto_hash_bytesv(QCryptoHashAlgorithm alg,
|
|
const struct iovec *iov,
|
|
size_t niov,
|
|
uint8_t **result,
|
|
size_t *resultlen,
|
|
Error **errp);
|
|
|
|
/**
|
|
* qcrypto_hash_bytes:
|
|
* @alg: the hash algorithm
|
|
* @buf: the memory region to hash
|
|
* @len: the length of @buf
|
|
* @result: pointer to hold output hash
|
|
* @resultlen: pointer to hold length of @result
|
|
* @errp: pointer to uninitialized error object
|
|
*
|
|
* Computes the hash across all the memory region
|
|
* @buf of length @len. The @result pointer will be
|
|
* filled with raw bytes representing the computed
|
|
* hash, which will have length @resultlen. The
|
|
* memory pointer in @result must be released
|
|
* with a call to g_free() when no longer required.
|
|
*
|
|
* Returns: 0 on success, -1 on error
|
|
*/
|
|
int qcrypto_hash_bytes(QCryptoHashAlgorithm alg,
|
|
const char *buf,
|
|
size_t len,
|
|
uint8_t **result,
|
|
size_t *resultlen,
|
|
Error **errp);
|
|
|
|
/**
|
|
* qcrypto_hash_digestv:
|
|
* @alg: the hash algorithm
|
|
* @iov: the array of memory regions to hash
|
|
* @niov: the length of @iov
|
|
* @digest: pointer to hold output hash
|
|
* @errp: pointer to uninitialized error object
|
|
*
|
|
* Computes the hash across all the memory regions
|
|
* present in @iov. The @digest pointer will be
|
|
* filled with the printable hex digest of the computed
|
|
* hash, which will be terminated by '\0'. The
|
|
* memory pointer in @digest must be released
|
|
* with a call to g_free() when no longer required.
|
|
*
|
|
* Returns: 0 on success, -1 on error
|
|
*/
|
|
int qcrypto_hash_digestv(QCryptoHashAlgorithm alg,
|
|
const struct iovec *iov,
|
|
size_t niov,
|
|
char **digest,
|
|
Error **errp);
|
|
|
|
/**
|
|
* qcrypto_hash_digest:
|
|
* @alg: the hash algorithm
|
|
* @buf: the memory region to hash
|
|
* @len: the length of @buf
|
|
* @digest: pointer to hold output hash
|
|
* @errp: pointer to uninitialized error object
|
|
*
|
|
* Computes the hash across all the memory region
|
|
* @buf of length @len. The @digest pointer will be
|
|
* filled with the printable hex digest of the computed
|
|
* hash, which will be terminated by '\0'. The
|
|
* memory pointer in @digest must be released
|
|
* with a call to g_free() when no longer required.
|
|
*
|
|
* Returns: 0 on success, -1 on error
|
|
*/
|
|
int qcrypto_hash_digest(QCryptoHashAlgorithm alg,
|
|
const char *buf,
|
|
size_t len,
|
|
char **digest,
|
|
Error **errp);
|
|
|
|
/**
|
|
* qcrypto_hash_base64v:
|
|
* @alg: the hash algorithm
|
|
* @iov: the array of memory regions to hash
|
|
* @niov: the length of @iov
|
|
* @base64: pointer to hold output hash
|
|
* @errp: pointer to uninitialized error object
|
|
*
|
|
* Computes the hash across all the memory regions
|
|
* present in @iov. The @base64 pointer will be
|
|
* filled with the base64 encoding of the computed
|
|
* hash, which will be terminated by '\0'. The
|
|
* memory pointer in @base64 must be released
|
|
* with a call to g_free() when no longer required.
|
|
*
|
|
* Returns: 0 on success, -1 on error
|
|
*/
|
|
int qcrypto_hash_base64v(QCryptoHashAlgorithm alg,
|
|
const struct iovec *iov,
|
|
size_t niov,
|
|
char **base64,
|
|
Error **errp);
|
|
|
|
/**
|
|
* qcrypto_hash_base64:
|
|
* @alg: the hash algorithm
|
|
* @buf: the memory region to hash
|
|
* @len: the length of @buf
|
|
* @base64: pointer to hold output hash
|
|
* @errp: pointer to uninitialized error object
|
|
*
|
|
* Computes the hash across all the memory region
|
|
* @buf of length @len. The @base64 pointer will be
|
|
* filled with the base64 encoding of the computed
|
|
* hash, which will be terminated by '\0'. The
|
|
* memory pointer in @base64 must be released
|
|
* with a call to g_free() when no longer required.
|
|
*
|
|
* Returns: 0 on success, -1 on error
|
|
*/
|
|
int qcrypto_hash_base64(QCryptoHashAlgorithm alg,
|
|
const char *buf,
|
|
size_t len,
|
|
char **base64,
|
|
Error **errp);
|
|
|
|
#endif /* QCRYPTO_HASH_H__ */
|