1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2016-2017 Intel Corporation.
3 Copyright (C) 2020 Marvell International Ltd.
5 IPsec Security Gateway Sample Application
6 =========================================
8 The IPsec Security Gateway application is an example of a "real world"
9 application using DPDK cryptodev framework.
14 The application demonstrates the implementation of a Security Gateway
15 (not IPsec compliant, see the Constraints section below) using DPDK based on RFC4301,
16 RFC4303, RFC3602 and RFC2404.
18 Internet Key Exchange (IKE) is not implemented, so only manual setting of
19 Security Policies and Security Associations is supported.
21 The Security Policies (SP) are implemented as ACL rules, the Security
22 Associations (SA) are stored in a table and the routing is implemented
25 The application classifies the ports as *Protected* and *Unprotected*.
26 Thus, traffic received on an Unprotected or Protected port is consider
27 Inbound or Outbound respectively.
29 The application also supports complete IPsec protocol offload to hardware
30 (Look aside crypto accelerator or using ethernet device). It also support
31 inline ipsec processing by the supported ethernet device during transmission.
32 These modes can be selected during the SA creation configuration.
34 In case of complete protocol offload, the processing of headers(ESP and outer
35 IP header) is done by the hardware and the application does not need to
36 add/remove them during outbound/inbound processing.
38 For inline offloaded outbound traffic, the application will not do the LPM
39 lookup for routing, as the port on which the packet has to be forwarded will be
40 part of the SA. Security parameters will be configured on that port only, and
41 sending the packet on other ports could result in unencrypted packets being
44 The Path for IPsec Inbound traffic is:
46 * Read packets from the port.
47 * Classify packets between IPv4 and ESP.
48 * Perform Inbound SA lookup for ESP packets based on their SPI.
49 * Perform Verification/Decryption (Not needed in case of inline ipsec).
50 * Remove ESP and outer IP header (Not needed in case of protocol offload).
51 * Inbound SP check using ACL of decrypted packets and any other IPv4 packets.
53 * Write packet to port.
55 The Path for the IPsec Outbound traffic is:
57 * Read packets from the port.
58 * Perform Outbound SP check using ACL of all IPv4 traffic.
59 * Perform Outbound SA lookup for packets that need IPsec protection.
60 * Add ESP and outer IP header (Not needed in case protocol offload).
61 * Perform Encryption/Digest (Not needed in case of inline ipsec).
63 * Write packet to port.
65 The application supports two modes of operation: poll mode and event mode.
67 * In the poll mode a core receives packets from statically configured list
68 of eth ports and eth ports' queues.
70 * In the event mode a core receives packets as events. After packet processing
71 is done core submits them back as events to an event device. This enables
72 multicore scaling and HW assisted scheduling by making use of the event device
73 capabilities. The event mode configuration is predefined. All packets reaching
74 given eth port will arrive at the same event queue. All event queues are mapped
75 to all event ports. This allows all cores to receive traffic from all ports.
76 Since the underlying event device might have varying capabilities, the worker
77 threads can be drafted differently to maximize performance. For example, if an
78 event device - eth device pair has Tx internal port, then application can call
79 rte_event_eth_tx_adapter_enqueue() instead of regular rte_event_enqueue_burst().
80 So a thread which assumes that the device pair has internal port will not be the
81 right solution for another pair. The infrastructure added for the event mode aims
82 to help application to have multiple worker threads by maximizing performance from
83 every type of event device without affecting existing paths/use cases. The worker
84 to be used will be determined by the operating conditions and the underlying device
85 capabilities. **Currently the application provides non-burst, internal port worker
86 threads and supports inline protocol only.** It also provides infrastructure for
87 non-internal port however does not define any worker threads.
89 Additionally the event mode introduces two submodes of processing packets:
91 * Driver submode: This submode has bare minimum changes in the application to support
92 IPsec. There are no lookups, no routing done in the application. And for inline
93 protocol use case, the worker thread resembles l2fwd worker thread as the IPsec
94 processing is done entirely in HW. This mode can be used to benchmark the raw
95 performance of the HW. The driver submode is selected with --single-sa option
96 (used also by poll mode). When --single-sa option is used in conjunction with event
97 mode then index passed to --single-sa is ignored.
99 * App submode: This submode has all the features currently implemented with the
100 application (non librte_ipsec path). All the lookups, routing follows existing
101 methods and report numbers that can be compared against regular poll mode
107 * No IPv6 options headers.
109 * Supported algorithms: AES-CBC, AES-CTR, AES-GCM, 3DES-CBC, HMAC-SHA1 and NULL.
110 * Each SA must be handle by a unique lcore (*1 RX queue per port*).
112 Compiling the Application
113 -------------------------
115 To compile the sample application see :doc:`compiling`.
117 The application is located in the ``ipsec-secgw`` sub-directory.
120 Running the Application
121 -----------------------
123 The application has a number of command line options::
126 ./<build_dir>/examples/dpdk-ipsec-secgw [EAL options] --
127 -p PORTMASK -P -u PORTMASK -j FRAMESIZE
128 -l -w REPLAY_WINDOW_SIZE -e -a
130 -t STATISTICS_INTERVAL
131 -s NUMBER_OF_MBUFS_IN_PACKET_POOL
133 --config (port,queue,lcore)[,(port,queue,lcore)]
135 --cryptodev_mask MASK
137 --event-schedule-type TYPE
142 --frag-ttl FRAG_TTL_NS
146 * ``-p PORTMASK``: Hexadecimal bitmask of ports to configure.
148 * ``-P``: *optional*. Sets all ports to promiscuous mode so that packets are
149 accepted regardless of the packet's Ethernet MAC destination address.
150 Without this option, only packets with the Ethernet MAC destination address
151 set to the Ethernet address of the port are accepted (default is enabled).
153 * ``-u PORTMASK``: hexadecimal bitmask of unprotected ports
155 * ``-j FRAMESIZE``: *optional*. data buffer size (in bytes),
156 in other words maximum data size for one segment.
157 Packets with length bigger then FRAMESIZE still can be received,
158 but will be segmented.
159 Default value: RTE_MBUF_DEFAULT_BUF_SIZE (2176)
160 Minimum value: RTE_MBUF_DEFAULT_BUF_SIZE (2176)
161 Maximum value: UINT16_MAX (65535).
163 * ``-l``: enables code-path that uses librte_ipsec.
165 * ``-w REPLAY_WINDOW_SIZE``: specifies the IPsec sequence number replay window
166 size for each Security Association (available only with librte_ipsec
169 * ``-e``: enables Security Association extended sequence number processing
170 (available only with librte_ipsec code path).
172 * ``-a``: enables Security Association sequence number atomic behavior
173 (available only with librte_ipsec code path).
175 * ``-c``: specifies the SAD cache size. Stores the most recent SA in a per
176 lcore cache. Cache represents flat array containing SA's indexed by SPI.
177 Zero value disables cache.
180 * ``-t``: specifies the statistics screen update interval in seconds. If set
181 to zero or omitted statistics screen is disabled.
184 * ``-s``: sets number of mbufs in packet pool, if not provided number of mbufs
185 will be calculated based on number of cores, eth ports and crypto queues.
187 * ``-f CONFIG_FILE_PATH``: the full path of text-based file containing all
188 configuration items for running the application (See Configuration file
189 syntax section below). ``-f CONFIG_FILE_PATH`` **must** be specified.
190 **ONLY** the UNIX format configuration file is accepted.
192 * ``--config (port,queue,lcore)[,(port,queue,lcore)]``: in poll mode determines
193 which queues from which ports are mapped to which cores. In event mode this
194 option is not used as packets are dynamically scheduled to cores by HW.
196 * ``--single-sa SAIDX``: in poll mode use a single SA for outbound traffic,
197 bypassing the SP on both Inbound and Outbound. This option is meant for
198 debugging/performance purposes. In event mode selects driver submode, SA index
201 * ``--cryptodev_mask MASK``: hexadecimal bitmask of the crypto devices
204 * ``--transfer-mode MODE``: sets operating mode of the application
205 "poll" : packet transfer via polling (default)
206 "event" : Packet transfer via event device
208 * ``--event-schedule-type TYPE``: queue schedule type, applies only when
209 --transfer-mode is set to event.
210 "ordered" : Ordered (default)
212 "parallel" : Parallel
213 When --event-schedule-type is set as RTE_SCHED_TYPE_ORDERED/ATOMIC, event
214 device will ensure the ordering. Ordering will be lost when tried in PARALLEL.
216 * ``--rxoffload MASK``: RX HW offload capabilities to enable/use on this port
217 (bitmask of RTE_ETH_RX_OFFLOAD_* values). It is an optional parameter and
218 allows user to disable some of the RX HW offload capabilities.
219 By default all HW RX offloads are enabled.
221 * ``--txoffload MASK``: TX HW offload capabilities to enable/use on this port
222 (bitmask of RTE_ETH_TX_OFFLOAD_* values). It is an optional parameter and
223 allows user to disable some of the TX HW offload capabilities.
224 By default all HW TX offloads are enabled.
226 * ``--reassemble NUM``: max number of entries in reassemble fragment table.
227 Zero value disables reassembly functionality.
230 * ``--mtu MTU``: MTU value (in bytes) on all attached ethernet ports.
231 Outgoing packets with length bigger then MTU will be fragmented.
232 Incoming packets with length bigger then MTU will be discarded.
235 * ``--frag-ttl FRAG_TTL_NS``: fragment lifetime (in nanoseconds).
236 If packet is not reassembled within this time, received fragments
237 will be discarded. Fragment lifetime should be decreased when
238 there is a high fragmented traffic loss in high bandwidth networks.
239 Should be lower for low number of reassembly buckets.
240 Valid values: from 1 ns to 10 s. Default value: 10000000 (10 s).
243 The mapping of lcores to port/queues is similar to other l3fwd applications.
245 For example, given the following command line to run application in poll mode::
247 ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
248 --vdev "crypto_null" -- -p 0xf -P -u 0x3 \
249 --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \
250 -f /path/to/config_file --transfer-mode poll \
252 where each option means:
254 * The ``-l`` option enables cores 20 and 21.
256 * The ``-n`` option sets memory 4 channels.
258 * The ``--socket-mem`` to use 2GB on socket 1.
260 * The ``--vdev "crypto_null"`` option creates virtual NULL cryptodev PMD.
262 * The ``-p`` option enables ports (detected) 0, 1, 2 and 3.
264 * The ``-P`` option enables promiscuous mode.
266 * The ``-u`` option sets ports 0 and 1 as unprotected, leaving 2 and 3 as protected.
268 * The ``--config`` option enables one queue per port with the following mapping:
270 +----------+-----------+-----------+---------------------------------------+
271 | **Port** | **Queue** | **lcore** | **Description** |
273 +----------+-----------+-----------+---------------------------------------+
274 | 0 | 0 | 20 | Map queue 0 from port 0 to lcore 20. |
276 +----------+-----------+-----------+---------------------------------------+
277 | 1 | 0 | 20 | Map queue 0 from port 1 to lcore 20. |
279 +----------+-----------+-----------+---------------------------------------+
280 | 2 | 0 | 21 | Map queue 0 from port 2 to lcore 21. |
282 +----------+-----------+-----------+---------------------------------------+
283 | 3 | 0 | 21 | Map queue 0 from port 3 to lcore 21. |
285 +----------+-----------+-----------+---------------------------------------+
287 * The ``-f /path/to/config_file`` option enables the application read and
288 parse the configuration file specified, and configures the application
289 with a given set of SP, SA and Routing entries accordingly. The syntax of
290 the configuration file will be explained below in more detail. Please
291 **note** the parser only accepts UNIX format text file. Other formats
292 such as DOS/MAC format will cause a parse error.
294 * The ``--transfer-mode`` option selects poll mode for processing packets.
296 Similarly for example, given the following command line to run application in
299 ./<build_dir>/examples/dpdk-ipsec-secgw -c 0x3 -- -P -p 0x3 -u 0x1 \
300 -f /path/to/config_file --transfer-mode event \
301 --event-schedule-type parallel \
303 where each option means:
305 * The ``-c`` option selects cores 0 and 1 to run on.
307 * The ``-P`` option enables promiscuous mode.
309 * The ``-p`` option enables ports (detected) 0 and 1.
311 * The ``-u`` option sets ports 0 as unprotected, leaving 1 as protected.
313 * The ``-f /path/to/config_file`` option has the same behavior as in poll
316 * The ``--transfer-mode`` option selects event mode for processing packets.
318 * The ``--event-schedule-type`` option selects parallel ordering of event queues.
321 Refer to the *DPDK Getting Started Guide* for general information on running
322 applications and the Environment Abstraction Layer (EAL) options.
324 The application would do a best effort to "map" crypto devices to cores, with
325 hardware devices having priority. Basically, hardware devices if present would
326 be assigned to a core before software ones.
327 This means that if the application is using a single core and both hardware
328 and software crypto devices are detected, hardware devices will be used.
330 A way to achieve the case where you want to force the use of virtual crypto
331 devices is to only use the Ethernet devices needed (via the allow flag)
332 and therefore implicitly blocking all hardware crypto devices.
334 For example, something like the following command line:
336 .. code-block:: console
338 ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
339 -a 81:00.0 -a 81:00.1 -a 81:00.2 -a 81:00.3 \
340 --vdev "crypto_aesni_mb" --vdev "crypto_null" \
342 -p 0xf -P -u 0x3 --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)" \
349 The following sections provide the syntax of configurations to initialize
350 your SP, SA, Routing, Flow and Neighbour tables.
351 Configurations shall be specified in the configuration file to be passed to
352 the application. The file is then parsed by the application. The successful
353 parsing will result in the appropriate rules being applied to the tables
357 Configuration File Syntax
358 ~~~~~~~~~~~~~~~~~~~~~~~~~
360 As mention in the overview, the Security Policies are ACL rules.
361 The application parsers the rules specified in the configuration file and
362 passes them to the ACL table, and replicates them per socket in use.
364 Following are the configuration file syntax.
369 The parse treats one line in the configuration file as one configuration
370 item (unless the line concatenation symbol exists). Every configuration
371 item shall follow the syntax of either SP, SA, Routing, Flow or Neighbour
372 rules specified below.
374 The configuration parser supports the following special symbols:
376 * Comment symbol **#**. Any character from this symbol to the end of
377 line is treated as comment and will not be parsed.
379 * Line concatenation symbol **\\**. This symbol shall be placed in the end
380 of the line to be concatenated to the line below. Multiple lines'
381 concatenation is supported.
387 The SP rule syntax is shown as follows:
389 .. code-block:: console
391 sp <ip_ver> <dir> esp <action> <priority> <src_ip> <dst_ip>
392 <proto> <sport> <dport>
395 where each options means:
399 * IP protocol version
405 * *ipv4*: IP protocol version 4
406 * *ipv6*: IP protocol version 6
410 * The traffic direction
416 * *in*: inbound traffic
417 * *out*: outbound traffic
427 * *protect <SA_idx>*: the specified traffic is protected by SA rule
429 * *bypass*: the specified traffic traffic is bypassed
430 * *discard*: the specified traffic is discarded
436 * Optional: Yes, default priority 0 will be used
442 * The source IP address and mask
444 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
448 * *src X.X.X.X/Y* for IPv4
449 * *src XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
453 * The destination IP address and mask
455 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
459 * *dst X.X.X.X/Y* for IPv4
460 * *dst XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
464 * The protocol start and end range
466 * Optional: yes, default range of 0 to 0 will be used
468 * Syntax: *proto X:Y*
472 * The source port start and end range
474 * Optional: yes, default range of 0 to 0 will be used
476 * Syntax: *sport X:Y*
480 * The destination port start and end range
482 * Optional: yes, default range of 0 to 0 will be used
484 * Syntax: *dport X:Y*
488 .. code-block:: console
490 sp ipv4 out esp protect 105 pri 1 dst 192.168.115.0/24 sport 0:65535 \
493 sp ipv6 in esp bypass pri 1 dst 0000:0000:0000:0000:5555:5555:\
494 0000:0000/96 sport 0:65535 dport 0:65535
500 The successfully parsed SA rules will be stored in an array table.
502 The SA rule syntax is shown as follows:
504 .. code-block:: console
506 sa <dir> <spi> <cipher_algo> <cipher_key> <auth_algo> <auth_key>
507 <mode> <src_ip> <dst_ip> <action_type> <port_id> <fallback>
508 <flow-direction> <port_id> <queue_id> <udp-encap>
510 where each options means:
514 * The traffic direction
520 * *in*: inbound traffic
521 * *out*: outbound traffic
529 * Syntax: unsigned integer number
535 * Optional: Yes, unless <aead_algo> is not used
539 * *null*: NULL algorithm
540 * *aes-128-cbc*: AES-CBC 128-bit algorithm
541 * *aes-192-cbc*: AES-CBC 192-bit algorithm
542 * *aes-256-cbc*: AES-CBC 256-bit algorithm
543 * *aes-128-ctr*: AES-CTR 128-bit algorithm
544 * *3des-cbc*: 3DES-CBC 192-bit algorithm
546 * Syntax: *cipher_algo <your algorithm>*
550 * Cipher key, NOT available when 'null' algorithm is used
552 * Optional: Yes, unless <aead_algo> is not used.
553 Must be followed by <cipher_algo> option
555 * Syntax: Hexadecimal bytes (0x0-0xFF) concatenate by colon symbol ':'.
556 The number of bytes should be as same as the specified cipher algorithm
559 For example: *cipher_key A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:
564 * Authentication algorithm
566 * Optional: Yes, unless <aead_algo> is not used
570 * *null*: NULL algorithm
571 * *sha1-hmac*: HMAC SHA1 algorithm
575 * Authentication key, NOT available when 'null' or 'aes-128-gcm' algorithm
578 * Optional: Yes, unless <aead_algo> is not used.
579 Must be followed by <auth_algo> option
581 * Syntax: Hexadecimal bytes (0x0-0xFF) concatenate by colon symbol ':'.
582 The number of bytes should be as same as the specified authentication
585 For example: *auth_key A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:
592 * Optional: Yes, unless <cipher_algo> and <auth_algo> are not used
596 * *aes-128-gcm*: AES-GCM 128-bit algorithm
597 * *aes-192-gcm*: AES-GCM 192-bit algorithm
598 * *aes-256-gcm*: AES-GCM 256-bit algorithm
600 * Syntax: *cipher_algo <your algorithm>*
604 * Cipher key, NOT available when 'null' algorithm is used
606 * Optional: Yes, unless <cipher_algo> and <auth_algo> are not used.
607 Must be followed by <aead_algo> option
609 * Syntax: Hexadecimal bytes (0x0-0xFF) concatenate by colon symbol ':'.
610 Last 4 bytes of the provided key will be used as 'salt' and so, the
611 number of bytes should be same as the sum of specified AEAD algorithm
612 key size and salt size (4 bytes).
614 For example: *aead_key A1:B2:C3:D4:A1:B2:C3:D4:A1:B2:C3:D4:
615 A1:B2:C3:D4:A1:B2:C3:D4*
625 * *ipv4-tunnel*: Tunnel mode for IPv4 packets
626 * *ipv6-tunnel*: Tunnel mode for IPv6 packets
627 * *transport*: transport mode
633 * The source IP address. This option is not available when
634 transport mode is used
636 * Optional: Yes, default address 0.0.0.0 will be used
640 * *src X.X.X.X* for IPv4
641 * *src XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX* for IPv6
645 * The destination IP address. This option is not available when
646 transport mode is used
648 * Optional: Yes, default address 0.0.0.0 will be used
652 * *dst X.X.X.X* for IPv4
653 * *dst XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX* for IPv6
657 * Action type to specify the security action. This option specify
658 the SA to be performed with look aside protocol offload to HW
659 accelerator or protocol offload on ethernet device or inline
660 crypto processing on the ethernet device during transmission.
662 * Optional: Yes, default type *no-offload*
666 * *lookaside-protocol-offload*: look aside protocol offload to HW accelerator
667 * *inline-protocol-offload*: inline protocol offload on ethernet device
668 * *inline-crypto-offload*: inline crypto processing on ethernet device
669 * *no-offload*: no offloading to hardware
673 * Port/device ID of the ethernet/crypto accelerator for which the SA is
674 configured. For *inline-crypto-offload* and *inline-protocol-offload*, this
675 port will be used for routing. The routing table will not be referred in
678 * Optional: No, if *type* is not *no-offload*
682 * *port_id X* X is a valid device number in decimal
686 * Action type for ingress IPsec packets that inline processor failed to
687 process. Only a combination of *inline-crypto-offload* as a primary
688 session and *lookaside-none* as a fall-back session is supported at the
691 If used in conjunction with IPsec window, its width needs be increased
692 due to different processing times of inline and lookaside modes which
693 results in packet reordering.
699 * *lookaside-none*: use automatically chosen cryptodev to process packets
703 * *fallback lookaside-none*
707 * Option for redirecting a specific inbound ipsec flow of a port to a specific
714 * *port_id*: Port ID of the NIC for which the SA is configured.
715 * *queue_id*: Queue ID to which traffic should be redirected.
719 * Option to enable IPsec UDP encapsulation for NAT Traversal.
720 Only *lookaside-protocol-offload* mode is supported at the moment.
722 * Optional: Yes, it is disabled by default
730 * Maximum segment size for TSO offload, available for egress SAs only.
732 * Optional: Yes, TSO offload not set by default
736 * *mss N* N is the segment size in bytes
741 .. code-block:: console
743 sa out 5 cipher_algo null auth_algo null mode ipv4-tunnel \
744 src 172.16.1.5 dst 172.16.2.5
746 sa out 25 cipher_algo aes-128-cbc \
747 cipher_key c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3 \
748 auth_algo sha1-hmac \
749 auth_key c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3:c3 \
751 src 1111:1111:1111:1111:1111:1111:1111:5555 \
752 dst 2222:2222:2222:2222:2222:2222:2222:5555
754 sa in 105 aead_algo aes-128-gcm \
755 aead_key de:ad:be:ef:de:ad:be:ef:de:ad:be:ef:de:ad:be:ef:de:ad:be:ef \
756 mode ipv4-tunnel src 172.16.2.5 dst 172.16.1.5
758 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 \
759 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 \
760 mode ipv4-tunnel src 172.16.1.5 dst 172.16.2.5 \
761 type lookaside-protocol-offload port_id 4
763 sa in 35 aead_algo aes-128-gcm \
764 aead_key de:ad:be:ef:de:ad:be:ef:de:ad:be:ef:de:ad:be:ef:de:ad:be:ef \
765 mode ipv4-tunnel src 172.16.2.5 dst 172.16.1.5 \
766 type inline-crypto-offload port_id 0
768 sa in 117 cipher_algo null auth_algo null mode ipv4-tunnel src 172.16.2.7 \
769 dst 172.16.1.7 flow-direction 0 2
774 The Routing rule syntax is shown as follows:
776 .. code-block:: console
778 rt <ip_ver> <src_ip> <dst_ip> <port>
781 where each options means:
785 * IP protocol version
791 * *ipv4*: IP protocol version 4
792 * *ipv6*: IP protocol version 6
796 * The source IP address and mask
798 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
802 * *src X.X.X.X/Y* for IPv4
803 * *src XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
807 * The destination IP address and mask
809 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
813 * *dst X.X.X.X/Y* for IPv4
814 * *dst XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
818 * The traffic output port id
820 * Optional: yes, default output port 0 will be used
826 .. code-block:: console
828 rt ipv4 dst 172.16.1.5/32 port 0
830 rt ipv6 dst 1111:1111:1111:1111:1111:1111:1111:5555/116 port 0
835 Flow rule enables the usage of hardware classification capabilities to match specific
836 ingress traffic and redirect the packets to the specified queue. This feature is
837 optional and relies on hardware ``rte_flow`` support.
839 The flow rule syntax is shown as follows:
841 .. code-block:: console
843 flow <ip_ver> <src_ip> <dst_ip> <port> <queue>
846 where each options means:
850 * IP protocol version
856 * *ipv4*: IP protocol version 4
857 * *ipv6*: IP protocol version 6
861 * The source IP address and mask
863 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
867 * *src X.X.X.X/Y* for IPv4
868 * *src XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
872 * The destination IP address and mask
874 * Optional: Yes, default address 0.0.0.0 and mask of 0 will be used
878 * *dst X.X.X.X/Y* for IPv4
879 * *dst XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX/Y* for IPv6
883 * The traffic input port id
885 * Optional: yes, default input port 0 will be used
891 * The traffic input queue id
893 * Optional: yes, default input queue 0 will be used
899 .. code-block:: console
901 flow ipv4 dst 172.16.1.5/32 port 0 queue 0
903 flow ipv6 dst 1111:1111:1111:1111:1111:1111:1111:5555/116 port 1 queue 0
906 Neighbour rule syntax
907 ^^^^^^^^^^^^^^^^^^^^^
909 The Neighbour rule syntax is shown as follows:
911 .. code-block:: console
913 neigh <port> <dst_mac>
916 where each options means:
928 * The destination ethernet address to use for that port
936 Example Neighbour rules:
938 .. code-block:: console
940 neigh port 0 DE:AD:BE:EF:01:02
945 The test directory contains scripts for testing the various encryption
948 The purpose of the scripts is to automate ipsec-secgw testing
949 using another system running linux as a DUT.
951 The user must setup the following environment variables:
953 * ``SGW_PATH``: path to the ipsec-secgw binary to test.
955 * ``REMOTE_HOST``: IP address/hostname of the DUT.
957 * ``REMOTE_IFACE``: interface name for the test-port on the DUT.
959 * ``ETH_DEV``: ethernet device to be used on the SUT by DPDK ('-a <pci-id>')
961 Also the user can optionally setup:
963 * ``SGW_LCORE``: lcore to run ipsec-secgw on (default value is 0)
965 * ``CRYPTO_DEV``: crypto device to be used ('-a <pci-id>'). If none specified
966 appropriate vdevs will be created by the script
968 Scripts can be used for multiple test scenarios. To check all available
971 .. code-block:: console
973 /bin/bash run_test.sh -h
975 Note that most of the tests require the appropriate crypto PMD/device to be
981 Two servers are required for the tests, SUT and DUT.
983 Make sure the user from the SUT can ssh to the DUT without entering the password.
984 To enable this feature keys must be setup on the DUT.
986 ``ssh-keygen`` will make a private & public key pair on the SUT.
988 ``ssh-copy-id`` <user name>@<target host name> on the SUT will copy the public
989 key to the DUT. It will ask for credentials so that it can upload the public key.
991 The SUT and DUT are connected through at least 2 NIC ports.
993 One NIC port is expected to be managed by linux on both machines and will be
994 used as a control path.
996 The second NIC port (test-port) should be bound to DPDK on the SUT, and should
997 be managed by linux on the DUT.
999 The script starts ``ipsec-secgw`` with 2 NIC devices: ``test-port`` and
1002 It then configures the local tap interface and the remote interface and IPsec
1003 policies in the following way:
1005 Traffic going over the test-port in both directions has to be protected by IPsec.
1007 Traffic going over the TAP port in both directions does not have to be protected.
1011 DUT OS(NIC1)--(IPsec)-->(NIC1)ipsec-secgw(TAP)--(plain)-->(TAP)SUT OS
1013 SUT OS(TAP)--(plain)-->(TAP)psec-secgw(NIC1)--(IPsec)-->(NIC1)DUT OS
1015 It then tries to perform some data transfer using the scheme described above.
1020 In the ipsec-secgw/test directory run
1022 /bin/bash run_test.sh <options> <ipsec_mode>
1026 * ``-4`` Perform tests with use of IPv4. One or both [-46] options needs to be
1029 * ``-6`` Perform tests with use of IPv6. One or both [-46] options needs to be
1032 * ``-m`` Add IPSec tunnel mixed IP version tests - outer IP version different
1033 than inner. Inner IP version will match selected option [-46].
1035 * ``-i`` Run tests in inline mode. Regular tests will not be invoked.
1037 * ``-f`` Run tests for fallback mechanism. Regular tests will not be invoked.
1039 * ``-l`` Run tests in legacy mode only. It cannot be used with options [-fsc].
1040 On default library mode is used.
1042 * ``-s`` Run all tests with reassembly support. On default only tests for
1043 fallback mechanism use reassembly support.
1045 * ``-c`` Run tests with use of cpu-crypto. For inline tests it will not be
1046 applied. On default lookaside-none is used.
1048 * ``-p`` Perform packet validation tests. Option [-46] is not required.
1050 * ``-h`` Show usage.
1052 If <ipsec_mode> is specified, only tests for that mode will be invoked. For the
1053 list of available modes please refer to run_test.sh.