Skip to contentSkip to conversation

src: use reentrant getprotobyname_r()/getprotobynumber_r()/getservbyport_r()

PATCH Applied Thomas Haller 2 participants 7 messages Aug 18, 2023 – Aug 20, 2023 netfilter

lore
Share & tools
lore
#0 lore raw

v3 cover src: use reentrant getprotobyname_r()/getprotobynumber_r()/getservbyport_r()

Changes since version 2:

- split the patch.

- add and use defines NFT_PROTONAME_MAXSIZE, NFT_SERVNAME_MAXSIZE, NETDB_BUFSIZE.

- add new GPL2+ source file as a place for the wrapper functions.

Thomas Haller (3):
nftutils: add new internal file for general utilities
nftutils: add wrappers for getprotoby{name,number}_r(),
getservbyport_r()
src: use wrappers for getprotoby{name,number}_r(), getservbyport_r()

 configure.ac    |   4 ++
 src/Makefile.am |   2 +
 src/datatype.c  |  33 ++++++++--------
 src/json.c      |  22 +++++------
 src/nftutils.c  | 102 ++++++++++++++++++++++++++++++++++++++++++++++++
 src/nftutils.h  |  21 ++++++++++
 src/rule.c      |   7 ++--
 7 files changed, 161 insertions(+), 30 deletions(-)
 create mode 100644 src/nftutils.c
 create mode 100644 src/nftutils.h
Signature · 1 line
2.41.0
#1 lore raw

PATCH v3 1/3 nftutils: add new internal file for general utilities

No code there, yet.

Similar to "utils.c", it is a place for various helper functions.

But this will be GPL-2.0-or-later licensed, from the start.

"utils.c" would be a better name, but that is already taken.

The header is not under include/ directory, but placed alongside the source files. That is, because this is internal API to the library. It also should be included with quotes instead of angle brackets.

---
 src/Makefile.am | 2 ++
 src/nftutils.c  | 5 +++++
 src/nftutils.h  | 5 +++++
 3 files changed, 12 insertions(+)
 create mode 100644 src/nftutils.c
 create mode 100644 src/nftutils.h
src/Makefile.am +2 -0
index ace38bd75a97..ad22a918c120 100644
@@ -64,6 +64,8 @@ libnftables_la_SOURCES =			\
 		segtree.c			\
 		gmputil.c			\
 		utils.c				\
+		nftutils.c			\
+		nftutils.h			\
 		erec.c				\
 		mnl.c				\
 		iface.c				\
src/nftutils.c new file +5 -0
new file mode 100644
index 000000000000..758283d1b650
@@ -0,0 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#include <config.h>
+
+#include "nftutils.h"
src/nftutils.h new file +5 -0
new file mode 100644
index 000000000000..9ad68d55ce47
@@ -0,0 +1,5 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+#ifndef NFTUTILS_H
+#define NFTUTILS_H
+
+#endif /* NFTUTILS_H */
Signature · 1 line
2.41.0
#2 lore raw

PATCH v3 2/3 nftutils: add wrappers for getprotoby{name,number}_r(), getservbyport_r()

In reply to Thomas Haller

We should aim to use the thread-safe variants of getprotoby{name,number} and getservbyport(). However, they may not be available with other libc, so it requires a configure check. As that is cumbersome, add wrappers that do that at one place.

---
 configure.ac   |  4 +++
 src/nftutils.c | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++
 src/nftutils.h | 16 +++++++++
 3 files changed, 117 insertions(+)
configure.ac +4 -0
index b0201ac3528e..42f0dc4cf392 100644
@@ -108,6 +108,10 @@ AC_DEFINE([HAVE_LIBJANSSON], [1], [Define if you have libjansson])
 ])
 AM_CONDITIONAL([BUILD_JSON], [test "x$with_json" != xno])
 
+AC_CHECK_DECLS([getprotobyname_r, getprotobynumber_r, getservbyport_r], [], [], [[
+#include <netdb.h>
+]])
+
 AC_CONFIG_FILES([					\
 		Makefile				\
 		libnftables.pc				\
src/nftutils.c +97 -0

100 lines not on this page · raw message

src/nftutils.h +16 -0
index 9ad68d55ce47..cb584b9ca32b 100644
@@ -2,4 +2,20 @@
 #ifndef NFTUTILS_H
 #define NFTUTILS_H
 
+#include <stdbool.h>
+#include <stddef.h>
+
+/* The maximum buffer size for (struct protoent).p_name. It is excessively large,
+ * while still reasonably fitting on the stack. Arbitrarily chosen. */
+#define NFT_PROTONAME_MAXSIZE 1024
+
+bool nft_getprotobynumber(int number, char *out_name, size_t name_len);
+int nft_getprotobyname(const char *name);
+
+/* The maximum buffer size for (struct servent).s_name. It is excessively large,
+ * while still reasonably fitting on the stack. Arbitrarily chosen. */
+#define NFT_SERVNAME_MAXSIZE 1024
+
+bool nft_getservbyport(int port, const char *proto, char *out_name, size_t name_len);
+
 #endif /* NFTUTILS_H */
Signature · 1 line
2.41.0
#3 lore raw

PATCH v3 3/3 src: use wrappers for getprotoby{name,number}_r(), getservbyport_r()

In reply to Thomas Haller

These wrappers are thread-safe, if libc provides the reentrant versions. Use them.

---
 src/datatype.c | 33 +++++++++++++++++----------------
 src/json.c     | 22 +++++++++++-----------
 src/rule.c     |  7 ++++---
 3 files changed, 32 insertions(+), 30 deletions(-)
src/datatype.c +17 -16
index da802a18bccd..381320eaf842 100644
@@ -29,6 +29,7 @@
 #include <netlink.h>
 #include <json.h>
 #include <misspell.h>
+#include "nftutils.h"
 
 #include <netinet/ip_icmp.h>
 
@@ -697,12 +698,11 @@ const struct datatype ip6addr_type = {
 static void inet_protocol_type_print(const struct expr *expr,
 				      struct output_ctx *octx)
 {
-	struct protoent *p;
-
 	if (!nft_output_numeric_proto(octx)) {
-		p = getprotobynumber(mpz_get_uint8(expr->value));
-		if (p != NULL) {
-			nft_print(octx, "%s", p->p_name);
+		char name[NFT_PROTONAME_MAXSIZE];
+
+		if (nft_getprotobynumber(mpz_get_uint8(expr->value), name, sizeof(name))) {
+			nft_print(octx, "%s", name);
 			return;
 		}
 	}
@@ -711,15 +711,15 @@ static void inet_protocol_type_print(const struct expr *expr,
 
 static void inet_protocol_type_describe(struct output_ctx *octx)
 {
-	struct protoent *p;
 	uint8_t protonum;
 
 	for (protonum = 0; protonum < UINT8_MAX; protonum++) {
-		p = getprotobynumber(protonum);
-		if (!p)
+		char name[NFT_PROTONAME_MAXSIZE];
+
+		if (!nft_getprotobynumber(protonum, name, sizeof(name)))
 			continue;
 
-		nft_print(octx, "\t%-30s\t%u\n", p->p_name, protonum);
+		nft_print(octx, "\t%-30s\t%u\n", name, protonum);
 	}
 }
 
@@ -727,7 +727,6 @@ static struct error_record *inet_protocol_type_parse(struct parse_ctx *ctx,
 						     const struct expr *sym,
 						     struct expr **res)
 {
-	struct protoent *p;
 	uint8_t proto;
 	uintmax_t i;
 	char *end;
@@ -740,11 +739,13 @@ static struct error_record *inet_protocol_type_parse(struct parse_ctx *ctx,
 
 		proto = i;
 	} else {
-		p = getprotobyname(sym->identifier);
-		if (p == NULL)
+		int r;
+
+		r = nft_getprotobyname(sym->identifier);
+		if (r < 0)
 			return error(&sym->location, "Could not resolve protocol name");
 
-		proto = p->p_proto;
+		proto = r;
 	}
 
 	*res = constant_expr_alloc(&sym->location, &inet_protocol_type,
@@ -768,12 +769,12 @@ const struct datatype inet_protocol_type = {
 static void inet_service_print(const struct expr *expr, struct output_ctx *octx)
 {
 	uint16_t port = mpz_get_be16(expr->value);
-	const struct servent *s = getservbyport(port, NULL);
+	char name[NFT_SERVNAME_MAXSIZE];
 
-	if (s == NULL)
+	if (!nft_getservbyport(port, NULL, name, sizeof(name)))
 		nft_print(octx, "%hu", ntohs(port));
 	else
-		nft_print(octx, "\"%s\"", s->s_name);
+		nft_print(octx, "\"%s\"", name);
 }
 
 void inet_service_type_print(const struct expr *expr, struct output_ctx *octx)
src/json.c +11 -11
index a119dfc4f1eb..57a597bce467 100644
@@ -15,6 +15,7 @@
 #include <netlink.h>
 #include <rule.h>
 #include <rt.h>
+#include "nftutils.h"
 
 #include <netdb.h>
 #include <netinet/icmp6.h>
@@ -297,10 +298,10 @@ static json_t *chain_print_json(const struct chain *chain)
 
 static json_t *proto_name_json(uint8_t proto)
 {
-	const struct protoent *p = getprotobynumber(proto);
+	char name[NFT_PROTONAME_MAXSIZE];
 
-	if (p)
-		return json_string(p->p_name);
+	if (nft_getprotobynumber(proto, name, sizeof(name)))
+		return json_string(name);
 	return json_integer(proto);
 }
 
@@ -1093,12 +1094,11 @@ json_t *boolean_type_json(const struct expr *expr, struct output_ctx *octx)
 json_t *inet_protocol_type_json(const struct expr *expr,
 				struct output_ctx *octx)
 {
-	struct protoent *p;
-
 	if (!nft_output_numeric_proto(octx)) {
-		p = getprotobynumber(mpz_get_uint8(expr->value));
-		if (p != NULL)
-			return json_string(p->p_name);
+		char name[NFT_PROTONAME_MAXSIZE];
+
+		if (nft_getprotobynumber(mpz_get_uint8(expr->value), name, sizeof(name)))
+			return json_string(name);
 	}
 	return integer_type_json(expr, octx);
 }
@@ -1106,13 +1106,13 @@ json_t *inet_protocol_type_json(const struct expr *expr,
 json_t *inet_service_type_json(const struct expr *expr, struct output_ctx *octx)
 {
 	uint16_t port = mpz_get_be16(expr->value);
-	const struct servent *s = NULL;
+	char name[NFT_SERVNAME_MAXSIZE];
 
 	if (!nft_output_service(octx) ||
-	    (s = getservbyport(port, NULL)) == NULL)
+	    !nft_getservbyport(port, NULL, name, sizeof(name)))
 		return json_integer(ntohs(port));
 
-	return json_string(s->s_name);
+	return json_string(name);
 }
 
 json_t *mark_type_json(const struct expr *expr, struct output_ctx *octx)
src/rule.c +4 -3
index 99c4f0bb8b00..b59fcd3a9fa8 100644
@@ -27,6 +27,7 @@
 #include <cache.h>
 #include <owner.h>
 #include <intervals.h>
+#include "nftutils.h"
 
 #include <libnftnl/common.h>
 #include <libnftnl/ruleset.h>
@@ -1666,10 +1667,10 @@ struct obj *obj_lookup_fuzzy(const char *obj_name,
 
 static void print_proto_name_proto(uint8_t l4, struct output_ctx *octx)
 {
-	const struct protoent *p = getprotobynumber(l4);
+	char name[NFT_PROTONAME_MAXSIZE];
 
-	if (p)
-		nft_print(octx, "%s", p->p_name);
+	if (nft_getprotobynumber(l4, name, sizeof(name)))
+		nft_print(octx, "%s", name);
 	else
 		nft_print(octx, "%d", l4);
 }
Signature · 1 line
2.41.0
#4 lore raw
In reply to Thomas Haller
Quoted 8 lines · Thomas Haller

Changes since version 2:

- split the patch.

- add and use defines NFT_PROTONAME_MAXSIZE, NFT_SERVNAME_MAXSIZE, NETDB_BUFSIZE.

- add new GPL2+ source file as a place for the wrapper functions.

Series LGTM. I would just collapse patch 1 and 2, I can do that before applying if you like. Or you send v4 as you prefer.

Thanks.

#5 lore raw
Quoted 5 lines · Pablo Neira Ayuso
Quoted 4 lines · Thomas Haller

Changes since version 2:

- split the patch.

Quoted 8 lines
Quoted 4 lines

- add and use defines NFT_PROTONAME_MAXSIZE, NFT_SERVNAME_MAXSIZE, NETDB_BUFSIZE.

- add new GPL2+ source file as a place for the wrapper functions.

Series LGTM. I would just collapse patch 1 and 2, I can do that before
applying if you like. Or you send v4 as you prefer.

Hi Pablo,

if you are OK with applying it (and mangling it first), please go ahead.

Thank you!!
Thomas

maintainer Applied
#6 lore raw
Quoted 11 lines · Thomas Haller
Quoted 10 lines · Pablo Neira Ayuso
Quoted 8 lines · Thomas Haller

Changes since version 2:

- split the patch.

- add and use defines NFT_PROTONAME_MAXSIZE, NFT_SERVNAME_MAXSIZE, NETDB_BUFSIZE.

- add new GPL2+ source file as a place for the wrapper functions.

Quoted 8 lines
Quoted 3 lines

Series LGTM. I would just collapse patch 1 and 2, I can do that before
applying if you like. Or you send v4 as you prefer.

Hi Pablo,

if you are OK with applying it (and mangling it first), please go ahead.

Applied, thanks.