cipher.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_CRYPTO_CIPHER_H_
#define ZEPHYR_INCLUDE_CRYPTO_CIPHER_H_
 
#include <zephyr/device.h>
#include <zephyr/sys/util.h>

enum cipher_algo {
        CRYPTO_CIPHER_ALGO_AES = 1, 
};

enum cipher_op {
        CRYPTO_CIPHER_OP_DECRYPT = 0, 
        CRYPTO_CIPHER_OP_ENCRYPT = 1, 
};

enum cipher_mode {
        CRYPTO_CIPHER_MODE_ECB = 1, 
        CRYPTO_CIPHER_MODE_CBC = 2, 
        CRYPTO_CIPHER_MODE_CTR = 3, 
        CRYPTO_CIPHER_MODE_CCM = 4, 
        CRYPTO_CIPHER_MODE_GCM = 5, 
        CRYPTO_CIPHER_MODE_CFB = 6, 
        CRYPTO_CIPHER_MODE_OFB = 7, 
};
 
/* Forward declarations */
struct cipher_aead_pkt;
struct cipher_ctx;
struct cipher_pkt;

typedef int (*block_op_t)(struct cipher_ctx *ctx, struct cipher_pkt *pkt);

typedef int (*cbc_op_t)(struct cipher_ctx *ctx, struct cipher_pkt *pkt,
                        uint8_t *iv);

typedef int (*ctr_op_t)(struct cipher_ctx *ctx, struct cipher_pkt *pkt,
                        uint8_t *ctr);

typedef int (*ccm_op_t)(struct cipher_ctx *ctx, struct cipher_aead_pkt *pkt,
                         uint8_t *nonce);

typedef int (*gcm_op_t)(struct cipher_ctx *ctx, struct cipher_aead_pkt *pkt,
                         uint8_t *nonce);

typedef int (*cfb_op_t)(struct cipher_ctx *ctx, struct cipher_pkt *pkt,
                        uint8_t *iv);

typedef int (*ofb_op_t)(struct cipher_ctx *ctx, struct cipher_pkt *pkt,
                        uint8_t *iv);

struct cipher_ops {

        enum cipher_mode cipher_mode;

        union {
                block_op_t      block_crypt_hndlr;
                cbc_op_t        cbc_crypt_hndlr;
                ctr_op_t        ctr_crypt_hndlr;
                ccm_op_t        ccm_crypt_hndlr;
                gcm_op_t        gcm_crypt_hndlr;
                cfb_op_t        cfb_crypt_hndlr;
                ofb_op_t        ofb_crypt_hndlr;
        };
};

struct ccm_params {
        uint16_t tag_len;
        uint16_t nonce_len;
};

struct ctr_params {
        uint32_t ctr_len;
};

struct gcm_params {
        uint16_t tag_len;
        uint16_t nonce_len;
};

struct cipher_ctx {

        struct cipher_ops ops;

        union {
                const uint8_t *bit_stream;
                void *handle;
        } key;

        const struct device *device;

        void *drv_sessn_state;

        void *app_sessn_state;

        union {
                struct ccm_params ccm_info;
                struct ctr_params ctr_info;
                struct gcm_params gcm_info;
        } mode_params;

        uint16_t  keylen;

        uint16_t flags;
};

struct cipher_pkt {

        uint8_t *in_buf;

        int  in_len;

        uint8_t *out_buf;

        int out_buf_max;

        int out_len;

        struct cipher_ctx *ctx;
};

struct cipher_aead_pkt {
        struct cipher_pkt *pkt;

        uint8_t *ad;

        uint32_t ad_len;

        uint8_t *tag;
};

typedef void (*cipher_completion_cb)(struct cipher_pkt *completed, int status);

#endif /* ZEPHYR_INCLUDE_CRYPTO_CIPHER_H_ */