mirror of
https://github.com/isc-projects/bind9.git
synced 2026-05-23 02:28:55 -04:00
06f9163d51
Since BIND 9 headers are not longer public, there's no reason to keep the ISC_LANG_BEGINDECL and ISC_LANG_ENDDECL macros to support including them from C++ projects.
191 lines
5.4 KiB
C
191 lines
5.4 KiB
C
/*
|
|
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
*
|
|
* SPDX-License-Identifier: MPL-2.0
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, you can obtain one at https://mozilla.org/MPL/2.0/.
|
|
*
|
|
* See the COPYRIGHT file distributed with this work for additional
|
|
* information regarding copyright ownership.
|
|
*/
|
|
|
|
/*!
|
|
* \file isc/md.h
|
|
* \brief This is the header file for message digest algorithms.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <isc/crypto.h>
|
|
#include <isc/result.h>
|
|
#include <isc/types.h>
|
|
|
|
typedef void isc_md_t;
|
|
|
|
/**
|
|
* isc_md_type_t:
|
|
* @ISC_MD_MD5: MD5
|
|
* @ISC_MD_SHA1: SHA-1
|
|
* @ISC_MD_SHA224: SHA-224
|
|
* @ISC_MD_SHA256: SHA-256
|
|
* @ISC_MD_SHA384: SHA-384
|
|
* @ISC_MD_SHA512: SHA-512
|
|
*
|
|
* Enumeration of supported message digest algorithms.
|
|
*/
|
|
typedef void isc_md_type_t;
|
|
|
|
#define ISC_MD_MD5 isc__crypto_md5
|
|
#define ISC_MD_SHA1 isc__crypto_sha1
|
|
#define ISC_MD_SHA224 isc__crypto_sha224
|
|
#define ISC_MD_SHA256 isc__crypto_sha256
|
|
#define ISC_MD_SHA384 isc__crypto_sha384
|
|
#define ISC_MD_SHA512 isc__crypto_sha512
|
|
|
|
#define ISC_MD5_DIGESTLENGTH isc_md_type_get_size(ISC_MD_MD5)
|
|
#define ISC_MD5_BLOCK_LENGTH isc_md_type_get_block_size(ISC_MD_MD5)
|
|
#define ISC_SHA1_DIGESTLENGTH isc_md_type_get_size(ISC_MD_SHA1)
|
|
#define ISC_SHA1_BLOCK_LENGTH isc_md_type_get_block_size(ISC_MD_SHA1)
|
|
#define ISC_SHA224_DIGESTLENGTH isc_md_type_get_size(ISC_MD_SHA224)
|
|
#define ISC_SHA224_BLOCK_LENGTH isc_md_type_get_block_size(ISC_MD_SHA224)
|
|
#define ISC_SHA256_DIGESTLENGTH isc_md_type_get_size(ISC_MD_SHA256)
|
|
#define ISC_SHA256_BLOCK_LENGTH isc_md_type_get_block_size(ISC_MD_SHA256)
|
|
#define ISC_SHA384_DIGESTLENGTH isc_md_type_get_size(ISC_MD_SHA384)
|
|
#define ISC_SHA384_BLOCK_LENGTH isc_md_type_get_block_size(ISC_MD_SHA384)
|
|
#define ISC_SHA512_DIGESTLENGTH isc_md_type_get_size(ISC_MD_SHA512)
|
|
#define ISC_SHA512_BLOCK_LENGTH isc_md_type_get_block_size(ISC_MD_SHA512)
|
|
|
|
#define ISC_MAX_MD_SIZE 64U /* EVP_MAX_MD_SIZE */
|
|
#define ISC_MAX_BLOCK_SIZE 128U /* ISC_SHA512_BLOCK_LENGTH */
|
|
|
|
/**
|
|
* isc_md:
|
|
* @type: the digest type
|
|
* @buf: the data to hash
|
|
* @len: the length of the data to hash
|
|
* @digest: the output buffer
|
|
* @digestlen: the length of the data written to @digest
|
|
*
|
|
* This function hashes @len bytes of data at @buf and places the result in
|
|
* @digest. If the @digestlen parameter is not NULL then the number of bytes of
|
|
* data written (i.e. the length of the digest) will be written to the integer
|
|
* at @digestlen, at most ISC_MAX_MD_SIZE bytes will be written.
|
|
*/
|
|
isc_result_t
|
|
isc_md(const isc_md_type_t *type, const unsigned char *buf, const size_t len,
|
|
unsigned char *digest, unsigned int *digestlen);
|
|
|
|
/**
|
|
* isc_md_new:
|
|
*
|
|
* This function allocates, initializes and returns a digest context.
|
|
*/
|
|
isc_md_t *
|
|
isc_md_new(void);
|
|
|
|
/**
|
|
* isc_md_free:
|
|
* @md: message digest context
|
|
*
|
|
* This function cleans up digest context ctx and frees up the space allocated
|
|
* to it.
|
|
*/
|
|
void
|
|
isc_md_free(isc_md_t *);
|
|
|
|
/**
|
|
* isc_md_init:
|
|
* @md: message digest context
|
|
* @type: digest type
|
|
*
|
|
* This function sets up digest context @md to use a digest @type. @md must be
|
|
* initialized before calling this function.
|
|
*/
|
|
isc_result_t
|
|
isc_md_init(isc_md_t *, const isc_md_type_t *md_type);
|
|
|
|
/**
|
|
* isc_md_reset:
|
|
* @md: message digest context
|
|
*
|
|
* This function resets the digest context ctx. This can be used to reuse an
|
|
* already existing context.
|
|
*/
|
|
isc_result_t
|
|
isc_md_reset(isc_md_t *md);
|
|
|
|
/**
|
|
* isc_md_update:
|
|
* @md: message digest context
|
|
* @buf: data to hash
|
|
* @len: length of the data to hash
|
|
*
|
|
* This function hashes @len bytes of data at @buf into the digest context @md.
|
|
* This function can be called several times on the same @md to hash additional
|
|
* data.
|
|
*/
|
|
isc_result_t
|
|
isc_md_update(isc_md_t *md, const unsigned char *buf, const size_t len);
|
|
|
|
/**
|
|
* isc_md_final:
|
|
* @md: message digest context
|
|
* @digest: the output buffer
|
|
* @digestlen: the length of the data written to @digest
|
|
*
|
|
* This function retrieves the digest value from @md and places it in @digest.
|
|
* If the @digestlen parameter is not NULL then the number of bytes of data
|
|
* written (i.e. the length of the digest) will be written to the integer at
|
|
* @digestlen, at most ISC_MAX_MD_SIZE bytes will be written. After calling
|
|
* this function no additional calls to isc_md_update() can be made.
|
|
*/
|
|
isc_result_t
|
|
isc_md_final(isc_md_t *md, unsigned char *digest, unsigned int *digestlen);
|
|
|
|
/**
|
|
* isc_md_get_type:
|
|
* @md: message digest contezt
|
|
*
|
|
* This function return the isc_md_type_t previously set for the supplied
|
|
* message digest context or NULL if no isc_md_type_t has been set.
|
|
*/
|
|
const isc_md_type_t *
|
|
isc_md_get_md_type(isc_md_t *md);
|
|
|
|
/**
|
|
* isc_md_size:
|
|
*
|
|
* This function return the size of the message digest when passed an isc_md_t
|
|
* structure, i.e. the size of the hash.
|
|
*/
|
|
size_t
|
|
isc_md_get_size(isc_md_t *md);
|
|
|
|
/**
|
|
* isc_md_block_size:
|
|
*
|
|
* This function return the block size of the message digest when passed an
|
|
* isc_md_t structure.
|
|
*/
|
|
size_t
|
|
isc_md_get_block_size(isc_md_t *md);
|
|
|
|
/**
|
|
* isc_md_size:
|
|
*
|
|
* This function return the size of the message digest when passed an
|
|
* isc_md_type_t , i.e. the size of the hash.
|
|
*/
|
|
size_t
|
|
isc_md_type_get_size(const isc_md_type_t *md_type);
|
|
|
|
/**
|
|
* isc_md_block_size:
|
|
*
|
|
* This function return the block size of the message digest when passed an
|
|
* isc_md_type_t.
|
|
*/
|
|
size_t
|
|
isc_md_type_get_block_size(const isc_md_type_t *md_type);
|