5 * Copyright(c) 2017 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of NXP nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #ifndef _RTE_SECURITY_H_
35 #define _RTE_SECURITY_H_
38 * @file rte_security.h
39 * @b EXPERIMENTAL: this API may change without prior notice
41 * RTE Security Common Definitions
49 #include <sys/types.h>
51 #include <netinet/in.h>
52 #include <netinet/ip.h>
53 #include <netinet/ip6.h>
55 #include <rte_common.h>
56 #include <rte_crypto.h>
58 #include <rte_memory.h>
59 #include <rte_mempool.h>
61 /** IPSec protocol mode */
62 enum rte_security_ipsec_sa_mode {
63 RTE_SECURITY_IPSEC_SA_MODE_TRANSPORT = 1,
64 /**< IPSec Transport mode */
65 RTE_SECURITY_IPSEC_SA_MODE_TUNNEL,
66 /**< IPSec Tunnel mode */
70 enum rte_security_ipsec_sa_protocol {
71 RTE_SECURITY_IPSEC_SA_PROTO_AH = 1,
73 RTE_SECURITY_IPSEC_SA_PROTO_ESP,
77 /** IPSEC tunnel type */
78 enum rte_security_ipsec_tunnel_type {
79 RTE_SECURITY_IPSEC_TUNNEL_IPV4 = 1,
80 /**< Outer header is IPv4 */
81 RTE_SECURITY_IPSEC_TUNNEL_IPV6,
82 /**< Outer header is IPv6 */
86 * Security context for crypto/eth devices
88 * Security instance for each driver to register security operations.
89 * The application can get the security context from the crypto/eth device id
90 * using the APIs rte_cryptodev_get_sec_ctx()/rte_eth_dev_get_sec_ctx()
91 * This structure is used to identify the device(crypto/eth) for which the
92 * security operations need to be performed.
94 struct rte_security_ctx {
96 /**< Crypto/ethernet device attached */
97 const struct rte_security_ops *ops;
98 /**< Pointer to security ops for the device */
100 /**< Number of sessions attached to this context */
104 * IPSEC tunnel parameters
106 * These parameters are used to build outbound tunnel headers.
108 struct rte_security_ipsec_tunnel_param {
109 enum rte_security_ipsec_tunnel_type type;
110 /**< Tunnel type: IPv4 or IPv6 */
114 struct in_addr src_ip;
115 /**< IPv4 source address */
116 struct in_addr dst_ip;
117 /**< IPv4 destination address */
119 /**< IPv4 Differentiated Services Code Point */
121 /**< IPv4 Don't Fragment bit */
123 /**< IPv4 Time To Live */
125 /**< IPv4 header parameters */
127 struct in6_addr src_addr;
128 /**< IPv6 source address */
129 struct in6_addr dst_addr;
130 /**< IPv6 destination address */
132 /**< IPv6 Differentiated Services Code Point */
134 /**< IPv6 flow label */
136 /**< IPv6 hop limit */
138 /**< IPv6 header parameters */
143 * IPsec Security Association option flags
145 struct rte_security_ipsec_sa_options {
146 /**< Extended Sequence Numbers (ESN)
148 * * 1: Use extended (64 bit) sequence numbers
149 * * 0: Use normal sequence numbers
153 /**< UDP encapsulation
155 * * 1: Do UDP encapsulation/decapsulation so that IPSEC packets can
156 * traverse through NAT boxes.
157 * * 0: No UDP encapsulation
159 uint32_t udp_encap : 1;
163 * * 1: Copy IPv4 or IPv6 DSCP bits from inner IP header to
164 * the outer IP header in encapsulation, and vice versa in
166 * * 0: Do not change DSCP field.
168 uint32_t copy_dscp : 1;
170 /**< Copy IPv6 Flow Label
172 * * 1: Copy IPv6 flow label from inner IPv6 header to the
174 * * 0: Outer header is not modified.
176 uint32_t copy_flabel : 1;
178 /**< Copy IPv4 Don't Fragment bit
180 * * 1: Copy the DF bit from the inner IPv4 header to the outer
182 * * 0: Outer header is not modified.
184 uint32_t copy_df : 1;
186 /**< Decrement inner packet Time To Live (TTL) field
188 * * 1: In tunnel mode, decrement inner packet IPv4 TTL or
189 * IPv6 Hop Limit after tunnel decapsulation, or before tunnel
191 * * 0: Inner packet is not modified.
193 uint32_t dec_ttl : 1;
196 /** IPSec security association direction */
197 enum rte_security_ipsec_sa_direction {
198 RTE_SECURITY_IPSEC_SA_DIR_EGRESS,
199 /**< Encrypt and generate digest */
200 RTE_SECURITY_IPSEC_SA_DIR_INGRESS,
201 /**< Verify digest and decrypt */
205 * IPsec security association configuration data.
207 * This structure contains data required to create an IPsec SA security session.
209 struct rte_security_ipsec_xform {
211 /**< SA security parameter index */
214 struct rte_security_ipsec_sa_options options;
215 /**< various SA options */
216 enum rte_security_ipsec_sa_direction direction;
217 /**< IPSec SA Direction - Egress/Ingress */
218 enum rte_security_ipsec_sa_protocol proto;
219 /**< IPsec SA Protocol - AH/ESP */
220 enum rte_security_ipsec_sa_mode mode;
221 /**< IPsec SA Mode - transport/tunnel */
222 struct rte_security_ipsec_tunnel_param tunnel;
223 /**< Tunnel parameters, NULL for transport mode */
227 * MACsec security session configuration
229 struct rte_security_macsec_xform {
235 * Security session action type.
237 enum rte_security_session_action_type {
238 RTE_SECURITY_ACTION_TYPE_NONE,
239 /**< No security actions */
240 RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO,
241 /**< Crypto processing for security protocol is processed inline
242 * during transmission
244 RTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL,
245 /**< All security protocol processing is performed inline during
248 RTE_SECURITY_ACTION_TYPE_LOOKASIDE_PROTOCOL
249 /**< All security protocol processing including crypto is performed
250 * on a lookaside accelerator
254 /** Security session protocol definition */
255 enum rte_security_session_protocol {
256 RTE_SECURITY_PROTOCOL_IPSEC = 1,
257 /**< IPsec Protocol */
258 RTE_SECURITY_PROTOCOL_MACSEC,
259 /**< MACSec Protocol */
263 * Security session configuration
265 struct rte_security_session_conf {
266 enum rte_security_session_action_type action_type;
267 /**< Type of action to be performed on the session */
268 enum rte_security_session_protocol protocol;
269 /**< Security protocol to be configured */
272 struct rte_security_ipsec_xform ipsec;
273 struct rte_security_macsec_xform macsec;
275 /**< Configuration parameters for security session */
276 struct rte_crypto_sym_xform *crypto_xform;
277 /**< Security Session Crypto Transformations */
279 /**< Application specific userdata to be saved with session */
282 struct rte_security_session {
283 void *sess_private_data;
284 /**< Private session material */
288 * Create security session as specified by the session configuration
290 * @param instance security instance
291 * @param conf session configuration parameters
292 * @param mp mempool to allocate session objects from
294 * - On success, pointer to session
297 struct rte_security_session *
298 rte_security_session_create(struct rte_security_ctx *instance,
299 struct rte_security_session_conf *conf,
300 struct rte_mempool *mp);
303 * Update security session as specified by the session configuration
305 * @param instance security instance
306 * @param sess session to update parameters
307 * @param conf update configuration parameters
309 * - On success returns 0
310 * - On failure return errno
313 rte_security_session_update(struct rte_security_ctx *instance,
314 struct rte_security_session *sess,
315 struct rte_security_session_conf *conf);
318 * Get the size of the security session data for a device.
320 * @param instance security instance.
323 * - Size of the private data, if successful
324 * - 0 if device is invalid or does not support the operation.
327 rte_security_session_get_size(struct rte_security_ctx *instance);
330 * Free security session header and the session private data and
331 * return it to its original mempool.
333 * @param instance security instance
334 * @param sess security session to freed
338 * - -EINVAL if session is NULL.
339 * - -EBUSY if not all device private data has been freed.
342 rte_security_session_destroy(struct rte_security_ctx *instance,
343 struct rte_security_session *sess);
346 * Updates the buffer with device-specific defined metadata
348 * @param instance security instance
349 * @param sess security session
350 * @param mb packet mbuf to set metadata on.
351 * @param params device-specific defined parameters
352 * required for metadata
355 * - On success, zero.
356 * - On failure, a negative value.
359 rte_security_set_pkt_metadata(struct rte_security_ctx *instance,
360 struct rte_security_session *sess,
361 struct rte_mbuf *mb, void *params);
364 * Get userdata associated with the security session which processed the
365 * packet. This userdata would be registered while creating the session, and
366 * application can use this to identify the SA etc. Device-specific metadata
367 * in the mbuf would be used for this.
369 * This is valid only for inline processed ingress packets.
371 * @param instance security instance
372 * @param md device-specific metadata set in mbuf
375 * - On success, userdata
379 rte_security_get_userdata(struct rte_security_ctx *instance, uint64_t md);
382 * Attach a session to a symmetric crypto operation
384 * @param sym_op crypto operation
385 * @param sess security session
388 __rte_security_attach_session(struct rte_crypto_sym_op *sym_op,
389 struct rte_security_session *sess)
391 sym_op->sec_session = sess;
397 get_sec_session_private_data(const struct rte_security_session *sess)
399 return sess->sess_private_data;
403 set_sec_session_private_data(struct rte_security_session *sess,
406 sess->sess_private_data = private_data;
410 * Attach a session to a crypto operation.
411 * This API is needed only in case of RTE_SECURITY_SESS_CRYPTO_PROTO_OFFLOAD
412 * For other rte_security_session_action_type, ol_flags in rte_mbuf may be
413 * defined to perform security operations.
415 * @param op crypto operation
416 * @param sess security session
419 rte_security_attach_session(struct rte_crypto_op *op,
420 struct rte_security_session *sess)
422 if (unlikely(op->type != RTE_CRYPTO_OP_TYPE_SYMMETRIC))
425 op->sess_type = RTE_CRYPTO_OP_SECURITY_SESSION;
427 return __rte_security_attach_session(op->sym, sess);
430 struct rte_security_macsec_stats {
434 struct rte_security_ipsec_stats {
439 struct rte_security_stats {
440 enum rte_security_session_protocol protocol;
441 /**< Security protocol to be configured */
445 struct rte_security_macsec_stats macsec;
446 struct rte_security_ipsec_stats ipsec;
451 * Get security session statistics
453 * @param instance security instance
454 * @param sess security session
455 * @param stats statistics
457 * - On success return 0
461 rte_security_session_stats_get(struct rte_security_ctx *instance,
462 struct rte_security_session *sess,
463 struct rte_security_stats *stats);
466 * Security capability definition
468 struct rte_security_capability {
469 enum rte_security_session_action_type action;
470 /**< Security action type*/
471 enum rte_security_session_protocol protocol;
472 /**< Security protocol */
476 enum rte_security_ipsec_sa_protocol proto;
477 /**< IPsec SA protocol */
478 enum rte_security_ipsec_sa_mode mode;
479 /**< IPsec SA mode */
480 enum rte_security_ipsec_sa_direction direction;
481 /**< IPsec SA direction */
482 struct rte_security_ipsec_sa_options options;
483 /**< IPsec SA supported options */
485 /**< IPsec capability */
490 /**< MACsec capability */
493 const struct rte_cryptodev_capabilities *crypto_capabilities;
494 /**< Corresponding crypto capabilities for security capability */
497 /**< Device offload flags */
500 #define RTE_SECURITY_TX_OLOAD_NEED_MDATA 0x00000001
501 /**< HW needs metadata update, see rte_security_set_pkt_metadata().
504 #define RTE_SECURITY_TX_HW_TRAILER_OFFLOAD 0x00000002
505 /**< HW constructs trailer of packets
506 * Transmitted packets will have the trailer added to them
507 * by hardawre. The next protocol field will be based on
508 * the mbuf->inner_esp_next_proto field.
510 #define RTE_SECURITY_RX_HW_TRAILER_OFFLOAD 0x00010000
511 /**< HW removes trailer of packets
512 * Received packets have no trailer, the next protocol field
513 * is supplied in the mbuf->inner_esp_next_proto field.
514 * Inner packet is not modified.
518 * Security capability index used to query a security instance for a specific
519 * security capability
521 struct rte_security_capability_idx {
522 enum rte_security_session_action_type action;
523 enum rte_security_session_protocol protocol;
528 enum rte_security_ipsec_sa_protocol proto;
529 enum rte_security_ipsec_sa_mode mode;
530 enum rte_security_ipsec_sa_direction direction;
536 * Returns array of security instance capabilities
538 * @param instance Security instance.
541 * - Returns array of security capabilities.
542 * - Return NULL if no capabilities available.
544 const struct rte_security_capability *
545 rte_security_capabilities_get(struct rte_security_ctx *instance);
548 * Query if a specific capability is available on security instance
550 * @param instance security instance.
551 * @param idx security capability index to match against
554 * - Returns pointer to security capability on match of capability
556 * - Return NULL if the capability not matched on security instance.
558 const struct rte_security_capability *
559 rte_security_capability_get(struct rte_security_ctx *instance,
560 struct rte_security_capability_idx *idx);
566 #endif /* _RTE_SECURITY_H_ */