2 Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Intel Corporation nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 .. _l2_fwd_crypto_app:
33 L2 Forwarding with Crypto Sample Application
34 ============================================
36 The L2 Forwarding with Crypto (l2fwd-crypto) sample application is a simple example of packet processing using
37 the Data Plane Development Kit (DPDK), in conjunction with the Cryptodev library.
42 The L2 Forwarding with Crypto sample application performs a crypto operation (cipher/hash)
43 specified by the user from command line (or using the default values),
44 with a crypto device capable of doing that operation,
45 for each packet that is received on a RX_PORT and performs L2 forwarding.
46 The destination port is the adjacent port from the enabled portmask, that is,
47 if the first four ports are enabled (portmask 0xf),
48 ports 0 and 1 forward into each other, and ports 2 and 3 forward into each other.
49 Also, the MAC addresses are affected as follows:
51 * The source MAC address is replaced by the TX_PORT MAC address
53 * The destination MAC address is replaced by 02:00:00:00:00:TX_PORT_ID
55 Compiling the Application
56 -------------------------
58 #. Go to the example directory:
60 .. code-block:: console
62 export RTE_SDK=/path/to/rte_sdk
63 cd ${RTE_SDK}/examples/l2fwd-crypto
65 #. Set the target (a default target is used if not specified). For example:
67 .. code-block:: console
69 export RTE_TARGET=x86_64-native-linuxapp-gcc
71 *See the DPDK Getting Started Guide* for possible RTE_TARGET values.
73 #. Build the application:
75 .. code-block:: console
79 Running the Application
80 -----------------------
82 The application requires a number of command line options:
84 .. code-block:: console
86 ./build/l2fwd-crypto [EAL options] -- [-p PORTMASK] [-q NQ] [-s] [-T PERIOD] /
87 [--cdev_type HW/SW/ANY] [--chain HASH_CIPHER/CIPHER_HASH/CIPHER_ONLY/HASH_ONLY] /
88 [--cipher_algo ALGO] [--cipher_op ENCRYPT/DECRYPT] [--cipher_key KEY] /
89 [--cipher_key_random_size SIZE] [--cipher_iv IV] [--cipher_iv_random_size SIZE] /
90 [--auth_algo ALGO] [--auth_op GENERATE/VERIFY] [--auth_key KEY] /
91 [--auth_key_random_size SIZE] [--auth_iv IV] [--auth_iv_random_size SIZE] /
92 [--aad AAD] [--aad_random_size SIZE] /
93 [--digest size SIZE] [--sessionless] [--cryptodev_mask MASK]
97 * p PORTMASK: A hexadecimal bitmask of the ports to configure (default is all the ports)
99 * q NQ: A number of queues (=ports) per lcore (default is 1)
101 * s: manage all ports from single core
103 * T PERIOD: statistics will be refreshed each PERIOD seconds
105 (0 to disable, 10 default, 86400 maximum)
107 * cdev_type: select preferred crypto device type: HW, SW or anything (ANY)
111 * chain: select the operation chaining to perform: Cipher->Hash (CIPHER_HASH),
113 Hash->Cipher (HASH_CIPHER), Cipher (CIPHER_ONLY), Hash (HASH_ONLY)
117 (default is Cipher->Hash)
119 * cipher_algo: select the ciphering algorithm (default is aes-cbc)
121 * cipher_op: select the ciphering operation to perform: ENCRYPT or DECRYPT
125 * cipher_key: set the ciphering key to be used. Bytes has to be separated with ":"
127 * cipher_key_random_size: set the size of the ciphering key,
129 which will be generated randomly.
131 Note that if --cipher_key is used, this will be ignored.
133 * cipher_iv: set the cipher IV to be used. Bytes has to be separated with ":"
135 * cipher_iv_random_size: set the size of the cipher IV, which will be generated randomly.
137 Note that if --cipher_iv is used, this will be ignored.
139 * auth_algo: select the authentication algorithm (default is sha1-hmac)
141 * auth_op: select the authentication operation to perform: GENERATE or VERIFY
143 (default is GENERATE)
145 * auth_key: set the authentication key to be used. Bytes has to be separated with ":"
147 * auth_key_random_size: set the size of the authentication key,
149 which will be generated randomly.
151 Note that if --auth_key is used, this will be ignored.
153 * auth_iv: set the auth IV to be used. Bytes has to be separated with ":"
155 * auth_iv_random_size: set the size of the auth IV, which will be generated randomly.
157 Note that if --auth_iv is used, this will be ignored.
159 * aead_algo: select the AEAD algorithm (default is aes-gcm)
161 * aead_op: select the AEAD operation to perform: ENCRYPT or DECRYPT
165 * aead_key: set the AEAD key to be used. Bytes has to be separated with ":"
167 * aead_key_random_size: set the size of the AEAD key,
169 which will be generated randomly.
171 Note that if --aead_key is used, this will be ignored.
173 * aead_iv: set the AEAD IV to be used. Bytes has to be separated with ":"
175 * aead_iv_random_size: set the size of the AEAD IV, which will be generated randomly.
177 Note that if --aead_iv is used, this will be ignored.
179 * aad: set the AAD to be used. Bytes has to be separated with ":"
181 * aad_random_size: set the size of the AAD, which will be generated randomly.
183 Note that if --aad is used, this will be ignored.
185 * digest_size: set the size of the digest to be generated/verified.
187 * sessionless: no crypto session will be created.
189 * cryptodev_mask: A hexadecimal bitmask of the cryptodevs to be used by the
192 (default is all cryptodevs).
195 The application requires that crypto devices capable of performing
196 the specified crypto operation are available on application initialization.
197 This means that HW crypto device/s must be bound to a DPDK driver or
198 a SW crypto device/s (virtual crypto PMD) must be created (using --vdev).
200 To run the application in linuxapp environment with 2 lcores, 2 ports and 2 crypto devices, issue the command:
202 .. code-block:: console
204 $ ./build/l2fwd-crypto -l 0-1 -n 4 --vdev "cryptodev_aesni_mb_pmd" \
205 --vdev "cryptodev_aesni_mb_pmd" -- -p 0x3 --chain CIPHER_HASH \
206 --cipher_op ENCRYPT --cipher_algo aes-cbc \
207 --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f \
208 --auth_op GENERATE --auth_algo aes-xcbc-mac \
209 --auth_key 10:11:12:13:14:15:16:17:18:19:1a:1b:1c:1d:1e:1f
211 Refer to the *DPDK Getting Started Guide* for general information on running applications
212 and the Environment Abstraction Layer (EAL) options.
217 The L2 forward with Crypto application demonstrates the performance of a crypto operation
218 on a packet received on a RX PORT before forwarding it to a TX PORT.
220 The following figure illustrates a sample flow of a packet in the application,
221 from reception until transmission.
223 .. _figure_l2_fwd_encrypt_flow:
225 .. figure:: img/l2_fwd_encrypt_flow.*
227 Encryption flow Through the L2 Forwarding with Crypto Application
230 The following sections provide some explanation of the application.
232 Crypto operation specification
233 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
235 All the packets received in all the ports get transformed by the crypto device/s
236 (ciphering and/or authentication).
237 The crypto operation to be performed on the packet is parsed from the command line
238 (go to "Running the Application section for all the options).
240 If no parameter is passed, the default crypto operation is:
242 * Encryption with AES-CBC with 128 bit key.
244 * Authentication with SHA1-HMAC (generation).
246 * Keys, IV and AAD are generated randomly.
248 There are two methods to pass keys, IV and ADD from the command line:
250 * Passing the full key, separated bytes by ":"::
252 --cipher_key 00:11:22:33:44
254 * Passing the size, so key is generated randomly::
256 --cipher_key_random_size 16
259 If full key is passed (first method) and the size is passed as well (second method),
260 the latter will be ignored.
262 Size of these keys are checked (regardless the method), before starting the app,
263 to make sure that it is supported by the crypto devices.
265 Crypto device initialization
266 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
268 Once the encryption operation is defined, crypto devices are initialized.
269 The crypto devices must be either bound to a DPDK driver (if they are physical devices)
270 or created using the EAL option --vdev (if they are virtual devices),
271 when running the application.
273 The initialize_cryptodevs() function performs the device initialization.
274 It iterates through the list of the available crypto devices and
275 check which ones are capable of performing the operation.
276 Each device has a set of capabilities associated with it,
277 which are stored in the device info structure, so the function checks if the operation
278 is within the structure of each device.
280 The following code checks if the device supports the specified cipher algorithm
281 (similar for the authentication algorithm):
285 /* Check if device supports cipher algo */
287 opt_cipher_algo = options->cipher_xform.cipher.algo;
288 cap = &dev_info.capabilities[i];
289 while (cap->op != RTE_CRYPTO_OP_TYPE_UNDEFINED) {
290 cap_cipher_algo = cap->sym.cipher.algo;
291 if (cap->sym.xform_type ==
292 RTE_CRYPTO_SYM_XFORM_CIPHER) {
293 if (cap_cipher_algo == opt_cipher_algo) {
294 if (check_type(options, &dev_info) == 0)
298 cap = &dev_info.capabilities[++i];
301 If a capable crypto device is found, key sizes are checked to see if they are supported
302 (cipher key and IV for the ciphering):
307 * Check if length of provided cipher key is supported
308 * by the algorithm chosen.
310 if (options->ckey_param) {
311 if (check_supported_size(
312 options->cipher_xform.cipher.key.length,
313 cap->sym.cipher.key_size.min,
314 cap->sym.cipher.key_size.max,
315 cap->sym.cipher.key_size.increment)
317 printf("Unsupported cipher key length\n");
321 * Check if length of the cipher key to be randomly generated
322 * is supported by the algorithm chosen.
324 } else if (options->ckey_random_size != -1) {
325 if (check_supported_size(options->ckey_random_size,
326 cap->sym.cipher.key_size.min,
327 cap->sym.cipher.key_size.max,
328 cap->sym.cipher.key_size.increment)
330 printf("Unsupported cipher key length\n");
333 options->cipher_xform.cipher.key.length =
334 options->ckey_random_size;
335 /* No size provided, use minimum size. */
337 options->cipher_xform.cipher.key.length =
338 cap->sym.cipher.key_size.min;
340 After all the checks, the device is configured and it is added to the
344 The number of crypto devices that supports the specified crypto operation
345 must be at least the number of ports to be used.
350 The crypto operation has a crypto session associated to it, which contains
351 information such as the transform chain to perform (e.g. ciphering then hashing),
352 pointers to the keys, lengths... etc.
354 This session is created and is later attached to the crypto operation:
358 static struct rte_cryptodev_sym_session *
359 initialize_crypto_session(struct l2fwd_crypto_options *options,
362 struct rte_crypto_sym_xform *first_xform;
364 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH) {
365 first_xform = &options->cipher_xform;
366 first_xform->next = &options->auth_xform;
367 } else if (options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER) {
368 first_xform = &options->auth_xform;
369 first_xform->next = &options->cipher_xform;
370 } else if (options->xform_chain == L2FWD_CRYPTO_CIPHER_ONLY) {
371 first_xform = &options->cipher_xform;
373 first_xform = &options->auth_xform;
376 /* Setup Cipher Parameters */
377 return rte_cryptodev_sym_session_create(cdev_id, first_xform);
382 port_cparams[i].session = initialize_crypto_session(options,
383 port_cparams[i].dev_id);
385 Crypto operation creation
386 ~~~~~~~~~~~~~~~~~~~~~~~~~
388 Given N packets received from a RX PORT, N crypto operations are allocated
395 * If we can't allocate a crypto_ops, then drop
396 * the rest of the burst and dequeue and
397 * process the packets to free offload structs
399 if (rte_crypto_op_bulk_alloc(
400 l2fwd_crypto_op_pool,
401 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
404 for (j = 0; j < nb_rx; j++)
405 rte_pktmbuf_free(pkts_burst[i]);
410 After filling the crypto operation (including session attachment),
411 the mbuf which will be transformed is attached to it::
415 Since no destination mbuf is set, the source mbuf will be overwritten
416 after the operation is done (in-place).
418 Crypto operation enqueuing/dequeuing
419 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
421 Once the operation has been created, it has to be enqueued in one of the crypto devices.
422 Before doing so, for performance reasons, the operation stays in a buffer.
423 When the buffer has enough operations (MAX_PKT_BURST), they are enqueued in the device,
424 which will perform the operation at that moment:
429 l2fwd_crypto_enqueue(struct rte_crypto_op *op,
430 struct l2fwd_crypto_params *cparams)
432 unsigned lcore_id, len;
433 struct lcore_queue_conf *qconf;
435 lcore_id = rte_lcore_id();
437 qconf = &lcore_queue_conf[lcore_id];
438 len = qconf->op_buf[cparams->dev_id].len;
439 qconf->op_buf[cparams->dev_id].buffer[len] = op;
442 /* enough ops to be sent */
443 if (len == MAX_PKT_BURST) {
444 l2fwd_crypto_send_burst(qconf, MAX_PKT_BURST, cparams);
448 qconf->op_buf[cparams->dev_id].len = len;
455 l2fwd_crypto_send_burst(struct lcore_queue_conf *qconf, unsigned n,
456 struct l2fwd_crypto_params *cparams)
458 struct rte_crypto_op **op_buffer;
461 op_buffer = (struct rte_crypto_op **)
462 qconf->op_buf[cparams->dev_id].buffer;
464 ret = rte_cryptodev_enqueue_burst(cparams->dev_id,
465 cparams->qp_id, op_buffer, (uint16_t) n);
467 crypto_statistics[cparams->dev_id].enqueued += ret;
468 if (unlikely(ret < n)) {
469 crypto_statistics[cparams->dev_id].errors += (n - ret);
471 rte_pktmbuf_free(op_buffer[ret]->sym->m_src);
472 rte_crypto_op_free(op_buffer[ret]);
479 After this, the operations are dequeued from the device, and the transformed mbuf
480 is extracted from the operation. Then, the operation is freed and the mbuf is
481 forwarded as it is done in the L2 forwarding application.
485 /* Dequeue packets from Crypto device */
487 nb_rx = rte_cryptodev_dequeue_burst(
488 cparams->dev_id, cparams->qp_id,
489 ops_burst, MAX_PKT_BURST);
491 crypto_statistics[cparams->dev_id].dequeued +=
494 /* Forward crypto'd packets */
495 for (j = 0; j < nb_rx; j++) {
496 m = ops_burst[j]->sym->m_src;
498 rte_crypto_op_free(ops_burst[j]);
499 l2fwd_simple_forward(m, portid);
501 } while (nb_rx == MAX_PKT_BURST);