1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2016-2017 Intel Corporation.
4 Cryptography Device Library
5 ===========================
7 The cryptodev library provides a Crypto device framework for management and
8 provisioning of hardware and software Crypto poll mode drivers, defining generic
9 APIs which support a number of different Crypto operations. The framework
10 currently only supports cipher, authentication, chained cipher/authentication
11 and AEAD symmetric and asymmetric Crypto operations.
17 The cryptodev library follows the same basic principles as those used in DPDKs
18 Ethernet Device framework. The Crypto framework provides a generic Crypto device
19 framework which supports both physical (hardware) and virtual (software) Crypto
20 devices as well as a generic Crypto API which allows Crypto devices to be
21 managed and configured and supports Crypto operations to be provisioned on
22 Crypto poll mode driver.
31 Physical Crypto devices are discovered during the PCI probe/enumeration of the
32 EAL function which is executed at DPDK initialization, based on
33 their PCI device identifier, each unique PCI BDF (bus/bridge, device,
34 function). Specific physical Crypto devices, like other physical devices in DPDK
35 can be white-listed or black-listed using the EAL command line options.
37 Virtual devices can be created by two mechanisms, either using the EAL command
38 line options or from within the application using an EAL API directly.
40 From the command line using the --vdev EAL option
42 .. code-block:: console
44 --vdev 'crypto_aesni_mb0,max_nb_queue_pairs=2,socket_id=0'
48 * If DPDK application requires multiple software crypto PMD devices then required
49 number of ``--vdev`` with appropriate libraries are to be added.
51 * An Application with crypto PMD instaces sharing the same library requires unique ID.
53 Example: ``--vdev 'crypto_aesni_mb0' --vdev 'crypto_aesni_mb1'``
55 Our using the rte_vdev_init API within the application code.
59 rte_vdev_init("crypto_aesni_mb",
60 "max_nb_queue_pairs=2,socket_id=0")
62 All virtual Crypto devices support the following initialization parameters:
64 * ``max_nb_queue_pairs`` - maximum number of queue pairs supported by the device.
65 * ``socket_id`` - socket on which to allocate the device resources on.
71 Each device, whether virtual or physical is uniquely designated by two
74 - A unique device index used to designate the Crypto device in all functions
75 exported by the cryptodev API.
77 - A device name used to designate the Crypto device in console messages, for
78 administration or debugging purposes. For ease of use, the port name includes
85 The configuration of each Crypto device includes the following operations:
87 - Allocation of resources, including hardware resources if a physical device.
88 - Resetting the device into a well-known default state.
89 - Initialization of statistics counters.
91 The rte_cryptodev_configure API is used to configure a Crypto device.
95 int rte_cryptodev_configure(uint8_t dev_id,
96 struct rte_cryptodev_config *config)
98 The ``rte_cryptodev_config`` structure is used to pass the configuration
99 parameters for socket selection and number of queue pairs.
103 struct rte_cryptodev_config {
105 /**< Socket to allocate resources on */
106 uint16_t nb_queue_pairs;
107 /**< Number of queue pairs to configure on device */
111 Configuration of Queue Pairs
112 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
114 Each Crypto devices queue pair is individually configured through the
115 ``rte_cryptodev_queue_pair_setup`` API.
116 Each queue pairs resources may be allocated on a specified socket.
120 int rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
121 const struct rte_cryptodev_qp_conf *qp_conf,
124 struct rte_cryptodev_qp_conf {
125 uint32_t nb_descriptors; /**< Number of descriptors per queue pair */
126 struct rte_mempool *mp_session;
127 /**< The mempool for creating session in sessionless mode */
128 struct rte_mempool *mp_session_private;
129 /**< The mempool for creating sess private data in sessionless mode */
133 The fields ``mp_session`` and ``mp_session_private`` are used for creating
134 temporary session to process the crypto operations in the session-less mode.
135 They can be the same other different mempools. Please note not all Cryptodev
136 PMDs supports session-less mode.
139 Logical Cores, Memory and Queues Pair Relationships
140 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
142 The Crypto device Library as the Poll Mode Driver library support NUMA for when
143 a processor’s logical cores and interfaces utilize its local memory. Therefore
144 Crypto operations, and in the case of symmetric Crypto operations, the session
145 and the mbuf being operated on, should be allocated from memory pools created
146 in the local memory. The buffers should, if possible, remain on the local
147 processor to obtain the best performance results and buffer descriptors should
148 be populated with mbufs allocated from a mempool allocated from local memory.
150 The run-to-completion model also performs better, especially in the case of
151 virtual Crypto devices, if the Crypto operation and session and data buffer is
152 in local memory instead of a remote processor's memory. This is also true for
153 the pipe-line model provided all logical cores used are located on the same
156 Multiple logical cores should never share the same queue pair for enqueuing
157 operations or dequeuing operations on the same Crypto device since this would
158 require global locks and hinder performance. It is however possible to use a
159 different logical core to dequeue an operation on a queue pair from the logical
160 core which it was enqueued on. This means that a crypto burst enqueue/dequeue
161 APIs are a logical place to transition from one logical core to another in a
162 packet processing pipeline.
165 Device Features and Capabilities
166 ---------------------------------
168 Crypto devices define their functionality through two mechanisms, global device
169 features and algorithm capabilities. Global devices features identify device
170 wide level features which are applicable to the whole device such as
171 the device having hardware acceleration or supporting symmetric and/or asymmetric
174 The capabilities mechanism defines the individual algorithms/functions which
175 the device supports, such as a specific symmetric Crypto cipher,
176 authentication operation or Authenticated Encryption with Associated Data
183 Currently the following Crypto device features are defined:
185 * Symmetric Crypto operations
186 * Asymmetric Crypto operations
187 * Chaining of symmetric Crypto operations
188 * SSE accelerated SIMD vector operations
189 * AVX accelerated SIMD vector operations
190 * AVX2 accelerated SIMD vector operations
191 * AESNI accelerated instructions
192 * Hardware off-load processing
195 Device Operation Capabilities
196 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198 Crypto capabilities which identify particular algorithm which the Crypto PMD
199 supports are defined by the operation type, the operation transform, the
200 transform identifier and then the particulars of the transform. For the full
201 scope of the Crypto capability see the definition of the structure in the
202 *DPDK API Reference*.
206 struct rte_cryptodev_capabilities;
208 Each Crypto poll mode driver defines its own private array of capabilities
209 for the operations it supports. Below is an example of the capabilities for a
210 PMD which supports the authentication algorithm SHA1_HMAC and the cipher
215 static const struct rte_cryptodev_capabilities pmd_capabilities[] = {
217 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
219 .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
221 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
239 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
241 .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
243 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
261 Capabilities Discovery
262 ~~~~~~~~~~~~~~~~~~~~~~
264 Discovering the features and capabilities of a Crypto device poll mode driver
265 is achieved through the ``rte_cryptodev_info_get`` function.
269 void rte_cryptodev_info_get(uint8_t dev_id,
270 struct rte_cryptodev_info *dev_info);
272 This allows the user to query a specific Crypto PMD and get all the device
273 features and capabilities. The ``rte_cryptodev_info`` structure contains all the
274 relevant information for the device.
278 struct rte_cryptodev_info {
279 const char *driver_name;
281 struct rte_device *device;
283 uint64_t feature_flags;
285 const struct rte_cryptodev_capabilities *capabilities;
287 unsigned max_nb_queue_pairs;
290 unsigned max_nb_sessions;
298 Scheduling of Crypto operations on DPDK's application data path is
299 performed using a burst oriented asynchronous API set. A queue pair on a Crypto
300 device accepts a burst of Crypto operations using enqueue burst API. On physical
301 Crypto devices the enqueue burst API will place the operations to be processed
302 on the devices hardware input queue, for virtual devices the processing of the
303 Crypto operations is usually completed during the enqueue call to the Crypto
304 device. The dequeue burst API will retrieve any processed operations available
305 from the queue pair on the Crypto device, from physical devices this is usually
306 directly from the devices processed queue, and for virtual device's from a
307 ``rte_ring`` where processed operations are place after being processed on the
313 For session-based operations, the set and get API provides a mechanism for an
314 application to store and retrieve the private user data information stored along
315 with the crypto session.
317 For example, suppose an application is submitting a crypto operation with a session
318 associated and wants to indicate private user data information which is required to be
319 used after completion of the crypto operation. In this case, the application can use
320 the set API to set the user data and retrieve it using get API.
324 int rte_cryptodev_sym_session_set_user_data(
325 struct rte_cryptodev_sym_session *sess, void *data, uint16_t size);
327 void * rte_cryptodev_sym_session_get_user_data(
328 struct rte_cryptodev_sym_session *sess);
331 For session-less mode, the private user data information can be placed along with the
332 ``struct rte_crypto_op``. The ``rte_crypto_op::private_data_offset`` indicates the
333 start of private data information. The offset is counted from the start of the
334 rte_crypto_op including other crypto information such as the IVs (since there can
335 be an IV also for authentication).
338 Enqueue / Dequeue Burst APIs
339 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
341 The burst enqueue API uses a Crypto device identifier and a queue pair
342 identifier to specify the Crypto device queue pair to schedule the processing on.
343 The ``nb_ops`` parameter is the number of operations to process which are
344 supplied in the ``ops`` array of ``rte_crypto_op`` structures.
345 The enqueue function returns the number of operations it actually enqueued for
346 processing, a return value equal to ``nb_ops`` means that all packets have been
351 uint16_t rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
352 struct rte_crypto_op **ops, uint16_t nb_ops)
354 The dequeue API uses the same format as the enqueue API of processed but
355 the ``nb_ops`` and ``ops`` parameters are now used to specify the max processed
356 operations the user wishes to retrieve and the location in which to store them.
357 The API call returns the actual number of processed operations returned, this
358 can never be larger than ``nb_ops``.
362 uint16_t rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
363 struct rte_crypto_op **ops, uint16_t nb_ops)
366 Operation Representation
367 ~~~~~~~~~~~~~~~~~~~~~~~~
369 An Crypto operation is represented by an rte_crypto_op structure, which is a
370 generic metadata container for all necessary information required for the
371 Crypto operation to be processed on a particular Crypto device poll mode driver.
373 .. figure:: img/crypto_op.*
375 The operation structure includes the operation type, the operation status
376 and the session type (session-based/less), a reference to the operation
377 specific data, which can vary in size and content depending on the operation
378 being provisioned. It also contains the source mempool for the operation,
379 if it allocated from a mempool.
381 If Crypto operations are allocated from a Crypto operation mempool, see next
382 section, there is also the ability to allocate private memory with the
383 operation for applications purposes.
385 Application software is responsible for specifying all the operation specific
386 fields in the ``rte_crypto_op`` structure which are then used by the Crypto PMD
387 to process the requested operation.
390 Operation Management and Allocation
391 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
393 The cryptodev library provides an API set for managing Crypto operations which
394 utilize the Mempool Library to allocate operation buffers. Therefore, it ensures
395 that the crytpo operation is interleaved optimally across the channels and
396 ranks for optimal processing.
397 A ``rte_crypto_op`` contains a field indicating the pool that it originated from.
398 When calling ``rte_crypto_op_free(op)``, the operation returns to its original pool.
402 extern struct rte_mempool *
403 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
404 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
407 During pool creation ``rte_crypto_op_init()`` is called as a constructor to
408 initialize each Crypto operation which subsequently calls
409 ``__rte_crypto_op_reset()`` to configure any operation type specific fields based
410 on the type parameter.
413 ``rte_crypto_op_alloc()`` and ``rte_crypto_op_bulk_alloc()`` are used to allocate
414 Crypto operations of a specific type from a given Crypto operation mempool.
415 ``__rte_crypto_op_reset()`` is called on each operation before being returned to
416 allocate to a user so the operation is always in a good known state before use
421 struct rte_crypto_op *rte_crypto_op_alloc(struct rte_mempool *mempool,
422 enum rte_crypto_op_type type)
424 unsigned rte_crypto_op_bulk_alloc(struct rte_mempool *mempool,
425 enum rte_crypto_op_type type,
426 struct rte_crypto_op **ops, uint16_t nb_ops)
428 ``rte_crypto_op_free()`` is called by the application to return an operation to
433 void rte_crypto_op_free(struct rte_crypto_op *op)
436 Symmetric Cryptography Support
437 ------------------------------
439 The cryptodev library currently provides support for the following symmetric
440 Crypto operations; cipher, authentication, including chaining of these
441 operations, as well as also supporting AEAD operations.
444 Session and Session Management
445 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
447 Sessions are used in symmetric cryptographic processing to store the immutable
448 data defined in a cryptographic transform which is used in the operation
449 processing of a packet flow. Sessions are used to manage information such as
450 expand cipher keys and HMAC IPADs and OPADs, which need to be calculated for a
451 particular Crypto operation, but are immutable on a packet to packet basis for
452 a flow. Crypto sessions cache this immutable data in a optimal way for the
453 underlying PMD and this allows further acceleration of the offload of
456 .. figure:: img/cryptodev_sym_sess.*
458 The Crypto device framework provides APIs to create session mempool and allocate
459 and initialize sessions for crypto devices, where sessions are mempool objects.
460 The application has to use ``rte_cryptodev_sym_session_pool_create()`` to
461 create the session header mempool that creates a mempool with proper element
462 size automatically and stores necessary information for safely accessing the
463 session in the mempool's private data field.
465 To create a mempool for storing session private data, the application has two
466 options. The first is to create another mempool with elt size equal to or
467 bigger than the maximum session private data size of all crypto devices that
468 will share the same session header. The creation of the mempool shall use the
469 traditional ``rte_mempool_create()`` with the correct ``elt_size``. The other
470 option is to change the ``elt_size`` parameter in
471 ``rte_cryptodev_sym_session_pool_create()`` to the correct value. The first
472 option is more complex to implement but may result in better memory usage as
473 a session header normally takes smaller memory footprint as the session private
476 Once the session mempools have been created, ``rte_cryptodev_sym_session_create()``
477 is used to allocate an uninitialized session from the given mempool.
478 The session then must be initialized using ``rte_cryptodev_sym_session_init()``
479 for each of the required crypto devices. A symmetric transform chain
480 is used to specify the operation and its parameters. See the section below for
481 details on transforms.
483 When a session is no longer used, user must call ``rte_cryptodev_sym_session_clear()``
484 for each of the crypto devices that are using the session, to free all driver
485 private session data. Once this is done, session should be freed using
486 ``rte_cryptodev_sym_session_free`` which returns them to their mempool.
489 Transforms and Transform Chaining
490 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
492 Symmetric Crypto transforms (``rte_crypto_sym_xform``) are the mechanism used
493 to specify the details of the Crypto operation. For chaining of symmetric
494 operations such as cipher encrypt and authentication generate, the next pointer
495 allows transform to be chained together. Crypto devices which support chaining
496 must publish the chaining of symmetric Crypto operations feature flag.
498 Currently there are three transforms types cipher, authentication and AEAD.
499 Also it is important to note that the order in which the
500 transforms are passed indicates the order of the chaining.
504 struct rte_crypto_sym_xform {
505 struct rte_crypto_sym_xform *next;
506 /**< next xform in chain */
507 enum rte_crypto_sym_xform_type type;
510 struct rte_crypto_auth_xform auth;
511 /**< Authentication / hash xform */
512 struct rte_crypto_cipher_xform cipher;
514 struct rte_crypto_aead_xform aead;
519 The API does not place a limit on the number of transforms that can be chained
520 together but this will be limited by the underlying Crypto device poll mode
521 driver which is processing the operation.
523 .. figure:: img/crypto_xform_chain.*
529 The symmetric Crypto operation structure contains all the mutable data relating
530 to performing symmetric cryptographic processing on a referenced mbuf data
531 buffer. It is used for either cipher, authentication, AEAD and chained
534 As a minimum the symmetric operation must have a source data buffer (``m_src``),
535 a valid session (or transform chain if in session-less mode) and the minimum
536 authentication/ cipher/ AEAD parameters required depending on the type of operation
537 specified in the session or the transform
542 struct rte_crypto_sym_op {
543 struct rte_mbuf *m_src;
544 struct rte_mbuf *m_dst;
547 struct rte_cryptodev_sym_session *session;
548 /**< Handle for the initialised session context */
549 struct rte_crypto_sym_xform *xform;
550 /**< Session-less API Crypto operation parameters */
558 } data; /**< Data offsets and length for AEAD */
562 rte_iova_t phys_addr;
563 } digest; /**< Digest parameters */
567 rte_iova_t phys_addr;
569 /**< Additional authentication parameters */
577 } data; /**< Data offsets and length for ciphering */
585 /**< Data offsets and length for authentication */
589 rte_iova_t phys_addr;
590 } digest; /**< Digest parameters */
599 There are various sample applications that show how to use the cryptodev library,
600 such as the L2fwd with Crypto sample application (L2fwd-crypto) and
601 the IPSec Security Gateway application (ipsec-secgw).
603 While these applications demonstrate how an application can be created to perform
604 generic crypto operation, the required complexity hides the basic steps of
605 how to use the cryptodev APIs.
607 The following sample code shows the basic steps to encrypt several buffers
608 with AES-CBC (although performing other crypto operations is similar),
609 using one of the crypto PMDs available in DPDK.
614 * Simple example to encrypt several buffers with AES-CBC using
615 * the Cryptodev APIs.
618 #define MAX_SESSIONS 1024
619 #define NUM_MBUFS 1024
620 #define POOL_CACHE_SIZE 128
621 #define BURST_SIZE 32
622 #define BUFFER_SIZE 1024
623 #define AES_CBC_IV_LENGTH 16
624 #define AES_CBC_KEY_LENGTH 16
625 #define IV_OFFSET (sizeof(struct rte_crypto_op) + \
626 sizeof(struct rte_crypto_sym_op))
628 struct rte_mempool *mbuf_pool, *crypto_op_pool;
629 struct rte_mempool *session_pool, *session_priv_pool;
630 unsigned int session_size;
633 /* Initialize EAL. */
634 ret = rte_eal_init(argc, argv);
636 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
638 uint8_t socket_id = rte_socket_id();
640 /* Create the mbuf pool. */
641 mbuf_pool = rte_pktmbuf_pool_create("mbuf_pool",
645 RTE_MBUF_DEFAULT_BUF_SIZE,
647 if (mbuf_pool == NULL)
648 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
651 * The IV is always placed after the crypto operation,
652 * so some private data is required to be reserved.
654 unsigned int crypto_op_private_data = AES_CBC_IV_LENGTH;
656 /* Create crypto operation pool. */
657 crypto_op_pool = rte_crypto_op_pool_create("crypto_op_pool",
658 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
661 crypto_op_private_data,
663 if (crypto_op_pool == NULL)
664 rte_exit(EXIT_FAILURE, "Cannot create crypto op pool\n");
666 /* Create the virtual crypto device. */
668 const char *crypto_name = "crypto_aesni_mb0";
669 snprintf(args, sizeof(args), "socket_id=%d", socket_id);
670 ret = rte_vdev_init(crypto_name, args);
672 rte_exit(EXIT_FAILURE, "Cannot create virtual device");
674 uint8_t cdev_id = rte_cryptodev_get_dev_id(crypto_name);
676 /* Get private session data size. */
677 session_size = rte_cryptodev_sym_get_private_session_size(cdev_id);
679 #ifdef USE_TWO_MEMPOOLS
680 /* Create session mempool for the session header. */
681 session_pool = rte_cryptodev_sym_session_pool_create("session_pool",
689 * Create session private data mempool for the
690 * private session data for the crypto device.
692 session_priv_pool = rte_mempool_create("session_pool",
701 /* Use of the same mempool for session header and private data */
702 session_pool = rte_cryptodev_sym_session_pool_create("session_pool",
709 session_priv_pool = session_pool;
713 /* Configure the crypto device. */
714 struct rte_cryptodev_config conf = {
716 .socket_id = socket_id
719 struct rte_cryptodev_qp_conf qp_conf = {
720 .nb_descriptors = 2048,
721 .mp_session = session_pool,
722 .mp_session_private = session_priv_pool
725 if (rte_cryptodev_configure(cdev_id, &conf) < 0)
726 rte_exit(EXIT_FAILURE, "Failed to configure cryptodev %u", cdev_id);
728 if (rte_cryptodev_queue_pair_setup(cdev_id, 0, &qp_conf, socket_id) < 0)
729 rte_exit(EXIT_FAILURE, "Failed to setup queue pair\n");
731 if (rte_cryptodev_start(cdev_id) < 0)
732 rte_exit(EXIT_FAILURE, "Failed to start device\n");
734 /* Create the crypto transform. */
735 uint8_t cipher_key[16] = {0};
736 struct rte_crypto_sym_xform cipher_xform = {
738 .type = RTE_CRYPTO_SYM_XFORM_CIPHER,
740 .op = RTE_CRYPTO_CIPHER_OP_ENCRYPT,
741 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
744 .length = AES_CBC_KEY_LENGTH
748 .length = AES_CBC_IV_LENGTH
753 /* Create crypto session and initialize it for the crypto device. */
754 struct rte_cryptodev_sym_session *session;
755 session = rte_cryptodev_sym_session_create(session_pool);
757 rte_exit(EXIT_FAILURE, "Session could not be created\n");
759 if (rte_cryptodev_sym_session_init(cdev_id, session,
760 &cipher_xform, session_priv_pool) < 0)
761 rte_exit(EXIT_FAILURE, "Session could not be initialized "
762 "for the crypto device\n");
764 /* Get a burst of crypto operations. */
765 struct rte_crypto_op *crypto_ops[BURST_SIZE];
766 if (rte_crypto_op_bulk_alloc(crypto_op_pool,
767 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
768 crypto_ops, BURST_SIZE) == 0)
769 rte_exit(EXIT_FAILURE, "Not enough crypto operations available\n");
771 /* Get a burst of mbufs. */
772 struct rte_mbuf *mbufs[BURST_SIZE];
773 if (rte_pktmbuf_alloc_bulk(mbuf_pool, mbufs, BURST_SIZE) < 0)
774 rte_exit(EXIT_FAILURE, "Not enough mbufs available");
776 /* Initialize the mbufs and append them to the crypto operations. */
778 for (i = 0; i < BURST_SIZE; i++) {
779 if (rte_pktmbuf_append(mbufs[i], BUFFER_SIZE) == NULL)
780 rte_exit(EXIT_FAILURE, "Not enough room in the mbuf\n");
781 crypto_ops[i]->sym->m_src = mbufs[i];
784 /* Set up the crypto operations. */
785 for (i = 0; i < BURST_SIZE; i++) {
786 struct rte_crypto_op *op = crypto_ops[i];
787 /* Modify bytes of the IV at the end of the crypto operation */
788 uint8_t *iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
791 generate_random_bytes(iv_ptr, AES_CBC_IV_LENGTH);
793 op->sym->cipher.data.offset = 0;
794 op->sym->cipher.data.length = BUFFER_SIZE;
796 /* Attach the crypto session to the operation */
797 rte_crypto_op_attach_sym_session(op, session);
800 /* Enqueue the crypto operations in the crypto device. */
801 uint16_t num_enqueued_ops = rte_cryptodev_enqueue_burst(cdev_id, 0,
802 crypto_ops, BURST_SIZE);
805 * Dequeue the crypto operations until all the operations
806 * are proccessed in the crypto device.
808 uint16_t num_dequeued_ops, total_num_dequeued_ops = 0;
810 struct rte_crypto_op *dequeued_ops[BURST_SIZE];
811 num_dequeued_ops = rte_cryptodev_dequeue_burst(cdev_id, 0,
812 dequeued_ops, BURST_SIZE);
813 total_num_dequeued_ops += num_dequeued_ops;
815 /* Check if operation was processed successfully */
816 for (i = 0; i < num_dequeued_ops; i++) {
817 if (dequeued_ops[i]->status != RTE_CRYPTO_OP_STATUS_SUCCESS)
818 rte_exit(EXIT_FAILURE,
819 "Some operations were not processed correctly");
822 rte_mempool_put_bulk(crypto_op_pool, (void **)dequeued_ops,
824 } while (total_num_dequeued_ops < num_enqueued_ops);
826 Asymmetric Cryptography
827 -----------------------
829 The cryptodev library currently provides support for the following asymmetric
830 Crypto operations; RSA, Modular exponentiation and inversion, Diffie-Hellman
831 public and/or private key generation and shared secret compute, DSA Signature
832 generation and verification.
834 Session and Session Management
835 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
837 Sessions are used in asymmetric cryptographic processing to store the immutable
838 data defined in asymmetric cryptographic transform which is further used in the
839 operation processing. Sessions typically stores information, such as, public
840 and private key information or domain params or prime modulus data i.e. immutable
841 across data sets. Crypto sessions cache this immutable data in a optimal way for the
842 underlying PMD and this allows further acceleration of the offload of Crypto workloads.
844 Like symmetric, the Crypto device framework provides APIs to allocate and initialize
845 asymmetric sessions for crypto devices, where sessions are mempool objects.
846 It is the application's responsibility to create and manage the session mempools.
847 Application using both symmetric and asymmetric sessions should allocate and maintain
848 different sessions pools for each type.
850 An application can use ``rte_cryptodev_get_asym_session_private_size()`` to
851 get the private size of asymmetric session on a given crypto device. This
852 function would allow an application to calculate the max device asymmetric
853 session size of all crypto devices to create a single session mempool.
854 If instead an application creates multiple asymmetric session mempools,
855 the Crypto device framework also provides ``rte_cryptodev_asym_get_header_session_size()`` to get
856 the size of an uninitialized session.
858 Once the session mempools have been created, ``rte_cryptodev_asym_session_create()``
859 is used to allocate an uninitialized asymmetric session from the given mempool.
860 The session then must be initialized using ``rte_cryptodev_asym_session_init()``
861 for each of the required crypto devices. An asymmetric transform chain
862 is used to specify the operation and its parameters. See the section below for
863 details on transforms.
865 When a session is no longer used, user must call ``rte_cryptodev_asym_session_clear()``
866 for each of the crypto devices that are using the session, to free all driver
867 private asymmetric session data. Once this is done, session should be freed using
868 ``rte_cryptodev_asym_session_free()`` which returns them to their mempool.
870 Asymmetric Sessionless Support
871 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
872 Currently asymmetric crypto framework does not support sessionless.
874 Transforms and Transform Chaining
875 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
877 Asymmetric Crypto transforms (``rte_crypto_asym_xform``) are the mechanism used
878 to specify the details of the asymmetric Crypto operation. Next pointer within
879 xform allows transform to be chained together. Also it is important to note that
880 the order in which the transforms are passed indicates the order of the chaining.
882 Not all asymmetric crypto xforms are supported for chaining. Currently supported
883 asymmetric crypto chaining is Diffie-Hellman private key generation followed by
884 public generation. Also, currently API does not support chaining of symmetric and
885 asymmetric crypto xfroms.
887 Each xform defines specific asymmetric crypto algo. Currently supported are:
889 * Modular operations (Exponentiation and Inverse)
892 * None - special case where PMD may support a passthrough mode. More for diagnostic purpose
894 See *DPDK API Reference* for details on each rte_crypto_xxx_xform struct
896 Asymmetric Operations
897 ~~~~~~~~~~~~~~~~~~~~~
899 The asymmetric Crypto operation structure contains all the mutable data relating
900 to asymmetric cryptographic processing on an input data buffer. It uses either
901 RSA, Modular, Diffie-Hellman or DSA operations depending upon session it is attached
904 Every operation must carry a valid session handle which further carries information
905 on xform or xform-chain to be performed on op. Every xform type defines its own set
906 of operational params in their respective rte_crypto_xxx_op_param struct. Depending
907 on xform information within session, PMD picks up and process respective op_param
909 Unlike symmetric, asymmetric operations do not use mbufs for input/output.
910 They operate on data buffer of type ``rte_crypto_param``.
912 See *DPDK API Reference* for details on each rte_crypto_xxx_op_param struct
914 Asymmetric crypto Sample code
915 -----------------------------
917 There's a unit test application test_cryptodev_asym.c inside unit test framework that
918 show how to setup and process asymmetric operations using cryptodev library.
920 The following sample code shows the basic steps to compute modular exponentiation
921 using 1024-bit modulus length using openssl PMD available in DPDK (performing other
922 crypto operations is similar except change to respective op and xform setup).
927 * Simple example to compute modular exponentiation with 1024-bit key
930 #define MAX_ASYM_SESSIONS 10
931 #define NUM_ASYM_BUFS 10
933 struct rte_mempool *crypto_op_pool, *asym_session_pool;
934 unsigned int asym_session_size;
937 /* Initialize EAL. */
938 ret = rte_eal_init(argc, argv);
940 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
942 uint8_t socket_id = rte_socket_id();
944 /* Create crypto operation pool. */
945 crypto_op_pool = rte_crypto_op_pool_create(
947 RTE_CRYPTO_OP_TYPE_ASYMMETRIC,
950 if (crypto_op_pool == NULL)
951 rte_exit(EXIT_FAILURE, "Cannot create crypto op pool\n");
953 /* Create the virtual crypto device. */
955 const char *crypto_name = "crypto_openssl";
956 snprintf(args, sizeof(args), "socket_id=%d", socket_id);
957 ret = rte_vdev_init(crypto_name, args);
959 rte_exit(EXIT_FAILURE, "Cannot create virtual device");
961 uint8_t cdev_id = rte_cryptodev_get_dev_id(crypto_name);
963 /* Get private asym session data size. */
964 asym_session_size = rte_cryptodev_get_asym_private_session_size(cdev_id);
967 * Create session mempool, with two objects per session,
968 * one for the session header and another one for the
969 * private asym session data for the crypto device.
971 asym_session_pool = rte_mempool_create("asym_session_pool",
972 MAX_ASYM_SESSIONS * 2,
979 /* Configure the crypto device. */
980 struct rte_cryptodev_config conf = {
982 .socket_id = socket_id
984 struct rte_cryptodev_qp_conf qp_conf = {
985 .nb_descriptors = 2048
988 if (rte_cryptodev_configure(cdev_id, &conf) < 0)
989 rte_exit(EXIT_FAILURE, "Failed to configure cryptodev %u", cdev_id);
991 if (rte_cryptodev_queue_pair_setup(cdev_id, 0, &qp_conf,
992 socket_id, asym_session_pool) < 0)
993 rte_exit(EXIT_FAILURE, "Failed to setup queue pair\n");
995 if (rte_cryptodev_start(cdev_id) < 0)
996 rte_exit(EXIT_FAILURE, "Failed to start device\n");
998 /* Setup crypto xform to do modular exponentiation with 1024 bit
1001 struct rte_crypto_asym_xform modex_xform = {
1003 .xform_type = RTE_CRYPTO_ASYM_XFORM_MODEX,
1008 ("\xb3\xa1\xaf\xb7\x13\x08\x00\x0a\x35\xdc\x2b\x20\x8d"
1009 "\xa1\xb5\xce\x47\x8a\xc3\x80\xf4\x7d\x4a\xa2\x62\xfd\x61\x7f"
1010 "\xb5\xa8\xde\x0a\x17\x97\xa0\xbf\xdf\x56\x5a\x3d\x51\x56\x4f"
1011 "\x70\x70\x3f\x63\x6a\x44\x5b\xad\x84\x0d\x3f\x27\x6e\x3b\x34"
1012 "\x91\x60\x14\xb9\xaa\x72\xfd\xa3\x64\xd2\x03\xa7\x53\x87\x9e"
1013 "\x88\x0b\xc1\x14\x93\x1a\x62\xff\xb1\x5d\x74\xcd\x59\x63\x18"
1014 "\x11\x3d\x4f\xba\x75\xd4\x33\x4e\x23\x6b\x7b\x57\x44\xe1\xd3"
1015 "\x03\x13\xa6\xf0\x8b\x60\xb0\x9e\xee\x75\x08\x9d\x71\x63\x13"
1016 "\xcb\xa6\x81\x92\x14\x03\x22\x2d\xde\x55"),
1020 .data = (uint8_t *)("\x01\x00\x01"),
1025 /* Create asym crypto session and initialize it for the crypto device. */
1026 struct rte_cryptodev_asym_session *asym_session;
1027 asym_session = rte_cryptodev_asym_session_create(asym_session_pool);
1028 if (asym_session == NULL)
1029 rte_exit(EXIT_FAILURE, "Session could not be created\n");
1031 if (rte_cryptodev_asym_session_init(cdev_id, asym_session,
1032 &modex_xform, asym_session_pool) < 0)
1033 rte_exit(EXIT_FAILURE, "Session could not be initialized "
1034 "for the crypto device\n");
1036 /* Get a burst of crypto operations. */
1037 struct rte_crypto_op *crypto_ops[1];
1038 if (rte_crypto_op_bulk_alloc(crypto_op_pool,
1039 RTE_CRYPTO_OP_TYPE_ASYMMETRIC,
1040 crypto_ops, 1) == 0)
1041 rte_exit(EXIT_FAILURE, "Not enough crypto operations available\n");
1043 /* Set up the crypto operations. */
1044 struct rte_crypto_asym_op *asym_op = crypto_ops[0]->asym;
1046 /* calculate mod exp of value 0xf8 */
1047 static unsigned char base[] = {0xF8};
1048 asym_op->modex.base.data = base;
1049 asym_op->modex.base.length = sizeof(base);
1050 asym_op->modex.base.iova = base;
1052 /* Attach the asym crypto session to the operation */
1053 rte_crypto_op_attach_asym_session(op, asym_session);
1055 /* Enqueue the crypto operations in the crypto device. */
1056 uint16_t num_enqueued_ops = rte_cryptodev_enqueue_burst(cdev_id, 0,
1060 * Dequeue the crypto operations until all the operations
1061 * are processed in the crypto device.
1063 uint16_t num_dequeued_ops, total_num_dequeued_ops = 0;
1065 struct rte_crypto_op *dequeued_ops[1];
1066 num_dequeued_ops = rte_cryptodev_dequeue_burst(cdev_id, 0,
1068 total_num_dequeued_ops += num_dequeued_ops;
1070 /* Check if operation was processed successfully */
1071 if (dequeued_ops[0]->status != RTE_CRYPTO_OP_STATUS_SUCCESS)
1072 rte_exit(EXIT_FAILURE,
1073 "Some operations were not processed correctly");
1075 } while (total_num_dequeued_ops < num_enqueued_ops);
1078 Asymmetric Crypto Device API
1079 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1081 The cryptodev Library API is described in the
1082 `DPDK API Reference <http://doc.dpdk.org/api/>`_