1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2016-2017 Intel Corporation.
4 IPsec Security Gateway Sample Application
5 =========================================
7 The IPsec Security Gateway application is an example of a "real world"
8 application using DPDK cryptodev framework.
13 The application demonstrates the implementation of a Security Gateway
14 (not IPsec compliant, see the Constraints section below) using DPDK based on RFC4301,
15 RFC4303, RFC3602 and RFC2404.
17 Internet Key Exchange (IKE) is not implemented, so only manual setting of
18 Security Policies and Security Associations is supported.
20 The Security Policies (SP) are implemented as ACL rules, the Security
21 Associations (SA) are stored in a table and the routing is implemented
24 The application classifies the ports as *Protected* and *Unprotected*.
25 Thus, traffic received on an Unprotected or Protected port is consider
26 Inbound or Outbound respectively.
28 The application also supports complete IPsec protocol offload to hardware
29 (Look aside crypto accelerator or using ethernet device). It also support
30 inline ipsec processing by the supported ethernet device during transmission.
31 These modes can be selected during the SA creation configuration.
33 In case of complete protocol offload, the processing of headers(ESP and outer
34 IP header) is done by the hardware and the application does not need to
35 add/remove them during outbound/inbound processing.
37 For inline offloaded outbound traffic, the application will not do the LPM
38 lookup for routing, as the port on which the packet has to be forwarded will be
39 part of the SA. Security parameters will be configured on that port only, and
40 sending the packet on other ports could result in unencrypted packets being
43 The Path for IPsec Inbound traffic is:
45 * Read packets from the port.
46 * Classify packets between IPv4 and ESP.
47 * Perform Inbound SA lookup for ESP packets based on their SPI.
48 * Perform Verification/Decryption (Not needed in case of inline ipsec).
49 * Remove ESP and outer IP header (Not needed in case of protocol offload).
50 * Inbound SP check using ACL of decrypted packets and any other IPv4 packets.
52 * Write packet to port.
54 The Path for the IPsec Outbound traffic is:
56 * Read packets from the port.
57 * Perform Outbound SP check using ACL of all IPv4 traffic.
58 * Perform Outbound SA lookup for packets that need IPsec protection.
59 * Add ESP and outer IP header (Not needed in case protocol offload).
60 * Perform Encryption/Digest (Not needed in case of inline ipsec).
62 * Write packet to port.
68 * No IPv6 options headers.
70 * Supported algorithms: AES-CBC, AES-CTR, AES-GCM, 3DES-CBC, HMAC-SHA1 and NULL.
71 * Each SA must be handle by a unique lcore (*1 RX queue per port*).
73 Compiling the Application
74 -------------------------
76 To compile the sample application see :doc:`compiling`.
78 The application is located in the ``ipsec-secgw`` sub-directory.
80 #. [Optional] Build the application for debugging:
81 This option adds some extra flags, disables compiler optimizations and
87 Running the Application
88 -----------------------
90 The application has a number of command line options::
93 ./build/ipsec-secgw [EAL options] --
94 -p PORTMASK -P -u PORTMASK -j FRAMESIZE
95 -l -w REPLAY_WINOW_SIZE -e -a
96 --config (port,queue,lcore)[,(port,queue,lcore]
106 * ``-p PORTMASK``: Hexadecimal bitmask of ports to configure.
108 * ``-P``: *optional*. Sets all ports to promiscuous mode so that packets are
109 accepted regardless of the packet's Ethernet MAC destination address.
110 Without this option, only packets with the Ethernet MAC destination address
111 set to the Ethernet address of the port are accepted (default is enabled).
113 * ``-u PORTMASK``: hexadecimal bitmask of unprotected ports
115 * ``-j FRAMESIZE``: *optional*. data buffer size (in bytes),
116 in other words maximum data size for one segment.
117 Packets with length bigger then FRAMESIZE still can be received,
118 but will be segmented.
119 Default value: RTE_MBUF_DEFAULT_BUF_SIZE (2176)
120 Minimum value: RTE_MBUF_DEFAULT_BUF_SIZE (2176)
121 Maximum value: UINT16_MAX (65535).
123 * ``-l``: enables code-path that uses librte_ipsec.
125 * ``-w REPLAY_WINOW_SIZE``: specifies the IPsec sequence number replay window
126 size for each Security Association (available only with librte_ipsec
129 * ``-e``: enables Security Association extended sequence number processing
130 (available only with librte_ipsec code path).
132 * ``-a``: enables Security Association sequence number atomic behavior
133 (available only with librte_ipsec code path).
135 * ``--config (port,queue,lcore)[,(port,queue,lcore)]``: determines which queues
136 from which ports are mapped to which cores.
138 * ``--single-sa SAIDX``: use a single SA for outbound traffic, bypassing the SP
139 on both Inbound and Outbound. This option is meant for debugging/performance
142 * ``--rxoffload MASK``: RX HW offload capabilities to enable/use on this port
143 (bitmask of DEV_RX_OFFLOAD_* values). It is an optional parameter and
144 allows user to disable some of the RX HW offload capabilities.
145 By default all HW RX offloads are enabled.
147 * ``--txoffload MASK``: TX HW offload capabilities to enable/use on this port
148 (bitmask of DEV_TX_OFFLOAD_* values). It is an optional parameter and
149 allows user to disable some of the TX HW offload capabilities.
150 By default all HW TX offloads are enabled.
152 * ``--mtu MTU``: MTU value (in bytes) on all attached ethernet ports.
153 Outgoing packets with length bigger then MTU will be fragmented.
154 Incoming packets with length bigger then MTU will be discarded.
157 * ``--reassemble NUM``: max number of entries in reassemble fragment table.
158 Zero value disables reassembly functionality.
161 * ``-f CONFIG_FILE_PATH``: the full path of text-based file containing all
162 configuration items for running the application (See Configuration file
163 syntax section below). ``-f CONFIG_FILE_PATH`` **must** be specified.
164 **ONLY** the UNIX format configuration file is accepted.
167 The mapping of lcores to port/queues is similar to other l3fwd applications.
169 For example, given the following command line::
171 ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
172 --vdev "crypto_null" -- -p 0xf -P -u 0x3 \
173 --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \
174 -f /path/to/config_file \
176 where each options means:
178 * The ``-l`` option enables cores 20 and 21.
180 * The ``-n`` option sets memory 4 channels.
182 * The ``--socket-mem`` to use 2GB on socket 1.
184 * The ``--vdev "crypto_null"`` option creates virtual NULL cryptodev PMD.
186 * The ``-p`` option enables ports (detected) 0, 1, 2 and 3.
188 * The ``-P`` option enables promiscuous mode.
190 * The ``-u`` option sets ports 1 and 2 as unprotected, leaving 2 and 3 as protected.
192 * The ``--config`` option enables one queue per port with the following mapping:
194 +----------+-----------+-----------+---------------------------------------+
195 | **Port** | **Queue** | **lcore** | **Description** |
197 +----------+-----------+-----------+---------------------------------------+
198 | 0 | 0 | 20 | Map queue 0 from port 0 to lcore 20. |
200 +----------+-----------+-----------+---------------------------------------+
201 | 1 | 0 | 20 | Map queue 0 from port 1 to lcore 20. |
203 +----------+-----------+-----------+---------------------------------------+
204 | 2 | 0 | 21 | Map queue 0 from port 2 to lcore 21. |
206 +----------+-----------+-----------+---------------------------------------+
207 | 3 | 0 | 21 | Map queue 0 from port 3 to lcore 21. |
209 +----------+-----------+-----------+---------------------------------------+
211 * The ``-f /path/to/config_file`` option enables the application read and
212 parse the configuration file specified, and configures the application
213 with a given set of SP, SA and Routing entries accordingly. The syntax of
214 the configuration file will be explained below in more detail. Please
215 **note** the parser only accepts UNIX format text file. Other formats
216 such as DOS/MAC format will cause a parse error.
218 Refer to the *DPDK Getting Started Guide* for general information on running
219 applications and the Environment Abstraction Layer (EAL) options.
221 The application would do a best effort to "map" crypto devices to cores, with
222 hardware devices having priority. Basically, hardware devices if present would
223 be assigned to a core before software ones.
224 This means that if the application is using a single core and both hardware
225 and software crypto devices are detected, hardware devices will be used.
227 A way to achieve the case where you want to force the use of virtual crypto
228 devices is to whitelist the Ethernet devices needed and therefore implicitly
229 blacklisting all hardware crypto devices.
231 For example, something like the following command line:
233 .. code-block:: console
235 ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
236 -w 81:00.0 -w 81:00.1 -w 81:00.2 -w 81:00.3 \
237 --vdev "crypto_aesni_mb" --vdev "crypto_null" \
239 -p 0xf -P -u 0x3 --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \
246 The following sections provide the syntax of configurations to initialize
247 your SP, SA, Routing and Neighbour tables.
248 Configurations shall be specified in the configuration file to be passed to
249 the application. The file is then parsed by the application. The successful
250 parsing will result in the appropriate rules being applied to the tables
254 Configuration File Syntax
255 ~~~~~~~~~~~~~~~~~~~~~~~~~
257 As mention in the overview, the Security Policies are ACL rules.
258 The application parsers the rules specified in the configuration file and
259 passes them to the ACL table, and replicates them per socket in use.
261 Following are the configuration file syntax.
266 The parse treats one line in the configuration file as one configuration
267 item (unless the line concatenation symbol exists). Every configuration
268 item shall follow the syntax of either SP, SA, Routing or Neighbour
269 rules specified below.
271 The configuration parser supports the following special symbols:
273 * Comment symbol **#**. Any character from this symbol to the end of
274 line is treated as comment and will not be parsed.
276 * Line concatenation symbol **\\**. This symbol shall be placed in the end
277 of the line to be concatenated to the line below. Multiple lines'
278 concatenation is supported.
284 The SP rule syntax is shown as follows:
286 .. code-block:: console
288 sp <ip_ver> <dir> esp <action> <priority> <src_ip> <dst_ip>
289 <proto> <sport> <dport>
292 where each options means:
296 * IP protocol version
302 * *ipv4*: IP protocol version 4
303 * *ipv6*: IP protocol version 6
307 * The traffic direction
313 * *in*: inbound traffic
314 * *out*: outbound traffic
324 * *protect <SA_idx>*: the specified traffic is protected by SA rule
326 * *bypass*: the specified traffic traffic is bypassed
327 * *discard*: the specified traffic is discarded
333 * Optional: Yes, default priority 0 will be used
339 * The source IP address and mask
341 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
345 * *src X.X.X.X/Y* for IPv4
346 * *src XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
350 * The destination IP address and mask
352 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
356 * *dst X.X.X.X/Y* for IPv4
357 * *dst XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
361 * The protocol start and end range
363 * Optional: yes, default range of 0 to 0 will be used
365 * Syntax: *proto X:Y*
369 * The source port start and end range
371 * Optional: yes, default range of 0 to 0 will be used
373 * Syntax: *sport X:Y*
377 * The destination port start and end range
379 * Optional: yes, default range of 0 to 0 will be used
381 * Syntax: *dport X:Y*
385 .. code-block:: console
387 sp ipv4 out esp protect 105 pri 1 dst 192.168.115.0/24 sport 0:65535 \
390 sp ipv6 in esp bypass pri 1 dst 0000:0000:0000:0000:5555:5555:\
391 0000:0000/96 sport 0:65535 dport 0:65535
397 The successfully parsed SA rules will be stored in an array table.
399 The SA rule syntax is shown as follows:
401 .. code-block:: console
403 sa <dir> <spi> <cipher_algo> <cipher_key> <auth_algo> <auth_key>
404 <mode> <src_ip> <dst_ip> <action_type> <port_id>
406 where each options means:
410 * The traffic direction
416 * *in*: inbound traffic
417 * *out*: outbound traffic
425 * Syntax: unsigned integer number
431 * Optional: Yes, unless <aead_algo> is not used
435 * *null*: NULL algorithm
436 * *aes-128-cbc*: AES-CBC 128-bit algorithm
437 * *aes-256-cbc*: AES-CBC 256-bit algorithm
438 * *aes-128-ctr*: AES-CTR 128-bit algorithm
439 * *3des-cbc*: 3DES-CBC 192-bit algorithm
441 * Syntax: *cipher_algo <your algorithm>*
445 * Cipher key, NOT available when 'null' algorithm is used
447 * Optional: Yes, unless <aead_algo> is not used.
448 Must be followed by <cipher_algo> option
450 * Syntax: Hexadecimal bytes (0x0-0xFF) concatenate by colon symbol ':'.
451 The number of bytes should be as same as the specified cipher algorithm
454 For example: *cipher_key A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:
459 * Authentication algorithm
461 * Optional: Yes, unless <aead_algo> is not used
465 * *null*: NULL algorithm
466 * *sha1-hmac*: HMAC SHA1 algorithm
470 * Authentication key, NOT available when 'null' or 'aes-128-gcm' algorithm
473 * Optional: Yes, unless <aead_algo> is not used.
474 Must be followed by <auth_algo> option
476 * Syntax: Hexadecimal bytes (0x0-0xFF) concatenate by colon symbol ':'.
477 The number of bytes should be as same as the specified authentication
480 For example: *auth_key A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:
487 * Optional: Yes, unless <cipher_algo> and <auth_algo> are not used
491 * *aes-128-gcm*: AES-GCM 128-bit algorithm
493 * Syntax: *cipher_algo <your algorithm>*
497 * Cipher key, NOT available when 'null' algorithm is used
499 * Optional: Yes, unless <cipher_algo> and <auth_algo> are not used.
500 Must be followed by <aead_algo> option
502 * Syntax: Hexadecimal bytes (0x0-0xFF) concatenate by colon symbol ':'.
503 The number of bytes should be as same as the specified AEAD algorithm
506 For example: *aead_key A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:
517 * *ipv4-tunnel*: Tunnel mode for IPv4 packets
518 * *ipv6-tunnel*: Tunnel mode for IPv6 packets
519 * *transport*: transport mode
525 * The source IP address. This option is not available when
526 transport mode is used
528 * Optional: Yes, default address 0.0.0.0 will be used
532 * *src X.X.X.X* for IPv4
533 * *src XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX* for IPv6
537 * The destination IP address. This option is not available when
538 transport mode is used
540 * Optional: Yes, default address 0.0.0.0 will be used
544 * *dst X.X.X.X* for IPv4
545 * *dst XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX* for IPv6
549 * Action type to specify the security action. This option specify
550 the SA to be performed with look aside protocol offload to HW
551 accelerator or protocol offload on ethernet device or inline
552 crypto processing on the ethernet device during transmission.
554 * Optional: Yes, default type *no-offload*
558 * *lookaside-protocol-offload*: look aside protocol offload to HW accelerator
559 * *inline-protocol-offload*: inline protocol offload on ethernet device
560 * *inline-crypto-offload*: inline crypto processing on ethernet device
561 * *no-offload*: no offloading to hardware
565 * Port/device ID of the ethernet/crypto accelerator for which the SA is
566 configured. For *inline-crypto-offload* and *inline-protocol-offload*, this
567 port will be used for routing. The routing table will not be referred in
570 * Optional: No, if *type* is not *no-offload*
574 * *port_id X* X is a valid device number in decimal
579 .. code-block:: console
581 sa out 5 cipher_algo null auth_algo null mode ipv4-tunnel \
582 src 172.16.1.5 dst 172.16.2.5
584 sa out 25 cipher_algo aes-128-cbc \
585 cipher_key c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3 \
586 auth_algo sha1-hmac \
587 auth_key c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3 \
589 src 1111:1111:1111:1111:1111:1111:1111:5555 \
590 dst 2222:2222:2222:2222:2222:2222:2222:5555
592 sa in 105 aead_algo aes-128-gcm \
593 aead_key de:ad:be:ef:de:ad:be:ef:de:ad:be:ef:de:ad:be:ef:de:ad:be:ef \
594 mode ipv4-tunnel src 172.16.2.5 dst 172.16.1.5
596 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 \
597 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 \
598 mode ipv4-tunnel src 172.16.1.5 dst 172.16.2.5 \
599 type lookaside-protocol-offload port_id 4
601 sa in 35 aead_algo aes-128-gcm \
602 aead_key de:ad:be:ef:de:ad:be:ef:de:ad:be:ef:de:ad:be:ef:de:ad:be:ef \
603 mode ipv4-tunnel src 172.16.2.5 dst 172.16.1.5 \
604 type inline-crypto-offload port_id 0
609 The Routing rule syntax is shown as follows:
611 .. code-block:: console
613 rt <ip_ver> <src_ip> <dst_ip> <port>
616 where each options means:
620 * IP protocol version
626 * *ipv4*: IP protocol version 4
627 * *ipv6*: IP protocol version 6
631 * The source IP address and mask
633 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
637 * *src X.X.X.X/Y* for IPv4
638 * *src XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
642 * The destination IP address and mask
644 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
648 * *dst X.X.X.X/Y* for IPv4
649 * *dst XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
653 * The traffic output port id
655 * Optional: yes, default output port 0 will be used
661 .. code-block:: console
663 rt ipv4 dst 172.16.1.5/32 port 0
665 rt ipv6 dst 1111:1111:1111:1111:1111:1111:1111:5555/116 port 0
667 Neighbour rule syntax
668 ^^^^^^^^^^^^^^^^^^^^^
670 The Neighbour rule syntax is shown as follows:
672 .. code-block:: console
674 neigh <port> <dst_mac>
677 where each options means:
689 * The destination ethernet address to use for that port
697 Example Neighbour rules:
699 .. code-block:: console
701 neigh port 0 DE:AD:BE:EF:01:02
706 The test directory contains scripts for testing the various encryption
709 The purpose of the scripts is to automate ipsec-secgw testing
710 using another system running linux as a DUT.
712 The user must setup the following environment variables:
714 * ``SGW_PATH``: path to the ipsec-secgw binary to test.
716 * ``REMOTE_HOST``: IP address/hostname of the DUT.
718 * ``REMOTE_IFACE``: interface name for the test-port on the DUT.
720 * ``ETH_DEV``: ethernet device to be used on the SUT by DPDK ('-w <pci-id>')
722 Also the user can optionally setup:
724 * ``SGW_LCORE``: lcore to run ipsec-secgw on (default value is 0)
726 * ``CRYPTO_DEV``: crypto device to be used ('-w <pci-id>'). If none specified
727 appropriate vdevs will be created by the script
729 Note that most of the tests require the appropriate crypto PMD/device to be
735 Two servers are required for the tests, SUT and DUT.
737 Make sure the user from the SUT can ssh to the DUT without entering the password.
738 To enable this feature keys must be setup on the DUT.
740 ``ssh-keygen`` will make a private & public key pair on the SUT.
742 ``ssh-copy-id`` <user name>@<target host name> on the SUT will copy the public
743 key to the DUT. It will ask for credentials so that it can upload the public key.
745 The SUT and DUT are connected through at least 2 NIC ports.
747 One NIC port is expected to be managed by linux on both machines and will be
748 used as a control path.
750 The second NIC port (test-port) should be bound to DPDK on the SUT, and should
751 be managed by linux on the DUT.
753 The script starts ``ipsec-secgw`` with 2 NIC devices: ``test-port`` and
756 It then configures the local tap interface and the remote interface and IPsec
757 policies in the following way:
759 Traffic going over the test-port in both directions has to be protected by IPsec.
761 Traffic going over the TAP port in both directions does not have to be protected.
765 DUT OS(NIC1)--(IPsec)-->(NIC1)ipsec-secgw(TAP)--(plain)-->(TAP)SUT OS
767 SUT OS(TAP)--(plain)-->(TAP)psec-secgw(NIC1)--(IPsec)-->(NIC1)DUT OS
769 It then tries to perform some data transfer using the scheme described above.
774 In the ipsec-secgw/test directory
776 to run one test for IPv4 or IPv6
778 /bin/bash linux_test(4|6).sh <ipsec_mode>
780 to run all tests for IPv4 or IPv6
782 /bin/bash run_test.sh -4|-6
784 For the list of available modes please refer to run_test.sh.