lib/librte_cryptodev/rte_crypto_sym.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
   5  *
   6  *   Redistribution and use in source and binary forms, with or without
   7  *   modification, are permitted provided that the following conditions
   8  *   are met:
   9  *
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above copyright
  13  *       notice, this list of conditions and the following disclaimer in
  14  *       the documentation and/or other materials provided with the
  15  *       distribution.
  16  *     * Neither the name of Intel Corporation nor the names of its
  17  *       contributors may be used to endorse or promote products derived
  18  *       from this software without specific prior written permission.
  19  *
  20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  */
  32
  33 #ifndef _RTE_CRYPTO_SYM_H_
  34 #define _RTE_CRYPTO_SYM_H_
  35
  36 /**
  37  * @file rte_crypto_sym.h
  38  *
  39  * RTE Definitions for Symmetric Cryptography
  40  *
  41  * Defines symmetric cipher and authentication algorithms and modes, as well
  42  * as supported symmetric crypto operation combinations.
  43  */
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 #include <string.h>
  50
  51 #include <rte_mbuf.h>
  52 #include <rte_memory.h>
  53 #include <rte_mempool.h>
  54 #include <rte_common.h>
  55
  56
  57 /** Symmetric Cipher Algorithms */
  58 enum rte_crypto_cipher_algorithm {
  59         RTE_CRYPTO_CIPHER_NULL = 1,
  60         /**< NULL cipher algorithm. No mode applies to the NULL algorithm. */
  61
  62         RTE_CRYPTO_CIPHER_3DES_CBC,
  63         /**< Triple DES algorithm in CBC mode */
  64         RTE_CRYPTO_CIPHER_3DES_CTR,
  65         /**< Triple DES algorithm in CTR mode */
  66         RTE_CRYPTO_CIPHER_3DES_ECB,
  67         /**< Triple DES algorithm in ECB mode */
  68
  69         RTE_CRYPTO_CIPHER_AES_CBC,
  70         /**< AES algorithm in CBC mode */
  71         RTE_CRYPTO_CIPHER_AES_CCM,
  72         /**< AES algorithm in CCM mode. When this cipher algorithm is used the
  73          * *RTE_CRYPTO_AUTH_AES_CCM* element of the
  74          * *rte_crypto_hash_algorithm* enum MUST be used to set up the related
  75          * *rte_crypto_auth_xform* structure in the session context or in
  76          * the op_params of the crypto operation structure in the case of a
  77          * session-less crypto operation
  78          */
  79         RTE_CRYPTO_CIPHER_AES_CTR,
  80         /**< AES algorithm in Counter mode */
  81         RTE_CRYPTO_CIPHER_AES_ECB,
  82         /**< AES algorithm in ECB mode */
  83         RTE_CRYPTO_CIPHER_AES_F8,
  84         /**< AES algorithm in F8 mode */
  85         RTE_CRYPTO_CIPHER_AES_GCM,
  86         /**< AES algorithm in GCM mode. When this cipher algorithm is used the
  87          * *RTE_CRYPTO_AUTH_AES_GCM* or *RTE_CRYPTO_AUTH_AES_GMAC* element
  88          * of the *rte_crypto_auth_algorithm* enum MUST be used to set up
  89          * the related *rte_crypto_auth_setup_data* structure in the session
  90          * context or in the op_params of the crypto operation structure
  91          * in the case of a session-less crypto operation.
  92          */
  93         RTE_CRYPTO_CIPHER_AES_XTS,
  94         /**< AES algorithm in XTS mode */
  95
  96         RTE_CRYPTO_CIPHER_ARC4,
  97         /**< (A)RC4 cipher algorithm */
  98
  99         RTE_CRYPTO_CIPHER_KASUMI_F8,
 100         /**< KASUMI algorithm in F8 mode */
 101
 102         RTE_CRYPTO_CIPHER_SNOW3G_UEA2,
 103         /**< SNOW 3G algorithm in UEA2 mode */
 104
 105         RTE_CRYPTO_CIPHER_ZUC_EEA3,
 106         /**< ZUC algorithm in EEA3 mode */
 107
 108         RTE_CRYPTO_CIPHER_DES_CBC,
 109         /**< DES algorithm in CBC mode */
 110
 111         RTE_CRYPTO_CIPHER_AES_DOCSISBPI,
 112         /**< AES algorithm using modes required by
 113          * DOCSIS Baseline Privacy Plus Spec.
 114          * Chained mbufs are not supported in this mode, i.e. rte_mbuf.next
 115          * for m_src and m_dst in the rte_crypto_sym_op must be NULL.
 116          */
 117
 118         RTE_CRYPTO_CIPHER_DES_DOCSISBPI,
 119         /**< DES algorithm using modes required by
 120          * DOCSIS Baseline Privacy Plus Spec.
 121          * Chained mbufs are not supported in this mode, i.e. rte_mbuf.next
 122          * for m_src and m_dst in the rte_crypto_sym_op must be NULL.
 123          */
 124
 125         RTE_CRYPTO_CIPHER_LIST_END
 126
 127 };
 128
 129 /** Cipher algorithm name strings */
 130 extern const char *
 131 rte_crypto_cipher_algorithm_strings[];
 132
 133 /** Symmetric Cipher Direction */
 134 enum rte_crypto_cipher_operation {
 135         RTE_CRYPTO_CIPHER_OP_ENCRYPT,
 136         /**< Encrypt cipher operation */
 137         RTE_CRYPTO_CIPHER_OP_DECRYPT
 138         /**< Decrypt cipher operation */
 139 };
 140
 141 /** Cipher operation name strings */
 142 extern const char *
 143 rte_crypto_cipher_operation_strings[];
 144
 145 /**
 146  * Symmetric Cipher Setup Data.
 147  *
 148  * This structure contains data relating to Cipher (Encryption and Decryption)
 149  *  use to create a session.
 150  */
 151 struct rte_crypto_cipher_xform {
 152         enum rte_crypto_cipher_operation op;
 153         /**< This parameter determines if the cipher operation is an encrypt or
 154          * a decrypt operation. For the RC4 algorithm and the F8/CTR modes,
 155          * only encrypt operations are valid.
 156          */
 157         enum rte_crypto_cipher_algorithm algo;
 158         /**< Cipher algorithm */
 159
 160         struct {
 161                 uint8_t *data;  /**< pointer to key data */
 162                 size_t length;  /**< key length in bytes */
 163         } key;
 164         /**< Cipher key
 165          *
 166          * For the RTE_CRYPTO_CIPHER_AES_F8 mode of operation, key.data will
 167          * point to a concatenation of the AES encryption key followed by a
 168          * keymask. As per RFC3711, the keymask should be padded with trailing
 169          * bytes to match the length of the encryption key used.
 170          *
 171          * For AES-XTS mode of operation, two keys must be provided and
 172          * key.data must point to the two keys concatenated together (Key1 ||
 173          * Key2). The cipher key length will contain the total size of both
 174          * keys.
 175          *
 176          * Cipher key length is in bytes. For AES it can be 128 bits (16 bytes),
 177          * 192 bits (24 bytes) or 256 bits (32 bytes).
 178          *
 179          * For the CCM mode of operation, the only supported key length is 128
 180          * bits (16 bytes).
 181          *
 182          * For the RTE_CRYPTO_CIPHER_AES_F8 mode of operation, key.length
 183          * should be set to the combined length of the encryption key and the
 184          * keymask. Since the keymask and the encryption key are the same size,
 185          * key.length should be set to 2 x the AES encryption key length.
 186          *
 187          * For the AES-XTS mode of operation:
 188          *  - Two keys must be provided and key.length refers to total length of
 189          *    the two keys.
 190          *  - Each key can be either 128 bits (16 bytes) or 256 bits (32 bytes).
 191          *  - Both keys must have the same size.
 192          **/
 193         struct {
 194                 uint16_t offset;
 195                 /**< Starting point for Initialisation Vector or Counter,
 196                  * specified as number of bytes from start of crypto
 197                  * operation (rte_crypto_op).
 198                  *
 199                  * - For block ciphers in CBC or F8 mode, or for KASUMI
 200                  * in F8 mode, or for SNOW 3G in UEA2 mode, this is the
 201                  * Initialisation Vector (IV) value.
 202                  *
 203                  * - For block ciphers in CTR mode, this is the counter.
 204                  *
 205                  * - For GCM mode, this is either the IV (if the length
 206                  * is 96 bits) or J0 (for other sizes), where J0 is as
 207                  * defined by NIST SP800-38D. Regardless of the IV
 208                  * length, a full 16 bytes needs to be allocated.
 209                  *
 210                  * - For CCM mode, the first byte is reserved, and the
 211                  * nonce should be written starting at &iv[1] (to allow
 212                  * space for the implementation to write in the flags
 213                  * in the first byte). Note that a full 16 bytes should
 214                  * be allocated, even though the length field will
 215                  * have a value less than this.
 216                  *
 217                  * - For AES-XTS, this is the 128bit tweak, i, from
 218                  * IEEE Std 1619-2007.
 219                  *
 220                  * For optimum performance, the data pointed to SHOULD
 221                  * be 8-byte aligned.
 222                  */
 223                 uint16_t length;
 224                 /**< Length of valid IV data.
 225                  *
 226                  * - For block ciphers in CBC or F8 mode, or for KASUMI
 227                  * in F8 mode, or for SNOW 3G in UEA2 mode, this is the
 228                  * length of the IV (which must be the same as the
 229                  * block length of the cipher).
 230                  *
 231                  * - For block ciphers in CTR mode, this is the length
 232                  * of the counter (which must be the same as the block
 233                  * length of the cipher).
 234                  *
 235                  * - For GCM mode, this is either 12 (for 96-bit IVs)
 236                  * or 16, in which case data points to J0.
 237                  *
 238                  * - For CCM mode, this is the length of the nonce,
 239                  * which can be in the range 7 to 13 inclusive.
 240                  */
 241         } iv;   /**< Initialisation vector parameters */
 242 };
 243
 244 /** Symmetric Authentication / Hash Algorithms */
 245 enum rte_crypto_auth_algorithm {
 246         RTE_CRYPTO_AUTH_NULL = 1,
 247         /**< NULL hash algorithm. */
 248
 249         RTE_CRYPTO_AUTH_AES_CBC_MAC,
 250         /**< AES-CBC-MAC algorithm. Only 128-bit keys are supported. */
 251         RTE_CRYPTO_AUTH_AES_CCM,
 252         /**< AES algorithm in CCM mode. This is an authenticated cipher. When
 253          * this hash algorithm is used, the *RTE_CRYPTO_CIPHER_AES_CCM*
 254          * element of the *rte_crypto_cipher_algorithm* enum MUST be used to
 255          * set up the related rte_crypto_cipher_setup_data structure in the
 256          * session context or the corresponding parameter in the crypto
 257          * operation data structures op_params parameter MUST be set for a
 258          * session-less crypto operation.
 259          */
 260         RTE_CRYPTO_AUTH_AES_CMAC,
 261         /**< AES CMAC algorithm. */
 262         RTE_CRYPTO_AUTH_AES_GCM,
 263         /**< AES algorithm in GCM mode. When this hash algorithm
 264          * is used, the RTE_CRYPTO_CIPHER_AES_GCM element of the
 265          * rte_crypto_cipher_algorithm enum MUST be used to set up the related
 266          * rte_crypto_cipher_setup_data structure in the session context, or
 267          * the corresponding parameter in the crypto operation data structures
 268          * op_params parameter MUST be set for a session-less crypto operation.
 269          */
 270         RTE_CRYPTO_AUTH_AES_GMAC,
 271         /**< AES GMAC algorithm. When this hash algorithm
 272         * is used, the RTE_CRYPTO_CIPHER_AES_GCM element of the
 273         * rte_crypto_cipher_algorithm enum MUST be used to set up the related
 274         * rte_crypto_cipher_setup_data structure in the session context,  or
 275         * the corresponding parameter in the crypto operation data structures
 276         * op_params parameter MUST be set for a session-less crypto operation.
 277         */
 278         RTE_CRYPTO_AUTH_AES_XCBC_MAC,
 279         /**< AES XCBC algorithm. */
 280
 281         RTE_CRYPTO_AUTH_KASUMI_F9,
 282         /**< KASUMI algorithm in F9 mode. */
 283
 284         RTE_CRYPTO_AUTH_MD5,
 285         /**< MD5 algorithm */
 286         RTE_CRYPTO_AUTH_MD5_HMAC,
 287         /**< HMAC using MD5 algorithm */
 288
 289         RTE_CRYPTO_AUTH_SHA1,
 290         /**< 128 bit SHA algorithm. */
 291         RTE_CRYPTO_AUTH_SHA1_HMAC,
 292         /**< HMAC using 128 bit SHA algorithm. */
 293         RTE_CRYPTO_AUTH_SHA224,
 294         /**< 224 bit SHA algorithm. */
 295         RTE_CRYPTO_AUTH_SHA224_HMAC,
 296         /**< HMAC using 224 bit SHA algorithm. */
 297         RTE_CRYPTO_AUTH_SHA256,
 298         /**< 256 bit SHA algorithm. */
 299         RTE_CRYPTO_AUTH_SHA256_HMAC,
 300         /**< HMAC using 256 bit SHA algorithm. */
 301         RTE_CRYPTO_AUTH_SHA384,
 302         /**< 384 bit SHA algorithm. */
 303         RTE_CRYPTO_AUTH_SHA384_HMAC,
 304         /**< HMAC using 384 bit SHA algorithm. */
 305         RTE_CRYPTO_AUTH_SHA512,
 306         /**< 512 bit SHA algorithm. */
 307         RTE_CRYPTO_AUTH_SHA512_HMAC,
 308         /**< HMAC using 512 bit SHA algorithm. */
 309
 310         RTE_CRYPTO_AUTH_SNOW3G_UIA2,
 311         /**< SNOW 3G algorithm in UIA2 mode. */
 312
 313         RTE_CRYPTO_AUTH_ZUC_EIA3,
 314         /**< ZUC algorithm in EIA3 mode */
 315
 316         RTE_CRYPTO_AUTH_LIST_END
 317 };
 318
 319 /** Authentication algorithm name strings */
 320 extern const char *
 321 rte_crypto_auth_algorithm_strings[];
 322
 323 /** Symmetric Authentication / Hash Operations */
 324 enum rte_crypto_auth_operation {
 325         RTE_CRYPTO_AUTH_OP_VERIFY,      /**< Verify authentication digest */
 326         RTE_CRYPTO_AUTH_OP_GENERATE     /**< Generate authentication digest */
 327 };
 328
 329 /** Authentication operation name strings */
 330 extern const char *
 331 rte_crypto_auth_operation_strings[];
 332
 333 /**
 334  * Authentication / Hash transform data.
 335  *
 336  * This structure contains data relating to an authentication/hash crypto
 337  * transforms. The fields op, algo and digest_length are common to all
 338  * authentication transforms and MUST be set.
 339  */
 340 struct rte_crypto_auth_xform {
 341         enum rte_crypto_auth_operation op;
 342         /**< Authentication operation type */
 343         enum rte_crypto_auth_algorithm algo;
 344         /**< Authentication algorithm selection */
 345
 346         struct {
 347                 uint8_t *data;  /**< pointer to key data */
 348                 size_t length;  /**< key length in bytes */
 349         } key;
 350         /**< Authentication key data.
 351          * The authentication key length MUST be less than or equal to the
 352          * block size of the algorithm. It is the callers responsibility to
 353          * ensure that the key length is compliant with the standard being used
 354          * (for example RFC 2104, FIPS 198a).
 355          */
 356
 357         uint32_t digest_length;
 358         /**< Length of the digest to be returned. If the verify option is set,
 359          * this specifies the length of the digest to be compared for the
 360          * session.
 361          *
 362          * It is the caller's responsibility to ensure that the
 363          * digest length is compliant with the hash algorithm being used.
 364          * If the value is less than the maximum length allowed by the hash,
 365          * the result shall be truncated.
 366          */
 367
 368         uint16_t add_auth_data_length;
 369         /**< The length of the additional authenticated data (AAD) in bytes.
 370          * The maximum permitted value is 65535 (2^16 - 1) bytes, unless
 371          * otherwise specified below.
 372          *
 373          * This field must be specified when the hash algorithm is one of the
 374          * following:
 375          *
 376          * - For GCM (@ref RTE_CRYPTO_AUTH_AES_GCM).  In this case, this is
 377          *   the length of the Additional Authenticated Data (called A, in NIST
 378          *   SP800-38D).
 379          *
 380          * - For CCM (@ref RTE_CRYPTO_AUTH_AES_CCM).  In this case, this is
 381          *   the length of the associated data (called A, in NIST SP800-38C).
 382          *   Note that this does NOT include the length of any padding, or the
 383          *   18 bytes reserved at the start of the above field to store the
 384          *   block B0 and the encoded length.  The maximum permitted value in
 385          *   this case is 222 bytes.
 386          *
 387          * @note
 388          *  For AES-GMAC (@ref RTE_CRYPTO_AUTH_AES_GMAC) mode of operation
 389          *  this field is not used and should be set to 0. Instead the length
 390          *  of the AAD data is specified in additional authentication data
 391          *  length field of the rte_crypto_sym_op_data structure
 392          */
 393
 394         struct {
 395                 uint16_t offset;
 396                 /**< Starting point for Initialisation Vector or Counter,
 397                  * specified as number of bytes from start of crypto
 398                  * operation (rte_crypto_op).
 399                  *
 400                  * - For KASUMI in F9 mode, SNOW 3G in UIA2 mode,
 401                  *   for ZUC in EIA3 mode and for AES-GMAC, this is the
 402                  *   authentication Initialisation Vector (IV) value.
 403                  *
 404                  *
 405                  * For optimum performance, the data pointed to SHOULD
 406                  * be 8-byte aligned.
 407                  */
 408                 uint16_t length;
 409                 /**< Length of valid IV data.
 410                  *
 411                  * - For KASUMI in F9 mode, SNOW3G in UIA2 mode, for
 412                  *   ZUC in EIA3 mode and for AES-GMAC, this is the length
 413                  *   of the IV.
 414                  *
 415                  */
 416         } iv;   /**< Initialisation vector parameters */
 417 };
 418
 419 /** Crypto transformation types */
 420 enum rte_crypto_sym_xform_type {
 421         RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED = 0, /**< No xform specified */
 422         RTE_CRYPTO_SYM_XFORM_AUTH,              /**< Authentication xform */
 423         RTE_CRYPTO_SYM_XFORM_CIPHER             /**< Cipher xform  */
 424 };
 425
 426 /**
 427  * Symmetric crypto transform structure.
 428  *
 429  * This is used to specify the crypto transforms required, multiple transforms
 430  * can be chained together to specify a chain transforms such as authentication
 431  * then cipher, or cipher then authentication. Each transform structure can
 432  * hold a single transform, the type field is used to specify which transform
 433  * is contained within the union
 434  */
 435 struct rte_crypto_sym_xform {
 436         struct rte_crypto_sym_xform *next;
 437         /**< next xform in chain */
 438         enum rte_crypto_sym_xform_type type
 439         ; /**< xform type */
 440         RTE_STD_C11
 441         union {
 442                 struct rte_crypto_auth_xform auth;
 443                 /**< Authentication / hash xform */
 444                 struct rte_crypto_cipher_xform cipher;
 445                 /**< Cipher xform */
 446         };
 447 };
 448
 449 struct rte_cryptodev_sym_session;
 450
 451 /**
 452  * Symmetric Cryptographic Operation.
 453  *
 454  * This structure contains data relating to performing symmetric cryptographic
 455  * processing on a referenced mbuf data buffer.
 456  *
 457  * When a symmetric crypto operation is enqueued with the device for processing
 458  * it must have a valid *rte_mbuf* structure attached, via m_src parameter,
 459  * which contains the source data which the crypto operation is to be performed
 460  * on.
 461  * While the mbuf is in use by a crypto operation no part of the mbuf should be
 462  * changed by the application as the device may read or write to any part of the
 463  * mbuf. In the case of hardware crypto devices some or all of the mbuf
 464  * may be DMAed in and out of the device, so writing over the original data,
 465  * though only the part specified by the rte_crypto_sym_op for transformation
 466  * will be changed.
 467  * Out-of-place (OOP) operation, where the source mbuf is different to the
 468  * destination mbuf, is a special case. Data will be copied from m_src to m_dst.
 469  * The part copied includes all the parts of the source mbuf that will be
 470  * operated on, based on the cipher.data.offset+cipher.data.length and
 471  * auth.data.offset+auth.data.length values in the rte_crypto_sym_op. The part
 472  * indicated by the cipher parameters will be transformed, any extra data around
 473  * this indicated by the auth parameters will be copied unchanged from source to
 474  * destination mbuf.
 475  * Also in OOP operation the cipher.data.offset and auth.data.offset apply to
 476  * both source and destination mbufs. As these offsets are relative to the
 477  * data_off parameter in each mbuf this can result in the data written to the
 478  * destination buffer being at a different alignment, relative to buffer start,
 479  * to the data in the source buffer.
 480  */
 481 struct rte_crypto_sym_op {
 482         struct rte_mbuf *m_src; /**< source mbuf */
 483         struct rte_mbuf *m_dst; /**< destination mbuf */
 484
 485         RTE_STD_C11
 486         union {
 487                 struct rte_cryptodev_sym_session *session;
 488                 /**< Handle for the initialised session context */
 489                 struct rte_crypto_sym_xform *xform;
 490                 /**< Session-less API crypto operation parameters */
 491         };
 492
 493         struct {
 494                 struct {
 495                         uint32_t offset;
 496                          /**< Starting point for cipher processing, specified
 497                           * as number of bytes from start of data in the source
 498                           * buffer. The result of the cipher operation will be
 499                           * written back into the output buffer starting at
 500                           * this location.
 501                           *
 502                           * @note
 503                           * For SNOW 3G @ RTE_CRYPTO_CIPHER_SNOW3G_UEA2,
 504                           * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
 505                           * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
 506                           * this field should be in bits.
 507                           */
 508
 509                         uint32_t length;
 510                          /**< The message length, in bytes, of the source buffer
 511                           * on which the cryptographic operation will be
 512                           * computed. This must be a multiple of the block size
 513                           * if a block cipher is being used. This is also the
 514                           * same as the result length.
 515                           *
 516                           * @note
 517                           * In the case of CCM @ref RTE_CRYPTO_AUTH_AES_CCM,
 518                           * this value should not include the length of the
 519                           * padding or the length of the MAC; the driver will
 520                           * compute the actual number of bytes over which the
 521                           * encryption will occur, which will include these
 522                           * values.
 523                           *
 524                           * @note
 525                           * For AES-GMAC @ref RTE_CRYPTO_AUTH_AES_GMAC, this
 526                           * field should be set to 0.
 527                           *
 528                           * @note
 529                           * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UEA2,
 530                           * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
 531                           * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
 532                           * this field should be in bits.
 533                           */
 534                 } data; /**< Data offsets and length for ciphering */
 535
 536         } cipher;
 537
 538         struct {
 539                 struct {
 540                         uint32_t offset;
 541                          /**< Starting point for hash processing, specified as
 542                           * number of bytes from start of packet in source
 543                           * buffer.
 544                           *
 545                           * @note
 546                           * For CCM and GCM modes of operation, this field is
 547                           * ignored. The field @ref aad field
 548                           * should be set instead.
 549                           *
 550                           * @note For AES-GMAC (@ref RTE_CRYPTO_AUTH_AES_GMAC)
 551                           * mode of operation, this field is set to 0. aad data
 552                           * pointer of rte_crypto_sym_op_data structure is
 553                           * used instead
 554                           *
 555                           * @note
 556                           * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
 557                           * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
 558                           * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
 559                           * this field should be in bits.
 560                           */
 561
 562                         uint32_t length;
 563                          /**< The message length, in bytes, of the source
 564                           * buffer that the hash will be computed on.
 565                           *
 566                           * @note
 567                           * For CCM and GCM modes of operation, this field is
 568                           * ignored. The field @ref aad field should be set
 569                           * instead.
 570                           *
 571                           * @note
 572                           * For AES-GMAC @ref RTE_CRYPTO_AUTH_AES_GMAC mode
 573                           * of operation, this field is set to 0.
 574                           * Auth.aad.length is used instead.
 575                           *
 576                           * @note
 577                           * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
 578                           * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
 579                           * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
 580                           * this field should be in bits.
 581                           */
 582                 } data; /**< Data offsets and length for authentication */
 583
 584                 struct {
 585                         uint8_t *data;
 586                         /**< This points to the location where the digest result
 587                          * should be inserted (in the case of digest generation)
 588                          * or where the purported digest exists (in the case of
 589                          * digest verification).
 590                          *
 591                          * At session creation time, the client specified the
 592                          * digest result length with the digest_length member
 593                          * of the @ref rte_crypto_auth_xform structure. For
 594                          * physical crypto devices the caller must allocate at
 595                          * least digest_length of physically contiguous memory
 596                          * at this location.
 597                          *
 598                          * For digest generation, the digest result will
 599                          * overwrite any data at this location.
 600                          *
 601                          * @note
 602                          * For GCM (@ref RTE_CRYPTO_AUTH_AES_GCM), for
 603                          * "digest result" read "authentication tag T".
 604                          */
 605                         phys_addr_t phys_addr;
 606                         /**< Physical address of digest */
 607                         uint16_t length;
 608                         /**< Length of digest. This must be the same value as
 609                          * @ref rte_crypto_auth_xform.digest_length.
 610                          */
 611                 } digest; /**< Digest parameters */
 612
 613                 struct {
 614                         uint8_t *data;
 615                         /**< Pointer to Additional Authenticated Data (AAD)
 616                          * needed for authenticated cipher mechanisms (CCM and
 617                          * GCM).
 618                          *
 619                          * The length of the data pointed to by this field is
 620                          * set up for the session in the @ref
 621                          * rte_crypto_auth_xform structure as part of the @ref
 622                          * rte_cryptodev_sym_session_create function call.
 623                          * This length must not exceed 65535 (2^16-1) bytes.
 624                          *
 625                          * Specifically for CCM (@ref RTE_CRYPTO_AUTH_AES_CCM),
 626                          * the caller should setup this field as follows:
 627                          *
 628                          * - the nonce should be written starting at an offset
 629                          * of one byte into the array, leaving room for the
 630                          * implementation to write in the flags to the first
 631                          *  byte.
 632                          *
 633                          * - the additional  authentication data itself should
 634                          * be written starting at an offset of 18 bytes into
 635                          * the array, leaving room for the length encoding in
 636                          * the first two bytes of the second block.
 637                          *
 638                          * - the array should be big enough to hold the above
 639                          *  fields, plus any padding to round this up to the
 640                          *  nearest multiple of the block size (16 bytes).
 641                          *  Padding will be added by the implementation.
 642                          *
 643                          * Finally, for GCM (@ref RTE_CRYPTO_AUTH_AES_GCM), the
 644                          * caller should setup this field as follows:
 645                          *
 646                          * - the AAD is written in starting at byte 0
 647                          * - the array must be big enough to hold the AAD, plus
 648                          * any space to round this up to the nearest multiple
 649                          * of the block size (16 bytes).
 650                          *
 651                          * @note
 652                          * For AES-GMAC (@ref RTE_CRYPTO_AUTH_AES_GMAC) mode of
 653                          * operation, this field is used to pass plaintext.
 654                          */
 655                         phys_addr_t phys_addr;  /**< physical address */
 656                 } aad;
 657                 /**< Additional authentication parameters */
 658         } auth;
 659 };
 660
 661
 662 /**
 663  * Reset the fields of a symmetric operation to their default values.
 664  *
 665  * @param       op      The crypto operation to be reset.
 666  */
 667 static inline void
 668 __rte_crypto_sym_op_reset(struct rte_crypto_sym_op *op)
 669 {
 670         memset(op, 0, sizeof(*op));
 671 }
 672
 673
 674 /**
 675  * Allocate space for symmetric crypto xforms in the private data space of the
 676  * crypto operation. This also defaults the crypto xform type to
 677  * RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED and configures the chaining of the xforms
 678  * in the crypto operation
 679  *
 680  * @return
 681  * - On success returns pointer to first crypto xform in crypto operations chain
 682  * - On failure returns NULL
 683  */
 684 static inline struct rte_crypto_sym_xform *
 685 __rte_crypto_sym_op_sym_xforms_alloc(struct rte_crypto_sym_op *sym_op,
 686                 void *priv_data, uint8_t nb_xforms)
 687 {
 688         struct rte_crypto_sym_xform *xform;
 689
 690         sym_op->xform = xform = (struct rte_crypto_sym_xform *)priv_data;
 691
 692         do {
 693                 xform->type = RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED;
 694                 xform = xform->next = --nb_xforms > 0 ? xform + 1 : NULL;
 695         } while (xform);
 696
 697         return sym_op->xform;
 698 }
 699
 700
 701 /**
 702  * Attach a session to a symmetric crypto operation
 703  *
 704  * @param       sym_op  crypto operation
 705  * @param       sess    cryptodev session
 706  */
 707 static inline int
 708 __rte_crypto_sym_op_attach_sym_session(struct rte_crypto_sym_op *sym_op,
 709                 struct rte_cryptodev_sym_session *sess)
 710 {
 711         sym_op->session = sess;
 712
 713         return 0;
 714 }
 715
 716
 717 #ifdef __cplusplus
 718 }
 719 #endif
 720
 721 #endif /* _RTE_CRYPTO_SYM_H_ */