types.h File Reference

AEAD type definitions for the PSA Crypto API. More...

Detailed Description

AEAD type definitions for the PSA Crypto API.

Author

Armin Wolf wolf..nosp@m.armi.nosp@m.n@mai.nosp@m.lbox.nosp@m..tu-d.nosp@m.resd.nosp@m.en.de

Lena Boeckmann lena..nosp@m.boec.nosp@m.kmann.nosp@m.@haw.nosp@m.-hamb.nosp@m.urg..nosp@m.de

Definition in file types.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	psa_aead_operation_s
	Structure storing an AEAD operation context. More...
#define	PSA_AEAD_OPERATION_INIT   { 0 }
	This macro returns a suitable initializer for an AEAD operation object of type psa_aead_operation_t.
typedef struct psa_aead_operation_s	psa_aead_operation_t
	The type of the state object for multi-part AEAD operations.
static psa_aead_operation_t	psa_aead_operation_init (void)
	Return an initial value for an AEAD operation object.

Macro Definition Documentation

PSA_AEAD_OPERATION_INIT

#define PSA_AEAD_OPERATION_INIT   { 0 }

This macro returns a suitable initializer for an AEAD operation object of type psa_aead_operation_t.

Definition at line 74 of file types.h.

Typedef Documentation

psa_aead_operation_t

typedef struct psa_aead_operation_s psa_aead_operation_t

The type of the state object for multi-part AEAD operations.

Before calling any function on an AEAD operation object, the application must initialize it by any of the following means:

• Set the object to all-bits-zero, for example:

  @ref psa_aead_operation_t operation;
  memset(&operation, 0, sizeof(operation));

• Initialize the object to logical zero values by declaring the object as static or global without an explicit initializer, for example:

  static @ref psa_aead_operation_t operation;

• Initialize the object to the initializer PSA_AEAD_OPERATION_INIT, for example:

  @ref psa_aead_operation_t operation = @ref PSA_AEAD_OPERATION_INIT;

• Assign the result of the function psa_aead_operation_init() to the object, for example:

  @ref psa_aead_operation_t operation;
  operation = @ref psa_aead_operation_init();

This is an implementation-defined type. Applications that make assumptions about the content of this object will result in in implementation-specific behavior, and are non-portable.

Definition at line 68 of file types.h.

Function Documentation

psa_aead_operation_init()

static psa_aead_operation_t psa_aead_operation_init ( void )

inlinestatic

Return an initial value for an AEAD operation object.

Returns

psa_aead_operation_t

Definition at line 81 of file types.h.