crypto_types.h File Reference

Type definitions for PSA Crypto. More...

Detailed Description

Type definitions for PSA Crypto.

Author

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

Definition in file crypto_types.h.

#include <stdint.h>
#include "psa/algorithm.h"
#include "psa/error.h"
#include "psa/key/attributes.h"

Include dependency graph for crypto_types.h:

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

Go to the source code of this file.

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_key_derivation_operation_s	psa_key_derivation_operation_t
	The type of the state object for key derivation operations.
typedef uint16_t	psa_key_derivation_step_t
	Encoding of the step of a key derivation.
typedef struct psa_aead_operation_s	psa_aead_operation_t
	The type of the state object for multi-part AEAD operations.
typedef struct psa_mac_operation_s	psa_mac_operation_t
	The type of the state object for multi-part MAC operations.
typedef struct psa_hash_operation_s	psa_hash_operation_t
	The type of the state data structure for multipart hash operations.
typedef struct psa_cipher_operation_s	psa_cipher_operation_t
	The type of the state object for multi-part cipher operations.

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 111 of file crypto_types.h.

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 206 of file crypto_types.h.

psa_hash_operation_t

typedef struct psa_hash_operation_s psa_hash_operation_t

The type of the state data structure for multipart hash operations.

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

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

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

• Initialize the structure to logical zero values, for example:

  @ref psa_hash_operation_t operation = {0};

• Initialize the structure to the initializer PSA_HASH_OPERATION_INIT, for example:

  @ref psa_hash_operation_t operation = @ref PSA_HASH_OPERATION_INIT;

• Assign the result of the function psa_hash_operation_init() to the structure, for example:

  @ref psa_hash_operation_t operation;
  operation = @ref psa_hash_operation_init();

This is an implementation-defined struct. Applications should not make any assumptions about the content of this structure except as directed by the documentation of a specific implementation.

Definition at line 174 of file crypto_types.h.

psa_key_derivation_operation_t

typedef struct psa_key_derivation_operation_s psa_key_derivation_operation_t

The type of the state object for key derivation operations.

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

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

  @ref psa_key_derivation_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_key_derivation_operation_t operation;

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

  @ref psa_key_derivation_operation_t operation =
  @ref PSA_KEY_DERIVATION_OPERATION_INIT;

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

  @ref psa_key_derivation_operation_t operation;
  operation = @ref psa_key_derivation_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 73 of file crypto_types.h.

psa_key_derivation_step_t

typedef uint16_t psa_key_derivation_step_t

Encoding of the step of a key derivation.

Definition at line 78 of file crypto_types.h.

psa_mac_operation_t

typedef struct psa_mac_operation_s psa_mac_operation_t

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

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

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

  @ref psa_mac_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_mac_operation_t operation;

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

  @ref psa_mac_operation_t operation = @ref PSA_MAC_OPERATION_INIT;

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

  @ref psa_mac_operation_t operation;
  operation = @ref psa_mac_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 142 of file crypto_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 37 of file crypto_types.h.