hash.h

Go to the documentation of this file.

/*
 * Copyright 2013-2015 Guardtime, Inc.
 *
 * This file is part of the Guardtime client SDK.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *     http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES, CONDITIONS, OR OTHER LICENSES OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 * "Guardtime" and "KSI" are trademarks or registered trademarks of
 * Guardtime, Inc., and no license to trademarks is granted; Guardtime
 * reserves and retains all trademark rights.
 */

#ifndef KSI_HASH_H_
#define KSI_HASH_H_

#include <time.h>

#include "types_base.h"
#include "common.h"

#ifdef __cplusplus
extern "C" {
#endif

        typedef struct KSI_DataHasher_st KSI_DataHasher;

        typedef struct KSI_DataHash_st KSI_DataHash;

        typedef enum KSI_HashAlgorithm_en {
                KSI_HASHALG_INVALID = -1,

                KSI_HASHALG_SHA1 = 0x00,
                KSI_HASHALG_SHA2_256 = 0x01,
                KSI_HASHALG_RIPEMD160 = 0x02,
                KSI_HASHALG_SHA2_384 = 0x04,
                KSI_HASHALG_SHA2_512 = 0x05,
                KSI_HASHALG_SHA3_224 = 0x07,
                KSI_HASHALG_SHA3_256 = 0x08,
                KSI_HASHALG_SHA3_384 = 0x09,
                KSI_HASHALG_SHA3_512 = 0x0a,
                KSI_HASHALG_SM3 = 0x0b,

                /* Number of known hash algorithms. */
                KSI_NUMBER_OF_KNOWN_HASHALGS,
        } KSI_HashAlgorithm;

        KSI_VAR_DEPRECATED(extern const int KSI_HASHALG_SHA3_244, This is a typo - use #KSI_HASHALG_SHA3_224 instead!);

        #define KSI_MAX_IMPRINT_LEN 65 /* Algorithm ID (1 byte) + longest digest. */

        int KSI_DataHasher_open(KSI_CTX *ctx, KSI_HashAlgorithm algo_id, KSI_DataHasher **hasher);

        int KSI_DataHasher_reset(KSI_DataHasher *hasher);

        int KSI_DataHasher_add(KSI_DataHasher *hasher, const void *data, size_t data_length);

        int KSI_DataHasher_addImprint(KSI_DataHasher *hasher, const KSI_DataHash *hsh);

        int KSI_DataHasher_addOctetString(KSI_DataHasher *hasher, const KSI_OctetString *data);

        int KSI_DataHasher_close(KSI_DataHasher *hasher, KSI_DataHash **hash);

        void KSI_DataHasher_free(KSI_DataHasher *hasher);

        void KSI_DataHash_free(KSI_DataHash *hash);

        int KSI_DataHash_create(KSI_CTX *ctx, const void *data, size_t data_length, KSI_HashAlgorithm algo_id, KSI_DataHash **hash);

        KSI_FN_DEPRECATED(int KSI_DataHash_clone(KSI_DataHash *from, KSI_DataHash **to), Use #KSI_DataHash_ref instead.);

        int KSI_DataHash_extract(const KSI_DataHash *hash, KSI_HashAlgorithm *algo_id, const unsigned char **digest, size_t *digest_length);

        int KSI_DataHash_fromDigest(KSI_CTX *ctx, KSI_HashAlgorithm algo_id, const unsigned char *digest, size_t digest_length, KSI_DataHash **hash);

        int KSI_DataHash_getImprint(const KSI_DataHash *hash, const unsigned char **imprint, size_t *imprint_length);

        int KSI_DataHash_fromImprint(KSI_CTX *ctx, const unsigned char *imprint, size_t imprint_length, KSI_DataHash **hash);

        KSI_HashAlgorithm KSI_getHashAlgorithmByName(const char *name);

        unsigned int KSI_getHashLength(KSI_HashAlgorithm algo_id);

        unsigned int KSI_HashAlgorithm_getBlockSize(KSI_HashAlgorithm algo_id);

        time_t KSI_HashAlgorithm_getDeprecatedFrom(KSI_HashAlgorithm algo_id);

        time_t KSI_HashAlgorithm_getObsoleteFrom(KSI_HashAlgorithm algo_id);

        int KSI_isHashAlgorithmTrusted(KSI_HashAlgorithm algo_id);

        int KSI_checkHashAlgorithmAt(KSI_HashAlgorithm algo_id, time_t used_at);

        int KSI_isHashAlgorithmSupported(KSI_HashAlgorithm algo_id);

        const char *KSI_getHashAlgorithmName(KSI_HashAlgorithm algo_id);

        int KSI_DataHash_equals(const KSI_DataHash *left, const KSI_DataHash *right);

        KSI_DEFINE_FN_FROM_TLV(KSI_DataHash);
        KSI_DEFINE_FN_TO_TLV(KSI_DataHash);

        int KSI_DataHash_getHashAlg(const KSI_DataHash *hash, KSI_HashAlgorithm *algo_id);

        char *KSI_DataHash_toString(const KSI_DataHash *hsh, char *buf, size_t buf_len);

        int KSI_DataHash_createZero(KSI_CTX *ctx, KSI_HashAlgorithm algo_id, KSI_DataHash **hsh);

        KSI_DEFINE_REF(KSI_DataHash);
        KSI_DEFINE_LIST(KSI_DataHash);
#define KSI_DataHashList_append(lst, o) KSI_APPLY_TO_NOT_NULL((lst), append, ((lst), (o)))
#define KSI_DataHashList_remove(lst, pos, o) KSI_APPLY_TO_NOT_NULL((lst), removeElement, ((lst), (pos), (o)))
#define KSI_DataHashList_indexOf(lst, o, i) KSI_APPLY_TO_NOT_NULL((lst), indexOf, ((lst), (o), (i)))
#define KSI_DataHashList_insertAt(lst, pos, o) KSI_APPLY_TO_NOT_NULL((lst), insertAt, ((lst), (pos), (o)))
#define KSI_DataHashList_replaceAt(lst, pos, o) KSI_APPLY_TO_NOT_NULL((lst), replaceAt, ((lst), (pos), (o)))
#define KSI_DataHashList_elementAt(lst, pos, o) KSI_APPLY_TO_NOT_NULL((lst), elementAt, ((lst), (pos), (o)))
#define KSI_DataHashList_length(lst) (((lst) != NULL && (lst)->length != NULL) ? (lst)->length((lst)) : 0)
#define KSI_DataHashList_sort(lst, cmp) KSI_APPLY_TO_NOT_NULL((lst), sort, ((lst), (cmp)))
#define KSI_DataHashList_foldl(lst, foldCtx, foldFn) (((lst) != NULL) ? (((lst)->foldl != NULL) ? ((lst)->foldl((lst), (foldCtx), (foldFn))) : KSI_INVALID_STATE) : KSI_OK)

#ifdef __cplusplus
}
#endif

#endif /* KSI_HASH_H_ */