Commit 90a19f74116eb09e4711d845d08c011cb62b8cbf | zig

author	Artem Kolichenkov <artem@kolichenkov.com> 2023-12-16 18:15:51+02:00
committer	GitHub <noreply@github.com> 2023-12-16 16:15:51+00:00
log	90a19f74116eb09e4711d845d08c011cb62b8cbf
tree	84c3c9cc793af76dacf69f7adbb53b53cd3f221b
parent	779b8e2598521de45934c085ebece852bf5039de
signature	Signed by PGP key 4AEE18F83AFDEB23

std.net: add explicit error sets for IP parsing

Inferred errors in switch statements prevented IP address parsing at comptime.
Adding explicit error sets fixes it.

Closes #18276

2 files changed, 42 insertions(+), 7 deletions(-)

lib
- std
  - net.zig
  - net
    test.zig

lib/std/net.zig+20-7

 @@ -14,6 +14,19 @@ pub const has_unix_sockets = @hasDecl(os.sockaddr, "un") and
     (builtin.target.os.tag != .windows or
     builtin.os.version_range.windows.isAtLeast(.win10_rs4) orelse false);
+pub const IPParseError = error{
+    Overflow,
+    InvalidEnd,
+    InvalidCharacter,
+    Incomplete,
+};
+pub const IPv4ParseError = IPParseError || error{NonCanonical};
+pub const IPv6ParseError = IPParseError || error{InvalidIpv4Mapping};
+pub const IPv6InterfaceError = os.SocketError || os.IoCtl_SIOCGIFINDEX_Error || error{NameTooLong};
+pub const IPv6ResolveError = IPv6ParseError || IPv6InterfaceError;
 pub const Address = extern union {
     any: os.sockaddr,
     in: Ip4Address,
 @@ -77,15 +90,15 @@ pub const Address = extern union {
         }
     }
-    pub fn parseIp6(buf: []const u8, port: u16) !Address {
+    pub fn parseIp6(buf: []const u8, port: u16) IPv6ParseError!Address {
         return Address{ .in6 = try Ip6Address.parse(buf, port) };
     }
-    pub fn resolveIp6(buf: []const u8, port: u16) !Address {
+    pub fn resolveIp6(buf: []const u8, port: u16) IPv6ResolveError!Address {
         return Address{ .in6 = try Ip6Address.resolve(buf, port) };
     }
-    pub fn parseIp4(buf: []const u8, port: u16) !Address {
+    pub fn parseIp4(buf: []const u8, port: u16) IPv4ParseError!Address {
         return Address{ .in = try Ip4Address.parse(buf, port) };
     }
 @@ -198,7 +211,7 @@ pub const Address = extern union {
 pub const Ip4Address = extern struct {
     sa: os.sockaddr.in,
-    pub fn parse(buf: []const u8, port: u16) !Ip4Address {
+    pub fn parse(buf: []const u8, port: u16) IPv4ParseError!Ip4Address {
         var result = Ip4Address{
             .sa = .{
                 .port = mem.nativeToBig(u16, port),
 @@ -307,7 +320,7 @@ pub const Ip6Address = extern struct {
     /// Parse a given IPv6 address string into an Address.
     /// Assumes the Scope ID of the address is fully numeric.
     /// For non-numeric addresses, see `resolveIp6`.
-    pub fn parse(buf: []const u8, port: u16) !Ip6Address {
+    pub fn parse(buf: []const u8, port: u16) IPv6ParseError!Ip6Address {
         var result = Ip6Address{
             .sa = os.sockaddr.in6{
                 .scope_id = 0,
 @@ -424,7 +437,7 @@ pub const Ip6Address = extern struct {
         }
     }
-    pub fn resolve(buf: []const u8, port: u16) !Ip6Address {
+    pub fn resolve(buf: []const u8, port: u16) IPv6ResolveError!Ip6Address {
         // TODO: Unify the implementations of resolveIp6 and parseIp6.
         var result = Ip6Address{
             .sa = os.sockaddr.in6{
 @@ -659,7 +672,7 @@ pub fn connectUnixSocket(path: []const u8) !Stream {
     };
 }
-fn if_nametoindex(name: []const u8) !u32 {
+fn if_nametoindex(name: []const u8) IPv6InterfaceError!u32 {
     if (builtin.target.os.tag == .linux) {
         var ifr: os.ifreq = undefined;
         const sockfd = try os.socket(os.AF.UNIX, os.SOCK.DGRAM | os.SOCK.CLOEXEC, 0);

lib/std/net/test.zig+22

...	@@ -4,6 +4,28 @@ const net = std.net;	...	@@ -4,6 +4,28 @@ const net = std.net;
4	const mem = std.mem;	4	const mem = std.mem;
5	const testing = std.testing;	5	const testing = std.testing;
6		6
		7	test "parse and render IP addresses at comptime" {
		8	if (builtin.os.tag == .wasi) return error.SkipZigTest;
		9	comptime {
		10	var ipAddrBuffer: [16]u8 = undefined;
		11	// Parses IPv6 at comptime
		12	const ipv6addr = net.Address.parseIp("::1", 0) catch unreachable;
		13	var ipv6 = std.fmt.bufPrint(ipAddrBuffer[0..], "{}", .{ipv6addr}) catch unreachable;
		14	try std.testing.expect(std.mem.eql(u8, "::1", ipv6[1 .. ipv6.len - 3]));
		15
		16	// Parses IPv4 at comptime
		17	const ipv4addr = net.Address.parseIp("127.0.0.1", 0) catch unreachable;
		18	var ipv4 = std.fmt.bufPrint(ipAddrBuffer[0..], "{}", .{ipv4addr}) catch unreachable;
		19	try std.testing.expect(std.mem.eql(u8, "127.0.0.1", ipv4[0 .. ipv4.len - 2]));
		20
		21	// Returns error for invalid IP addresses at comptime
		22	try testing.expectError(error.InvalidIPAddressFormat, net.Address.parseIp("::123.123.123.123", 0));
		23	try testing.expectError(error.InvalidIPAddressFormat, net.Address.parseIp("127.01.0.1", 0));
		24	try testing.expectError(error.InvalidIPAddressFormat, net.Address.resolveIp("::123.123.123.123", 0));
		25	try testing.expectError(error.InvalidIPAddressFormat, net.Address.resolveIp("127.01.0.1", 0));
		26	}
		27	}
		28
7	test "parse and render IPv6 addresses" {	29	test "parse and render IPv6 addresses" {
8	if (builtin.os.tag == .wasi) return error.SkipZigTest;	30	if (builtin.os.tag == .wasi) return error.SkipZigTest;
9		31