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                 uint16_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                 uint16_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         struct {
 330                 uint16_t offset;
 331                 /**< Starting point for Initialisation Vector or Counter,
 332                  * specified as number of bytes from start of crypto
 333                  * operation (rte_crypto_op).
 334                  *
 335                  * - For SNOW 3G in UIA2 mode, for ZUC in EIA3 mode and
 336                  *   for AES-GMAC, this is the authentication
 337                  *   Initialisation Vector (IV) value.
 338                  *
 339                  * - For KASUMI in F9 mode and other authentication
 340                  *   algorithms, this field is not used.
 341                  *
 342                  * For optimum performance, the data pointed to SHOULD
 343                  * be 8-byte aligned.
 344                  */
 345                 uint16_t length;
 346                 /**< Length of valid IV data.
 347                  *
 348                  * - For SNOW3G in UIA2 mode, for ZUC in EIA3 mode and
 349                  *   for AES-GMAC, this is the length of the IV.
 350                  *
 351                  * - For KASUMI in F9 mode and other authentication
 352                  *   algorithms, this field is not used.
 353                  *
 354                  */
 355         } iv;   /**< Initialisation vector parameters */
 356 };
 357
 358
 359 /** Symmetric AEAD Algorithms */
 360 enum rte_crypto_aead_algorithm {
 361         RTE_CRYPTO_AEAD_AES_CCM = 1,
 362         /**< AES algorithm in CCM mode. */
 363         RTE_CRYPTO_AEAD_AES_GCM,
 364         /**< AES algorithm in GCM mode. */
 365         RTE_CRYPTO_AEAD_LIST_END
 366 };
 367
 368 /** AEAD algorithm name strings */
 369 extern const char *
 370 rte_crypto_aead_algorithm_strings[];
 371
 372 /** Symmetric AEAD Operations */
 373 enum rte_crypto_aead_operation {
 374         RTE_CRYPTO_AEAD_OP_ENCRYPT,
 375         /**< Encrypt and generate digest */
 376         RTE_CRYPTO_AEAD_OP_DECRYPT
 377         /**< Verify digest and decrypt */
 378 };
 379
 380 /** Authentication operation name strings */
 381 extern const char *
 382 rte_crypto_aead_operation_strings[];
 383
 384 struct rte_crypto_aead_xform {
 385         enum rte_crypto_aead_operation op;
 386         /**< AEAD operation type */
 387         enum rte_crypto_aead_algorithm algo;
 388         /**< AEAD algorithm selection */
 389
 390         struct {
 391                 uint8_t *data;  /**< pointer to key data */
 392                 uint16_t length;/**< key length in bytes */
 393         } key;
 394
 395         struct {
 396                 uint16_t offset;
 397                 /**< Starting point for Initialisation Vector or Counter,
 398                  * specified as number of bytes from start of crypto
 399                  * operation (rte_crypto_op).
 400                  *
 401                  * - For GCM mode, this is either the IV (if the length
 402                  * is 96 bits) or J0 (for other sizes), where J0 is as
 403                  * defined by NIST SP800-38D. Regardless of the IV
 404                  * length, a full 16 bytes needs to be allocated.
 405                  *
 406                  * - For CCM mode, the first byte is reserved, and the
 407                  * nonce should be written starting at &iv[1] (to allow
 408                  * space for the implementation to write in the flags
 409                  * in the first byte). Note that a full 16 bytes should
 410                  * be allocated, even though the length field will
 411                  * have a value less than this.
 412                  *
 413                  * For optimum performance, the data pointed to SHOULD
 414                  * be 8-byte aligned.
 415                  */
 416                 uint16_t length;
 417                 /**< Length of valid IV data.
 418                  *
 419                  * - For GCM mode, this is either 12 (for 96-bit IVs)
 420                  * or 16, in which case data points to J0.
 421                  *
 422                  * - For CCM mode, this is the length of the nonce,
 423                  * which can be in the range 7 to 13 inclusive.
 424                  */
 425         } iv;   /**< Initialisation vector parameters */
 426
 427         uint16_t digest_length;
 428
 429         uint16_t aad_length;
 430         /**< The length of the additional authenticated data (AAD) in bytes. */
 431 };
 432
 433 /** Crypto transformation types */
 434 enum rte_crypto_sym_xform_type {
 435         RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED = 0, /**< No xform specified */
 436         RTE_CRYPTO_SYM_XFORM_AUTH,              /**< Authentication xform */
 437         RTE_CRYPTO_SYM_XFORM_CIPHER,            /**< Cipher xform  */
 438         RTE_CRYPTO_SYM_XFORM_AEAD               /**< AEAD xform  */
 439 };
 440
 441 /**
 442  * Symmetric crypto transform structure.
 443  *
 444  * This is used to specify the crypto transforms required, multiple transforms
 445  * can be chained together to specify a chain transforms such as authentication
 446  * then cipher, or cipher then authentication. Each transform structure can
 447  * hold a single transform, the type field is used to specify which transform
 448  * is contained within the union
 449  */
 450 struct rte_crypto_sym_xform {
 451         struct rte_crypto_sym_xform *next;
 452         /**< next xform in chain */
 453         enum rte_crypto_sym_xform_type type
 454         ; /**< xform type */
 455         RTE_STD_C11
 456         union {
 457                 struct rte_crypto_auth_xform auth;
 458                 /**< Authentication / hash xform */
 459                 struct rte_crypto_cipher_xform cipher;
 460                 /**< Cipher xform */
 461                 struct rte_crypto_aead_xform aead;
 462                 /**< AEAD xform */
 463         };
 464 };
 465
 466 struct rte_cryptodev_sym_session;
 467
 468 /**
 469  * Symmetric Cryptographic Operation.
 470  *
 471  * This structure contains data relating to performing symmetric cryptographic
 472  * processing on a referenced mbuf data buffer.
 473  *
 474  * When a symmetric crypto operation is enqueued with the device for processing
 475  * it must have a valid *rte_mbuf* structure attached, via m_src parameter,
 476  * which contains the source data which the crypto operation is to be performed
 477  * on.
 478  * While the mbuf is in use by a crypto operation no part of the mbuf should be
 479  * changed by the application as the device may read or write to any part of the
 480  * mbuf. In the case of hardware crypto devices some or all of the mbuf
 481  * may be DMAed in and out of the device, so writing over the original data,
 482  * though only the part specified by the rte_crypto_sym_op for transformation
 483  * will be changed.
 484  * Out-of-place (OOP) operation, where the source mbuf is different to the
 485  * destination mbuf, is a special case. Data will be copied from m_src to m_dst.
 486  * The part copied includes all the parts of the source mbuf that will be
 487  * operated on, based on the cipher.data.offset+cipher.data.length and
 488  * auth.data.offset+auth.data.length values in the rte_crypto_sym_op. The part
 489  * indicated by the cipher parameters will be transformed, any extra data around
 490  * this indicated by the auth parameters will be copied unchanged from source to
 491  * destination mbuf.
 492  * Also in OOP operation the cipher.data.offset and auth.data.offset apply to
 493  * both source and destination mbufs. As these offsets are relative to the
 494  * data_off parameter in each mbuf this can result in the data written to the
 495  * destination buffer being at a different alignment, relative to buffer start,
 496  * to the data in the source buffer.
 497  */
 498 struct rte_crypto_sym_op {
 499         struct rte_mbuf *m_src; /**< source mbuf */
 500         struct rte_mbuf *m_dst; /**< destination mbuf */
 501
 502         RTE_STD_C11
 503         union {
 504                 struct rte_cryptodev_sym_session *session;
 505                 /**< Handle for the initialised session context */
 506                 struct rte_crypto_sym_xform *xform;
 507                 /**< Session-less API crypto operation parameters */
 508         };
 509
 510         union {
 511                 struct {
 512                         struct {
 513                                 uint32_t offset;
 514                                  /**< Starting point for AEAD processing, specified as
 515                                   * number of bytes from start of packet in source
 516                                   * buffer.
 517                                   */
 518                                 uint32_t length;
 519                                  /**< The message length, in bytes, of the source buffer
 520                                   * on which the cryptographic operation will be
 521                                   * computed. This must be a multiple of the block size
 522                                   */
 523                         } data; /**< Data offsets and length for AEAD */
 524                         struct {
 525                                 uint8_t *data;
 526                                 /**< This points to the location where the digest result
 527                                  * should be inserted (in the case of digest generation)
 528                                  * or where the purported digest exists (in the case of
 529                                  * digest verification).
 530                                  *
 531                                  * At session creation time, the client specified the
 532                                  * digest result length with the digest_length member
 533                                  * of the @ref rte_crypto_auth_xform structure. For
 534                                  * physical crypto devices the caller must allocate at
 535                                  * least digest_length of physically contiguous memory
 536                                  * at this location.
 537                                  *
 538                                  * For digest generation, the digest result will
 539                                  * overwrite any data at this location.
 540                                  *
 541                                  * @note
 542                                  * For GCM (@ref RTE_CRYPTO_AEAD_AES_GCM), for
 543                                  * "digest result" read "authentication tag T".
 544                                  */
 545                                 phys_addr_t phys_addr;
 546                                 /**< Physical address of digest */
 547                         } digest; /**< Digest parameters */
 548                         struct {
 549                                 uint8_t *data;
 550                                 /**< Pointer to Additional Authenticated Data (AAD)
 551                                  * needed for authenticated cipher mechanisms (CCM and
 552                                  * GCM)
 553                                  *
 554                                  * Specifically for CCM (@ref RTE_CRYPTO_AEAD_AES_CCM),
 555                                  * the caller should setup this field as follows:
 556                                  *
 557                                  * - the nonce should be written starting at an offset
 558                                  * of one byte into the array, leaving room for the
 559                                  * implementation to write in the flags to the first
 560                                  * byte.
 561                                  *
 562                                  * - the additional  authentication data itself should
 563                                  * be written starting at an offset of 18 bytes into
 564                                  * the array, leaving room for the length encoding in
 565                                  * the first two bytes of the second block.
 566                                  *
 567                                  * - the array should be big enough to hold the above
 568                                  *  fields, plus any padding to round this up to the
 569                                  *  nearest multiple of the block size (16 bytes).
 570                                  *  Padding will be added by the implementation.
 571                                  *
 572                                  * Finally, for GCM (@ref RTE_CRYPTO_AEAD_AES_GCM), the
 573                                  * caller should setup this field as follows:
 574                                  *
 575                                  * - the AAD is written in starting at byte 0
 576                                  * - the array must be big enough to hold the AAD, plus
 577                                  * any space to round this up to the nearest multiple
 578                                  * of the block size (16 bytes).
 579                                  *
 580                                  */
 581                                 phys_addr_t phys_addr;  /**< physical address */
 582                         } aad;
 583                         /**< Additional authentication parameters */
 584                 } aead;
 585
 586                 struct {
 587                         struct {
 588                                 struct {
 589                                         uint32_t offset;
 590                                          /**< Starting point for cipher processing,
 591                                           * specified as number of bytes from start
 592                                           * of data in the source buffer.
 593                                           * The result of the cipher operation will be
 594                                           * written back into the output buffer
 595                                           * starting at this location.
 596                                           *
 597                                           * @note
 598                                           * For SNOW 3G @ RTE_CRYPTO_CIPHER_SNOW3G_UEA2,
 599                                           * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
 600                                           * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
 601                                           * this field should be in bits.
 602                                           */
 603                                         uint32_t length;
 604                                          /**< The message length, in bytes, of the
 605                                           * source buffer on which the cryptographic
 606                                           * operation will be computed.
 607                                           * This must be a multiple of the block size
 608                                           * if a block cipher is being used. This is
 609                                           * also the same as the result length.
 610                                           *
 611                                           * @note
 612                                           * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UEA2,
 613                                           * KASUMI @ RTE_CRYPTO_CIPHER_KASUMI_F8
 614                                           * and ZUC @ RTE_CRYPTO_CIPHER_ZUC_EEA3,
 615                                           * this field should be in bits.
 616                                           */
 617                                 } data; /**< Data offsets and length for ciphering */
 618                         } cipher;
 619
 620                         struct {
 621                                 struct {
 622                                         uint32_t offset;
 623                                          /**< Starting point for hash processing,
 624                                           * specified as number of bytes from start of
 625                                           * packet in source buffer.
 626                                           *
 627                                           * @note
 628                                           * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
 629                                           * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
 630                                           * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
 631                                           * this field should be in bits.
 632                                           *
 633                                           * @note
 634                                           * For KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9,
 635                                           * this offset should be such that
 636                                           * data to authenticate starts at COUNT.
 637                                           */
 638                                         uint32_t length;
 639                                          /**< The message length, in bytes, of the source
 640                                           * buffer that the hash will be computed on.
 641                                           *
 642                                           * @note
 643                                           * For SNOW 3G @ RTE_CRYPTO_AUTH_SNOW3G_UIA2,
 644                                           * KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9
 645                                           * and ZUC @ RTE_CRYPTO_AUTH_ZUC_EIA3,
 646                                           * this field should be in bits.
 647                                           *
 648                                           * @note
 649                                           * For KASUMI @ RTE_CRYPTO_AUTH_KASUMI_F9,
 650                                           * the length should include the COUNT,
 651                                           * FRESH, message, direction bit and padding
 652                                           * (to be multiple of 8 bits).
 653                                           */
 654                                 } data;
 655                                 /**< Data offsets and length for authentication */
 656
 657                                 struct {
 658                                         uint8_t *data;
 659                                         /**< This points to the location where
 660                                          * the digest result should be inserted
 661                                          * (in the case of digest generation)
 662                                          * or where the purported digest exists
 663                                          * (in the case of digest verification).
 664                                          *
 665                                          * At session creation time, the client
 666                                          * specified the digest result length with
 667                                          * the digest_length member of the
 668                                          * @ref rte_crypto_auth_xform structure.
 669                                          * For physical crypto devices the caller
 670                                          * must allocate at least digest_length of
 671                                          * physically contiguous memory at this
 672                                          * location.
 673                                          *
 674                                          * For digest generation, the digest result
 675                                          * will overwrite any data at this location.
 676                                          *
 677                                          */
 678                                         phys_addr_t phys_addr;
 679                                         /**< Physical address of digest */
 680                                 } digest; /**< Digest parameters */
 681                         } auth;
 682                 };
 683         };
 684 };
 685
 686
 687 /**
 688  * Reset the fields of a symmetric operation to their default values.
 689  *
 690  * @param       op      The crypto operation to be reset.
 691  */
 692 static inline void
 693 __rte_crypto_sym_op_reset(struct rte_crypto_sym_op *op)
 694 {
 695         memset(op, 0, sizeof(*op));
 696 }
 697
 698
 699 /**
 700  * Allocate space for symmetric crypto xforms in the private data space of the
 701  * crypto operation. This also defaults the crypto xform type to
 702  * RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED and configures the chaining of the xforms
 703  * in the crypto operation
 704  *
 705  * @return
 706  * - On success returns pointer to first crypto xform in crypto operations chain
 707  * - On failure returns NULL
 708  */
 709 static inline struct rte_crypto_sym_xform *
 710 __rte_crypto_sym_op_sym_xforms_alloc(struct rte_crypto_sym_op *sym_op,
 711                 void *priv_data, uint8_t nb_xforms)
 712 {
 713         struct rte_crypto_sym_xform *xform;
 714
 715         sym_op->xform = xform = (struct rte_crypto_sym_xform *)priv_data;
 716
 717         do {
 718                 xform->type = RTE_CRYPTO_SYM_XFORM_NOT_SPECIFIED;
 719                 xform = xform->next = --nb_xforms > 0 ? xform + 1 : NULL;
 720         } while (xform);
 721
 722         return sym_op->xform;
 723 }
 724
 725
 726 /**
 727  * Attach a session to a symmetric crypto operation
 728  *
 729  * @param       sym_op  crypto operation
 730  * @param       sess    cryptodev session
 731  */
 732 static inline int
 733 __rte_crypto_sym_op_attach_sym_session(struct rte_crypto_sym_op *sym_op,
 734                 struct rte_cryptodev_sym_session *sess)
 735 {
 736         sym_op->session = sess;
 737
 738         return 0;
 739 }
 740
 741
 742 #ifdef __cplusplus
 743 }
 744 #endif
 745
 746 #endif /* _RTE_CRYPTO_SYM_H_ */