iqr_context.h File Reference

ISARA Radiate Security Solution Suite's Context object. More...

Typedefs
typedef struct iqr_Context_struct	iqr_Context

Functions
IQR_API iqr_retval	iqr_CreateContext (iqr_Context **ctx)
IQR_API_UNENFORCED_RETURN iqr_retval	iqr_DestroyContext (iqr_Context **ctx)

Typedef Documentation

iqr_Context

typedef struct iqr_Context_struct iqr_Context

The Context object.

Function Documentation

iqr_CreateContext()

IQR_API iqr_retval iqr_CreateContext

(

iqr_Context **

ctx

)

Create and initialize a Context object.

The *ctx parameter must be initialized to NULL prior to calling this function. Otherwise, IQR_EINVPTR will be returned.

The caller must free the ctx using iqr_DestroyContext().

Parameters

[out]

ctx

Address of a context pointer.

Returns

IQR_OK on success, or a value from iqr_retval.h when an error occurs.

iqr_DestroyContext()

IQR_API_UNENFORCED_RETURN iqr_retval iqr_DestroyContext

(

iqr_Context **

ctx

)

Clear and deallocate a Context object.

ctx will be set to NULL prior to returning.

All internal iqr_Context buffers are cleared and deallocated during the call to iqr_DestroyContext(). The iqr_Context does not store any cryptographic material.

Parameters

[in,out]

ctx

Context pointer.

Returns

IQR_OK on success, or a value from iqr_retval.h when an error occurs.

Detailed Description

ISARA Radiate Security Solution Suite's Context object.

Many of the APIs in ISARA's toolkit require a Context object when creating a new object. It stores information about the toolkit library itself, keeps track of the registered implementations for the hash algorithms and watchdog callback.

Copyright

Copyright 2015-2018, ISARA Corporation, All Rights Reserved.

License

The code and other content set out herein is not in the public domain, is considered a trade secret and is confidential to ISARA Corporation. Use, reproduction or distribution, in whole or in part, of such code or other content is strictly prohibited except by express written permission of ISARA Corporation. Please contact ISARA Corporation at info@.nosp@m.isar.nosp@m.a.com for more information.