1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2016-2020 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 DPDK's
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 instances sharing the same library requires unique ID.
53 Example: ``--vdev 'crypto_aesni_mb0' --vdev 'crypto_aesni_mb1'``
55 Or 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 placed 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);
330 Please note the ``size`` passed to set API cannot be bigger than the predefined
331 ``user_data_sz`` when creating the session header mempool, otherwise the
332 function will return error. Also when ``user_data_sz`` was defined as ``0`` when
333 creating the session header mempool, the get API will always return ``NULL``.
335 For session-less mode, the private user data information can be placed along with the
336 ``struct rte_crypto_op``. The ``rte_crypto_op::private_data_offset`` indicates the
337 start of private data information. The offset is counted from the start of the
338 rte_crypto_op including other crypto information such as the IVs (since there can
339 be an IV also for authentication).
342 Enqueue / Dequeue Burst APIs
343 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
345 The burst enqueue API uses a Crypto device identifier and a queue pair
346 identifier to specify the Crypto device queue pair to schedule the processing on.
347 The ``nb_ops`` parameter is the number of operations to process which are
348 supplied in the ``ops`` array of ``rte_crypto_op`` structures.
349 The enqueue function returns the number of operations it actually enqueued for
350 processing, a return value equal to ``nb_ops`` means that all packets have been
355 uint16_t rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
356 struct rte_crypto_op **ops, uint16_t nb_ops)
358 The dequeue API uses the same format as the enqueue API of processed but
359 the ``nb_ops`` and ``ops`` parameters are now used to specify the max processed
360 operations the user wishes to retrieve and the location in which to store them.
361 The API call returns the actual number of processed operations returned, this
362 can never be larger than ``nb_ops``.
366 uint16_t rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
367 struct rte_crypto_op **ops, uint16_t nb_ops)
370 Operation Representation
371 ~~~~~~~~~~~~~~~~~~~~~~~~
373 An Crypto operation is represented by an rte_crypto_op structure, which is a
374 generic metadata container for all necessary information required for the
375 Crypto operation to be processed on a particular Crypto device poll mode driver.
377 .. figure:: img/crypto_op.*
379 The operation structure includes the operation type, the operation status
380 and the session type (session-based/less), a reference to the operation
381 specific data, which can vary in size and content depending on the operation
382 being provisioned. It also contains the source mempool for the operation,
383 if it allocated from a mempool.
385 If Crypto operations are allocated from a Crypto operation mempool, see next
386 section, there is also the ability to allocate private memory with the
387 operation for applications purposes.
389 Application software is responsible for specifying all the operation specific
390 fields in the ``rte_crypto_op`` structure which are then used by the Crypto PMD
391 to process the requested operation.
394 Operation Management and Allocation
395 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
397 The cryptodev library provides an API set for managing Crypto operations which
398 utilize the Mempool Library to allocate operation buffers. Therefore, it ensures
399 that the crypto operation is interleaved optimally across the channels and
400 ranks for optimal processing.
401 A ``rte_crypto_op`` contains a field indicating the pool that it originated from.
402 When calling ``rte_crypto_op_free(op)``, the operation returns to its original pool.
406 extern struct rte_mempool *
407 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
408 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
411 During pool creation ``rte_crypto_op_init()`` is called as a constructor to
412 initialize each Crypto operation which subsequently calls
413 ``__rte_crypto_op_reset()`` to configure any operation type specific fields based
414 on the type parameter.
417 ``rte_crypto_op_alloc()`` and ``rte_crypto_op_bulk_alloc()`` are used to allocate
418 Crypto operations of a specific type from a given Crypto operation mempool.
419 ``__rte_crypto_op_reset()`` is called on each operation before being returned to
420 allocate to a user so the operation is always in a good known state before use
425 struct rte_crypto_op *rte_crypto_op_alloc(struct rte_mempool *mempool,
426 enum rte_crypto_op_type type)
428 unsigned rte_crypto_op_bulk_alloc(struct rte_mempool *mempool,
429 enum rte_crypto_op_type type,
430 struct rte_crypto_op **ops, uint16_t nb_ops)
432 ``rte_crypto_op_free()`` is called by the application to return an operation to
437 void rte_crypto_op_free(struct rte_crypto_op *op)
440 Symmetric Cryptography Support
441 ------------------------------
443 The cryptodev library currently provides support for the following symmetric
444 Crypto operations; cipher, authentication, including chaining of these
445 operations, as well as also supporting AEAD operations.
448 Session and Session Management
449 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
451 Sessions are used in symmetric cryptographic processing to store the immutable
452 data defined in a cryptographic transform which is used in the operation
453 processing of a packet flow. Sessions are used to manage information such as
454 expand cipher keys and HMAC IPADs and OPADs, which need to be calculated for a
455 particular Crypto operation, but are immutable on a packet to packet basis for
456 a flow. Crypto sessions cache this immutable data in a optimal way for the
457 underlying PMD and this allows further acceleration of the offload of
460 .. figure:: img/cryptodev_sym_sess.*
462 The Crypto device framework provides APIs to create session mempool and allocate
463 and initialize sessions for crypto devices, where sessions are mempool objects.
464 The application has to use ``rte_cryptodev_sym_session_pool_create()`` to
465 create the session header mempool that creates a mempool with proper element
466 size automatically and stores necessary information for safely accessing the
467 session in the mempool's private data field.
469 To create a mempool for storing session private data, the application has two
470 options. The first is to create another mempool with elt size equal to or
471 bigger than the maximum session private data size of all crypto devices that
472 will share the same session header. The creation of the mempool shall use the
473 traditional ``rte_mempool_create()`` with the correct ``elt_size``. The other
474 option is to change the ``elt_size`` parameter in
475 ``rte_cryptodev_sym_session_pool_create()`` to the correct value. The first
476 option is more complex to implement but may result in better memory usage as
477 a session header normally takes smaller memory footprint as the session private
480 Once the session mempools have been created, ``rte_cryptodev_sym_session_create()``
481 is used to allocate an uninitialized session from the given mempool.
482 The session then must be initialized using ``rte_cryptodev_sym_session_init()``
483 for each of the required crypto devices. A symmetric transform chain
484 is used to specify the operation and its parameters. See the section below for
485 details on transforms.
487 When a session is no longer used, user must call ``rte_cryptodev_sym_session_clear()``
488 for each of the crypto devices that are using the session, to free all driver
489 private session data. Once this is done, session should be freed using
490 ``rte_cryptodev_sym_session_free`` which returns them to their mempool.
493 Transforms and Transform Chaining
494 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
496 Symmetric Crypto transforms (``rte_crypto_sym_xform``) are the mechanism used
497 to specify the details of the Crypto operation. For chaining of symmetric
498 operations such as cipher encrypt and authentication generate, the next pointer
499 allows transform to be chained together. Crypto devices which support chaining
500 must publish the chaining of symmetric Crypto operations feature flag. Allocation of the
501 xform structure is in the application domain. To allow future API extensions in a
502 backwardly compatible manner, e.g. addition of a new parameter, the application should
503 zero the full xform struct before populating it.
505 Currently there are three transforms types cipher, authentication and AEAD.
506 Also it is important to note that the order in which the
507 transforms are passed indicates the order of the chaining.
511 struct rte_crypto_sym_xform {
512 struct rte_crypto_sym_xform *next;
513 /**< next xform in chain */
514 enum rte_crypto_sym_xform_type type;
517 struct rte_crypto_auth_xform auth;
518 /**< Authentication / hash xform */
519 struct rte_crypto_cipher_xform cipher;
521 struct rte_crypto_aead_xform aead;
526 The API does not place a limit on the number of transforms that can be chained
527 together but this will be limited by the underlying Crypto device poll mode
528 driver which is processing the operation.
530 .. figure:: img/crypto_xform_chain.*
536 The symmetric Crypto operation structure contains all the mutable data relating
537 to performing symmetric cryptographic processing on a referenced mbuf data
538 buffer. It is used for either cipher, authentication, AEAD and chained
541 As a minimum the symmetric operation must have a source data buffer (``m_src``),
542 a valid session (or transform chain if in session-less mode) and the minimum
543 authentication/ cipher/ AEAD parameters required depending on the type of operation
544 specified in the session or the transform
549 struct rte_crypto_sym_op {
550 struct rte_mbuf *m_src;
551 struct rte_mbuf *m_dst;
554 struct rte_cryptodev_sym_session *session;
555 /**< Handle for the initialised session context */
556 struct rte_crypto_sym_xform *xform;
557 /**< Session-less API Crypto operation parameters */
565 } data; /**< Data offsets and length for AEAD */
569 rte_iova_t phys_addr;
570 } digest; /**< Digest parameters */
574 rte_iova_t phys_addr;
576 /**< Additional authentication parameters */
584 } data; /**< Data offsets and length for ciphering */
592 /**< Data offsets and length for authentication */
596 rte_iova_t phys_addr;
597 } digest; /**< Digest parameters */
606 Some cryptodevs support synchronous mode alongside with a standard asynchronous
607 mode. In that case operations are performed directly when calling
608 ``rte_cryptodev_sym_cpu_crypto_process`` method instead of enqueuing and
609 dequeuing an operation before. This mode of operation allows cryptodevs which
610 utilize CPU cryptographic acceleration to have significant performance boost
611 comparing to standard asynchronous approach. Cryptodevs supporting synchronous
612 mode have ``RTE_CRYPTODEV_FF_SYM_CPU_CRYPTO`` feature flag set.
614 To perform a synchronous operation a call to
615 ``rte_cryptodev_sym_cpu_crypto_process`` has to be made with vectorized
616 operation descriptor (``struct rte_crypto_sym_vec``) containing:
618 - ``num`` - number of operations to perform,
619 - pointer to an array of size ``num`` containing a scatter-gather list
620 descriptors of performed operations (``struct rte_crypto_sgl``). Each instance
621 of ``struct rte_crypto_sgl`` consists of a number of segments and a pointer to
622 an array of segment descriptors ``struct rte_crypto_vec``;
623 - pointers to arrays of size ``num`` containing IV, AAD and digest information,
624 - pointer to an array of size ``num`` where status information will be stored
627 Function returns a number of successfully completed operations and sets
628 appropriate status number for each operation in the status array provided as
629 a call argument. Status different than zero must be treated as error.
631 For more details, e.g. how to convert an mbuf to an SGL, please refer to an
632 example usage in the IPsec library implementation.
637 There are various sample applications that show how to use the cryptodev library,
638 such as the L2fwd with Crypto sample application (L2fwd-crypto) and
639 the IPsec Security Gateway application (ipsec-secgw).
641 While these applications demonstrate how an application can be created to perform
642 generic crypto operation, the required complexity hides the basic steps of
643 how to use the cryptodev APIs.
645 The following sample code shows the basic steps to encrypt several buffers
646 with AES-CBC (although performing other crypto operations is similar),
647 using one of the crypto PMDs available in DPDK.
652 * Simple example to encrypt several buffers with AES-CBC using
653 * the Cryptodev APIs.
656 #define MAX_SESSIONS 1024
657 #define NUM_MBUFS 1024
658 #define POOL_CACHE_SIZE 128
659 #define BURST_SIZE 32
660 #define BUFFER_SIZE 1024
661 #define AES_CBC_IV_LENGTH 16
662 #define AES_CBC_KEY_LENGTH 16
663 #define IV_OFFSET (sizeof(struct rte_crypto_op) + \
664 sizeof(struct rte_crypto_sym_op))
666 struct rte_mempool *mbuf_pool, *crypto_op_pool;
667 struct rte_mempool *session_pool, *session_priv_pool;
668 unsigned int session_size;
671 /* Initialize EAL. */
672 ret = rte_eal_init(argc, argv);
674 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
676 uint8_t socket_id = rte_socket_id();
678 /* Create the mbuf pool. */
679 mbuf_pool = rte_pktmbuf_pool_create("mbuf_pool",
683 RTE_MBUF_DEFAULT_BUF_SIZE,
685 if (mbuf_pool == NULL)
686 rte_exit(EXIT_FAILURE, "Cannot create mbuf pool\n");
689 * The IV is always placed after the crypto operation,
690 * so some private data is required to be reserved.
692 unsigned int crypto_op_private_data = AES_CBC_IV_LENGTH;
694 /* Create crypto operation pool. */
695 crypto_op_pool = rte_crypto_op_pool_create("crypto_op_pool",
696 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
699 crypto_op_private_data,
701 if (crypto_op_pool == NULL)
702 rte_exit(EXIT_FAILURE, "Cannot create crypto op pool\n");
704 /* Create the virtual crypto device. */
706 const char *crypto_name = "crypto_aesni_mb0";
707 snprintf(args, sizeof(args), "socket_id=%d", socket_id);
708 ret = rte_vdev_init(crypto_name, args);
710 rte_exit(EXIT_FAILURE, "Cannot create virtual device");
712 uint8_t cdev_id = rte_cryptodev_get_dev_id(crypto_name);
714 /* Get private session data size. */
715 session_size = rte_cryptodev_sym_get_private_session_size(cdev_id);
717 #ifdef USE_TWO_MEMPOOLS
718 /* Create session mempool for the session header. */
719 session_pool = rte_cryptodev_sym_session_pool_create("session_pool",
727 * Create session private data mempool for the
728 * private session data for the crypto device.
730 session_priv_pool = rte_mempool_create("session_pool",
739 /* Use of the same mempool for session header and private data */
740 session_pool = rte_cryptodev_sym_session_pool_create("session_pool",
747 session_priv_pool = session_pool;
751 /* Configure the crypto device. */
752 struct rte_cryptodev_config conf = {
754 .socket_id = socket_id
757 struct rte_cryptodev_qp_conf qp_conf = {
758 .nb_descriptors = 2048,
759 .mp_session = session_pool,
760 .mp_session_private = session_priv_pool
763 if (rte_cryptodev_configure(cdev_id, &conf) < 0)
764 rte_exit(EXIT_FAILURE, "Failed to configure cryptodev %u", cdev_id);
766 if (rte_cryptodev_queue_pair_setup(cdev_id, 0, &qp_conf, socket_id) < 0)
767 rte_exit(EXIT_FAILURE, "Failed to setup queue pair\n");
769 if (rte_cryptodev_start(cdev_id) < 0)
770 rte_exit(EXIT_FAILURE, "Failed to start device\n");
772 /* Create the crypto transform. */
773 uint8_t cipher_key[16] = {0};
774 struct rte_crypto_sym_xform cipher_xform = {
776 .type = RTE_CRYPTO_SYM_XFORM_CIPHER,
778 .op = RTE_CRYPTO_CIPHER_OP_ENCRYPT,
779 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
782 .length = AES_CBC_KEY_LENGTH
786 .length = AES_CBC_IV_LENGTH
791 /* Create crypto session and initialize it for the crypto device. */
792 struct rte_cryptodev_sym_session *session;
793 session = rte_cryptodev_sym_session_create(session_pool);
795 rte_exit(EXIT_FAILURE, "Session could not be created\n");
797 if (rte_cryptodev_sym_session_init(cdev_id, session,
798 &cipher_xform, session_priv_pool) < 0)
799 rte_exit(EXIT_FAILURE, "Session could not be initialized "
800 "for the crypto device\n");
802 /* Get a burst of crypto operations. */
803 struct rte_crypto_op *crypto_ops[BURST_SIZE];
804 if (rte_crypto_op_bulk_alloc(crypto_op_pool,
805 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
806 crypto_ops, BURST_SIZE) == 0)
807 rte_exit(EXIT_FAILURE, "Not enough crypto operations available\n");
809 /* Get a burst of mbufs. */
810 struct rte_mbuf *mbufs[BURST_SIZE];
811 if (rte_pktmbuf_alloc_bulk(mbuf_pool, mbufs, BURST_SIZE) < 0)
812 rte_exit(EXIT_FAILURE, "Not enough mbufs available");
814 /* Initialize the mbufs and append them to the crypto operations. */
816 for (i = 0; i < BURST_SIZE; i++) {
817 if (rte_pktmbuf_append(mbufs[i], BUFFER_SIZE) == NULL)
818 rte_exit(EXIT_FAILURE, "Not enough room in the mbuf\n");
819 crypto_ops[i]->sym->m_src = mbufs[i];
822 /* Set up the crypto operations. */
823 for (i = 0; i < BURST_SIZE; i++) {
824 struct rte_crypto_op *op = crypto_ops[i];
825 /* Modify bytes of the IV at the end of the crypto operation */
826 uint8_t *iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
829 generate_random_bytes(iv_ptr, AES_CBC_IV_LENGTH);
831 op->sym->cipher.data.offset = 0;
832 op->sym->cipher.data.length = BUFFER_SIZE;
834 /* Attach the crypto session to the operation */
835 rte_crypto_op_attach_sym_session(op, session);
838 /* Enqueue the crypto operations in the crypto device. */
839 uint16_t num_enqueued_ops = rte_cryptodev_enqueue_burst(cdev_id, 0,
840 crypto_ops, BURST_SIZE);
843 * Dequeue the crypto operations until all the operations
844 * are processed in the crypto device.
846 uint16_t num_dequeued_ops, total_num_dequeued_ops = 0;
848 struct rte_crypto_op *dequeued_ops[BURST_SIZE];
849 num_dequeued_ops = rte_cryptodev_dequeue_burst(cdev_id, 0,
850 dequeued_ops, BURST_SIZE);
851 total_num_dequeued_ops += num_dequeued_ops;
853 /* Check if operation was processed successfully */
854 for (i = 0; i < num_dequeued_ops; i++) {
855 if (dequeued_ops[i]->status != RTE_CRYPTO_OP_STATUS_SUCCESS)
856 rte_exit(EXIT_FAILURE,
857 "Some operations were not processed correctly");
860 rte_mempool_put_bulk(crypto_op_pool, (void **)dequeued_ops,
862 } while (total_num_dequeued_ops < num_enqueued_ops);
864 Asymmetric Cryptography
865 -----------------------
867 The cryptodev library currently provides support for the following asymmetric
868 Crypto operations; RSA, Modular exponentiation and inversion, Diffie-Hellman
869 public and/or private key generation and shared secret compute, DSA Signature
870 generation and verification.
872 Session and Session Management
873 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
875 Sessions are used in asymmetric cryptographic processing to store the immutable
876 data defined in asymmetric cryptographic transform which is further used in the
877 operation processing. Sessions typically stores information, such as, public
878 and private key information or domain params or prime modulus data i.e. immutable
879 across data sets. Crypto sessions cache this immutable data in a optimal way for the
880 underlying PMD and this allows further acceleration of the offload of Crypto workloads.
882 Like symmetric, the Crypto device framework provides APIs to allocate and initialize
883 asymmetric sessions for crypto devices, where sessions are mempool objects.
884 It is the application's responsibility to create and manage the session mempools.
885 Application using both symmetric and asymmetric sessions should allocate and maintain
886 different sessions pools for each type.
888 An application can use ``rte_cryptodev_get_asym_session_private_size()`` to
889 get the private size of asymmetric session on a given crypto device. This
890 function would allow an application to calculate the max device asymmetric
891 session size of all crypto devices to create a single session mempool.
892 If instead an application creates multiple asymmetric session mempools,
893 the Crypto device framework also provides ``rte_cryptodev_asym_get_header_session_size()`` to get
894 the size of an uninitialized session.
896 Once the session mempools have been created, ``rte_cryptodev_asym_session_create()``
897 is used to allocate an uninitialized asymmetric session from the given mempool.
898 The session then must be initialized using ``rte_cryptodev_asym_session_init()``
899 for each of the required crypto devices. An asymmetric transform chain
900 is used to specify the operation and its parameters. See the section below for
901 details on transforms.
903 When a session is no longer used, user must call ``rte_cryptodev_asym_session_clear()``
904 for each of the crypto devices that are using the session, to free all driver
905 private asymmetric session data. Once this is done, session should be freed using
906 ``rte_cryptodev_asym_session_free()`` which returns them to their mempool.
908 Asymmetric Sessionless Support
909 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
911 Asymmetric crypto framework supports session-less operations as well.
913 Fields that should be set by user are:
915 Member xform of struct rte_crypto_asym_op should point to the user created rte_crypto_asym_xform.
916 Note that rte_crypto_asym_xform should be immutable for the lifetime of associated crypto_op.
918 Member sess_type of rte_crypto_op should also be set to RTE_CRYPTO_OP_SESSIONLESS.
920 Transforms and Transform Chaining
921 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
923 Asymmetric Crypto transforms (``rte_crypto_asym_xform``) are the mechanism used
924 to specify the details of the asymmetric Crypto operation. Next pointer within
925 xform allows transform to be chained together. Also it is important to note that
926 the order in which the transforms are passed indicates the order of the chaining. Allocation
927 of the xform structure is in the application domain. To allow future API extensions in a
928 backwardly compatible manner, e.g. addition of a new parameter, the application should
929 zero the full xform struct before populating it.
931 Not all asymmetric crypto xforms are supported for chaining. Currently supported
932 asymmetric crypto chaining is Diffie-Hellman private key generation followed by
933 public generation. Also, currently API does not support chaining of symmetric and
934 asymmetric crypto xforms.
936 Each xform defines specific asymmetric crypto algo. Currently supported are:
938 * Modular operations (Exponentiation and Inverse)
941 * None - special case where PMD may support a passthrough mode. More for diagnostic purpose
943 See *DPDK API Reference* for details on each rte_crypto_xxx_xform struct
945 Asymmetric Operations
946 ~~~~~~~~~~~~~~~~~~~~~
948 The asymmetric Crypto operation structure contains all the mutable data relating
949 to asymmetric cryptographic processing on an input data buffer. It uses either
950 RSA, Modular, Diffie-Hellman or DSA operations depending upon session it is attached
953 Every operation must carry a valid session handle which further carries information
954 on xform or xform-chain to be performed on op. Every xform type defines its own set
955 of operational params in their respective rte_crypto_xxx_op_param struct. Depending
956 on xform information within session, PMD picks up and process respective op_param
958 Unlike symmetric, asymmetric operations do not use mbufs for input/output.
959 They operate on data buffer of type ``rte_crypto_param``.
961 See *DPDK API Reference* for details on each rte_crypto_xxx_op_param struct
963 Asymmetric crypto Sample code
964 -----------------------------
966 There's a unit test application test_cryptodev_asym.c inside unit test framework that
967 show how to setup and process asymmetric operations using cryptodev library.
969 The following sample code shows the basic steps to compute modular exponentiation
970 using 1024-bit modulus length using openssl PMD available in DPDK (performing other
971 crypto operations is similar except change to respective op and xform setup).
976 * Simple example to compute modular exponentiation with 1024-bit key
979 #define MAX_ASYM_SESSIONS 10
980 #define NUM_ASYM_BUFS 10
982 struct rte_mempool *crypto_op_pool, *asym_session_pool;
983 unsigned int asym_session_size;
986 /* Initialize EAL. */
987 ret = rte_eal_init(argc, argv);
989 rte_exit(EXIT_FAILURE, "Invalid EAL arguments\n");
991 uint8_t socket_id = rte_socket_id();
993 /* Create crypto operation pool. */
994 crypto_op_pool = rte_crypto_op_pool_create(
996 RTE_CRYPTO_OP_TYPE_ASYMMETRIC,
999 if (crypto_op_pool == NULL)
1000 rte_exit(EXIT_FAILURE, "Cannot create crypto op pool\n");
1002 /* Create the virtual crypto device. */
1004 const char *crypto_name = "crypto_openssl";
1005 snprintf(args, sizeof(args), "socket_id=%d", socket_id);
1006 ret = rte_vdev_init(crypto_name, args);
1008 rte_exit(EXIT_FAILURE, "Cannot create virtual device");
1010 uint8_t cdev_id = rte_cryptodev_get_dev_id(crypto_name);
1012 /* Get private asym session data size. */
1013 asym_session_size = rte_cryptodev_get_asym_private_session_size(cdev_id);
1016 * Create session mempool, with two objects per session,
1017 * one for the session header and another one for the
1018 * private asym session data for the crypto device.
1020 asym_session_pool = rte_mempool_create("asym_session_pool",
1021 MAX_ASYM_SESSIONS * 2,
1024 0, NULL, NULL, NULL,
1028 /* Configure the crypto device. */
1029 struct rte_cryptodev_config conf = {
1030 .nb_queue_pairs = 1,
1031 .socket_id = socket_id
1033 struct rte_cryptodev_qp_conf qp_conf = {
1034 .nb_descriptors = 2048
1037 if (rte_cryptodev_configure(cdev_id, &conf) < 0)
1038 rte_exit(EXIT_FAILURE, "Failed to configure cryptodev %u", cdev_id);
1040 if (rte_cryptodev_queue_pair_setup(cdev_id, 0, &qp_conf,
1041 socket_id, asym_session_pool) < 0)
1042 rte_exit(EXIT_FAILURE, "Failed to setup queue pair\n");
1044 if (rte_cryptodev_start(cdev_id) < 0)
1045 rte_exit(EXIT_FAILURE, "Failed to start device\n");
1047 /* Setup crypto xform to do modular exponentiation with 1024 bit
1050 struct rte_crypto_asym_xform modex_xform = {
1052 .xform_type = RTE_CRYPTO_ASYM_XFORM_MODEX,
1057 ("\xb3\xa1\xaf\xb7\x13\x08\x00\x0a\x35\xdc\x2b\x20\x8d"
1058 "\xa1\xb5\xce\x47\x8a\xc3\x80\xf4\x7d\x4a\xa2\x62\xfd\x61\x7f"
1059 "\xb5\xa8\xde\x0a\x17\x97\xa0\xbf\xdf\x56\x5a\x3d\x51\x56\x4f"
1060 "\x70\x70\x3f\x63\x6a\x44\x5b\xad\x84\x0d\x3f\x27\x6e\x3b\x34"
1061 "\x91\x60\x14\xb9\xaa\x72\xfd\xa3\x64\xd2\x03\xa7\x53\x87\x9e"
1062 "\x88\x0b\xc1\x14\x93\x1a\x62\xff\xb1\x5d\x74\xcd\x59\x63\x18"
1063 "\x11\x3d\x4f\xba\x75\xd4\x33\x4e\x23\x6b\x7b\x57\x44\xe1\xd3"
1064 "\x03\x13\xa6\xf0\x8b\x60\xb0\x9e\xee\x75\x08\x9d\x71\x63\x13"
1065 "\xcb\xa6\x81\x92\x14\x03\x22\x2d\xde\x55"),
1069 .data = (uint8_t *)("\x01\x00\x01"),
1074 /* Create asym crypto session and initialize it for the crypto device. */
1075 struct rte_cryptodev_asym_session *asym_session;
1076 asym_session = rte_cryptodev_asym_session_create(asym_session_pool);
1077 if (asym_session == NULL)
1078 rte_exit(EXIT_FAILURE, "Session could not be created\n");
1080 if (rte_cryptodev_asym_session_init(cdev_id, asym_session,
1081 &modex_xform, asym_session_pool) < 0)
1082 rte_exit(EXIT_FAILURE, "Session could not be initialized "
1083 "for the crypto device\n");
1085 /* Get a burst of crypto operations. */
1086 struct rte_crypto_op *crypto_ops[1];
1087 if (rte_crypto_op_bulk_alloc(crypto_op_pool,
1088 RTE_CRYPTO_OP_TYPE_ASYMMETRIC,
1089 crypto_ops, 1) == 0)
1090 rte_exit(EXIT_FAILURE, "Not enough crypto operations available\n");
1092 /* Set up the crypto operations. */
1093 struct rte_crypto_asym_op *asym_op = crypto_ops[0]->asym;
1095 /* calculate mod exp of value 0xf8 */
1096 static unsigned char base[] = {0xF8};
1097 asym_op->modex.base.data = base;
1098 asym_op->modex.base.length = sizeof(base);
1099 asym_op->modex.base.iova = base;
1101 /* Attach the asym crypto session to the operation */
1102 rte_crypto_op_attach_asym_session(op, asym_session);
1104 /* Enqueue the crypto operations in the crypto device. */
1105 uint16_t num_enqueued_ops = rte_cryptodev_enqueue_burst(cdev_id, 0,
1109 * Dequeue the crypto operations until all the operations
1110 * are processed in the crypto device.
1112 uint16_t num_dequeued_ops, total_num_dequeued_ops = 0;
1114 struct rte_crypto_op *dequeued_ops[1];
1115 num_dequeued_ops = rte_cryptodev_dequeue_burst(cdev_id, 0,
1117 total_num_dequeued_ops += num_dequeued_ops;
1119 /* Check if operation was processed successfully */
1120 if (dequeued_ops[0]->status != RTE_CRYPTO_OP_STATUS_SUCCESS)
1121 rte_exit(EXIT_FAILURE,
1122 "Some operations were not processed correctly");
1124 } while (total_num_dequeued_ops < num_enqueued_ops);
1127 Asymmetric Crypto Device API
1128 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1130 The cryptodev Library API is described in the
1131 `DPDK API Reference <https://doc.dpdk.org/api/>`_