lib/librte_cryptodev/rte_crypto_sym.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2016 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_LIST_END
 112
 113 };
 114
 115 /** Cipher algorithm name strings */
 116 extern const char *
 117 rte_crypto_cipher_algorithm_strings[];
 118
 119 /** Symmetric Cipher Direction */
 120 enum rte_crypto_cipher_operation {
 121         RTE_CRYPTO_CIPHER_OP_ENCRYPT,
 122         /**< Encrypt cipher operation */
 123         RTE_CRYPTO_CIPHER_OP_DECRYPT
 124         /**< Decrypt cipher operation */
 125 };
 126
 127 /** Cipher operation name strings */
 128 extern const char *
 129 rte_crypto_cipher_operation_strings[];
 130
 131 /**
 132  * Symmetric Cipher Setup Data.
 133  *
 134  * This structure contains data relating to Cipher (Encryption and Decryption)
 135  *  use to create a session.
 136  */
 137 struct rte_crypto_cipher_xform {
 138         enum rte_crypto_cipher_operation op;
 139         /**< This parameter determines if the cipher operation is an encrypt or
 140          * a decrypt operation. For the RC4 algorithm and the F8/CTR modes,
 141          * only encrypt operations are valid.
 142          */
 143         enum rte_crypto_cipher_algorithm algo;
 144         /**< Cipher algorithm */
 145
 146         struct {
 147                 uint8_t *data;  /**< pointer to key data */
 148                 size_t length;  /**< key length in bytes */
 149         } key;
 150         /**< Cipher key
 151          *
 152          * For the RTE_CRYPTO_CIPHER_AES_F8 mode of operation, key.data will
 153          * point to a concatenation of the AES encryption key followed by a
 154          * keymask. As per RFC3711, the keymask should be padded with trailing
 155          * bytes to match the length of the encryption key used.
 156          *
 157          * For AES-XTS mode of operation, two keys must be provided and
 158          * key.data must point to the two keys concatenated together (Key1 ||
 159          * Key2). The cipher key length will contain the total size of both
 160          * keys.
 161          *
 162          * Cipher key length is in bytes. For AES it can be 128 bits (16 bytes),
 163          * 192 bits (24 bytes) or 256 bits (32 bytes).
 164          *
 165          * For the CCM mode of operation, the only supported key length is 128
 166          * bits (16 bytes).
 167          *
 168          * For the RTE_CRYPTO_CIPHER_AES_F8 mode of operation, key.length
 169          * should be set to the combined length of the encryption key and the
 170          * keymask. Since the keymask and the encryption key are the same size,
 171          * key.length should be set to 2 x the AES encryption key length.
 172          *
 173          * For the AES-XTS mode of operation:
 174          *  - Two keys must be provided and key.length refers to total length of
 175          *    the two keys.
 176          *  - Each key can be either 128 bits (16 bytes) or 256 bits (32 bytes).
 177          *  - Both keys must have the same size.
 178          **/
 179 };
 180
 181 /** Symmetric Authentication / Hash Algorithms */
 182 enum rte_crypto_auth_algorithm {
 183         RTE_CRYPTO_AUTH_NULL = 1,
 184         /**< NULL hash algorithm. */
 185
 186         RTE_CRYPTO_AUTH_AES_CBC_MAC,
 187         /**< AES-CBC-MAC algorithm. Only 128-bit keys are supported. */
 188         RTE_CRYPTO_AUTH_AES_CCM,
 189         /**< AES algorithm in CCM mode. This is an authenticated cipher. When
 190          * this hash algorithm is used, the *RTE_CRYPTO_CIPHER_AES_CCM*
 191          * element of the *rte_crypto_cipher_algorithm* enum MUST be used to
 192          * set up the related rte_crypto_cipher_setup_data structure in the
 193          * session context or the corresponding parameter in the crypto
 194          * operation data structures op_params parameter MUST be set for a
 195          * session-less crypto operation.
 196          */
 197         RTE_CRYPTO_AUTH_AES_CMAC,
 198         /**< AES CMAC algorithm. */
 199         RTE_CRYPTO_AUTH_AES_GCM,
 200         /**< AES algorithm in GCM mode. When this hash algorithm
 201          * is used, the RTE_CRYPTO_CIPHER_AES_GCM element of the
 202          * rte_crypto_cipher_algorithm enum MUST be used to set up the related
 203          * rte_crypto_cipher_setup_data structure in the session context, or
 204          * the corresponding parameter in the crypto operation data structures
 205          * op_params parameter MUST be set for a session-less crypto operation.
 206          */
 207         RTE_CRYPTO_AUTH_AES_GMAC,
 208         /**< AES GMAC algorithm. When this hash algorithm
 209         * is used, the RTE_CRYPTO_CIPHER_AES_GCM element of the
 210         * rte_crypto_cipher_algorithm enum MUST be used to set up the related
 211         * rte_crypto_cipher_setup_data structure in the session context,  or
 212         * the corresponding parameter in the crypto operation data structures
 213         * op_params parameter MUST be set for a session-less crypto operation.
 214         */
 215         RTE_CRYPTO_AUTH_AES_XCBC_MAC,
 216         /**< AES XCBC algorithm. */
 217
 218         RTE_CRYPTO_AUTH_KASUMI_F9,
 219         /**< KASUMI algorithm in F9 mode. */
 220
 221         RTE_CRYPTO_AUTH_MD5,
 222         /**< MD5 algorithm */
 223         RTE_CRYPTO_AUTH_MD5_HMAC,
 224         /**< HMAC using MD5 algorithm */
 225
 226         RTE_CRYPTO_AUTH_SHA1,
 227         /**< 128 bit SHA algorithm. */
 228         RTE_CRYPTO_AUTH_SHA1_HMAC,
 229         /**< HMAC using 128 bit SHA algorithm. */
 230         RTE_CRYPTO_AUTH_SHA224,
 231         /**< 224 bit SHA algorithm. */
 232         RTE_CRYPTO_AUTH_SHA224_HMAC,
 233         /**< HMAC using 224 bit SHA algorithm. */
 234         RTE_CRYPTO_AUTH_SHA256,
 235         /**< 256 bit SHA algorithm. */
 236         RTE_CRYPTO_AUTH_SHA256_HMAC,
 237         /**< HMAC using 256 bit SHA algorithm. */
 238         RTE_CRYPTO_AUTH_SHA384,
 239         /**< 384 bit SHA algorithm. */
 240         RTE_CRYPTO_AUTH_SHA384_HMAC,
 241         /**< HMAC using 384 bit SHA algorithm. */
 242         RTE_CRYPTO_AUTH_SHA512,
 243         /**< 512 bit SHA algorithm. */
 244         RTE_CRYPTO_AUTH_SHA512_HMAC,
 245         /**< HMAC using 512 bit SHA algorithm. */
 246
 247         RTE_CRYPTO_AUTH_SNOW3G_UIA2,
 248         /**< SNOW 3G algorithm in UIA2 mode. */
 249
 250         RTE_CRYPTO_AUTH_ZUC_EIA3,
 251         /**< ZUC algorithm in EIA3 mode */
 252
 253         RTE_CRYPTO_AUTH_LIST_END
 254 };
 255
 256 /** Authentication algorithm name strings */
 257 extern const char *
 258 rte_crypto_auth_algorithm_strings[];
 259
 260 /** Symmetric Authentication / Hash Operations */
 261 enum rte_crypto_auth_operation {
 262         RTE_CRYPTO_AUTH_OP_VERIFY,      /**< Verify authentication digest */
 263         RTE_CRYPTO_AUTH_OP_GENERATE     /**< Generate authentication digest */
 264 };
 265
 266 /** Authentication operation name strings */
 267 extern const char *
 268 rte_crypto_auth_operation_strings[];
 269
 270 /**
 271  * Authentication / Hash transform data.
 272  *
 273  * This structure contains data relating to an authentication/hash crypto
 274  * transforms. The fields op, algo and digest_length are common to all
 275  * authentication transforms and MUST be set.
 276  */
 277 struct rte_crypto_auth_xform {
 278         enum rte_crypto_auth_operation op;
 279         /**< Authentication operation type */
 280         enum rte_crypto_auth_algorithm algo;
 281         /**< Authentication algorithm selection */
 282
 283         struct {
 284                 uint8_t *data;  /**< pointer to key data */
 285                 size_t length;  /**< key length in bytes */
 286         } key;
 287         /**< Authentication key data.
 288          * The authentication key length MUST be less than or equal to the
 289          * block size of the algorithm. It is the callers responsibility to
 290          * ensure that the key length is compliant with the standard being used
 291          * (for example RFC 2104, FIPS 198a).
 292          */
 293
 294         uint32_t digest_length;
 295         /**< Length of the digest to be returned. If the verify option is set,
 296          * this specifies the length of the digest to be compared for the
 297          * session.
 298          *
 299          * If the value is less than the maximum length allowed by the hash,
 300          * the result shall be truncated.  If the value is greater than the
 301          * maximum length allowed by the hash then an error will be generated
 302          * by *rte_cryptodev_sym_session_create* or by the
 303          * *rte_cryptodev_sym_enqueue_burst* if using session-less APIs.
 304          */
 305
 306         uint32_t add_auth_data_length;
 307         /**< The length of the additional authenticated data (AAD) in bytes.
 308          * The maximum permitted value is 240 bytes, unless otherwise specified
 309          * below.
 310          *
 311          * This field must be specified when the hash algorithm is one of the
 312          * following:
 313          *
 314          * - For SNOW 3G (@ref RTE_CRYPTO_AUTH_SNOW3G_UIA2), this is the
 315          *   length of the IV (which should be 16).
 316          *
 317          * - For GCM (@ref RTE_CRYPTO_AUTH_AES_GCM).  In this case, this is
 318          *   the length of the Additional Authenticated Data (called A, in NIST
 319          *   SP800-38D).
 320          *
 321          * - For CCM (@ref RTE_CRYPTO_AUTH_AES_CCM).  In this case, this is
 322          *   the length of the associated data (called A, in NIST SP800-38C).
 323          *   Note that this does NOT include the length of any padding, or the
 324          *   18 bytes reserved at the start of the above field to store the
 325          *   block B0 and the encoded length.  The maximum permitted value in
 326          *   this case is 222 bytes.
 327          *
 328          * @note
 329          *  For AES-GMAC (@ref RTE_CRYPTO_AUTH_AES_GMAC) mode of operation
 330          *  this field is not used and should be set to 0. Instead the length
 331          *  of the AAD data is specified in additional authentication data
 332          *  length field of the rte_crypto_sym_op_data structure
 333          */
 334 };
 335
 336 /** Crypto transformation types */
 337 enum rte_crypto_sym_xform_type {
 338         RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED = 0, /**< No xform specified */
 339         RTE_CRYPTO_SYM_XFORM_AUTH,              /**< Authentication xform */
 340         RTE_CRYPTO_SYM_XFORM_CIPHER             /**< Cipher xform  */
 341 };
 342
 343 /**
 344  * Symmetric crypto transform structure.
 345  *
 346  * This is used to specify the crypto transforms required, multiple transforms
 347  * can be chained together to specify a chain transforms such as authentication
 348  * then cipher, or cipher then authentication. Each transform structure can
 349  * hold a single transform, the type field is used to specify which transform
 350  * is contained within the union
 351  */
 352 struct rte_crypto_sym_xform {
 353         struct rte_crypto_sym_xform *next;
 354         /**< next xform in chain */
 355         enum rte_crypto_sym_xform_type type
 356         ; /**< xform type */
 357         RTE_STD_C11
 358         union {
 359                 struct rte_crypto_auth_xform auth;
 360                 /**< Authentication / hash xform */
 361                 struct rte_crypto_cipher_xform cipher;
 362                 /**< Cipher xform */
 363         };
 364 };
 365
 366 /**
 367  * Crypto operation session type. This is used to specify whether a crypto
 368  * operation has session structure attached for immutable parameters or if all
 369  * operation information is included in the operation data structure.
 370  */
 371 enum rte_crypto_sym_op_sess_type {
 372         RTE_CRYPTO_SYM_OP_WITH_SESSION, /**< Session based crypto operation */
 373         RTE_CRYPTO_SYM_OP_SESSIONLESS   /**< Session-less crypto operation */
 374 };
 375
 376
 377 struct rte_cryptodev_sym_session;
 378
 379 /**
 380  * Symmetric Cryptographic Operation.
 381  *
 382  * This structure contains data relating to performing symmetric cryptographic
 383  * processing on a referenced mbuf data buffer.
 384  *
 385  * When a symmetric crypto operation is enqueued with the device for processing
 386  * it must have a valid *rte_mbuf* structure attached, via m_src parameter,
 387  * which contains the source data which the crypto operation is to be performed
 388  * on.
 389  * While the mbuf is in use by a crypto operation no part of the mbuf should be
 390  * changed by the application as the device may read or write to any part of the
 391  * mbuf. In the case of hardware crypto devices some or all of the mbuf
 392  * may be DMAed in and out of the device, so writing over the original data,
 393  * though only the part specified by the rte_crypto_sym_op for transformation
 394  * will be changed.
 395  * Out-of-place (OOP) operation, where the source mbuf is different to the
 396  * destination mbuf, is a special case. Data will be copied from m_src to m_dst.
 397  * The part copied includes all the parts of the source mbuf that will be
 398  * operated on, based on the cipher.data.offset+cipher.data.length and
 399  * auth.data.offset+auth.data.length values in the rte_crypto_sym_op. The part
 400  * indicated by the cipher parameters will be transformed, any extra data around
 401  * this indicated by the auth parameters will be copied unchanged from source to
 402  * destination mbuf.
 403  * Also in OOP operation the cipher.data.offset and auth.data.offset apply to
 404  * both source and destination mbufs. As these offsets are relative to the
 405  * data_off parameter in each mbuf this can result in the data written to the
 406  * destination buffer being at a different alignment, relative to buffer start,
 407  * to the data in the source buffer.
 408  */
 409 struct rte_crypto_sym_op {
 410         struct rte_mbuf *m_src; /**< source mbuf */
 411         struct rte_mbuf *m_dst; /**< destination mbuf */
 412
 413         enum rte_crypto_sym_op_sess_type sess_type;
 414
 415         RTE_STD_C11
 416         union {
 417                 struct rte_cryptodev_sym_session *session;
 418                 /**< Handle for the initialised session context */
 419                 struct rte_crypto_sym_xform *xform;
 420                 /**< Session-less API crypto operation parameters */
 421         };
 422
 423         struct {
 424                 struct {
 425                         uint32_t offset;
 426                          /**< Starting point for cipher processing, specified
 427                           * as number of bytes from start of data in the source
 428                           * buffer. The result of the cipher operation will be
 429                           * written back into the output buffer starting at
 430                           * this location.
 431                           *
 432                           * @note
 433                           * For SNOW 3G @ RTE_CRYPTO_CIPHER_SNOW3G_UEA2,
 434                           * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
 435                           * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
 436                           * this field should be in bits.
 437                           */
 438
 439                         uint32_t length;
 440                          /**< The message length, in bytes, of the source buffer
 441                           * on which the cryptographic operation will be
 442                           * computed. This must be a multiple of the block size
 443                           * if a block cipher is being used. This is also the
 444                           * same as the result length.
 445                           *
 446                           * @note
 447                           * In the case of CCM @ref RTE_CRYPTO_AUTH_AES_CCM,
 448                           * this value should not include the length of the
 449                           * padding or the length of the MAC; the driver will
 450                           * compute the actual number of bytes over which the
 451                           * encryption will occur, which will include these
 452                           * values.
 453                           *
 454                           * @note
 455                           * For AES-GMAC @ref RTE_CRYPTO_AUTH_AES_GMAC, this
 456                           * field should be set to 0.
 457                           *
 458                           * @note
 459                           * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UEA2,
 460                           * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
 461                           * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
 462                           * this field should be in bits.
 463                           */
 464                 } data; /**< Data offsets and length for ciphering */
 465
 466                 struct {
 467                         uint8_t *data;
 468                         /**< Initialisation Vector or Counter.
 469                          *
 470                          * - For block ciphers in CBC or F8 mode, or for KASUMI
 471                          * in F8 mode, or for SNOW 3G in UEA2 mode, this is the
 472                          * Initialisation Vector (IV) value.
 473                          *
 474                          * - For block ciphers in CTR mode, this is the counter.
 475                          *
 476                          * - For GCM mode, this is either the IV (if the length
 477                          * is 96 bits) or J0 (for other sizes), where J0 is as
 478                          * defined by NIST SP800-38D. Regardless of the IV
 479                          * length, a full 16 bytes needs to be allocated.
 480                          *
 481                          * - For CCM mode, the first byte is reserved, and the
 482                          * nonce should be written starting at &iv[1] (to allow
 483                          * space for the implementation to write in the flags
 484                          * in the first byte). Note that a full 16 bytes should
 485                          * be allocated, even though the length field will
 486                          * have a value less than this.
 487                          *
 488                          * - For AES-XTS, this is the 128bit tweak, i, from
 489                          * IEEE Std 1619-2007.
 490                          *
 491                          * For optimum performance, the data pointed to SHOULD
 492                          * be 8-byte aligned.
 493                          */
 494                         phys_addr_t phys_addr;
 495                         uint16_t length;
 496                         /**< Length of valid IV data.
 497                          *
 498                          * - For block ciphers in CBC or F8 mode, or for KASUMI
 499                          * in F8 mode, or for SNOW 3G in UEA2 mode, this is the
 500                          * length of the IV (which must be the same as the
 501                          * block length of the cipher).
 502                          *
 503                          * - For block ciphers in CTR mode, this is the length
 504                          * of the counter (which must be the same as the block
 505                          * length of the cipher).
 506                          *
 507                          * - For GCM mode, this is either 12 (for 96-bit IVs)
 508                          * or 16, in which case data points to J0.
 509                          *
 510                          * - For CCM mode, this is the length of the nonce,
 511                          * which can be in the range 7 to 13 inclusive.
 512                          */
 513                 } iv;   /**< Initialisation vector parameters */
 514         } cipher;
 515
 516         struct {
 517                 struct {
 518                         uint32_t offset;
 519                          /**< Starting point for hash processing, specified as
 520                           * number of bytes from start of packet in source
 521                           * buffer.
 522                           *
 523                           * @note
 524                           * For CCM and GCM modes of operation, this field is
 525                           * ignored. The field @ref aad field
 526                           * should be set instead.
 527                           *
 528                           * @note For AES-GMAC (@ref RTE_CRYPTO_AUTH_AES_GMAC)
 529                           * mode of operation, this field is set to 0. aad data
 530                           * pointer of rte_crypto_sym_op_data structure is
 531                           * used instead
 532                           *
 533                           * @note
 534                           * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
 535                           * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
 536                           * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
 537                           * this field should be in bits.
 538                           */
 539
 540                         uint32_t length;
 541                          /**< The message length, in bytes, of the source
 542                           * buffer that the hash will be computed on.
 543                           *
 544                           * @note
 545                           * For CCM and GCM modes of operation, this field is
 546                           * ignored. The field @ref aad field should be set
 547                           * instead.
 548                           *
 549                           * @note
 550                           * For AES-GMAC @ref RTE_CRYPTO_AUTH_AES_GMAC mode
 551                           * of operation, this field is set to 0.
 552                           * Auth.aad.length is used instead.
 553                           *
 554                           * @note
 555                           * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
 556                           * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
 557                           * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
 558                           * this field should be in bits.
 559                           */
 560                 } data; /**< Data offsets and length for authentication */
 561
 562                 struct {
 563                         uint8_t *data;
 564                         /**< This points to the location where the digest result
 565                          * should be inserted (in the case of digest generation)
 566                          * or where the purported digest exists (in the case of
 567                          * digest verification).
 568                          *
 569                          * At session creation time, the client specified the
 570                          * digest result length with the digest_length member
 571                          * of the @ref rte_crypto_auth_xform structure. For
 572                          * physical crypto devices the caller must allocate at
 573                          * least digest_length of physically contiguous memory
 574                          * at this location.
 575                          *
 576                          * For digest generation, the digest result will
 577                          * overwrite any data at this location.
 578                          *
 579                          * @note
 580                          * For GCM (@ref RTE_CRYPTO_AUTH_AES_GCM), for
 581                          * "digest result" read "authentication tag T".
 582                          */
 583                         phys_addr_t phys_addr;
 584                         /**< Physical address of digest */
 585                         uint16_t length;
 586                         /**< Length of digest */
 587                 } digest; /**< Digest parameters */
 588
 589                 struct {
 590                         uint8_t *data;
 591                         /**< Pointer to Additional Authenticated Data (AAD)
 592                          * needed for authenticated cipher mechanisms (CCM and
 593                          * GCM), and to the IV for SNOW 3G authentication
 594                          * (@ref RTE_CRYPTO_AUTH_SNOW3G_UIA2). For other
 595                          * authentication mechanisms this pointer is ignored.
 596                          *
 597                          * The length of the data pointed to by this field is
 598                          * set up for the session in the @ref
 599                          * rte_crypto_auth_xform structure as part of the @ref
 600                          * rte_cryptodev_sym_session_create function call.
 601                          * This length must not exceed 240 bytes.
 602                          *
 603                          * Specifically for CCM (@ref RTE_CRYPTO_AUTH_AES_CCM),
 604                          * the caller should setup this field as follows:
 605                          *
 606                          * - the nonce should be written starting at an offset
 607                          * of one byte into the array, leaving room for the
 608                          * implementation to write in the flags to the first
 609                          *  byte.
 610                          *
 611                          * - the additional  authentication data itself should
 612                          * be written starting at an offset of 18 bytes into
 613                          * the array, leaving room for the length encoding in
 614                          * the first two bytes of the second block.
 615                          *
 616                          * - the array should be big enough to hold the above
 617                          *  fields, plus any padding to round this up to the
 618                          *  nearest multiple of the block size (16 bytes).
 619                          *  Padding will be added by the implementation.
 620                          *
 621                          * Finally, for GCM (@ref RTE_CRYPTO_AUTH_AES_GCM), the
 622                          * caller should setup this field as follows:
 623                          *
 624                          * - the AAD is written in starting at byte 0
 625                          * - the array must be big enough to hold the AAD, plus
 626                          * any space to round this up to the nearest multiple
 627                          * of the block size (16 bytes).
 628                          *
 629                          * @note
 630                          * For AES-GMAC (@ref RTE_CRYPTO_AUTH_AES_GMAC) mode of
 631                          * operation, this field is used to pass plaintext.
 632                          */
 633                         phys_addr_t phys_addr;  /**< physical address */
 634                         uint16_t length;        /**< Length of digest */
 635                 } aad;
 636                 /**< Additional authentication parameters */
 637         } auth;
 638 } __rte_cache_aligned;
 639
 640
 641 /**
 642  * Reset the fields of a symmetric operation to their default values.
 643  *
 644  * @param       op      The crypto operation to be reset.
 645  */
 646 static inline void
 647 __rte_crypto_sym_op_reset(struct rte_crypto_sym_op *op)
 648 {
 649         memset(op, 0, sizeof(*op));
 650
 651         op->sess_type = RTE_CRYPTO_SYM_OP_SESSIONLESS;
 652 }
 653
 654
 655 /**
 656  * Allocate space for symmetric crypto xforms in the private data space of the
 657  * crypto operation. This also defaults the crypto xform type to
 658  * RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED and configures the chaining of the xforms
 659  * in the crypto operation
 660  *
 661  * @return
 662  * - On success returns pointer to first crypto xform in crypto operations chain
 663  * - On failure returns NULL
 664  */
 665 static inline struct rte_crypto_sym_xform *
 666 __rte_crypto_sym_op_sym_xforms_alloc(struct rte_crypto_sym_op *sym_op,
 667                 void *priv_data, uint8_t nb_xforms)
 668 {
 669         struct rte_crypto_sym_xform *xform;
 670
 671         sym_op->xform = xform = (struct rte_crypto_sym_xform *)priv_data;
 672
 673         do {
 674                 xform->type = RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED;
 675                 xform = xform->next = --nb_xforms > 0 ? xform + 1 : NULL;
 676         } while (xform);
 677
 678         return sym_op->xform;
 679 }
 680
 681
 682 /**
 683  * Attach a session to a symmetric crypto operation
 684  *
 685  * @param       sym_op  crypto operation
 686  * @param       sess    cryptodev session
 687  */
 688 static inline int
 689 __rte_crypto_sym_op_attach_sym_session(struct rte_crypto_sym_op *sym_op,
 690                 struct rte_cryptodev_sym_session *sess)
 691 {
 692         sym_op->session = sess;
 693         sym_op->sess_type = RTE_CRYPTO_SYM_OP_WITH_SESSION;
 694
 695         return 0;
 696 }
 697
 698
 699 #ifdef __cplusplus
 700 }
 701 #endif
 702
 703 #endif /* _RTE_CRYPTO_SYM_H_ */