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 IPsec Security Gateway Sample Application
32 =========================================
34 The IPsec Security Gateway application is an example of a "real world"
35 application using DPDK cryptodev framework.
40 The application demonstrates the implementation of a Security Gateway
41 (not IPsec compliant, see the Constraints section below) using DPDK based on RFC4301,
42 RFC4303, RFC3602 and RFC2404.
44 Internet Key Exchange (IKE) is not implemented, so only manual setting of
45 Security Policies and Security Associations is supported.
47 The Security Policies (SP) are implemented as ACL rules, the Security
48 Associations (SA) are stored in a table and the routing is implemented
51 The application classifies the ports as *Protected* and *Unprotected*.
52 Thus, traffic received on an Unprotected or Protected port is consider
53 Inbound or Outbound respectively.
55 The application also supports complete IPSec protocol offload to hardware
56 (Look aside crypto accelarator or using ethernet device). It also support
57 inline ipsec processing by the supported ethernet device during transmission.
58 These modes can be selected during the SA creation configuration.
60 In case of complete protocol offload, the processing of headers(ESP and outer
61 IP header) is done by the hardware and the application does not need to
62 add/remove them during outbound/inbound processing.
64 The Path for IPsec Inbound traffic is:
66 * Read packets from the port.
67 * Classify packets between IPv4 and ESP.
68 * Perform Inbound SA lookup for ESP packets based on their SPI.
69 * Perform Verification/Decryption (Not needed in case of inline ipsec).
70 * Remove ESP and outer IP header (Not needed in case of protocol offload).
71 * Inbound SP check using ACL of decrypted packets and any other IPv4 packets.
73 * Write packet to port.
75 The Path for the IPsec Outbound traffic is:
77 * Read packets from the port.
78 * Perform Outbound SP check using ACL of all IPv4 traffic.
79 * Perform Outbound SA lookup for packets that need IPsec protection.
80 * Add ESP and outer IP header (Not needed in case protocol offload).
81 * Perform Encryption/Digest (Not needed in case of inline ipsec).
83 * Write packet to port.
89 * No IPv6 options headers.
91 * Supported algorithms: AES-CBC, AES-CTR, AES-GCM, HMAC-SHA1 and NULL.
92 * Each SA must be handle by a unique lcore (*1 RX queue per port*).
95 Compiling the Application
96 -------------------------
98 To compile the sample application see :doc:`compiling`.
100 The application is located in the ``rpsec-secgw`` sub-directory.
102 #. [Optional] Build the application for debugging:
103 This option adds some extra flags, disables compiler optimizations and
109 Running the Application
110 -----------------------
112 The application has a number of command line options::
115 ./build/ipsec-secgw [EAL options] --
116 -p PORTMASK -P -u PORTMASK -j FRAMESIZE
117 --config (port,queue,lcore)[,(port,queue,lcore]
123 * ``-p PORTMASK``: Hexadecimal bitmask of ports to configure.
125 * ``-P``: *optional*. Sets all ports to promiscuous mode so that packets are
126 accepted regardless of the packet's Ethernet MAC destination address.
127 Without this option, only packets with the Ethernet MAC destination address
128 set to the Ethernet address of the port are accepted (default is enabled).
130 * ``-u PORTMASK``: hexadecimal bitmask of unprotected ports
132 * ``-j FRAMESIZE``: *optional*. Enables jumbo frames with the maximum size
133 specified as FRAMESIZE. If an invalid value is provided as FRAMESIZE
134 then the default value 9000 is used.
136 * ``--config (port,queue,lcore)[,(port,queue,lcore)]``: determines which queues
137 from which ports are mapped to which cores.
139 * ``--single-sa SAIDX``: use a single SA for outbound traffic, bypassing the SP
140 on both Inbound and Outbound. This option is meant for debugging/performance
143 * ``-f CONFIG_FILE_PATH``: the full path of text-based file containing all
144 configuration items for running the application (See Configuration file
145 syntax section below). ``-f CONFIG_FILE_PATH`` **must** be specified.
146 **ONLY** the UNIX format configuration file is accepted.
149 The mapping of lcores to port/queues is similar to other l3fwd applications.
151 For example, given the following command line::
153 ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
154 --vdev "crypto_null" -- -p 0xf -P -u 0x3 \
155 --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \
156 -f /path/to/config_file \
158 where each options means:
160 * The ``-l`` option enables cores 20 and 21.
162 * The ``-n`` option sets memory 4 channels.
164 * The ``--socket-mem`` to use 2GB on socket 1.
166 * The ``--vdev "crypto_null"`` option creates virtual NULL cryptodev PMD.
168 * The ``-p`` option enables ports (detected) 0, 1, 2 and 3.
170 * The ``-P`` option enables promiscuous mode.
172 * The ``-u`` option sets ports 1 and 2 as unprotected, leaving 2 and 3 as protected.
174 * The ``--config`` option enables one queue per port with the following mapping:
176 +----------+-----------+-----------+---------------------------------------+
177 | **Port** | **Queue** | **lcore** | **Description** |
179 +----------+-----------+-----------+---------------------------------------+
180 | 0 | 0 | 20 | Map queue 0 from port 0 to lcore 20. |
182 +----------+-----------+-----------+---------------------------------------+
183 | 1 | 0 | 20 | Map queue 0 from port 1 to lcore 20. |
185 +----------+-----------+-----------+---------------------------------------+
186 | 2 | 0 | 21 | Map queue 0 from port 2 to lcore 21. |
188 +----------+-----------+-----------+---------------------------------------+
189 | 3 | 0 | 21 | Map queue 0 from port 3 to lcore 21. |
191 +----------+-----------+-----------+---------------------------------------+
193 * The ``-f /path/to/config_file`` option enables the application read and
194 parse the configuration file specified, and configures the application
195 with a given set of SP, SA and Routing entries accordingly. The syntax of
196 the configuration file will be explained below in more detail. Please
197 **note** the parser only accepts UNIX format text file. Other formats
198 such as DOS/MAC format will cause a parse error.
200 Refer to the *DPDK Getting Started Guide* for general information on running
201 applications and the Environment Abstraction Layer (EAL) options.
203 The application would do a best effort to "map" crypto devices to cores, with
204 hardware devices having priority. Basically, hardware devices if present would
205 be assigned to a core before software ones.
206 This means that if the application is using a single core and both hardware
207 and software crypto devices are detected, hardware devices will be used.
209 A way to achieve the case where you want to force the use of virtual crypto
210 devices is to whitelist the Ethernet devices needed and therefore implicitly
211 blacklisting all hardware crypto devices.
213 For example, something like the following command line:
215 .. code-block:: console
217 ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
218 -w 81:00.0 -w 81:00.1 -w 81:00.2 -w 81:00.3 \
219 --vdev "crypto_aesni_mb" --vdev "crypto_null" \
221 -p 0xf -P -u 0x3 --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \
228 The following sections provide the syntax of configurations to initialize
229 your SP, SA and Routing tables.
230 Configurations shall be specified in the configuration file to be passed to
231 the application. The file is then parsed by the application. The successful
232 parsing will result in the appropriate rules being applied to the tables
236 Configuration File Syntax
237 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
239 As mention in the overview, the Security Policies are ACL rules.
240 The application parsers the rules specified in the configuration file and
241 passes them to the ACL table, and replicates them per socket in use.
243 Following are the configuration file syntax.
248 The parse treats one line in the configuration file as one configuration
249 item (unless the line concatenation symbol exists). Every configuration
250 item shall follow the syntax of either SP, SA, or Routing rules specified
253 The configuration parser supports the following special symbols:
255 * Comment symbol **#**. Any character from this symbol to the end of
256 line is treated as comment and will not be parsed.
258 * Line concatenation symbol **\\**. This symbol shall be placed in the end
259 of the line to be concatenated to the line below. Multiple lines'
260 concatenation is supported.
266 The SP rule syntax is shown as follows:
268 .. code-block:: console
270 sp <ip_ver> <dir> esp <action> <priority> <src_ip> <dst_ip>
271 <proto> <sport> <dport>
274 where each options means:
278 * IP protocol version
284 * *ipv4*: IP protocol version 4
285 * *ipv6*: IP protocol version 6
289 * The traffic direction
295 * *in*: inbound traffic
296 * *out*: outbound traffic
306 * *protect <SA_idx>*: the specified traffic is protected by SA rule
308 * *bypass*: the specified traffic traffic is bypassed
309 * *discard*: the specified traffic is discarded
315 * Optional: Yes, default priority 0 will be used
321 * The source IP address and mask
323 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
327 * *src X.X.X.X/Y* for IPv4
328 * *src XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
332 * The destination IP address and mask
334 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
338 * *dst X.X.X.X/Y* for IPv4
339 * *dst XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
343 * The protocol start and end range
345 * Optional: yes, default range of 0 to 0 will be used
347 * Syntax: *proto X:Y*
351 * The source port start and end range
353 * Optional: yes, default range of 0 to 0 will be used
355 * Syntax: *sport X:Y*
359 * The destination port start and end range
361 * Optional: yes, default range of 0 to 0 will be used
363 * Syntax: *dport X:Y*
367 .. code-block:: console
369 sp ipv4 out esp protect 105 pri 1 dst 192.168.115.0/24 sport 0:65535 \
372 sp ipv6 in esp bypass pri 1 dst 0000:0000:0000:0000:5555:5555:\
373 0000:0000/96 sport 0:65535 dport 0:65535
379 The successfully parsed SA rules will be stored in an array table.
381 The SA rule syntax is shown as follows:
383 .. code-block:: console
385 sa <dir> <spi> <cipher_algo> <cipher_key> <auth_algo> <auth_key>
386 <mode> <src_ip> <dst_ip> <action_type> <port_id>
388 where each options means:
392 * The traffic direction
398 * *in*: inbound traffic
399 * *out*: outbound traffic
407 * Syntax: unsigned integer number
413 * Optional: Yes, unless <aead_algo> is not used
417 * *null*: NULL algorithm
418 * *aes-128-cbc*: AES-CBC 128-bit algorithm
419 * *aes-128-ctr*: AES-CTR 128-bit algorithm
421 * Syntax: *cipher_algo <your algorithm>*
425 * Cipher key, NOT available when 'null' algorithm is used
427 * Optional: Yes, unless <aead_algo> is not used.
428 Must be followed by <cipher_algo> option
430 * Syntax: Hexadecimal bytes (0x0-0xFF) concatenate by colon symbol ':'.
431 The number of bytes should be as same as the specified cipher algorithm
434 For example: *cipher_key A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:
439 * Authentication algorithm
441 * Optional: Yes, unless <aead_algo> is not used
445 * *null*: NULL algorithm
446 * *sha1-hmac*: HMAC SHA1 algorithm
450 * Authentication key, NOT available when 'null' or 'aes-128-gcm' algorithm
453 * Optional: Yes, unless <aead_algo> is not used.
454 Must be followed by <auth_algo> option
456 * Syntax: Hexadecimal bytes (0x0-0xFF) concatenate by colon symbol ':'.
457 The number of bytes should be as same as the specified authentication
460 For example: *auth_key A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:
467 * Optional: Yes, unless <cipher_algo> and <auth_algo> are not used
471 * *aes-128-gcm*: AES-GCM 128-bit algorithm
473 * Syntax: *cipher_algo <your algorithm>*
477 * Cipher key, NOT available when 'null' algorithm is used
479 * Optional: Yes, unless <cipher_algo> and <auth_algo> are not used.
480 Must be followed by <aead_algo> option
482 * Syntax: Hexadecimal bytes (0x0-0xFF) concatenate by colon symbol ':'.
483 The number of bytes should be as same as the specified AEAD algorithm
486 For example: *aead_key A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:
497 * *ipv4-tunnel*: Tunnel mode for IPv4 packets
498 * *ipv6-tunnel*: Tunnel mode for IPv6 packets
499 * *transport*: transport mode
505 * The source IP address. This option is not available when
506 transport mode is used
508 * Optional: Yes, default address 0.0.0.0 will be used
512 * *src X.X.X.X* for IPv4
513 * *src XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX* for IPv6
517 * The destination IP address. This option is not available when
518 transport mode is used
520 * Optional: Yes, default address 0.0.0.0 will be used
524 * *dst X.X.X.X* for IPv4
525 * *dst XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX* for IPv6
529 * Action type to specify the security action. This option specify
530 the SA to be performed with look aside protocol offload to HW
531 accelerator or protocol offload on ethernet device or inline
532 crypto processing on the ethernet device during transmission.
534 * Optional: Yes, default type *no-offload*
538 * *lookaside-protocol-offload*: look aside protocol offload to HW accelerator
539 * *inline-protocol-offload*: inline protocol offload on ethernet device
540 * *inline-crypto-offload*: inline crypto processing on ethernet device
541 * *no-offload*: no offloading to hardware
545 * Port/device ID of the ethernet/crypto accelerator for which the SA is
546 configured. This option is used when *type* is NOT *no-offload*
548 * Optional: No, if *type* is not *no-offload*
552 * *port_id X* X is a valid device number in decimal
557 .. code-block:: console
559 sa out 5 cipher_algo null auth_algo null mode ipv4-tunnel \
560 src 172.16.1.5 dst 172.16.2.5
562 sa out 25 cipher_algo aes-128-cbc \
563 cipher_key c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3 \
564 auth_algo sha1-hmac \
565 auth_key c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3 \
567 src 1111:1111:1111:1111:1111:1111:1111:5555 \
568 dst 2222:2222:2222:2222:2222:2222:2222:5555
570 sa in 105 aead_algo aes-128-gcm \
571 aead_key de:ad:be:ef:de:ad:be:ef:de:ad:be:ef:de:ad:be:ef:de:ad:be:ef \
572 mode ipv4-tunnel src 172.16.2.5 dst 172.16.1.5
574 sa out 5 cipher_algo aes-128-cbc cipher_key 0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0 \
575 auth_algo sha1-hmac auth_key 0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0:0 \
576 mode ipv4-tunnel src 172.16.1.5 dst 172.16.2.5 \
577 type lookaside-protocol-offload port_id 4
582 The Routing rule syntax is shown as follows:
584 .. code-block:: console
586 rt <ip_ver> <src_ip> <dst_ip> <port>
589 where each options means:
593 * IP protocol version
599 * *ipv4*: IP protocol version 4
600 * *ipv6*: IP protocol version 6
604 * The source IP address and mask
606 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
610 * *src X.X.X.X/Y* for IPv4
611 * *src XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
615 * The destination IP address and mask
617 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
621 * *dst X.X.X.X/Y* for IPv4
622 * *dst XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
626 * The traffic output port id
628 * Optional: yes, default output port 0 will be used
634 .. code-block:: console
636 rt ipv4 dst 172.16.1.5/32 port 0
638 rt ipv6 dst 1111:1111:1111:1111:1111:1111:1111:5555/116 port 0