tcp: md5: refine tcp_md5_do_add()/tcp_md5_hash_key() barriers
Subsystems (3)
PATCH v2 1/1 tcp: md5: refine tcp_md5_do_add()/tcp_md5_hash_key() barriers
My prior fix went a bit too far, according to Herbert and Mathieu.
Since we accept that concurrent TCP MD5 lookups might see inconsistent keys, we can use READ_ONCE()/WRITE_ONCE() instead of smp_rmb()/smp_wmb()
Clearing all key->key[] is needed to avoid possible KMSAN reports, if key->keylen is increased. Since tcp_md5_do_add() is not fast path, using __GFP_ZERO to clear all struct tcp_md5sig_key is simpler.
data_race() was added in linux-5.8 and will prevent KCSAN reports, this can safely be removed in stable backports, if data_race() is not yet backported.
v2: use data_race() both in tcp_md5_hash_key() and tcp_md5_do_add()
--- net/ipv4/tcp.c | 8 ++++---- net/ipv4/tcp_ipv4.c | 19 ++++++++++++++----- 2 files changed, 18 insertions(+), 9 deletions(-)
net/ipv4/tcp.c +4 -4
@@ -4033,14 +4033,14 @@ EXPORT_SYMBOL(tcp_md5_hash_skb_data);int tcp_md5_hash_key (struct tcp_md5sig_pool *hp,const struct tcp_md5sig_key *key) { -u8 keylen = key->keylen; +u8 keylen =READ_ONCE (key->keylen);/* paired with WRITE_ONCE() in tcp_md5_do_add */ struct scatterlist sg; -smp_rmb ();/* paired with smp_wmb() in tcp_md5_do_add() */ -sg_init_one (&sg, key->key, keylen);ahash_request_set_crypt (hp->md5_req, &sg,NULL , keylen); -return crypto_ahash_update (hp->md5_req); + +/* We use data_race() because tcp_md5_do_add() might change key->key under us */ +return data_race (crypto_ahash_update (hp->md5_req)); }EXPORT_SYMBOL (tcp_md5_hash_key);
net/ipv4/tcp_ipv4.c +14 -5
@@ -1111,12 +1111,21 @@ int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr, key =tcp_md5_do_lookup_exact (sk, addr, family, prefixlen, l3index);if (key) { -/* Pre-existing entry - just update that one. */ -memcpy (key->key, newkey, newkeylen); +/* Pre-existing entry - just update that one. +* Note that the key might be used concurrently. +* data_race() is telling kcsan that we do not care of +* key mismatches, since changing MD5 key on live flows +* can lead to packet drops. +*/ +data_race (memcpy (key->key, newkey, newkeylen)); -smp_wmb ();/* pairs with smp_rmb() in tcp_md5_hash_key() */ +/* Pairs with READ_ONCE() in tcp_md5_hash_key(). +* Also note that a reader could catch new key->keylen value +* but old key->key[], this is the reason we use __GFP_ZERO +* at sock_kmalloc() time below these lines. +*/ +WRITE_ONCE (key->keylen, newkeylen); - key->keylen = newkeylen;return 0 ; }
@@ -1132,7 +1141,7 @@ int tcp_md5_do_add(struct sock *sk, const union tcp_md5_addr *addr,rcu_assign_pointer (tp->md5sig_info, md5sig); } - key =sock_kmalloc (sk,sizeof (*key), gfp); + key =sock_kmalloc (sk,sizeof (*key), gfp | __GFP_ZERO);if (!key)return -ENOMEM ;if (!tcp_alloc_md5sig_pool ()) {
Signature · 1 line
2.27.0.212.ge8ba1cc988-goog
Quoted 13 lines · ----- On Jul 1, 2020, at 2:43 PM, Eric Dumazet [email protected] wrote:
My prior fix went a bit too far, according to Herbert and Mathieu.
Since we accept that concurrent TCP MD5 lookups might see inconsistent keys, we can use READ_ONCE()/WRITE_ONCE() instead of smp_rmb()/smp_wmb()
Clearing all key->key[] is needed to avoid possible KMSAN reports, if
key->keylenis increased. Sincetcp_md5_do_add()is not fast path, using__GFP_ZEROto clear all structtcp_md5sig_keyis simpler.
data_race()was added in linux-5.8 and will prevent KCSAN reports, this can safely be removed in stable backports, ifdata_race()is not yet backported.
Quoted 6 lines
v2: use
data_race()both intcp_md5_hash_key()andtcp_md5_do_add()Fixes 6a2febec338d ("tcp: md5: add missing memory barriers intcp_md5_do_add()/tcp_md5_hash_key()")
Signed-off-by Eric Dumazet <[email protected]>Cc Mathieu Desnoyers <[email protected]>
Thanks !
Mathieu
Signature · 3 lines
Mathieu Desnoyers EfficiOS Inc. http://www.efficios.com
Quoted 20 lines · Eric Dumazet
My prior fix went a bit too far, according to Herbert and Mathieu.
Since we accept that concurrent TCP MD5 lookups might see inconsistent keys, we can use READ_ONCE()/WRITE_ONCE() instead of smp_rmb()/smp_wmb()
Clearing all key->key[] is needed to avoid possible KMSAN reports, if
key->keylenis increased. Sincetcp_md5_do_add()is not fast path, using__GFP_ZEROto clear all structtcp_md5sig_keyis simpler.
data_race()was added in linux-5.8 and will prevent KCSAN reports, this can safely be removed in stable backports, ifdata_race()is not yet backported.v2: use
data_race()both intcp_md5_hash_key()andtcp_md5_do_add()Fixes 6a2febec338d ("tcp: md5: add missing memory barriers in tcp_md5_do_add()/tcp_md5_hash_key()")Signed-off-by Eric Dumazet <[email protected]>Cc Mathieu Desnoyers <[email protected]>Cc Herbert Xu <[email protected]>Cc Marco Elver <[email protected]>
Quoted 4 lines
--- net/ipv4/tcp.c | 8 ++++---- net/ipv4/tcp_ipv4.c | 19 ++++++++++++++----- 2 files changed, 18 insertions(+), 9 deletions(-)
Thanks,
Signature · 3 lines
Email: Herbert Xu <[email protected]> Home Page: http://gondor.apana.org.au/~herbert/ PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
David Miller
maintainerFrom: Eric Dumazet <[email protected]>
Date: Wed, 1 Jul 2020 11:43:04 -0700
Quoted 9 lines
My prior fix went a bit too far, according to Herbert and Mathieu.
Since we accept that concurrent TCP MD5 lookups might see inconsistent keys, we can use READ_ONCE()/WRITE_ONCE() instead of smp_rmb()/smp_wmb()
Clearing all key->key[] is needed to avoid possible KMSAN reports, if
key->keylenis increased. Sincetcp_md5_do_add()is not fast path, using__GFP_ZEROto clear all structtcp_md5sig_keyis simpler.
Quoted 8 lines
data_race()was added in linux-5.8 and will prevent KCSAN reports, this can safely be removed in stable backports, ifdata_race()is not yet backported.v2: use
data_race()both intcp_md5_hash_key()andtcp_md5_do_add()Fixes 6a2febec338d ("tcp: md5: add missing memory barriers in tcp_md5_do_add()/tcp_md5_hash_key()")Signed-off-by Eric Dumazet <[email protected]>
Applied and queued up for -stable, thanks Eric.