CryptoUtils.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2021, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_cryptoutils_utils_CryptoUtils__include
#define ti_drivers_cryptoutils_utils_CryptoUtils__include

#include <stdint.h>
#include <stdbool.h>
#include <string.h>


#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    CryptoUtils_ENDIANESS_BIG = 0u,     
    CryptoUtils_ENDIANESS_LITTLE = 1u,  
} CryptoUtils_Endianess;

extern const uint8_t *CryptoUtils_limitZero;

extern const uint8_t *CryptoUtils_limitOne;

bool CryptoUtils_buffersMatch(const volatile void *volatile buffer0,
                              const volatile void *volatile buffer1,
                              size_t bufferByteLength);

bool CryptoUtils_buffersMatchWordAligned(const volatile uint32_t *volatile buffer0,
                                         const volatile uint32_t *volatile buffer1,
                                         size_t bufferByteLength);

bool CryptoUtils_isBufferAllZeros(const void *buffer, size_t bufferByteLength);

void CryptoUtils_memset(void *dest, size_t destSize, uint8_t val, size_t count);

void CryptoUtils_reverseBufferBytewise(void * buffer, size_t bufferByteLength);

void CryptoUtils_copyPad(const void *source,
                         uint32_t *destination,
                         size_t sourceLength);

void CryptoUtils_reverseCopyPad(const void *source,
                                uint32_t *destination,
                                size_t sourceLength);

void CryptoUtils_reverseCopy(const void *source,
                             void *destination,
                             size_t sourceLength);

bool CryptoUtils_isNumberInRange(const void *number,
                                 size_t bitLength,
                                 CryptoUtils_Endianess endianess,
                                 const void *lowerLimit,
                                 const void *upperLimit);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_cryptoutils_utils_CryptoUtils__include */