net: Introduce nlmsg_payload helper
Subsystems (3)
v2 cover net: Introduce nlmsg_payload helper
In the current codebase, there are multiple instances where the structure size is checked before assigning it to a Netlink message. This check is crucial for ensuring that the structure is correctly mapped onto the Netlink message, providing a layer of security.
To streamline this process, Jakub Kicinski suggested creating a helper function, nlmsg_payload, which verifies if the structure fits within the message. If it does, the function returns the data; otherwise, it returns NULL. This approach simplifies the code and reduces redundancy.
This patchset introduces the nlmsg_payload helper and updates several parts of the code to use it. Further updates will follow in subsequent patchsets.
---
Changes in v2:
- Add the "Return" kdoc entry for nlmsg_payload() (Jakub)
- Use the same function in some other places (Kuniyuki Iwashima)
- Link to v1: https://lore.kernel.org/r/[email protected]
---
Breno Leitao (10):
netlink: Introduce nlmsg_payload helper
neighbour: Use nlmsg_payload in neightbl_valid_dump_info
neighbour: Use nlmsg_payload in neigh_valid_get_req
rtnetlink: Use nlmsg_payload in valid_fdb_dump_strict
mpls: Use nlmsg_payload in mpls_valid_fib_dump_req
ipv6: Use nlmsg_payload in inet6_valid_dump_ifaddr_req
ipv6: Use nlmsg_payload in inet6_rtm_valid_getaddr_req
mpls: Use nlmsg_payload in mpls_valid_getroute_req
net: fib_rules: Use nlmsg_payload in fib_valid_dumprule_req
net: fib_rules: Use nlmsg_payload in fib_{new,del}rule()
include/net/netlink.h | 16 ++++++++++++++++ net/core/fib_rules.c | 14 ++++++++------ net/core/neighbour.c | 8 ++++---- net/core/rtnetlink.c | 4 ++-- net/ipv6/addrconf.c | 8 ++++---- net/mpls/af_mpls.c | 8 ++++---- 6 files changed, 38 insertions(+), 20 deletions(-)
---
base-commit: 6a325aed130bb68790e765f923e76ec5669d2da7
change-id: 20250411-nlmsg-2dd8c30ba35c
Best regards,
Signature · 1 line
Breno Leitao <[email protected]>
PATCH v2 1/10 netlink: Introduce nlmsg_payload helper
Create a new helper function, nlmsg_payload(), to simplify checking and retrieving Netlink message payloads.
This reduces boilerplate code for users who need to verify the message length before accessing its data.
--- include/net/netlink.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)
include/net/netlink.h +16 -0
@@ -611,6 +611,22 @@ static inline int nlmsg_len(const struct nlmsghdr *nlh)return nlh->nlmsg_len -NLMSG_HDRLEN ; } +/** +* nlmsg_payload - message payload if the data fits in the len +* @nlh: netlink message header +* @len: struct length +* +* Returns: The netlink message payload/data if the length is sufficient, +* otherwise NULL. +*/ +static inline void *nlmsg_payload (const struct nlmsghdr *nlh,size_t len) +{ +if (nlh->nlmsg_len <nlmsg_msg_size (len)) +return NULL ; + +return nlmsg_data (nlh); +} +/** * nlmsg_attrdata - head of attributes data * @nlh: netlink message header
Signature · 1 line
2.47.1
PATCH v2 2/10 neighbour: Use nlmsg_payload in neightbl_valid_dump_info
In reply to Breno LeitaoUpdate neightbl_valid_dump_info function to utilize the new nlmsg_payload() helper function.
This change improves code clarity and safety by ensuring that the Netlink message payload is properly validated before accessing its data.
--- net/core/neighbour.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
net/core/neighbour.c +2 -2
@@ -2430,12 +2430,12 @@ static int neightbl_valid_dump_info(const struct nlmsghdr *nlh, {struct ndtmsg *ndtm; -if (nlh->nlmsg_len <nlmsg_msg_size (sizeof (*ndtm))) { + ndtm =nlmsg_payload (nlh,sizeof (*ndtm)); +if (!ndtm) {NL_SET_ERR_MSG (extack,"Invalid header for neighbor table dump request" );return -EINVAL ; } - ndtm =nlmsg_data (nlh);if (ndtm->ndtm_pad1 || ndtm->ndtm_pad2) {NL_SET_ERR_MSG (extack,"Invalid values in header for neighbor table dump request" );return -EINVAL ;
Signature · 1 line
2.47.1
PATCH v2 3/10 neighbour: Use nlmsg_payload in neigh_valid_get_req
In reply to Breno LeitaoUpdate neigh_valid_get_req function to utilize the new nlmsg_payload() helper function.
This change improves code clarity and safety by ensuring that the Netlink message payload is properly validated before accessing its data.
--- net/core/neighbour.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
net/core/neighbour.c +2 -2
@@ -2855,12 +2855,12 @@ static int neigh_valid_get_req(const struct nlmsghdr *nlh,struct ndmsg *ndm;int err, i; -if (nlh->nlmsg_len <nlmsg_msg_size (sizeof (*ndm))) { + ndm =nlmsg_payload (nlh,sizeof (*ndm)); +if (!ndm) {NL_SET_ERR_MSG (extack,"Invalid header for neighbor get request" );return -EINVAL ; } - ndm =nlmsg_data (nlh);if (ndm->ndm_pad1 || ndm->ndm_pad2 || ndm->ndm_state || ndm->ndm_type) {NL_SET_ERR_MSG (extack,"Invalid values in header for neighbor get request" );
Signature · 1 line
2.47.1
PATCH v2 4/10 rtnetlink: Use nlmsg_payload in valid_fdb_dump_strict
In reply to Breno LeitaoLeverage the new nlmsg_payload() helper to avoid checking for message size and then reading the nlmsg data.
--- net/core/rtnetlink.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
net/core/rtnetlink.c +2 -2
@@ -4886,12 +4886,12 @@ static int valid_fdb_dump_strict(const struct nlmsghdr *nlh,struct ndmsg *ndm;int err, i; -if (nlh->nlmsg_len <nlmsg_msg_size (sizeof (*ndm))) { + ndm =nlmsg_payload (nlh,sizeof (*ndm)); +if (!ndm) {NL_SET_ERR_MSG (extack,"Invalid header for fdb dump request" );return -EINVAL ; } - ndm =nlmsg_data (nlh);if (ndm->ndm_pad1 || ndm->ndm_pad2 || ndm->ndm_state || ndm->ndm_flags || ndm->ndm_type) {NL_SET_ERR_MSG (extack,"Invalid values in header for fdb dump request" );
Signature · 1 line
2.47.1
PATCH v2 5/10 mpls: Use nlmsg_payload in mpls_valid_fib_dump_req
In reply to Breno LeitaoLeverage the new nlmsg_payload() helper to avoid checking for message size and then reading the nlmsg data.
--- net/mpls/af_mpls.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
net/mpls/af_mpls.c +2 -2
@@ -2095,12 +2095,12 @@ static int mpls_valid_fib_dump_req(struct net *net, const struct nlmsghdr *nlh,struct rtmsg *rtm;int err, i; -if (nlh->nlmsg_len <nlmsg_msg_size (sizeof (*rtm))) { + rtm =nlmsg_payload (nlh,sizeof (*rtm)); +if (!rtm) {NL_SET_ERR_MSG_MOD (extack,"Invalid header for FIB dump request" );return -EINVAL ; } - rtm =nlmsg_data (nlh);if (rtm->rtm_dst_len || rtm->rtm_src_len || rtm->rtm_tos || rtm->rtm_table || rtm->rtm_scope || rtm->rtm_type || rtm->rtm_flags) {
Signature · 1 line
2.47.1
PATCH v2 6/10 ipv6: Use nlmsg_payload in inet6_valid_dump_ifaddr_req
In reply to Breno LeitaoLeverage the new nlmsg_payload() helper to avoid checking for message size and then reading the nlmsg data.
--- net/ipv6/addrconf.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
net/ipv6/addrconf.c +2 -2
@@ -5346,12 +5346,12 @@ static int inet6_valid_dump_ifaddr_req(const struct nlmsghdr *nlh,struct ifaddrmsg *ifm;int err, i; -if (nlh->nlmsg_len <nlmsg_msg_size (sizeof (*ifm))) { + ifm =nlmsg_payload (nlh,sizeof (*ifm)); +if (!ifm) {NL_SET_ERR_MSG_MOD (extack,"Invalid header for address dump request" );return -EINVAL ; } - ifm =nlmsg_data (nlh);if (ifm->ifa_prefixlen || ifm->ifa_flags || ifm->ifa_scope) {NL_SET_ERR_MSG_MOD (extack,"Invalid values in header for address dump request" );return -EINVAL ;
Signature · 1 line
2.47.1
PATCH v2 7/10 ipv6: Use nlmsg_payload in inet6_rtm_valid_getaddr_req
In reply to Breno LeitaoLeverage the new nlmsg_payload() helper to avoid checking for message size and then reading the nlmsg data.
--- net/ipv6/addrconf.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
net/ipv6/addrconf.c +2 -2
@@ -5484,7 +5484,8 @@ static int inet6_rtm_valid_getaddr_req(struct sk_buff *skb,struct ifaddrmsg *ifm;int i, err; -if (nlh->nlmsg_len <nlmsg_msg_size (sizeof (*ifm))) { + ifm =nlmsg_payload (nlh,sizeof (*ifm)); +if (!ifm) {NL_SET_ERR_MSG_MOD (extack,"Invalid header for get address request" );return -EINVAL ; }
@@ -5493,7 +5494,6 @@ static int inet6_rtm_valid_getaddr_req(struct sk_buff *skb,return nlmsg_parse_deprecated (nlh,sizeof (*ifm), tb,IFA_MAX , ifa_ipv6_policy, extack); - ifm =nlmsg_data (nlh);if (ifm->ifa_prefixlen || ifm->ifa_flags || ifm->ifa_scope) {NL_SET_ERR_MSG_MOD (extack,"Invalid values in header for get address request" );return -EINVAL ;
Signature · 1 line
2.47.1
PATCH v2 8/10 mpls: Use nlmsg_payload in mpls_valid_getroute_req
In reply to Breno LeitaoLeverage the new nlmsg_payload() helper to avoid checking for message size and then reading the nlmsg data.
--- net/mpls/af_mpls.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
net/mpls/af_mpls.c +2 -2
@@ -2288,7 +2288,8 @@ static int mpls_valid_getroute_req(struct sk_buff *skb,struct rtmsg *rtm;int i, err; -if (nlh->nlmsg_len <nlmsg_msg_size (sizeof (*rtm))) { + rtm =nlmsg_payload (nlh,sizeof (*rtm)); +if (!rtm) {NL_SET_ERR_MSG_MOD (extack,"Invalid header for get route request" );return -EINVAL ;
@@ -2298,7 +2299,6 @@ static int mpls_valid_getroute_req(struct sk_buff *skb,return nlmsg_parse_deprecated (nlh,sizeof (*rtm), tb,RTA_MAX , rtm_mpls_policy, extack); - rtm =nlmsg_data (nlh);if ((rtm->rtm_dst_len && rtm->rtm_dst_len !=20 ) || rtm->rtm_src_len || rtm->rtm_tos || rtm->rtm_table || rtm->rtm_protocol || rtm->rtm_scope || rtm->rtm_type) {
Signature · 1 line
2.47.1
PATCH v2 9/10 net: fib_rules: Use nlmsg_payload in fib_valid_dumprule_req
In reply to Breno LeitaoLeverage the new nlmsg_payload() helper to avoid checking for message size and then reading the nlmsg data.
--- net/core/fib_rules.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
net/core/fib_rules.c +2 -2
@@ -1238,12 +1238,12 @@ static int fib_valid_dumprule_req(const struct nlmsghdr *nlh, {struct fib_rule_hdr *frh; -if (nlh->nlmsg_len <nlmsg_msg_size (sizeof (*frh))) { + frh =nlmsg_payload (nlh,sizeof (*frh)); +if (!frh) {NL_SET_ERR_MSG (extack,"Invalid header for fib rule dump request" );return -EINVAL ; } - frh =nlmsg_data (nlh);if (frh->dst_len || frh->src_len || frh->tos || frh->table || frh->res1 || frh->res2 || frh->action || frh->flags) { NL_SET_ERR_MSG(extack,
Signature · 1 line
2.47.1
PATCH v2 10/10 net: fib_rules: Use nlmsg_payload in fib_{new,del}rule()
In reply to Breno LeitaoLeverage the new nlmsg_payload() helper to avoid checking for message size and then reading the nlmsg data.
--- net/core/fib_rules.c | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)
net/core/fib_rules.c +6 -4
@@ -852,13 +852,14 @@ int fib_newrule(struct net *net, struct sk_buff *skb, struct nlmsghdr *nlh, struct netlink_ext_ack *extack, bool rtnl_held) {struct fib_rule *rule =NULL , *r, *last =NULL ; -struct fib_rule_hdr *frh =nlmsg_data (nlh);int err = -EINVAL , unresolved =0 ;struct fib_rules_ops *ops =NULL ;struct nlattr *tb[FRA_MAX +1 ];bool user_priority = false; +struct fib_rule_hdr *frh; -if (nlh->nlmsg_len <nlmsg_msg_size (sizeof (*frh))) { + frh =nlmsg_payload (nlh,sizeof (*frh)); +if (!frh) {NL_SET_ERR_MSG (extack,"Invalid msg length" ); goto errout; }
@@ -980,13 +981,14 @@ int fib_delrule(struct net *net, struct sk_buff *skb, struct nlmsghdr *nlh, struct netlink_ext_ack *extack, bool rtnl_held) {struct fib_rule *rule =NULL , *nlrule =NULL ; -struct fib_rule_hdr *frh =nlmsg_data (nlh);struct fib_rules_ops *ops =NULL ;struct nlattr *tb[FRA_MAX +1 ];bool user_priority = false; +struct fib_rule_hdr *frh;int err = -EINVAL ; -if (nlh->nlmsg_len <nlmsg_msg_size (sizeof (*frh))) { + frh =nlmsg_payload (nlh,sizeof (*frh)); +if (!frh) {NL_SET_ERR_MSG (extack,"Invalid msg length" ); goto errout; }
Signature · 1 line
2.47.1
Re: [PATCH net-next v2 10/10] net: fib_rules: Use nlmsg_payload in fib_{new,del}rule()
From: Breno Leitao <[email protected]>
Date: Mon, 14 Apr 2025 06:24:16 -0700
Quoted 5 lines
Leverage the new
nlmsg_payload()helper to avoid checking for message size and then reading the nlmsg data.Suggested-by Kuniyuki Iwashima <[email protected]>Signed-off-by Breno Leitao <[email protected]>
This series was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Hello:
This series was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Quoted 11 lines · On Mon, 14 Apr 2025 06:24:06 -0700 you wrote:
In the current codebase, there are multiple instances where the structure size is checked before assigning it to a Netlink message. This check is crucial for ensuring that the structure is correctly mapped onto the Netlink message, providing a layer of security.
To streamline this process, Jakub Kicinski suggested creating a helper function,
nlmsg_payload, which verifies if the structure fits within the message. If it does, the function returns the data; otherwise, it returns NULL. This approach simplifies the code and reduces redundancy.[...]
Here is the summary with links:
- [net-next,v2,01/10] netlink: Introduce nlmsg_payload helper
https://git.kernel.org/netdev/net-next/c/95d06e92a401 - [net-next,v2,02/10] neighbour: Use nlmsg_payload in neightbl_valid_dump_info https://git.kernel.org/netdev/net-next/c/7527efe8a416 - [net-next,v2,03/10] neighbour: Use nlmsg_payload in neigh_valid_get_req https://git.kernel.org/netdev/net-next/c/2d1f827f0642 - [net-next,v2,04/10] rtnetlink: Use nlmsg_payload in valid_fdb_dump_strict https://git.kernel.org/netdev/net-next/c/77d02290366f - [net-next,v2,05/10] mpls: Use nlmsg_payload in mpls_valid_fib_dump_req https://git.kernel.org/netdev/net-next/c/72be72bea9dc - [net-next,v2,06/10] ipv6: Use nlmsg_payload in inet6_valid_dump_ifaddr_req https://git.kernel.org/netdev/net-next/c/e87187dfbb9f - [net-next,v2,07/10] ipv6: Use nlmsg_payload in inet6_rtm_valid_getaddr_req https://git.kernel.org/netdev/net-next/c/8cf1e30907de - [net-next,v2,08/10] mpls: Use nlmsg_payload in mpls_valid_getroute_req https://git.kernel.org/netdev/net-next/c/69a1ecfe47f0 - [net-next,v2,09/10] net: fib_rules: Use nlmsg_payload in fib_valid_dumprule_req https://git.kernel.org/netdev/net-next/c/4c113c803fdc - [net-next,v2,10/10] net: fib_rules: Use nlmsg_payload in fib_{new,del}rule() https://git.kernel.org/netdev/net-next/c/8ff953036110
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html