Structure encoding IO parameters of one cryptographic operation like encrypt/decrypt. More...

#include <zephyr/crypto/cipher.h>

Data Fields
uint8_t *	in_buf
	Start address of the input buffer.
int	in_len
	Number of input bytes to process.
uint8_t *	out_buf
	Start address of the output buffer.
int	out_buf_max
	Size of the output buffer, in bytes.
int	out_len
	To be populated by driver on return from cipher_xxx_op() and holds the size of the actual result.
struct cipher_ctx *	ctx
	Context this packet relates to.

Detailed Description

Structure encoding IO parameters of one cryptographic operation like encrypt/decrypt.

The fields which has not been explicitly called out has to be filled up by the app before making the cipher_xxx_op() call.

Field Documentation

◆ ctx

struct cipher_ctx* cipher_pkt::ctx

Context this packet relates to.

This can be useful to get the session details, especially for async ops. Will be populated by the cipher_xxx_op() API based on the ctx parameter.

◆ in_buf

uint8_t* cipher_pkt::in_buf

Start address of the input buffer.

The buffer is allocated by the application and must remain valid for the duration of the operation.

◆ in_len

int cipher_pkt::in_len

Number of input bytes to process.

◆ out_buf

uint8_t* cipher_pkt::out_buf

Start address of the output buffer.

The buffer is allocated by the application and must remain valid for the duration of the operation. This can be NULL for in-place operations, in which case the driver writes the result to in_buf.

◆ out_buf_max

int cipher_pkt::out_buf_max

Size of the output buffer, in bytes.

Drivers must not write past this buffer size.

◆ out_len

int cipher_pkt::out_len

To be populated by driver on return from cipher_xxx_op() and holds the size of the actual result.

The documentation for this struct was generated from the following file:

zephyr/crypto/cipher.h

Data Fields