Received-SPF: pass (google.com: domain of linux-bluetooth+bounces-4539-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
From: Erick Archer <erick.archer@outlook.com>
To: Marcel Holtmann <marcel@holtmann.org>,
	Johan Hedberg <johan.hedberg@gmail.com>,
	Luiz Augusto von Dentz <luiz.dentz@gmail.com>,
	"David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Jakub Kicinski <kuba@kernel.org>,
	Paolo Abeni <pabeni@redhat.com>,
	Kees Cook <keescook@chromium.org>,
	"Gustavo A. R. Silva" <gustavoars@kernel.org>,
	Nathan Chancellor <nathan@kernel.org>,
	Nick Desaulniers <ndesaulniers@google.com>,
	Bill Wendling <morbo@google.com>,
	Justin Stitt <justinstitt@google.com>,
	"Jiri Slaby (SUSE)" <jirislaby@kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Geert Uytterhoeven <geert@linux-m68k.org>
Cc: Erick Archer <erick.archer@outlook.com>,
	linux-bluetooth@vger.kernel.org,
	netdev@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	linux-hardening@vger.kernel.org,
	llvm@lists.linux.dev
Subject: [PATCH v2] tty: rfcomm: prefer struct_size over open coded arithmetic
Date: Sun, 12 May 2024 13:17:24 +0200
Message-ID:
 <AS8PR02MB7237262C62B054FABD7229168BE12@AS8PR02MB7237.eurprd02.prod.outlook.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-MessageSentRepresentingType: 1
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: AS8PR02MB7237:EE_|GVXPR02MB10690:EE_
X-MS-Office365-Filtering-Correlation-Id: b9e7f092-dbf6-4107-6eeb-08dc72752341
X-Microsoft-Antispam:
	BCL:0;ARA:14566002|461199019|1602099003|440099019|3412199016|1710799017;
X-Microsoft-Antispam-Message-Info:
	0zuDgyWjKt8f63JVqPGb+wwvHL9dMuf53GBWzIdoYpKnJ4gC4p5wxE9q7FdmqGo1aa9JhHjM0JAOBOvHknwVdBv36dzLmMQM5/yAIH/eSsm3TehAZfJVDAs3u6epp6T5hvhRj3bmwCkOYXqFnyK8C5I/GzzIX+YXrIvNwVuQKLCSofuEQQWC/bcqWjx1qcw5ABpKh5FqmQJdu3iiRlGpbT7Y+rUwDzXuyUkxkbYSwQZvVE7Wk09F1Ij+b4D3lDOCWtXO3rRBjwz6RdyWJYg1xpiiTjDRrJyaUZIOs00+Emxy57dSSBZWtPu7vMwFLrlX2YHMzWZOOPP1Yv6O1Iz27A79Cf6h0kNoIw1TfuzL0JKnO5A2GO66Ea302w1yGapAIZuOoNsX9gbCSg5RzEl/YVUUXsjmzWXtMB9ZwAPPKqTn/bDORsCUExwXvHzsYYrPqJi3oSml+WuLIRQqGgZ2cqjMyrp50ty9uUKWsABnTWFoU1/UdXnbLaPHzDkmYG0LgfxIJtIDPOioIEte4puJlRjKfmh9W6mDgzCoLxt+uFaaoLLq+xhFLMhfKM3hyYxfap5PYdB4+kEAEjFi1ON/x3xg7bUMw5zMDiVV656K49GV33vAYN0hEYlnYHDolZaMo0XsfbOX/OYHgQHY+2pzPXoawgMNXwvSt3hdCN4Yc+z78azOHOZAM8H9YnvwqCneRKiejwB8hBhWkUwH7t9zAw==
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?JXH39S/gWMh1ErEmQM/HmkXIHcjIF1VEMJ4KZYl6y1upxXt12K7RQvV1Jt3a?=
 =?us-ascii?Q?8YrX6m1+ww6nH3LyOP+DB2MOKfu0Ay2VeEsY9QkkPxgiD+vsEVJRpkx7TJkV?=
 =?us-ascii?Q?3Sk6PASO0MKcAE0uxg1TG19Mzb5p2GqbAAkhN0L8HGwxcAB6XBlW8sHH8l9b?=
 =?us-ascii?Q?xk5vUWVcBgnrbr0ukvov/Rvmr3Lf/qNrGOdQUzjeLAwkxthsAyhv7BjaD/HC?=
 =?us-ascii?Q?UI7Eu5NoFSxg3887hFOXzI57EJWnhYEnA9TSv0UivrhajHKNaIxGFMUMBlpa?=
 =?us-ascii?Q?e3HQ1ILIUHeL9Ysodo4SiFMcL/rEfwAAdtQB8KTLVgkw4xmltT9jvJot/esH?=
 =?us-ascii?Q?Ji4RRNKdqtJJ/NdFaTb0eWQFLl27r4t66d4wmDlSv9un0BvsHPTZTGJUzPXG?=
 =?us-ascii?Q?e9aOxsOYcvyOXSQJLtEd6TFoQZg1JcxclCPuXS8d9c0k7+RT3oVf9eDtB6G1?=
 =?us-ascii?Q?o/D4vjs3lD01IKPv0yPjBQ5rHK5/kB+6fdcvmDVwiL1T1AnHH1v6bfLPbpo9?=
 =?us-ascii?Q?yyLyfdgbleGuXVGZ9/3YviD/2SAiEAUpHuOCJ1/3uNVUwwyeBeWzVizkXZi8?=
 =?us-ascii?Q?dTCGgm2bajpggK5I0v2DXZu1UY19DIGf2atdPdZO4qGjqBi6Z8fGL8ijdSl5?=
 =?us-ascii?Q?8N8RxWfqf8Fj1b0zQ1FKUMOr3+a0aWoGBlXwVD+PxCbh2jNmjSY7KpUyL45w?=
 =?us-ascii?Q?47aYfYDAicJajU3susbS5/Pv4UeVPoH0uzdsDKtaIXTBq1GI1J+Mb8sx3+LJ?=
 =?us-ascii?Q?RjsypqTH0z8c8AFAKmn164DVK9P/YqIp7ESOQwIM/ds0eV9B2dHenQATWY7B?=
 =?us-ascii?Q?byXLV2dgHMj6hDZ0/2bwM4Vf15cQu2zrnFakipBekCQGJOYV1sOUev1sAqV8?=
 =?us-ascii?Q?c7xk581bV4mgDxp2ya49LuGWLCvCtf5gQ6//0PG4HWcU4vciSRv7h1wkfJf4?=
 =?us-ascii?Q?h+K5LPfu3MX0U/tTYSMj5UlGM9uEqn8G+ptOgn+S+UbRWMQcUdwQYKN73Wp/?=
 =?us-ascii?Q?RopL1bEAhe01y09SIAgR2Bxuinf5/QyPtaIGB9zARQFZ6oK1tE97690I2Gyf?=
 =?us-ascii?Q?JUlyApKmujQMunNMJAbDZ9fDtUB/2qny7cCpxswHiAidk11IKyLQwsRz58PI?=
 =?us-ascii?Q?nPQAkmJmpEm2u0q1EEKWjKNpBDMFIR+exoeplVC3DYU2K3mMWXOLupjaOJat?=
 =?us-ascii?Q?t9tyAoWdRYQLcQonF7Zie6Wo8G+SZOc7GH3fogjiUMysk4SsWMPNSlq46h3y?=
 =?us-ascii?Q?FASBtBSX93Ckz4QS7r0r?=
X-OriginatorOrg: outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: b9e7f092-dbf6-4107-6eeb-08dc72752341
X-MS-Exchange-CrossTenant-AuthSource: AS8PR02MB7237.eurprd02.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 May 2024 11:17:41.1723
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg:
	00000000-0000-0000-0000-000000000000
X-MS-Exchange-Transport-CrossTenantHeadersStamped: GVXPR02MB10690

This is an effort to get rid of all multiplications from allocation
functions in order to prevent integer overflows [1][2].

As the "dl" variable is a pointer to "struct rfcomm_dev_list_req" and
this structure ends in a flexible array:

struct rfcomm_dev_list_req {
	[...]
	struct   rfcomm_dev_info dev_info[];
};

the preferred way in the kernel is to use the struct_size() helper to
do the arithmetic instead of the calculation "size + count * size" in
the kzalloc() and copy_to_user() functions.

At the same time, prepare for the coming implementation by GCC and Clang
of the __counted_by attribute. Flexible array members annotated with
__counted_by can have their accesses bounds-checked at run-time via
CONFIG_UBSAN_BOUNDS (for array indexing) and CONFIG_FORTIFY_SOURCE (for
strcpy/memcpy-family functions).

In this case, it is important to note that the logic needs a little
refactoring to ensure that the "dev_num" member is initialized before
the first access to the flex array. Specifically, add the assignment
before the list_for_each_entry() loop.

Also remove the "size" variable as it is no longer needed and refactor
the list_for_each_entry() loop to use di[n] instead of (di + n).

This way, the code is more readable, idiomatic and safer.

This code was detected with the help of Coccinelle, and audited and
modified manually.

Link: https://www.kernel.org/doc/html/latest/process/deprecated.html#open-coded-arithmetic-in-allocator-arguments [1]
Link: https://github.com/KSPP/linux/issues/160 [2]
Signed-off-by: Erick Archer <erick.archer@outlook.com>
---
Changes in v2:
- Add the __counted_by() attribute (Kees Cook).
- Refactor the list_for_each_entry() loop to use di[n] instead of
  (di + n) (Kees Cook).

Previous versions:
v1 -> https://lore.kernel.org/linux-hardening/AS8PR02MB723725E0069F7AE8F64E876E8B142@AS8PR02MB7237.eurprd02.prod.outlook.com/
---
 include/net/bluetooth/rfcomm.h |  2 +-
 net/bluetooth/rfcomm/tty.c     | 23 ++++++++++-------------
 2 files changed, 11 insertions(+), 14 deletions(-)

diff --git a/include/net/bluetooth/rfcomm.h b/include/net/bluetooth/rfcomm.h
index 99d26879b02a..c05882476900 100644
--- a/include/net/bluetooth/rfcomm.h
+++ b/include/net/bluetooth/rfcomm.h
@@ -355,7 +355,7 @@ struct rfcomm_dev_info {
 
 struct rfcomm_dev_list_req {
 	u16      dev_num;
-	struct   rfcomm_dev_info dev_info[];
+	struct   rfcomm_dev_info dev_info[] __counted_by(dev_num);
 };
 
 int  rfcomm_dev_ioctl(struct sock *sk, unsigned int cmd, void __user *arg);
diff --git a/net/bluetooth/rfcomm/tty.c b/net/bluetooth/rfcomm/tty.c
index 69c75c041fe1..af80d599c337 100644
--- a/net/bluetooth/rfcomm/tty.c
+++ b/net/bluetooth/rfcomm/tty.c
@@ -504,7 +504,7 @@ static int rfcomm_get_dev_list(void __user *arg)
 	struct rfcomm_dev *dev;
 	struct rfcomm_dev_list_req *dl;
 	struct rfcomm_dev_info *di;
-	int n = 0, size, err;
+	int n = 0, err;
 	u16 dev_num;
 
 	BT_DBG("");
@@ -515,12 +515,11 @@ static int rfcomm_get_dev_list(void __user *arg)
 	if (!dev_num || dev_num > (PAGE_SIZE * 4) / sizeof(*di))
 		return -EINVAL;
 
-	size = sizeof(*dl) + dev_num * sizeof(*di);
-
-	dl = kzalloc(size, GFP_KERNEL);
+	dl = kzalloc(struct_size(dl, dev_info, dev_num), GFP_KERNEL);
 	if (!dl)
 		return -ENOMEM;
 
+	dl->dev_num = dev_num;
 	di = dl->dev_info;
 
 	mutex_lock(&rfcomm_dev_lock);
@@ -528,12 +527,12 @@ static int rfcomm_get_dev_list(void __user *arg)
 	list_for_each_entry(dev, &rfcomm_dev_list, list) {
 		if (!tty_port_get(&dev->port))
 			continue;
-		(di + n)->id      = dev->id;
-		(di + n)->flags   = dev->flags;
-		(di + n)->state   = dev->dlc->state;
-		(di + n)->channel = dev->channel;
-		bacpy(&(di + n)->src, &dev->src);
-		bacpy(&(di + n)->dst, &dev->dst);
+		di[n].id      = dev->id;
+		di[n].flags   = dev->flags;
+		di[n].state   = dev->dlc->state;
+		di[n].channel = dev->channel;
+		bacpy(&di[n].src, &dev->src);
+		bacpy(&di[n].dst, &dev->dst);
 		tty_port_put(&dev->port);
 		if (++n >= dev_num)
 			break;
@@ -542,9 +541,7 @@ static int rfcomm_get_dev_list(void __user *arg)
 	mutex_unlock(&rfcomm_dev_lock);
 
 	dl->dev_num = n;
-	size = sizeof(*dl) + n * sizeof(*di);
-
-	err = copy_to_user(arg, dl, size);
+	err = copy_to_user(arg, dl, struct_size(dl, dev_info, n));
 	kfree(dl);
 
 	return err ? -EFAULT : 0;
-- 
2.25.1