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)
115 (default is Cipher->Hash)
117 * cipher_algo: select the ciphering algorithm (default is aes-cbc)
119 * cipher_op: select the ciphering operation to perform: ENCRYPT or DECRYPT
123 * cipher_key: set the ciphering key to be used. Bytes has to be separated with ":"
125 * cipher_key_random_size: set the size of the ciphering key,
127 which will be generated randomly.
129 Note that if --cipher_key is used, this will be ignored.
131 * cipher_iv: set the cipher IV to be used. Bytes has to be separated with ":"
133 * cipher_iv_random_size: set the size of the cipher IV, which will be generated randomly.
135 Note that if --cipher_iv is used, this will be ignored.
137 * auth_algo: select the authentication algorithm (default is sha1-hmac)
139 * auth_op: select the authentication operation to perform: GENERATE or VERIFY
141 (default is GENERATE)
143 * auth_key: set the authentication key to be used. Bytes has to be separated with ":"
145 * auth_key_random_size: set the size of the authentication key,
147 which will be generated randomly.
149 Note that if --auth_key is used, this will be ignored.
151 * auth_iv: set the auth IV to be used. Bytes has to be separated with ":"
153 * auth_iv_random_size: set the size of the auth IV, which will be generated randomly.
155 Note that if --auth_iv is used, this will be ignored.
157 * aad: set the AAD to be used. Bytes has to be separated with ":"
159 * aad_random_size: set the size of the AAD, which will be generated randomly.
161 Note that if --aad is used, this will be ignored.
163 * digest_size: set the size of the digest to be generated/verified.
165 * sessionless: no crypto session will be created.
167 * cryptodev_mask: A hexadecimal bitmask of the cryptodevs to be used by the
170 (default is all cryptodevs).
173 The application requires that crypto devices capable of performing
174 the specified crypto operation are available on application initialization.
175 This means that HW crypto device/s must be bound to a DPDK driver or
176 a SW crypto device/s (virtual crypto PMD) must be created (using --vdev).
178 To run the application in linuxapp environment with 2 lcores, 2 ports and 2 crypto devices, issue the command:
180 .. code-block:: console
182 $ ./build/l2fwd-crypto -l 0-1 -n 4 --vdev "cryptodev_aesni_mb_pmd" \
183 --vdev "cryptodev_aesni_mb_pmd" -- -p 0x3 --chain CIPHER_HASH \
184 --cipher_op ENCRYPT --cipher_algo aes-cbc \
185 --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f \
186 --auth_op GENERATE --auth_algo aes-xcbc-mac \
187 --auth_key 10:11:12:13:14:15:16:17:18:19:1a:1b:1c:1d:1e:1f
189 Refer to the *DPDK Getting Started Guide* for general information on running applications
190 and the Environment Abstraction Layer (EAL) options.
195 The L2 forward with Crypto application demonstrates the performance of a crypto operation
196 on a packet received on a RX PORT before forwarding it to a TX PORT.
198 The following figure illustrates a sample flow of a packet in the application,
199 from reception until transmission.
201 .. _figure_l2_fwd_encrypt_flow:
203 .. figure:: img/l2_fwd_encrypt_flow.*
205 Encryption flow Through the L2 Forwarding with Crypto Application
208 The following sections provide some explanation of the application.
210 Crypto operation specification
211 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
213 All the packets received in all the ports get transformed by the crypto device/s
214 (ciphering and/or authentication).
215 The crypto operation to be performed on the packet is parsed from the command line
216 (go to "Running the Application section for all the options).
218 If no parameter is passed, the default crypto operation is:
220 * Encryption with AES-CBC with 128 bit key.
222 * Authentication with SHA1-HMAC (generation).
224 * Keys, IV and AAD are generated randomly.
226 There are two methods to pass keys, IV and ADD from the command line:
228 * Passing the full key, separated bytes by ":"::
230 --cipher_key 00:11:22:33:44
232 * Passing the size, so key is generated randomly::
234 --cipher_key_random_size 16
237 If full key is passed (first method) and the size is passed as well (second method),
238 the latter will be ignored.
240 Size of these keys are checked (regardless the method), before starting the app,
241 to make sure that it is supported by the crypto devices.
243 Crypto device initialization
244 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
246 Once the encryption operation is defined, crypto devices are initialized.
247 The crypto devices must be either bound to a DPDK driver (if they are physical devices)
248 or created using the EAL option --vdev (if they are virtual devices),
249 when running the application.
251 The initialize_cryptodevs() function performs the device initialization.
252 It iterates through the list of the available crypto devices and
253 check which ones are capable of performing the operation.
254 Each device has a set of capabilities associated with it,
255 which are stored in the device info structure, so the function checks if the operation
256 is within the structure of each device.
258 The following code checks if the device supports the specified cipher algorithm
259 (similar for the authentication algorithm):
263 /* Check if device supports cipher algo */
265 opt_cipher_algo = options->cipher_xform.cipher.algo;
266 cap = &dev_info.capabilities[i];
267 while (cap->op != RTE_CRYPTO_OP_TYPE_UNDEFINED) {
268 cap_cipher_algo = cap->sym.cipher.algo;
269 if (cap->sym.xform_type ==
270 RTE_CRYPTO_SYM_XFORM_CIPHER) {
271 if (cap_cipher_algo == opt_cipher_algo) {
272 if (check_type(options, &dev_info) == 0)
276 cap = &dev_info.capabilities[++i];
279 If a capable crypto device is found, key sizes are checked to see if they are supported
280 (cipher key and IV for the ciphering):
285 * Check if length of provided cipher key is supported
286 * by the algorithm chosen.
288 if (options->ckey_param) {
289 if (check_supported_size(
290 options->cipher_xform.cipher.key.length,
291 cap->sym.cipher.key_size.min,
292 cap->sym.cipher.key_size.max,
293 cap->sym.cipher.key_size.increment)
295 printf("Unsupported cipher key length\n");
299 * Check if length of the cipher key to be randomly generated
300 * is supported by the algorithm chosen.
302 } else if (options->ckey_random_size != -1) {
303 if (check_supported_size(options->ckey_random_size,
304 cap->sym.cipher.key_size.min,
305 cap->sym.cipher.key_size.max,
306 cap->sym.cipher.key_size.increment)
308 printf("Unsupported cipher key length\n");
311 options->cipher_xform.cipher.key.length =
312 options->ckey_random_size;
313 /* No size provided, use minimum size. */
315 options->cipher_xform.cipher.key.length =
316 cap->sym.cipher.key_size.min;
318 After all the checks, the device is configured and it is added to the
322 The number of crypto devices that supports the specified crypto operation
323 must be at least the number of ports to be used.
328 The crypto operation has a crypto session associated to it, which contains
329 information such as the transform chain to perform (e.g. ciphering then hashing),
330 pointers to the keys, lengths... etc.
332 This session is created and is later attached to the crypto operation:
336 static struct rte_cryptodev_sym_session *
337 initialize_crypto_session(struct l2fwd_crypto_options *options,
340 struct rte_crypto_sym_xform *first_xform;
342 if (options->xform_chain == L2FWD_CRYPTO_CIPHER_HASH) {
343 first_xform = &options->cipher_xform;
344 first_xform->next = &options->auth_xform;
345 } else if (options->xform_chain == L2FWD_CRYPTO_HASH_CIPHER) {
346 first_xform = &options->auth_xform;
347 first_xform->next = &options->cipher_xform;
348 } else if (options->xform_chain == L2FWD_CRYPTO_CIPHER_ONLY) {
349 first_xform = &options->cipher_xform;
351 first_xform = &options->auth_xform;
354 /* Setup Cipher Parameters */
355 return rte_cryptodev_sym_session_create(cdev_id, first_xform);
360 port_cparams[i].session = initialize_crypto_session(options,
361 port_cparams[i].dev_id);
363 Crypto operation creation
364 ~~~~~~~~~~~~~~~~~~~~~~~~~
366 Given N packets received from a RX PORT, N crypto operations are allocated
373 * If we can't allocate a crypto_ops, then drop
374 * the rest of the burst and dequeue and
375 * process the packets to free offload structs
377 if (rte_crypto_op_bulk_alloc(
378 l2fwd_crypto_op_pool,
379 RTE_CRYPTO_OP_TYPE_SYMMETRIC,
382 for (j = 0; j < nb_rx; j++)
383 rte_pktmbuf_free(pkts_burst[i]);
388 After filling the crypto operation (including session attachment),
389 the mbuf which will be transformed is attached to it::
393 Since no destination mbuf is set, the source mbuf will be overwritten
394 after the operation is done (in-place).
396 Crypto operation enqueuing/dequeuing
397 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
399 Once the operation has been created, it has to be enqueued in one of the crypto devices.
400 Before doing so, for performance reasons, the operation stays in a buffer.
401 When the buffer has enough operations (MAX_PKT_BURST), they are enqueued in the device,
402 which will perform the operation at that moment:
407 l2fwd_crypto_enqueue(struct rte_crypto_op *op,
408 struct l2fwd_crypto_params *cparams)
410 unsigned lcore_id, len;
411 struct lcore_queue_conf *qconf;
413 lcore_id = rte_lcore_id();
415 qconf = &lcore_queue_conf[lcore_id];
416 len = qconf->op_buf[cparams->dev_id].len;
417 qconf->op_buf[cparams->dev_id].buffer[len] = op;
420 /* enough ops to be sent */
421 if (len == MAX_PKT_BURST) {
422 l2fwd_crypto_send_burst(qconf, MAX_PKT_BURST, cparams);
426 qconf->op_buf[cparams->dev_id].len = len;
433 l2fwd_crypto_send_burst(struct lcore_queue_conf *qconf, unsigned n,
434 struct l2fwd_crypto_params *cparams)
436 struct rte_crypto_op **op_buffer;
439 op_buffer = (struct rte_crypto_op **)
440 qconf->op_buf[cparams->dev_id].buffer;
442 ret = rte_cryptodev_enqueue_burst(cparams->dev_id,
443 cparams->qp_id, op_buffer, (uint16_t) n);
445 crypto_statistics[cparams->dev_id].enqueued += ret;
446 if (unlikely(ret < n)) {
447 crypto_statistics[cparams->dev_id].errors += (n - ret);
449 rte_pktmbuf_free(op_buffer[ret]->sym->m_src);
450 rte_crypto_op_free(op_buffer[ret]);
457 After this, the operations are dequeued from the device, and the transformed mbuf
458 is extracted from the operation. Then, the operation is freed and the mbuf is
459 forwarded as it is done in the L2 forwarding application.
463 /* Dequeue packets from Crypto device */
465 nb_rx = rte_cryptodev_dequeue_burst(
466 cparams->dev_id, cparams->qp_id,
467 ops_burst, MAX_PKT_BURST);
469 crypto_statistics[cparams->dev_id].dequeued +=
472 /* Forward crypto'd packets */
473 for (j = 0; j < nb_rx; j++) {
474 m = ops_burst[j]->sym->m_src;
476 rte_crypto_op_free(ops_burst[j]);
477 l2fwd_simple_forward(m, portid);
479 } while (nb_rx == MAX_PKT_BURST);