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