[dpdk-dev] [PATCH v3 1/2] lib/ipsec: add support for header construction

Ananyev, Konstantin konstantin.ananyev at intel.com
Thu Jun 27 00:15:12 CEST 2019


Hi Fan,

> -----Original Message-----
> From: Zhang, Roy Fan
> Sent: Wednesday, June 26, 2019 4:05 PM
> To: dev at dpdk.org
> Cc: akhil.goyal at nxp.com; Ananyev, Konstantin <konstantin.ananyev at intel.com>; Zhang, Roy Fan <roy.fan.zhang at intel.com>; Kovacevic,
> Marko <marko.kovacevic at intel.com>
> Subject: [PATCH v3 1/2] lib/ipsec: add support for header construction
> 
> Add support for RFC 4301(5.1.2) to update of
> Type of service field and Traffic class field
> bits inside ipv4/ipv6 packets for outbound cases
> and inbound cases which deals with the update of
> the DSCP/ENC bits inside each of the fields.
> 

This series cause all tunnel _esn_ testcases for non-AEAD algorithms
(tun_aescbc_sha1_esn, tun_3descbc_sha1_esn, ...) to fail -
ping can't go through. Both ipv4 and ipv6.
Could you have a look?
Thanks
Konstantin 

> Signed-off-by: Marko Kovacevic <marko.kovacevic at intel.com>
> Signed-off-by: Fan Zhang <roy.fan.zhang at intel.com>
> ---
>  lib/librte_ipsec/esp_inb.c         |  16 +++-
>  lib/librte_ipsec/esp_outb.c        |   3 +-
>  lib/librte_ipsec/iph.h             | 148 +++++++++++++++++++++++++++++++++++--
>  lib/librte_ipsec/rte_ipsec_sa.h    |  25 +++++++
>  lib/librte_ipsec/sa.c              |  17 +++++
>  lib/librte_ipsec/sa.h              |   2 +
>  lib/librte_net/rte_ip.h            |  11 +++
>  lib/librte_security/rte_security.h |   9 +++
>  8 files changed, 221 insertions(+), 10 deletions(-)
> 
> diff --git a/lib/librte_ipsec/esp_inb.c b/lib/librte_ipsec/esp_inb.c
> index fb10b7085..3e1894e13 100644
> --- a/lib/librte_ipsec/esp_inb.c
> +++ b/lib/librte_ipsec/esp_inb.c
> @@ -464,13 +464,15 @@ tun_process(const struct rte_ipsec_sa *sa, struct rte_mbuf *mb[],
>  	uint32_t hl[num], to[num];
>  	struct esp_tail espt[num];
>  	struct rte_mbuf *ml[num];
> +	const uint32_t cofs = sa->ctp.cipher.offset;
> +	void *inner_h;
> +	const void *outter_h;
> 
>  	/*
>  	 * remove icv, esp trailer and high-order
>  	 * 32 bits of esn from packet length
>  	 */
>  	const uint32_t tlen = sa->icv_len + sizeof(espt[0]) + sqh_len;
> -	const uint32_t cofs = sa->ctp.cipher.offset;
> 
>  	/*
>  	 * to minimize stalls due to load latency,
> @@ -489,9 +491,17 @@ tun_process(const struct rte_ipsec_sa *sa, struct rte_mbuf *mb[],
>  		if (tun_process_check(mb[i], &ml[i], &to[i], espt[i], adj, tl,
>  					sa->proto) == 0) {
> 
> +			outter_h = rte_pktmbuf_mtod_offset(mb[i], uint8_t *,
> +					mb[i]->l2_len);
> +
>  			/* modify packet's layout */
> -			tun_process_step2(mb[i], ml[i], hl[i], adj, to[i],
> -				tl, sqn + k);
> +
> +			inner_h = tun_process_step2(mb[i], ml[i], hl[i], adj,
> +					to[i], tl, sqn + k);
> +
> +			if ((sa->type & TUN_HDR_MSK) != 0)
> +				update_inb_tun_l3_hdr(sa, inner_h, outter_h);
> +
>  			/* update mbuf's metadata */
>  			tun_process_step3(mb[i], sa->tx_offload.msk,
>  				sa->tx_offload.val);
> diff --git a/lib/librte_ipsec/esp_outb.c b/lib/librte_ipsec/esp_outb.c
> index 8c6db3553..0c72a9d5f 100644
> --- a/lib/librte_ipsec/esp_outb.c
> +++ b/lib/librte_ipsec/esp_outb.c
> @@ -152,7 +152,8 @@ outb_tun_pkt_prepare(struct rte_ipsec_sa *sa, rte_be64_t sqc,
>  	rte_memcpy(ph, sa->hdr, sa->hdr_len);
> 
>  	/* update original and new ip header fields */
> -	update_tun_l3hdr(sa, ph + sa->hdr_l3_off, mb->pkt_len - sqh_len,
> +
> +	update_outb_tun_l3hdr(sa, ph + sa->hdr_l3_off, ph + hlen, mb->pkt_len,
>  			sa->hdr_l3_off, sqn_low16(sqc));
> 
>  	/* update spi, seqn and iv */
> diff --git a/lib/librte_ipsec/iph.h b/lib/librte_ipsec/iph.h
> index 62d78b7b1..1bde9daeb 100644
> --- a/lib/librte_ipsec/iph.h
> +++ b/lib/librte_ipsec/iph.h
> @@ -5,14 +5,17 @@
>  #ifndef _IPH_H_
>  #define _IPH_H_
> 
> -#include <rte_ip.h>
> -
>  /**
>   * @file iph.h
>   * Contains functions/structures/macros to manipulate IPv4/IPv6 headers
>   * used internally by ipsec library.
>   */
> 
> +#define IPV6_DSCP_MASK	(RTE_IP_DSCP_MASK << RTE_IPV6_HDR_TC_SHIFT)
> +#define IPV6_ECN_MASK	(RTE_IP_ECN_MASK << RTE_IPV6_HDR_TC_SHIFT)
> +#define IPV6_TOS_MASK	(IPV6_ECN_MASK | IPV6_DSCP_MASK)
> +#define IPV6_ECN_CE	IPV6_ECN_MASK
> +
>  /*
>   * Move preceding (L3) headers down to remove ESP header and IV.
>   */
> @@ -37,6 +40,26 @@ insert_esph(char *np, char *op, uint32_t hlen)
>  		np[i] = op[i];
>  }
> 
> +static inline uint8_t
> +get_ipv6_tos(rte_be32_t vtc_flow)
> +{
> +	uint32_t v;
> +
> +	v = rte_be_to_cpu_32(vtc_flow);
> +	return v >> RTE_IPV6_HDR_TC_SHIFT;
> +}
> +
> +static inline rte_be32_t
> +set_ipv6_tos(rte_be32_t vtc_flow, uint32_t tos)
> +{
> +	uint32_t v;
> +
> +	v = rte_cpu_to_be_32(tos << RTE_IPV6_HDR_TC_SHIFT);
> +	vtc_flow &= ~rte_cpu_to_be_32(IPV6_TOS_MASK);
> +
> +	return (v | vtc_flow);
> +}
> +
>  /* update original ip header fields for transport case */
>  static inline int
>  update_trs_l3hdr(const struct rte_ipsec_sa *sa, void *p, uint32_t plen,
> @@ -101,23 +124,136 @@ update_trs_l3hdr(const struct rte_ipsec_sa *sa, void *p, uint32_t plen,
>  	return rc;
>  }
> 
> +/**
> + * Update type-of-service/traffic-class field of inbound/outbound tunnel
> + * packet.
> + *
> + * @param ref_h: reference header, for outbound it is inner header, otherwise
> + *   outer header.
> + * @param update_h: header to be updated tos/tc field, for outbound it is outer
> + *   header, otherwise inner header.
> + * @param tos_mask: type-of-service mask stored in sa.
> + * @param is_outh_ipv4: 1 if outer header is ipv4, 0 if it is ipv6.
> + * @param is_inner_ipv4: 1 if inner header is ipv4, 0 if it is ipv6.
> + * @param is_inbound: 1 if it is a inbound packet, 0 if it is outbound.
> + */
> +static inline void
> +update_tun_tos(const void *ref_h, void *update_h, uint32_t tos_mask,
> +		uint8_t is_outh_ipv4, uint8_t is_inh_ipv4, uint8_t is_inbound)
> +{
> +	uint8_t idx = ((is_inbound << 2) | (is_outh_ipv4 << 1) | is_inh_ipv4);
> +	struct rte_ipv4_hdr *v4out_h;
> +	struct rte_ipv6_hdr *v6out_h;
> +	struct rte_ipv4_hdr *v4in_h;
> +	struct rte_ipv6_hdr *v6in_h;
> +	uint32_t itp, otp;
> +	uint8_t ecn_v4out, ecn_v4in;
> +	uint32_t ecn_v6out, ecn_v6in;
> +
> +	switch (idx) {
> +	/* outbound */
> +	case 0: /*outh ipv6, inh ipv6 */
> +		v6out_h = update_h;
> +		otp = get_ipv6_tos(v6out_h->vtc_flow) & ~tos_mask;
> +		itp = get_ipv6_tos(((const struct rte_ipv6_hdr *)ref_h)->
> +				vtc_flow) & tos_mask;
> +		v6out_h->vtc_flow = set_ipv6_tos(v6out_h->vtc_flow, otp | itp);
> +		break;
> +	case 1: /*outh ipv6, inh ipv4 */
> +		v6out_h = update_h;
> +		otp = get_ipv6_tos(v6out_h->vtc_flow) & ~tos_mask;
> +		itp = ((const struct rte_ipv4_hdr *)ref_h)->type_of_service &
> +				tos_mask;
> +		v6out_h->vtc_flow = set_ipv6_tos(v6out_h->vtc_flow, otp | itp);
> +		break;
> +	case 2: /*outh ipv4, inh ipv6 */
> +		v4out_h = update_h;
> +		otp = v4out_h->type_of_service & ~tos_mask;
> +		itp = get_ipv6_tos(((const struct rte_ipv6_hdr *)ref_h)->
> +				vtc_flow) & tos_mask;
> +		v4out_h->type_of_service = (otp | itp);
> +		break;
> +	case 3: /* outh ipv4, inh ipv4 */
> +		v4out_h = update_h;
> +		otp = v4out_h->type_of_service & ~tos_mask;
> +		itp = ((const struct rte_ipv4_hdr *)ref_h)->type_of_service &
> +				tos_mask;
> +		v4out_h->type_of_service = (otp | itp);
> +		break;
> +	/* inbound */
> +	case 4: /* outh ipv6, inh ipv6 */
> +		v6in_h = update_h;
> +		ecn_v6out = ((const struct rte_ipv6_hdr *)ref_h)->vtc_flow &
> +				rte_cpu_to_be_32(IPV6_ECN_MASK);
> +		ecn_v6in = v6in_h->vtc_flow & rte_cpu_to_be_32(IPV6_ECN_MASK);
> +		if ((ecn_v6out == rte_cpu_to_be_32(IPV6_ECN_CE)) &&
> +				(ecn_v6in != 0))
> +			v6in_h->vtc_flow |= rte_cpu_to_be_32(IPV6_ECN_CE);
> +		break;
> +	case 5: /* outh ipv6, inh ipv4 */
> +		v4in_h = update_h;
> +		ecn_v6out = ((const struct rte_ipv6_hdr *)ref_h)->vtc_flow &
> +				rte_cpu_to_be_32(IPV6_ECN_MASK);
> +		ecn_v4in = v4in_h->type_of_service & RTE_IP_ECN_MASK;
> +		if ((ecn_v6out == rte_cpu_to_be_32(IPV6_ECN_CE)) &&
> +				(ecn_v4in != 0))
> +			v4in_h->type_of_service |= RTE_IP_ECN_CE;
> +		break;
> +	case 6: /* outh ipv4, inh ipv6 */
> +		v6in_h = update_h;
> +		ecn_v4out = ((const struct rte_ipv4_hdr *)ref_h)->
> +				type_of_service & RTE_IP_ECN_MASK;
> +		ecn_v6in = v6in_h->vtc_flow & rte_cpu_to_be_32(IPV6_ECN_MASK);
> +		if (ecn_v4out == RTE_IP_ECN_CE && ecn_v6in != 0)
> +			v6in_h->vtc_flow |= rte_cpu_to_be_32(IPV6_ECN_CE);
> +		break;
> +	case 7: /* outh ipv4, inh ipv4 */
> +		v4in_h = update_h;
> +		ecn_v4out = ((const struct rte_ipv4_hdr *)ref_h)->
> +				type_of_service & RTE_IP_ECN_MASK;
> +		ecn_v4in = v4in_h->type_of_service & RTE_IP_ECN_MASK;
> +		if (ecn_v4out == RTE_IP_ECN_CE && ecn_v4in != 0)
> +			v4in_h->type_of_service |= RTE_IP_ECN_CE;
> +		break;
> +	}
> +}
> +
> +
>  /* update original and new ip header fields for tunnel case */
>  static inline void
> -update_tun_l3hdr(const struct rte_ipsec_sa *sa, void *p, uint32_t plen,
> -		uint32_t l2len, rte_be16_t pid)
> +update_outb_tun_l3hdr(const struct rte_ipsec_sa *sa, void *outh,
> +		const void *inh, uint32_t plen, uint32_t l2len, rte_be16_t pid)
>  {
>  	struct rte_ipv4_hdr *v4h;
>  	struct rte_ipv6_hdr *v6h;
> +	uint8_t is_out_ipv4;
> 
>  	if (sa->type & RTE_IPSEC_SATP_MODE_TUNLV4) {
> -		v4h = p;
> +		is_out_ipv4 = 1;
> +		v4h = outh;
>  		v4h->packet_id = pid;
>  		v4h->total_length = rte_cpu_to_be_16(plen - l2len);
>  	} else {
> -		v6h = p;
> +		is_out_ipv4 = 0;
> +		v6h = outh;
>  		v6h->payload_len = rte_cpu_to_be_16(plen - l2len -
>  				sizeof(*v6h));
>  	}
> +
> +	if (sa->type & TUN_HDR_MSK)
> +		update_tun_tos(inh, outh, sa->tos_mask, is_out_ipv4,
> +				((sa->type & RTE_IPSEC_SATP_IPV_MASK) ==
> +					RTE_IPSEC_SATP_IPV4), 0);
> +}
> +
> +static inline void
> +update_inb_tun_l3_hdr(const struct rte_ipsec_sa *sa, void *ip_inner,
> +		const void *ip_outter)
> +{
> +	update_tun_tos(ip_outter, ip_inner, sa->tos_mask,
> +		((sa->type & RTE_IPSEC_SATP_MODE_TUNLV4) != 0),
> +		((sa->type & RTE_IPSEC_SATP_IPV_MASK) == RTE_IPSEC_SATP_IPV4),
> +			1);
>  }
> 
>  #endif /* _IPH_H_ */
> diff --git a/lib/librte_ipsec/rte_ipsec_sa.h b/lib/librte_ipsec/rte_ipsec_sa.h
> index fd9b3ed60..8f179ee9d 100644
> --- a/lib/librte_ipsec/rte_ipsec_sa.h
> +++ b/lib/librte_ipsec/rte_ipsec_sa.h
> @@ -95,6 +95,11 @@ enum {
>  	RTE_SATP_LOG2_MODE,
>  	RTE_SATP_LOG2_SQN = RTE_SATP_LOG2_MODE + 2,
>  	RTE_SATP_LOG2_ESN,
> +	RTE_SATP_LOG2_ECN,
> +	RTE_SATP_LOG2_DSCP,
> +	RTE_SATP_LOG2_TTL,
> +	RTE_SATP_LOG2_DF,
> +	RTE_SATP_LOG2_FLABEL,
>  	RTE_SATP_LOG2_NUM
>  };
> 
> @@ -123,6 +128,26 @@ enum {
>  #define RTE_IPSEC_SATP_ESN_DISABLE	(0ULL << RTE_SATP_LOG2_ESN)
>  #define RTE_IPSEC_SATP_ESN_ENABLE	(1ULL << RTE_SATP_LOG2_ESN)
> 
> +#define RTE_IPSEC_SATP_ECN_MASK		(1ULL << RTE_SATP_LOG2_ECN)
> +#define RTE_IPSEC_SATP_ECN_DISABLE	(0ULL << RTE_SATP_LOG2_ECN)
> +#define RTE_IPSEC_SATP_ECN_ENABLE	(1ULL << RTE_SATP_LOG2_ECN)
> +
> +#define RTE_IPSEC_SATP_DSCP_MASK	(1ULL << RTE_SATP_LOG2_DSCP)
> +#define RTE_IPSEC_SATP_DSCP_DISABLE	(0ULL << RTE_SATP_LOG2_DSCP)
> +#define RTE_IPSEC_SATP_DSCP_ENABLE	(1ULL << RTE_SATP_LOG2_DSCP)
> +
> +#define RTE_IPSEC_SATP_TTL_MASK		(1ULL << RTE_SATP_LOG2_TTL)
> +#define RTE_IPSEC_SATP_TTL_DISABLE	(0ULL << RTE_SATP_LOG2_TTL)
> +#define RTE_IPSEC_SATP_TTL_ENABLE	(1ULL << RTE_SATP_LOG2_TTL)
> +
> +#define RTE_IPSEC_SATP_DF_MASK		(1ULL << RTE_SATP_LOG2_DF)
> +#define RTE_IPSEC_SATP_DF_DISABLE	(0ULL << RTE_SATP_LOG2_DF)
> +#define RTE_IPSEC_SATP_DF_ENABLE	(1ULL << RTE_SATP_LOG2_DF)
> +
> +#define RTE_IPSEC_SATP_FLABEL_MASK	(1ULL << RTE_SATP_LOG2_FLABEL)
> +#define RTE_IPSEC_SATP_FLABEL_DISABLE	(0ULL << RTE_SATP_LOG2_FLABEL)
> +#define RTE_IPSEC_SATP_FLABEL_ENABLE	(1ULL << RTE_SATP_LOG2_FLABEL)
> +
>  /**
>   * get type of given SA
>   * @return
> diff --git a/lib/librte_ipsec/sa.c b/lib/librte_ipsec/sa.c
> index 087de958a..61d817dfc 100644
> --- a/lib/librte_ipsec/sa.c
> +++ b/lib/librte_ipsec/sa.c
> @@ -220,6 +220,17 @@ fill_sa_type(const struct rte_ipsec_sa_prm *prm, uint64_t *type)
>  	else
>  		tp |= RTE_IPSEC_SATP_SQN_RAW;
> 
> +	/* check for ECN flag */
> +	if (prm->ipsec_xform.options.ecn == 0)
> +		tp |= RTE_IPSEC_SATP_ECN_DISABLE;
> +	else
> +		tp |= RTE_IPSEC_SATP_ECN_ENABLE;
> +	/* check for DSCP flag */
> +	if (prm->ipsec_xform.options.copy_dscp == 0)
> +		tp |= RTE_IPSEC_SATP_DSCP_DISABLE;
> +	else
> +		tp |= RTE_IPSEC_SATP_DSCP_ENABLE;
> +
>  	*type = tp;
>  	return 0;
>  }
> @@ -310,6 +321,12 @@ esp_sa_init(struct rte_ipsec_sa *sa, const struct rte_ipsec_sa_prm *prm,
>  	static const uint64_t msk = RTE_IPSEC_SATP_DIR_MASK |
>  				RTE_IPSEC_SATP_MODE_MASK;
> 
> +	if (prm->ipsec_xform.options.ecn)
> +		sa->tos_mask |= RTE_IP_ECN_MASK;
> +
> +	if (prm->ipsec_xform.options.copy_dscp)
> +		sa->tos_mask |= RTE_IP_DSCP_MASK;
> +
>  	if (cxf->aead != NULL) {
>  		switch (cxf->aead->algo) {
>  		case RTE_CRYPTO_AEAD_AES_GCM:
> diff --git a/lib/librte_ipsec/sa.h b/lib/librte_ipsec/sa.h
> index 20c0a65c0..51e69ad05 100644
> --- a/lib/librte_ipsec/sa.h
> +++ b/lib/librte_ipsec/sa.h
> @@ -10,6 +10,7 @@
>  #define IPSEC_MAX_HDR_SIZE	64
>  #define IPSEC_MAX_IV_SIZE	16
>  #define IPSEC_MAX_IV_QWORD	(IPSEC_MAX_IV_SIZE / sizeof(uint64_t))
> +#define TUN_HDR_MSK (RTE_IPSEC_SATP_ECN_MASK | RTE_IPSEC_SATP_DSCP_MASK)
> 
>  /* padding alignment for different algorithms */
>  enum {
> @@ -103,6 +104,7 @@ struct rte_ipsec_sa {
>  	uint8_t iv_ofs; /* offset for algo-specific IV inside crypto op */
>  	uint8_t iv_len;
>  	uint8_t pad_align;
> +	uint8_t tos_mask;
> 
>  	/* template for tunnel header */
>  	uint8_t hdr[IPSEC_MAX_HDR_SIZE];
> diff --git a/lib/librte_net/rte_ip.h b/lib/librte_net/rte_ip.h
> index c2c67b85d..85c53e8d9 100644
> --- a/lib/librte_net/rte_ip.h
> +++ b/lib/librte_net/rte_ip.h
> @@ -46,6 +46,17 @@ struct rte_ipv4_hdr {
>  					   (((b) & 0xff) << 16) | \
>  					   (((c) & 0xff) << 8)  | \
>  					   ((d) & 0xff))
> +/**
> + * RFC 3168 Explicit Congestion Notification (ECN)
> + * * ECT(1) (ECN-Capable Transport(1))
> + * * ECT(0) (ECN-Capable Transport(0))
> + * * ECT(CE)(CE (Congestion Experienced))
> + */
> +#define RTE_IP_ECN_MASK		(0x03)
> +#define RTE_IP_ECN_CE		RTE_IP_ECN_MASK
> +
> +/** Packet Option Masks */
> +#define RTE_IP_DSCP_MASK		(0xFC)
> 
>  /** Maximal IPv4 packet length (including a header) */
>  #define RTE_IPV4_MAX_PKT_LEN        65535
> diff --git a/lib/librte_security/rte_security.h b/lib/librte_security/rte_security.h
> index 76f54e0e0..d0492928c 100644
> --- a/lib/librte_security/rte_security.h
> +++ b/lib/librte_security/rte_security.h
> @@ -163,6 +163,15 @@ struct rte_security_ipsec_sa_options {
>  	 * * 0: Inner packet is not modified.
>  	 */
>  	uint32_t dec_ttl : 1;
> +
> +	/**< Explicit Congestion Notification (ECN)
> +	 *
> +	 * * 1: In tunnel mode, enable outer header ECN Field copied from
> +	 *      inner header in tunnel encapsulation, or inner header ECN
> +	 *      field construction in decapsulation.
> +	 * * 0: Inner/outer header are not modified.
> +	 */
> +	uint32_t ecn : 1;
>  };
> 
>  /** IPSec security association direction */
> --
> 2.14.5



More information about the dev mailing list