src/common/common.h

Utility functions for use in liboqs.

SPDX-License-Identifier: MIT

Includes

#include <limits.h>
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <oqs/oqsconfig.h>

Enumeration Types

enum OQS_STATUS
enum OQS_CPU_EXT

[src]

`enum OQS_STATUS`

Represents return values from functions.

Callers should compare with the symbol rather than the individual value. For example,

ret = OQS_KEM_encaps(...);
if (ret == OQS_SUCCESS) { ... }

rather than

if (!OQS_KEM_encaps(...) { ... }

Enumeration values

`OQS_ERROR = -1`	Used to indicate that some undefined error occurred.
`OQS_SUCCESS = 0`	Used to indicate successful return from function.
`OQS_EXTERNAL_LIB_ERROR_OPENSSL = 50`	Used to indicate failures in external libraries (e.g., OpenSSL).

[src]

`enum OQS_CPU_EXT`

CPU runtime detection flags

Enumeration values

`OQS_CPU_EXT_INIT`
`OQS_CPU_EXT_ADX`
`OQS_CPU_EXT_AES`
`OQS_CPU_EXT_AVX`
`OQS_CPU_EXT_AVX2`
`OQS_CPU_EXT_AVX512`
`OQS_CPU_EXT_BMI1`
`OQS_CPU_EXT_BMI2`
`OQS_CPU_EXT_PCLMULQDQ`
`OQS_CPU_EXT_VPCLMULQDQ`
`OQS_CPU_EXT_POPCNT`
`OQS_CPU_EXT_SSE`
`OQS_CPU_EXT_SSE2`
`OQS_CPU_EXT_SSE3`
`OQS_CPU_EXT_ARM_AES`
`OQS_CPU_EXT_ARM_SHA2`
`OQS_CPU_EXT_ARM_SHA3`
`OQS_CPU_EXT_ARM_NEON`
`OQS_CPU_EXT_COUNT`

Functions

`OQS_API int`	`OQS_CPU_has_extension(OQS_CPU_EXT ext)`
`OQS_API void`	`OQS_init(void)`
`OQS_API void`	`OQS_destroy(void)`
`OQS_API const char *`	`OQS_version(void)`
`OQS_API int`	`OQS_MEM_secure_bcmp(const void a, const void b, size_t len)`
`OQS_API void`	`OQS_MEM_cleanse(void *ptr, size_t len)`
`OQS_API void`	`OQS_MEM_secure_free(void *ptr, size_t len)`
`OQS_API void`	`OQS_MEM_insecure_free(void *ptr)`
`void *`	`OQS_MEM_aligned_alloc(size_t alignment, size_t size)`
`void`	`OQS_MEM_aligned_free(void *ptr)`

[src]

OQS_CPU_has_extension

OQS_API int OQS_CPU_has_extension(OQS_CPU_EXT ext)

Checks if the CPU supports a given extension

Returns

1 if the given CPU extension is available, 0 otherwise.

[src]

OQS_init

OQS_API void OQS_init(void)

This currently sets the values in the OQS_CPU_EXTENSIONS and prefetches the OpenSSL objects if necessary.

[src]

OQS_destroy

OQS_API void OQS_destroy(void)

This function frees prefetched OpenSSL objects

[src]

OQS_version

OQS_API const char * OQS_version(void)

Return library version string.

[src]

OQS_MEM_secure_bcmp

OQS_API int OQS_MEM_secure_bcmp(const void *a, const void *b, size_t len)

Constant time comparison of byte sequences a and b of length len. Returns 0 if the byte sequences are equal or if len=0. Returns 1 otherwise.

Parameters

`const void *`	`a`	A byte sequence of length at least `len`.
`const void *`	`b`	A byte sequence of length at least `len`.
`size_t`	`len`	The number of bytes to compare.

[src]

OQS_MEM_cleanse

OQS_API void OQS_MEM_cleanse(void *ptr, size_t len)

Zeros out len bytes of memory starting at ptr.

Designed to be protected against optimizing compilers which try to remove "unnecessary" operations. Should be used for all buffers containing secret data.

Parameters

`void *`	`ptr`	The start of the memory to zero out.
`size_t`	`len`	The number of bytes to zero out.

[src]

OQS_MEM_secure_free

OQS_API void OQS_MEM_secure_free(void *ptr, size_t len)

Zeros out len bytes of memory starting at ptr, then frees ptr.

Can be called with ptr = NULL, in which case no operation is performed.

Designed to be protected against optimizing compilers which try to remove "unnecessary" operations. Should be used for all buffers containing secret data.

Parameters

`void *`	`ptr`	The start of the memory to zero out and free.
`size_t`	`len`	The number of bytes to zero out.

[src]

OQS_MEM_insecure_free

OQS_API void OQS_MEM_insecure_free(void *ptr)

Frees ptr.

Can be called with ptr = NULL, in which case no operation is performed.

Should only be used on non-secret data.

Parameters

void *

ptr

The start of the memory to free.

[src]

OQS_MEM_aligned_alloc

void * OQS_MEM_aligned_alloc(size_t alignment, size_t size)

Internal implementation of C11 aligned_alloc to work around compiler quirks.

Allocates size bytes of uninitialized memory with a base pointer that is a multiple of alignment. Alignment must be a power of two and a multiple of sizeof(void *). Size must be a multiple of alignment.

[src]

OQS_MEM_aligned_free

void OQS_MEM_aligned_free(void *ptr)

Free memory allocated with OQS_MEM_aligned_alloc.

Macros

[src]

#define OQS_EXIT_IF_NULLPTR (x, loc)

Macro for terminating the program if x is a null pointer.

    do {                          \
        if ( (x) == (void*)0 ) {  \
            fprintf(stderr, "Unexpected NULL returned from %s API. Exiting.\n", loc); \
            exit(EXIT_FAILURE); \
        }  \
    } while (0)

[src]

#define OQS_OPENSSL_GUARD (x)

This macro is intended to replace those assert()s involving side-effecting statements in aes/aes_ossl.c.

assert() becomes a no-op when -DNDEBUG is defined, which causes compilation failures when the statement being checked also results in side-effects.

This is a temporary workaround until a better error handling strategy is developed.

    do {                        \
        if( 1 != (x) ) {        \
            fprintf(stderr, "Error return value from OpenSSL API: %d. Exiting.\n", x); \
            exit(EXIT_FAILURE); \
        }                       \
    } while (0)

[src]

#define SIZE_T_TO_INT_OR_EXIT (size_t_var_name, int_var_name)

Certain functions (such as OQS_randombytes_openssl in src/rand/rand.c) take in a size_t parameter, but can only handle values up to INT_MAX for those parameters. This macro is a temporary workaround for such functions.

    int int_var_name = 0;                                     \
    if (size_t_var_name <= INT_MAX) {                         \
        int_var_name = (int)size_t_var_name;                  \
    } else {                                                  \
        exit(EXIT_FAILURE);                                   \
    }

[src]

#define OQS_API __attribute__((visibility("default")))

Defines which functions should be exposed outside the LibOQS library

By default the visibility of all the symbols is defined to "hidden" Only the library API should be marked as default

Example: OQS_API return_value function_name(void);