RE: [EXTERNAL] [PATCH v15 14/21] crypto/zsda: introduce key expansion code

[Akhil Goyal <gakhil@marvell.com>]

> Introduce key expansion code for zsda sym drivers.
> 
> Signed-off-by: Hanxiao Li <li.hanxiao@zte.com.cn>
> ---
>  drivers/common/zsda/meson.build        |  15 +-
>  drivers/crypto/zsda/zsda_sym_session.c | 281 +++++++++++++++++++++++++
>  drivers/crypto/zsda/zsda_sym_session.h |   9 +
>  3 files changed, 304 insertions(+), 1 deletion(-)
>  create mode 100644 drivers/crypto/zsda/zsda_sym_session.c
>  create mode 100644 drivers/crypto/zsda/zsda_sym_session.h


Do not use camel case.
Every variable should be in lower case.
> 
> diff --git a/drivers/common/zsda/meson.build
> b/drivers/common/zsda/meson.build
> index 318adb1fd7..9ce01a96fc 100644
> --- a/drivers/common/zsda/meson.build
> +++ b/drivers/common/zsda/meson.build
> @@ -7,7 +7,7 @@ if is_windows
>      subdir_done()
>  endif
> 
> -deps += ['bus_pci', 'mbuf', 'compressdev']
> +deps += ['bus_pci','mbuf', 'compressdev', 'cryptodev']
>  sources += files(
>          'zsda_logs.c',
>          'zsda_common.c',
> @@ -24,3 +24,16 @@ if zsda_compress
>          sources += files(join_paths(zsda_compress_relpath, f))
>      endforeach
>  endif
> +
> +zsda_crypto = true
> +zsda_crypto_path = 'crypto/zsda'
> +zsda_crypto_relpath = '../../' + zsda_crypto_path
> +if zsda_crypto
> +    libcrypto = dependency('libcrypto', required: false, method: 'pkg-config')
> +    foreach f: ['zsda_sym_session.c']
> +        sources += files(join_paths(zsda_crypto_relpath, f))
> +    endforeach
> +    deps += ['security']

Why security?

> +    ext_deps += libcrypto

Why libcrypto?
It is HW accelerated, right? So why using sw lib for crypto?

> +    cflags += ['-DBUILD_ZSDA_SYM']
> +endif
> diff --git a/drivers/crypto/zsda/zsda_sym_session.c
> b/drivers/crypto/zsda/zsda_sym_session.c
> new file mode 100644
> index 0000000000..ddb6b6a62f
> --- /dev/null
> +++ b/drivers/crypto/zsda/zsda_sym_session.c
> @@ -0,0 +1,281 @@
> +/* SPDX-License-Identifier: BSD-3-Clause
> + * Copyright(c) 2024 ZTE Corporation
> + */
> +
> +#include "cryptodev_pmd.h"
> +
> +#include "zsda_common.h"
> +#include "zsda_sym_session.h"
> +
> +/**************** AES KEY EXPANSION ****************/
> +/**
> + * AES S-boxes
> + * Sbox table: 8bits input convert to 8bits output
> + **/
> +static const unsigned char aes_sbox[256] = {
> +    /* 0     1    2      3     4    5     6     7      8    9     A      B
> +     * C     D    E     F
> +     */
> +    0x63, 0x7c, 0x77, 0x7b, 0xf2, 0x6b, 0x6f, 0xc5, 0x30, 0x01, 0x67, 0x2b,
> +    0xfe, 0xd7, 0xab, 0x76, 0xca, 0x82, 0xc9, 0x7d, 0xfa, 0x59, 0x47, 0xf0,
> +    0xad, 0xd4, 0xa2, 0xaf, 0x9c, 0xa4, 0x72, 0xc0, 0xb7, 0xfd, 0x93, 0x26,
> +    0x36, 0x3f, 0xf7, 0xcc, 0x34, 0xa5, 0xe5, 0xf1, 0x71, 0xd8, 0x31, 0x15,
> +    0x04, 0xc7, 0x23, 0xc3, 0x18, 0x96, 0x05, 0x9a, 0x07, 0x12, 0x80, 0xe2,
> +    0xeb, 0x27, 0xb2, 0x75, 0x09, 0x83, 0x2c, 0x1a, 0x1b, 0x6e, 0x5a, 0xa0,
> +    0x52, 0x3b, 0xd6, 0xb3, 0x29, 0xe3, 0x2f, 0x84, 0x53, 0xd1, 0x00, 0xed,
> +    0x20, 0xfc, 0xb1, 0x5b, 0x6a, 0xcb, 0xbe, 0x39, 0x4a, 0x4c, 0x58, 0xcf,
> +    0xd0, 0xef, 0xaa, 0xfb, 0x43, 0x4d, 0x33, 0x85, 0x45, 0xf9, 0x02, 0x7f,
> +    0x50, 0x3c, 0x9f, 0xa8, 0x51, 0xa3, 0x40, 0x8f, 0x92, 0x9d, 0x38, 0xf5,
> +    0xbc, 0xb6, 0xda, 0x21, 0x10, 0xff, 0xf3, 0xd2, 0xcd, 0x0c, 0x13, 0xec,
> +    0x5f, 0x97, 0x44, 0x17, 0xc4, 0xa7, 0x7e, 0x3d, 0x64, 0x5d, 0x19, 0x73,
> +    0x60, 0x81, 0x4f, 0xdc, 0x22, 0x2a, 0x90, 0x88, 0x46, 0xee, 0xb8, 0x14,
> +    0xde, 0x5e, 0x0b, 0xdb, 0xe0, 0x32, 0x3a, 0x0a, 0x49, 0x06, 0x24, 0x5c,
> +    0xc2, 0xd3, 0xac, 0x62, 0x91, 0x95, 0xe4, 0x79, 0xe7, 0xc8, 0x37, 0x6d,
> +    0x8d, 0xd5, 0x4e, 0xa9, 0x6c, 0x56, 0xf4, 0xea, 0x65, 0x7a, 0xae, 0x08,
> +    0xba, 0x78, 0x25, 0x2e, 0x1c, 0xa6, 0xb4, 0xc6, 0xe8, 0xdd, 0x74, 0x1f,
> +    0x4b, 0xbd, 0x8b, 0x8a, 0x70, 0x3e, 0xb5, 0x66, 0x48, 0x03, 0xf6, 0x0e,
> +    0x61, 0x35, 0x57, 0xb9, 0x86, 0xc1, 0x1d, 0x9e, 0xe1, 0xf8, 0x98, 0x11,
> +    0x69, 0xd9, 0x8e, 0x94, 0x9b, 0x1e, 0x87, 0xe9, 0xce, 0x55, 0x28, 0xdf,
> +    0x8c, 0xa1, 0x89, 0x0d, 0xbf, 0xe6, 0x42, 0x68, 0x41, 0x99, 0x2d, 0x0f,
> +    0xb0, 0x54, 0xbb, 0x16};
> +
> +/**
> + * The round constant word array, Rcon[i]
> + *
> + * From Wikipedia's article on the Rijndael key schedule @
> + * https://en.wikipedia.org/wiki/Rijndael_key_schedule#Rcon
> 
>  "Only
> the first some
> + * of these constants are actually used – up to rcon[10] for AES-128 (as 11
> + * round keys are needed), up to rcon[8] for AES-192, up to rcon[7] for AES-256.
> + * rcon[0] is not used in AES algorithm."
> + */
> +static const unsigned char Rcon[11] = {0x8d, 0x01, 0x02, 0x04, 0x08, 0x10,
> +                       0x20, 0x40, 0x80, 0x1b, 0x36};
> +
> +#define GET_AES_SBOX_VAL(num) (aes_sbox[(num)])
> +
> +/**************** SM4 KEY EXPANSION ****************/
> +/*
> + * 32-bit integer manipulation macros (big endian)
> + */
> +#ifndef GET_ULONG_BE
> +#define GET_ULONG_BE(n, b, i)                                                  \
> +    {                                                                      \
> +        (n) = ((unsigned int)(b)[(i)] << 24) |                         \
> +              ((unsigned int)(b)[(i) + 1] << 16) |                     \
> +              ((unsigned int)(b)[(i) + 2] << 8) |                      \
> +              ((unsigned int)(b)[(i) + 3]);                            \
> +    }
> +#endif
> +
> +#ifndef PUT_ULONG_BE
> +#define PUT_ULONG_BE(n, b, i)                                                  \
> +    {                                                                      \
> +        (b)[(i)] = (unsigned char)((n) >> 24);                         \
> +        (b)[(i) + 1] = (unsigned char)((n) >> 16);                     \
> +        (b)[(i) + 2] = (unsigned char)((n) >> 8);                      \
> +        (b)[(i) + 3] = (unsigned char)((n));                           \
> +    }
> +#endif

You can use rte_ APIs in lib/eal/include/generic/rte_byteorder.h


> +
> +/**
> + *rotate shift left marco definition
> + *
> + **/
> +#define SHL(x, n)  (((x)&0xFFFFFFFF) << n)
> +#define ROTL(x, n) (SHL((x), n) | ((x) >> (32 - n)))
> +
> +/**
> + * SM4 S-boxes
> + * Sbox table: 8bits input convert to 8 bitg288s output
> + **/
> +static unsigned char sm4_sbox[16][16] = {
> +    {0xd6, 0x90, 0xe9, 0xfe, 0xcc, 0xe1, 0x3d, 0xb7, 0x16, 0xb6, 0x14, 0xc2,
> +     0x28, 0xfb, 0x2c, 0x05},
> +    {0x2b, 0x67, 0x9a, 0x76, 0x2a, 0xbe, 0x04, 0xc3, 0xaa, 0x44, 0x13, 0x26,
> +     0x49, 0x86, 0x06, 0x99},
> +    {0x9c, 0x42, 0x50, 0xf4, 0x91, 0xef, 0x98, 0x7a, 0x33, 0x54, 0x0b, 0x43,
> +     0xed, 0xcf, 0xac, 0x62},
> +    {0xe4, 0xb3, 0x1c, 0xa9, 0xc9, 0x08, 0xe8, 0x95, 0x80, 0xdf, 0x94, 0xfa,
> +     0x75, 0x8f, 0x3f, 0xa6},
> +    {0x47, 0x07, 0xa7, 0xfc, 0xf3, 0x73, 0x17, 0xba, 0x83, 0x59, 0x3c, 0x19,
> +     0xe6, 0x85, 0x4f, 0xa8},
> +    {0x68, 0x6b, 0x81, 0xb2, 0x71, 0x64, 0xda, 0x8b, 0xf8, 0xeb, 0x0f, 0x4b,
> +     0x70, 0x56, 0x9d, 0x35},
> +    {0x1e, 0x24, 0x0e, 0x5e, 0x63, 0x58, 0xd1, 0xa2, 0x25, 0x22, 0x7c, 0x3b,
> +     0x01, 0x21, 0x78, 0x87},
> +    {0xd4, 0x00, 0x46, 0x57, 0x9f, 0xd3, 0x27, 0x52, 0x4c, 0x36, 0x02, 0xe7,
> +     0xa0, 0xc4, 0xc8, 0x9e},
> +    {0xea, 0xbf, 0x8a, 0xd2, 0x40, 0xc7, 0x38, 0xb5, 0xa3, 0xf7, 0xf2, 0xce,
> +     0xf9, 0x61, 0x15, 0xa1},
> +    {0xe0, 0xae, 0x5d, 0xa4, 0x9b, 0x34, 0x1a, 0x55, 0xad, 0x93, 0x32, 0x30,
> +     0xf5, 0x8c, 0xb1, 0xe3},
> +    {0x1d, 0xf6, 0xe2, 0x2e, 0x82, 0x66, 0xca, 0x60, 0xc0, 0x29, 0x23, 0xab,
> +     0x0d, 0x53, 0x4e, 0x6f},
> +    {0xd5, 0xdb, 0x37, 0x45, 0xde, 0xfd, 0x8e, 0x2f, 0x03, 0xff, 0x6a, 0x72,
> +     0x6d, 0x6c, 0x5b, 0x51},
> +    {0x8d, 0x1b, 0xaf, 0x92, 0xbb, 0xdd, 0xbc, 0x7f, 0x11, 0xd9, 0x5c, 0x41,
> +     0x1f, 0x10, 0x5a, 0xd8},
> +    {0x0a, 0xc1, 0x31, 0x88, 0xa5, 0xcd, 0x7b, 0xbd, 0x2d, 0x74, 0xd0, 0x12,
> +     0xb8, 0xe5, 0xb4, 0xb0},
> +    {0x89, 0x69, 0x97, 0x4a, 0x0c, 0x96, 0x77, 0x7e, 0x65, 0xb9, 0xf1, 0x09,
> +     0xc5, 0x6e, 0xc6, 0x84},
> +    {0x18, 0xf0, 0x7d, 0xec, 0x3a, 0xdc, 0x4d, 0x20, 0x79, 0xee, 0x5f, 0x3e,
> +     0xd7, 0xcb, 0x39, 0x48},
> +};
> +
> +/* System parameter */
> +static const unsigned int FK[4] = {0xa3b1bac6, 0x56aa3350, 0x677d9197,
> +                   0xb27022dc};
> +
> +/* fixed parameter */
> +static const unsigned int CK[32] = {
> +    0x00070e15, 0x1c232a31, 0x383f464d, 0x545b6269, 0x70777e85,
> 0x8c939aa1,
> +    0xa8afb6bd, 0xc4cbd2d9, 0xe0e7eef5, 0xfc030a11, 0x181f262d, 0x343b4249,
> +    0x50575e65, 0x6c737a81, 0x888f969d, 0xa4abb2b9, 0xc0c7ced5, 0xdce3eaf1,
> +    0xf8ff060d, 0x141b2229, 0x30373e45, 0x4c535a61, 0x686f767d, 0x848b9299,
> +    0xa0a7aeb5, 0xbcc3cad1, 0xd8dfe6ed, 0xf4fb0209, 0x10171e25, 0x2c333a41,
> +    0x484f565d, 0x646b7279};
> +
> +/*
> + * private function:
> + * look up in SM4 S-boxes and get the related value.
> + * args:    [in] inch: 0x00~0xFF (8 bits unsigned value).
> + */
> +static unsigned char
> +sm4Sbox(unsigned char inch)
> +{
> +    unsigned char *pTable = (unsigned char *)sm4_sbox;
> +    unsigned char retVal = (unsigned char)(pTable[inch]);
> +    return retVal;
> +}
> +
> +/* private function:
> + * Calculating round encryption key.
> + * args:    [in] ka: ka is a 32 bits unsigned value;
> + * return:  sk[i]: i{0,1,2,3,...31}.
> + */
> +static unsigned int
> +sm4CalciRK(unsigned int ka)

sm4_calci_rk

> +{
> +    unsigned int bb = 0;
> +    unsigned int rk = 0;
> +    unsigned char a[4];
> +    unsigned char b[4];
> +
> +    PUT_ULONG_BE(ka, a, 0)
> +    b[0] = sm4Sbox(a[0]);
> +    b[1] = sm4Sbox(a[1]);
> +    b[2] = sm4Sbox(a[2]);
> +    b[3] = sm4Sbox(a[3]);

sm4_sbox()

> +    GET_ULONG_BE(bb, b, 0)
> +    rk = bb ^ (ROTL(bb, 13)) ^ (ROTL(bb, 23));
> +    return rk;
> +}
> +
> +static void
> +zsda_sm4_key_expansion(unsigned int SK[32], const uint8_t key[16])
> +{
> +    unsigned int MK[4];
> +    unsigned int k[36];
> +    unsigned int i = 0;
> +
> +    GET_ULONG_BE(MK[0], key, 0);
> +    GET_ULONG_BE(MK[1], key, 4);
> +    GET_ULONG_BE(MK[2], key, 8);
> +    GET_ULONG_BE(MK[3], key, 12);
> +    k[0] = MK[0] ^ FK[0];
> +    k[1] = MK[1] ^ FK[1];
> +    k[2] = MK[2] ^ FK[2];
> +    k[3] = MK[3] ^ FK[3];
> +    for (; i < 32; i++) {
> +        k[i + 4] = k[i] ^
> +               (sm4CalciRK(k[i + 1] ^ k[i + 2] ^ k[i + 3] ^ CK[i]));
> +        SK[i] = k[i + 4];
> +    }
> +}
> +
> +static void
> +u32_to_u8(uint32_t *u_int32_t_data, uint8_t *u8_data)
> +{
> +    *(u8_data + 0) = ((*u_int32_t_data & 0xFF000000) >> 24) & (0xFF);
> +    *(u8_data + 1) = ((*u_int32_t_data & 0x00FF0000) >> 16) & (0xFF);
> +    *(u8_data + 2) = ((*u_int32_t_data & 0x0000FF00) >> 8) & (0xFF);
> +    *(u8_data + 3) = (*u_int32_t_data & 0x000000FF);
> +}

Will this not work?
u8_data = (uint8_t *) u_int32_t_data;


> +
> +static void
> +zsda_aes_key_expansion(uint8_t *round_key, uint32_t round_num,
> +               const uint8_t *key, uint32_t key_len)
> +{
> +    uint32_t i, j, k, nk, nr;
> +    uint8_t tempa[4];
> +
> +    nk = key_len >> 2;
> +    nr = round_num;
> +
> +    /* The first round key is the key itself. */
> +    for (i = 0; i < nk; ++i) {
> +        round_key[(i * 4) + 0] = key[(i * 4) + 0];
> +
> +        round_key[(i * 4) + 1] = key[(i * 4) + 1];
> +
> +        round_key[(i * 4) + 2] = key[(i * 4) + 2];
> +        round_key[(i * 4) + 3] = key[(i * 4) + 3];
> +    }
> +
> +    /* All other round keys are found from the previous round keys. */
> +    for (i = nk; i < (4 * (nr + 1)); ++i) {
> +        k = (i - 1) * 4;
> +        tempa[0] = round_key[k + 0];
> +        tempa[1] = round_key[k + 1];
> +        tempa[2] = round_key[k + 2];
> +        tempa[3] = round_key[k + 3];
> +
> +        if ((nk != 0) && ((i % nk) == 0)) {
> +            /* This function shifts the 4 bytes in a word to the
> +             * left once. [a0,a1,a2,a3] becomes [a1,a2,a3,a0]
> +             * Function RotWord()
> +             */
> +            {
> +                const uint8_t u8tmp = tempa[0];
> +
> +                tempa[0] = tempa[1];
> +                tempa[1] = tempa[2];
> +                tempa[2] = tempa[3];
> +                tempa[3] = u8tmp;
> +            }
> +
> +            /* SubWord() is a function that takes a four-byte input
> +             * word and applies the S-box to each of the four bytes
> +             * to produce an output word. Function Subword()
> +             */
> +            {
> +                tempa[0] = GET_AES_SBOX_VAL(tempa[0]);
> +                tempa[1] = GET_AES_SBOX_VAL(tempa[1]);
> +                tempa[2] = GET_AES_SBOX_VAL(tempa[2]);
> +                tempa[3] = GET_AES_SBOX_VAL(tempa[3]);
> +            }
> +
> +            tempa[0] = tempa[0] ^ Rcon[i / nk];
> +        }
> +
> +        if (nk == 8) {
> +            if ((i % nk) == 4) {
> +                /* Function Subword() */
> +                {
> +                    tempa[0] = GET_AES_SBOX_VAL(tempa[0]);
> +                    tempa[1] = GET_AES_SBOX_VAL(tempa[1]);
> +                    tempa[2] = GET_AES_SBOX_VAL(tempa[2]);
> +                    tempa[3] = GET_AES_SBOX_VAL(tempa[3]);
> +                }
> +            }
> +        }
> +
> +        j = i * 4;
> +        k = (i - nk) * 4;
> +        round_key[j + 0] = round_key[k + 0] ^ tempa[0];
> +        round_key[j + 1] = round_key[k + 1] ^ tempa[1];
> +        round_key[j + 2] = round_key[k + 2] ^ tempa[2];
> +        round_key[j + 3] = round_key[k + 3] ^ tempa[3];
> +    }
> +}


> diff --git a/drivers/crypto/zsda/zsda_sym_session.h
> b/drivers/crypto/zsda/zsda_sym_session.h
> new file mode 100644
> index 0000000000..15897b1aaf
> --- /dev/null
> +++ b/drivers/crypto/zsda/zsda_sym_session.h
> @@ -0,0 +1,9 @@
> +/* SPDX-License-Identifier: BSD-3-Clause
> + * Copyright(c) 2024 ZTE Corporation
> + */
> +
> +#ifndef _ZSDA_SYM_SESSION_H_
> +#define _ZSDA_SYM_SESSION_H_
> +
> +
> +#endif /* _ZSDA_SYM_SESSION_H_ */
No point of adding the empty file here which has no relevance in the current patch.
Move it to next patch which which uses this file.