gre: fix ERSPAN o_flags race/corruption in xmit and fill_info
Subsystems (4)
PATCH v2 1/1 gre: fix ERSPAN o_flags race/corruption in xmit and fill_info
For IPv4 ERSPAN:
In erspan_xmit(), the driver clears IP_TUNNEL_SEQ_BIT (for version 0) and IP_TUNNEL_KEY_BIT directly in the shared tunnel->parms.o_flags structure. Since transmit paths can run locklessly and concurrently, this leads to a data race.
Furthermore, modifying tunnel->parms.o_flags permanently alters the tunnel configuration. To work around this, erspan_fill_info() (which reports config to userspace) was setting IP_TUNNEL_KEY_BIT back. If erspan_fill_info (running under RTNL) and erspan_xmit (running locklessly) race, erspan_xmit might see IP_TUNNEL_KEY_BIT set when it shouldnt, leading to GRE header corruption (injecting a key field into the ERSPAN GRE header).
Fix this by:
1) Snapshotting tunnel->parms.o_flags onto the stack in ipgre_xmit(), gre_tap_xmit(), and __gre6_xmit(), and computing the GRE header length via gre_calc_hlen(flags) instead of reading tunnel->tun_hlen. This eliminates TOCTOU races between flags, offload checks, and header length.
Note: Since tunnel->tun_hlen is no longer used in fast path xmit, it could be removed altogether in net-next.
2) Using local flags in erspan_xmit(), clearing IP_TUNNEL_CSUM_BIT and IP_TUNNEL_KEY_BIT (and IP_TUNNEL_SEQ_BIT for v0) before passing them to __gre_xmit().
3) Removing the racy modification of t->parms.o_flags in erspan_fill_info().
4) Forcing IP_TUNNEL_KEY_BIT in the reported flags for ERSPAN locally in ipgre_fill_info().
For IPv6 ERSPAN:ip6erspan_tunnel_xmit() was locklessly clearing IP_TUNNEL_KEY_BIT in t->parms.o_flags even though it does not use these flags for building the GRE header (it uses local flags). This permanently corrupts the configuration and races with ip6gre_fill_info() which reads it.
Remove the redundant and racy modification.
This should remove false sharing in a fast path.
Add const qualifiers in ipgre_fill_info(), erspan_fill_info() and ip6gre_fill_info() to clarify that these methods are not supposed to write any live parameters.
---
v2: addressed Sashiko and Ido feedback.
v1: https://lore.kernel.org/netdev/[email protected]/
net/ipv4/ip_gre.c | 45 +++++++++++++++++++++++++-------------------- net/ipv6/ip6_gre.c | 7 +++---- 2 files changed, 28 insertions(+), 24 deletions(-)
net/ipv4/ip_gre.c +25 -20
@@ -475,15 +475,12 @@ static int gre_rcv(struct sk_buff *skb)static void __gre_xmit (struct sk_buff *skb,struct net_device *dev,const struct iphdr *tnl_params, -__be16 proto) +__be16 proto,const unsigned long *flags) {struct ip_tunnel *tunnel =netdev_priv (dev); -IP_TUNNEL_DECLARE_FLAGS (flags); - -ip_tunnel_flags_copy (flags, tunnel->parms.o_flags);/* Push GRE header. */ -gre_build_header (skb, tunnel->tun_hlen, +gre_build_header (skb,gre_calc_hlen (flags), flags, proto, tunnel->parms.o_key,test_bit (IP_TUNNEL_SEQ_BIT , flags) ?htonl (atomic_fetch_inc (&tunnel->o_seqno)) :0 );
@@ -654,6 +651,7 @@ static netdev_tx_t ipgre_xmit(struct sk_buff *skb, {struct ip_tunnel *tunnel =netdev_priv (dev);const struct iphdr *tnl_params; +IP_TUNNEL_DECLARE_FLAGS (flags);if (!pskb_inet_may_pull (skb)) goto free_skb;
@@ -663,6 +661,8 @@ static netdev_tx_t ipgre_xmit(struct sk_buff *skb,return NETDEV_TX_OK ; } +ip_tunnel_flags_copy (flags, tunnel->parms.o_flags); +if (dev->header_ops) {int pull_len = tunnel->hlen +sizeof (struct iphdr );
@@ -688,11 +688,10 @@ static netdev_tx_t ipgre_xmit(struct sk_buff *skb, tnl_params = &tunnel->parms.iph; } -if (gre_handle_offloads (skb,test_bit (IP_TUNNEL_CSUM_BIT , - tunnel->parms.o_flags))) +if (gre_handle_offloads (skb,test_bit (IP_TUNNEL_CSUM_BIT , flags))) goto free_skb; -__gre_xmit (skb, dev, tnl_params, skb->protocol); +__gre_xmit (skb, dev, tnl_params, skb->protocol, flags);return NETDEV_TX_OK ; free_skb:
@@ -705,6 +704,7 @@ static netdev_tx_t erspan_xmit(struct sk_buff *skb, struct net_device *dev) {struct ip_tunnel *tunnel =netdev_priv (dev); +IP_TUNNEL_DECLARE_FLAGS (flags);bool truncate = false;__be16 proto;
@@ -728,10 +728,12 @@ static netdev_tx_t erspan_xmit(struct sk_buff *skb, truncate = true; } +ip_tunnel_flags_copy (flags, tunnel->parms.o_flags); +/* Push ERSPAN header */ if (tunnel->erspan_ver ==0 ) { proto =htons (ETH_P_ERSPAN ); -__clear_bit (IP_TUNNEL_SEQ_BIT , tunnel->parms.o_flags); +__clear_bit (IP_TUNNEL_SEQ_BIT , flags); }else if (tunnel->erspan_ver ==1 ) { erspan_build_header(skb, ntohl(tunnel->parms.o_key), tunnel->index,
@@ -746,8 +748,9 @@ static netdev_tx_t erspan_xmit(struct sk_buff *skb, goto free_skb; } -__clear_bit (IP_TUNNEL_KEY_BIT , tunnel->parms.o_flags); -__gre_xmit (skb, dev, &tunnel->parms.iph, proto); +__clear_bit (IP_TUNNEL_CSUM_BIT , flags); +__clear_bit (IP_TUNNEL_KEY_BIT , flags); +__gre_xmit (skb, dev, &tunnel->parms.iph, proto, flags);return NETDEV_TX_OK ; free_skb:
@@ -760,6 +763,7 @@ static netdev_tx_t gre_tap_xmit(struct sk_buff *skb, struct net_device *dev) {struct ip_tunnel *tunnel =netdev_priv (dev); +IP_TUNNEL_DECLARE_FLAGS (flags);if (!pskb_inet_may_pull (skb)) goto free_skb;
@@ -769,14 +773,15 @@ static netdev_tx_t gre_tap_xmit(struct sk_buff *skb,return NETDEV_TX_OK ; } -if (gre_handle_offloads (skb,test_bit (IP_TUNNEL_CSUM_BIT , - tunnel->parms.o_flags))) +ip_tunnel_flags_copy (flags, tunnel->parms.o_flags); + +if (gre_handle_offloads (skb,test_bit (IP_TUNNEL_CSUM_BIT , flags))) goto free_skb;if (skb_cow_head (skb, dev->needed_headroom)) goto free_skb; -__gre_xmit (skb, dev, &tunnel->parms.iph,htons (ETH_P_TEB )); +__gre_xmit (skb, dev, &tunnel->parms.iph,htons (ETH_P_TEB ), flags);return NETDEV_TX_OK ; free_skb:
@@ -1560,12 +1565,15 @@ static size_t ipgre_get_size(const struct net_device *dev)static int ipgre_fill_info (struct sk_buff *skb,const struct net_device *dev) { -struct ip_tunnel *t =netdev_priv (dev); -struct ip_tunnel_parm_kern *p = &t->parms; +const struct ip_tunnel *t =netdev_priv (dev); +const struct ip_tunnel_parm_kern *p = &t->parms;IP_TUNNEL_DECLARE_FLAGS (o_flags);ip_tunnel_flags_copy (o_flags, p->o_flags); +if (t->erspan_ver !=0 && !t->collect_md) +__set_bit (IP_TUNNEL_KEY_BIT , o_flags); + if (nla_put_u32(skb, IFLA_GRE_LINK, p->link) || nla_put_be16(skb, IFLA_GRE_IFLAGS, gre_tnl_flags_to_gre_flags(p->i_flags)) ||
@@ -1608,12 +1616,9 @@ static int ipgre_fill_info(struct sk_buff *skb, const struct net_device *dev)static int erspan_fill_info (struct sk_buff *skb,const struct net_device *dev) { -struct ip_tunnel *t =netdev_priv (dev); +const struct ip_tunnel *t =netdev_priv (dev);if (t->erspan_ver <=2 ) { -if (t->erspan_ver !=0 && !t->collect_md) -__set_bit (IP_TUNNEL_KEY_BIT , t->parms.o_flags); -if (nla_put_u8 (skb,IFLA_GRE_ERSPAN_VER , t->erspan_ver)) goto nla_put_failure;
net/ipv6/ip6_gre.c +3 -4
@@ -777,7 +777,7 @@ static netdev_tx_t __gre6_xmit(struct sk_buff *skb,ip_tunnel_flags_copy (flags, tunnel->parms.o_flags); - gre_build_header(skb, tunnel->tun_hlen, flags, + gre_build_header(skb, gre_calc_hlen(flags), flags, protocol, tunnel->parms.o_key, test_bit(IP_TUNNEL_SEQ_BIT, flags) ? htonl(atomic_fetch_inc(&tunnel->o_seqno)) :
@@ -964,7 +964,6 @@ static netdev_tx_t ip6erspan_tunnel_xmit(struct sk_buff *skb,if (skb_cow_head (skb, dev->needed_headroom ?: t->hlen)) goto tx_err; -__clear_bit (IP_TUNNEL_KEY_BIT , t->parms.o_flags);IPCB (skb)->flags =0 ;/* For collect_md mode, derive fl6 from the tunnel key,
@@ -2115,8 +2114,8 @@ static size_t ip6gre_get_size(const struct net_device *dev)static int ip6gre_fill_info (struct sk_buff *skb,const struct net_device *dev) { -struct ip6_tnl *t =netdev_priv (dev); -struct __ip6_tnl_parm *p = &t->parms; +const struct ip6_tnl *t =netdev_priv (dev); +const struct __ip6_tnl_parm *p = &t->parms;IP_TUNNEL_DECLARE_FLAGS (o_flags);ip_tunnel_flags_copy (o_flags, p->o_flags);
Signature · 1 line
2.55.0.229.g6434b31f56-goog
Quoted 42 lines · Eric Dumazet
For IPv4 ERSPAN:
Inerspan_xmit(), the driver clearsIP_TUNNEL_SEQ_BIT(for version 0) andIP_TUNNEL_KEY_BITdirectly in the sharedtunnel->parms.o_flagsstructure. Since transmit paths can run locklessly and concurrently, this leads to a data race.Furthermore, modifying
tunnel->parms.o_flagspermanently alters the tunnel configuration. To work around this,erspan_fill_info()(which reports config to userspace) was settingIP_TUNNEL_KEY_BITback. Iferspan_fill_info(running under RTNL) anderspan_xmit(running locklessly) race,erspan_xmitmight seeIP_TUNNEL_KEY_BITset when it shouldnt, leading to GRE header corruption (injecting a key field into the ERSPAN GRE header).Fix this by:
1) Snapshottingtunnel->parms.o_flagsonto the stack inipgre_xmit(),gre_tap_xmit(), and__gre6_xmit(), and computing the GRE header length viagre_calc_hlen(flags)instead of readingtunnel->tun_hlen. This eliminates TOCTOU races between flags, offload checks, and header length.
Note: Sincetunnel->tun_hlenis no longer used in fast path xmit, it could be removed altogether in net-next.
2) Using local flags inerspan_xmit(), clearingIP_TUNNEL_CSUM_BITandIP_TUNNEL_KEY_BIT(andIP_TUNNEL_SEQ_BITfor v0) before passing them to__gre_xmit().
3) Removing the racy modification oft->parms.o_flagsinerspan_fill_info().
4) ForcingIP_TUNNEL_KEY_BITin the reported flags for ERSPAN locally inipgre_fill_info().For IPv6 ERSPAN:
ip6erspan_tunnel_xmit()was locklessly clearingIP_TUNNEL_KEY_BITint->parms.o_flagseven though it does not use these flags for building the GRE header (it uses local flags). This permanently corrupts the configuration and races withip6gre_fill_info()which reads it.Remove the redundant and racy modification.
This should remove false sharing in a fast path.Add const qualifiers in
ipgre_fill_info(),erspan_fill_info()andip6gre_fill_info()to clarify that these methods are not supposed to write any live parameters.
Quoted 8 lines
Fixes 84e54fe0a5ea ("gre: introduce native tunnel support for ERSPAN")Fixes ee496694b9ee ("ip_gre: do not report erspan version on GRE interface")Fixes 5a963eb61b7c ("ip6_gre: Add ERSPAN native tunnel support")Signed-off-by Eric Dumazet <[email protected]>---
v2: addressed Sashiko and Ido feedback.
v1: https://lore.kernel.org/netdev/[email protected]/
Sashiko said:
<quote>
Does this code generate malformed GRE headers for ERSPAN if the sequence bit is missing from the output flags?
erspan_validate() permits configurations where the sequence bit is present in the input flags but missing from the output flags. In that case, the snapshot of the flags lacks IP_TUNNEL_SEQ_BIT.
After clearing IP_TUNNEL_CSUM_BIT and IP_TUNNEL_KEY_BIT, if IP_TUNNEL_SEQ_BIT is also missing:
net/ipv4/ip_gre.c:__gre_xmit() {
...
gre_build_header(skb, gre_calc_hlen(flags),
...
}
gre_calc_hlen(flags) will evaluate to 4 bytes instead of the 8 bytes required by the ERSPAN protocol. Before this patch, the hardcoded tunnel->tun_hlen ensured an 8-byte header for ERSPAN.
Could this result in structurally malformed packets being transmitted?
</quote>
What a mess.
pw-bot: cr
I will squash the following:
net/ipv4/ip_gre.c +0 -0
100644
net/ipv4/ip_gre.c +2 -0
@@ -739,11 +739,13 @@ static netdev_tx_t erspan_xmit(struct sk_buff *skb, tunnel->index, truncate, true); proto =htons (ETH_P_ERSPAN ); +__set_bit (IP_TUNNEL_SEQ_BIT , flags); }else if (tunnel->erspan_ver ==2 ) {erspan_build_header_v2 (skb,ntohl (tunnel->parms.o_key), tunnel->dir, tunnel->hwid, truncate, true); proto =htons (ETH_P_ERSPAN2 ); +__set_bit (IP_TUNNEL_SEQ_BIT , flags); }else { goto free_skb; }