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, if MAC addresses updating is enabled, 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] /
94 [--mac-updating] [--no-mac-updating]
98 * p PORTMASK: A hexadecimal bitmask of the ports to configure (default is all the ports)
100 * q NQ: A number of queues (=ports) per lcore (default is 1)
102 * s: manage all ports from single core
104 * T PERIOD: statistics will be refreshed each PERIOD seconds
106 (0 to disable, 10 default, 86400 maximum)
108 * cdev_type: select preferred crypto device type: HW, SW or anything (ANY)
112 * chain: select the operation chaining to perform: Cipher->Hash (CIPHER_HASH),
114 Hash->Cipher (HASH_CIPHER), Cipher (CIPHER_ONLY), Hash (HASH_ONLY)
118 (default is Cipher->Hash)
120 * cipher_algo: select the ciphering algorithm (default is aes-cbc)
122 * cipher_op: select the ciphering operation to perform: ENCRYPT or DECRYPT
126 * cipher_key: set the ciphering key to be used. Bytes has to be separated with ":"
128 * cipher_key_random_size: set the size of the ciphering key,
130 which will be generated randomly.
132 Note that if --cipher_key is used, this will be ignored.
134 * cipher_iv: set the cipher IV to be used. Bytes has to be separated with ":"
136 * cipher_iv_random_size: set the size of the cipher IV, which will be generated randomly.
138 Note that if --cipher_iv is used, this will be ignored.
140 * auth_algo: select the authentication algorithm (default is sha1-hmac)
142 * auth_op: select the authentication operation to perform: GENERATE or VERIFY
144 (default is GENERATE)
146 * auth_key: set the authentication key to be used. Bytes has to be separated with ":"
148 * auth_key_random_size: set the size of the authentication key,
150 which will be generated randomly.
152 Note that if --auth_key is used, this will be ignored.
154 * auth_iv: set the auth IV to be used. Bytes has to be separated with ":"
156 * auth_iv_random_size: set the size of the auth IV, which will be generated randomly.
158 Note that if --auth_iv is used, this will be ignored.
160 * aead_algo: select the AEAD algorithm (default is aes-gcm)
162 * aead_op: select the AEAD operation to perform: ENCRYPT or DECRYPT
166 * aead_key: set the AEAD key to be used. Bytes has to be separated with ":"
168 * aead_key_random_size: set the size of the AEAD key,
170 which will be generated randomly.
172 Note that if --aead_key is used, this will be ignored.
174 * aead_iv: set the AEAD IV to be used. Bytes has to be separated with ":"
176 * aead_iv_random_size: set the size of the AEAD IV, which will be generated randomly.
178 Note that if --aead_iv is used, this will be ignored.
180 * aad: set the AAD to be used. Bytes has to be separated with ":"
182 * aad_random_size: set the size of the AAD, which will be generated randomly.
184 Note that if --aad is used, this will be ignored.
186 * digest_size: set the size of the digest to be generated/verified.
188 * sessionless: no crypto session will be created.
190 * cryptodev_mask: A hexadecimal bitmask of the cryptodevs to be used by the
193 (default is all cryptodevs).
195 * [no-]mac-updating: Enable or disable MAC addresses updating (enabled by default).
198 The application requires that crypto devices capable of performing
199 the specified crypto operation are available on application initialization.
200 This means that HW crypto device/s must be bound to a DPDK driver or
201 a SW crypto device/s (virtual crypto PMD) must be created (using --vdev).
203 To run the application in linuxapp environment with 2 lcores, 2 ports and 2 crypto devices, issue the command:
205 .. code-block:: console
207 $ ./build/l2fwd-crypto -l 0-1 -n 4 --vdev "crypto_aesni_mb0" \
208 --vdev "crypto_aesni_mb1" -- -p 0x3 --chain CIPHER_HASH \
209 --cipher_op ENCRYPT --cipher_algo aes-cbc \
210 --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f \
211 --auth_op GENERATE --auth_algo aes-xcbc-mac \
212 --auth_key 10:11:12:13:14:15:16:17:18:19:1a:1b:1c:1d:1e:1f
214 Refer to the *DPDK Getting Started Guide* for general information on running applications
215 and the Environment Abstraction Layer (EAL) options.
220 The L2 forward with Crypto application demonstrates the performance of a crypto operation
221 on a packet received on a RX PORT before forwarding it to a TX PORT.
223 The following figure illustrates a sample flow of a packet in the application,
224 from reception until transmission.
226 .. _figure_l2_fwd_encrypt_flow:
228 .. figure:: img/l2_fwd_encrypt_flow.*
230 Encryption flow Through the L2 Forwarding with Crypto Application
233 The following sections provide some explanation of the application.
235 Crypto operation specification
236 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
238 All the packets received in all the ports get transformed by the crypto device/s
239 (ciphering and/or authentication).
240 The crypto operation to be performed on the packet is parsed from the command line
241 (go to "Running the Application section for all the options).
243 If no parameter is passed, the default crypto operation is:
245 * Encryption with AES-CBC with 128 bit key.
247 * Authentication with SHA1-HMAC (generation).
249 * Keys, IV and AAD are generated randomly.
251 There are two methods to pass keys, IV and ADD from the command line:
253 * Passing the full key, separated bytes by ":"::
255 --cipher_key 00:11:22:33:44
257 * Passing the size, so key is generated randomly::
259 --cipher_key_random_size 16
262 If full key is passed (first method) and the size is passed as well (second method),
263 the latter will be ignored.
265 Size of these keys are checked (regardless the method), before starting the app,
266 to make sure that it is supported by the crypto devices.
268 Crypto device initialization
269 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
271 Once the encryption operation is defined, crypto devices are initialized.
272 The crypto devices must be either bound to a DPDK driver (if they are physical devices)
273 or created using the EAL option --vdev (if they are virtual devices),
274 when running the application.
276 The initialize_cryptodevs() function performs the device initialization.
277 It iterates through the list of the available crypto devices and
278 check which ones are capable of performing the operation.
279 Each device has a set of capabilities associated with it,
280 which are stored in the device info structure, so the function checks if the operation
281 is within the structure of each device.
283 The following code checks if the device supports the specified cipher algorithm
284 (similar for the authentication algorithm):
288 /* Check if device supports cipher algo */
290 opt_cipher_algo = options->cipher_xform.cipher.algo;
291 cap = &dev_info.capabilities[i];
292 while (cap->op != RTE_CRYPTO_OP_TYPE_UNDEFINED) {
293 cap_cipher_algo = cap->sym.cipher.algo;
294 if (cap->sym.xform_type ==
295 RTE_CRYPTO_SYM_XFORM_CIPHER) {
296 if (cap_cipher_algo == opt_cipher_algo) {
297 if (check_type(options, &dev_info) == 0)
301 cap = &dev_info.capabilities[++i];
304 If a capable crypto device is found, key sizes are checked to see if they are supported
305 (cipher key and IV for the ciphering):
310 * Check if length of provided cipher key is supported
311 * by the algorithm chosen.
313 if (options->ckey_param) {
314 if (check_supported_size(
315 options->cipher_xform.cipher.key.length,
316 cap->sym.cipher.key_size.min,
317 cap->sym.cipher.key_size.max,
318 cap->sym.cipher.key_size.increment)
320 printf("Unsupported cipher key length\n");
324 * Check if length of the cipher key to be randomly generated
325 * is supported by the algorithm chosen.
327 } else if (options->ckey_random_size != -1) {
328 if (check_supported_size(options->ckey_random_size,
329 cap->sym.cipher.key_size.min,
330 cap->sym.cipher.key_size.max,
331 cap->sym.cipher.key_size.increment)
333 printf("Unsupported cipher key length\n");
336 options->cipher_xform.cipher.key.length =
337 options->ckey_random_size;
338 /* No size provided, use minimum size. */
340 options->cipher_xform.cipher.key.length =
341 cap->sym.cipher.key_size.min;
343 After all the checks, the device is configured and it is added to the
347 The number of crypto devices that supports the specified crypto operation
348 must be at least the number of ports to be used.
353 The crypto operation has a crypto session associated to it, which contains
354 information such as the transform chain to perform (e.g. ciphering then hashing),
355 pointers to the keys, lengths... etc.
357 This session is created and is later attached to the crypto operation:
361 static struct rte_cryptodev_sym_session *
362 initialize_crypto_session(struct l2fwd_crypto_options *options,
365 struct rte_crypto_sym_xform *first_xform;
367 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH) {
368 first_xform = &options->cipher_xform;
369 first_xform->next = &options->auth_xform;
370 } else if (options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER) {
371 first_xform = &options->auth_xform;
372 first_xform->next = &options->cipher_xform;
373 } else if (options->xform_chain == L2FWD_CRYPTO_CIPHER_ONLY) {
374 first_xform = &options->cipher_xform;
376 first_xform = &options->auth_xform;
379 /* Setup Cipher Parameters */
380 return rte_cryptodev_sym_session_create(cdev_id, first_xform);
385 port_cparams[i].session = initialize_crypto_session(options,
386 port_cparams[i].dev_id);
388 Crypto operation creation
389 ~~~~~~~~~~~~~~~~~~~~~~~~~
391 Given N packets received from a RX PORT, N crypto operations are allocated
398 * If we can't allocate a crypto_ops, then drop
399 * the rest of the burst and dequeue and
400 * process the packets to free offload structs
402 if (rte_crypto_op_bulk_alloc(
403 l2fwd_crypto_op_pool,
404 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
407 for (j = 0; j < nb_rx; j++)
408 rte_pktmbuf_free(pkts_burst[i]);
413 After filling the crypto operation (including session attachment),
414 the mbuf which will be transformed is attached to it::
418 Since no destination mbuf is set, the source mbuf will be overwritten
419 after the operation is done (in-place).
421 Crypto operation enqueuing/dequeuing
422 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
424 Once the operation has been created, it has to be enqueued in one of the crypto devices.
425 Before doing so, for performance reasons, the operation stays in a buffer.
426 When the buffer has enough operations (MAX_PKT_BURST), they are enqueued in the device,
427 which will perform the operation at that moment:
432 l2fwd_crypto_enqueue(struct rte_crypto_op *op,
433 struct l2fwd_crypto_params *cparams)
435 unsigned lcore_id, len;
436 struct lcore_queue_conf *qconf;
438 lcore_id = rte_lcore_id();
440 qconf = &lcore_queue_conf[lcore_id];
441 len = qconf->op_buf[cparams->dev_id].len;
442 qconf->op_buf[cparams->dev_id].buffer[len] = op;
445 /* enough ops to be sent */
446 if (len == MAX_PKT_BURST) {
447 l2fwd_crypto_send_burst(qconf, MAX_PKT_BURST, cparams);
451 qconf->op_buf[cparams->dev_id].len = len;
458 l2fwd_crypto_send_burst(struct lcore_queue_conf *qconf, unsigned n,
459 struct l2fwd_crypto_params *cparams)
461 struct rte_crypto_op **op_buffer;
464 op_buffer = (struct rte_crypto_op **)
465 qconf->op_buf[cparams->dev_id].buffer;
467 ret = rte_cryptodev_enqueue_burst(cparams->dev_id,
468 cparams->qp_id, op_buffer, (uint16_t) n);
470 crypto_statistics[cparams->dev_id].enqueued += ret;
471 if (unlikely(ret < n)) {
472 crypto_statistics[cparams->dev_id].errors += (n - ret);
474 rte_pktmbuf_free(op_buffer[ret]->sym->m_src);
475 rte_crypto_op_free(op_buffer[ret]);
482 After this, the operations are dequeued from the device, and the transformed mbuf
483 is extracted from the operation. Then, the operation is freed and the mbuf is
484 forwarded as it is done in the L2 forwarding application.
488 /* Dequeue packets from Crypto device */
490 nb_rx = rte_cryptodev_dequeue_burst(
491 cparams->dev_id, cparams->qp_id,
492 ops_burst, MAX_PKT_BURST);
494 crypto_statistics[cparams->dev_id].dequeued +=
497 /* Forward crypto'd packets */
498 for (j = 0; j < nb_rx; j++) {
499 m = ops_burst[j]->sym->m_src;
501 rte_crypto_op_free(ops_burst[j]);
502 l2fwd_simple_forward(m, portid);
504 } while (nb_rx == MAX_PKT_BURST);