types.h File Reference

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

Detailed Description

Cipher 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.

#include "crypto/psa/riot_ciphers.h"
#include "kernel_defines.h"
#include "psa/algorithm.h"

Include dependency graph for types.h:

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

Go to the source code of this file.

Data Structures
union	psa_cipher_context_t
	Structure containing the cipher contexts needed by the application. More...
struct	psa_se_cipher_context_t
	Structure containing the secure element specific cipher contexts needed by the application. More...
union	psa_se_cipher_context_t::driver_context
	Structure containing a driver specific cipher context. More...
struct	psa_cipher_operation_s
	Structure storing a cipher operation context. More...
union	psa_cipher_operation_s::cipher_context
	Union containing cipher contexts for the executing backend. More...
#define	PSA_CIPHER_OPERATION_INIT   { 0 }
	This macro returns a suitable initializer for a cipher operation object of type psa_cipher_operation_t.
enum	psa_encrypt_or_decrypt_t { PSA_CRYPTO_DRIVER_DECRYPT , PSA_CRYPTO_DRIVER_ENCRYPT }
	For encrypt-decrypt functions, whether the operation is an encryption or a decryption. More...
typedef struct psa_cipher_operation_s	psa_cipher_operation_t
	The type of the state object for multi-part cipher operations.
static psa_cipher_operation_t	psa_cipher_operation_init (void)
	Return an initial value for a cipher operation object.

Macro Definition Documentation

PSA_CIPHER_OPERATION_INIT

#define PSA_CIPHER_OPERATION_INIT   { 0 }

This macro returns a suitable initializer for a cipher operation object of type psa_cipher_operation_t.

Definition at line 134 of file types.h.

Typedef Documentation

psa_cipher_operation_t

typedef struct psa_cipher_operation_s psa_cipher_operation_t

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

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

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

  @ref psa_cipher_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_cipher_operation_t operation;

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

  @ref psa_cipher_operation_t operation = @ref PSA_CIPHER_OPERATION_INIT;

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

  @ref psa_cipher_operation_t operation;
  operation = @ref psa_cipher_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 128 of file types.h.

Enumeration Type Documentation

psa_encrypt_or_decrypt_t

enum psa_encrypt_or_decrypt_t

For encrypt-decrypt functions, whether the operation is an encryption or a decryption.

Definition at line 44 of file types.h.

Function Documentation

psa_cipher_operation_init()

static psa_cipher_operation_t psa_cipher_operation_init ( void )

inlinestatic

Return an initial value for a cipher operation object.

Returns

psa_cipher_operation_t

Definition at line 141 of file types.h.