Move npipe config to its own section

Author: swiatekm

config/confignet/README.md

@@ -16,10 +16,10 @@ leverage network configuration to set connection and transport information.
   "npipe" (Windows named pipes, Windows-only).
 - `dialer`: Dialer configuration
   - `timeout`: Dialer timeout is the maximum amount of time a dial will wait for a connect to complete. The default is no timeout.
+- `npipe`: Windows named pipe configuration (ignored for all other transport types)
   - `security_descriptor`: A [Security Descriptor Definition Language (SDDL)](https://learn.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-definition-language)
-    string applied when creating a Windows named pipe listener. Ignored for any
-    transport other than `npipe` and for client-side dials. When empty, Windows
-    applies its [default named pipe DACL](https://learn.microsoft.com/en-us/windows/win32/ipc/named-pipe-security-and-access-rights),
+    string applied to the named pipe when a listener is created. When empty,
+    Windows applies its [default named pipe DACL](https://learn.microsoft.com/en-us/windows/win32/ipc/named-pipe-security-and-access-rights),
     which is roughly equivalent to
     `D:P(A;;GA;;;SY)(A;;GA;;;BA)(A;;0x12019b;;;WD)(A;;0x12019b;;;AN)` — full
     control for `LocalSystem` (`SY`) and `Administrators` (`BA`), and read plus

config/confignet/config.schema.yaml

@@ -6,6 +6,9 @@ $defs:
       dialer:
         description: DialerConfig contains options for connecting to an address.
         $ref: dialer_config
+      npipe:
+        description: NpipeConfig contains options specific to the "npipe" transport (Windows named pipes). Settings in this section are ignored for all other transport types.
+        $ref: npipe_config
       endpoint:
         description: Endpoint configures the address for this network connection. For TCP and UDP networks, the address has the form "host:port". The host must be a literal IP address, or a host name that can be resolved to IP addresses. The port must be a literal port number or a service name. If the host is a literal IPv6 address it must be enclosed in square brackets, as in "[2001:db8::1]:80" or "[fe80::1%zone]:80". The zone specifies the scope of the literal IPv6 address as defined in RFC 4007.
         type: string
@@ -16,14 +19,18 @@ $defs:
     description: DialerConfig contains options for connecting to an address.
     type: object
     properties:
-      security_descriptor:
-        description: SecurityDescriptor is a Security Descriptor Definition Language (SDDL) string used when creating a Windows named pipe listener. It is ignored for any transport other than "npipe" and for client-side dials. When empty, Windows applies its default named pipe DACL, which is roughly equivalent to "D:P(A;;GA;;;SY)(A;;GA;;;BA)(A;;0x12019b;;;WD)(A;;0x12019b;;;AN)" — full control for LocalSystem (SY) and Administrators (BA), and read plus limited write for Everyone (WD) and Anonymous Logon (AN). See https://learn.microsoft.com/en-us/windows/win32/ipc/named-pipe-security-and-access-rights and https://learn.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-definition-language
-        type: string
       timeout:
         description: Timeout is the maximum amount of time a dial will wait for a connect to complete. The default is no timeout.
         type: string
         x-customType: time.Duration
         format: duration
+  npipe_config:
+    description: NpipeConfig contains options specific to Windows named pipe transport. Settings in this section are ignored for all other transport types.
+    type: object
+    properties:
+      security_descriptor:
+        description: SecurityDescriptor is a Security Descriptor Definition Language (SDDL) string applied to the named pipe when a listener is created. When empty, Windows applies its default named pipe DACL, which is roughly equivalent to "D:P(A;;GA;;;SY)(A;;GA;;;BA)(A;;0x12019b;;;WD)(A;;0x12019b;;;AN)" — full control for LocalSystem (SY) and Administrators (BA), and read plus limited write for Everyone (WD) and Anonymous Logon (AN). See https://learn.microsoft.com/en-us/windows/win32/ipc/named-pipe-security-and-access-rights and https://learn.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-definition-language
+        type: string
   tcp_addr_config:
     description: TCPAddrConfig represents a TCP endpoint address.
     type: object

config/confignet/confignet.go

@@ -63,13 +63,23 @@ type DialerConfig struct {
 	// Timeout is the maximum amount of time a dial will wait for
 	// a connect to complete. The default is no timeout.
 	Timeout time.Duration `mapstructure:"timeout,omitempty"`
+	// prevent unkeyed literal initialization
+	_ struct{}
+}
+
+// NewDefaultDialerConfig creates a new DialerConfig with any default values set
+func NewDefaultDialerConfig() DialerConfig {
+	return DialerConfig{}
+}
+
+// NpipeConfig contains options specific to Windows named pipe transport.
+type NpipeConfig struct {
 	// SecurityDescriptor is a Security Descriptor Definition Language (SDDL)
-	// string used when creating a Windows named pipe listener. It is ignored
-	// for any transport other than "npipe" and for client-side dials. When
-	// empty, Windows applies its default named pipe DACL, which is roughly
-	// equivalent to "D:P(A;;GA;;;SY)(A;;GA;;;BA)(A;;0x12019b;;;WD)(A;;0x12019b;;;AN)"
-	// — full control for LocalSystem (SY) and Administrators (BA), and
-	// read plus limited write for Everyone (WD) and Anonymous Logon (AN).
+	// string applied to the named pipe when a listener is created. When empty,
+	// Windows applies its default named pipe DACL, which is roughly equivalent
+	// to "D:P(A;;GA;;;SY)(A;;GA;;;BA)(A;;0x12019b;;;WD)(A;;0x12019b;;;AN)"
+	// — full control for LocalSystem (SY) and Administrators (BA), and read
+	// plus limited write for Everyone (WD) and Anonymous Logon (AN).
 	// See:
 	//   - https://learn.microsoft.com/en-us/windows/win32/ipc/named-pipe-security-and-access-rights
 	//   - https://learn.microsoft.com/en-us/windows/win32/secauthz/security-descriptor-definition-language
@@ -78,9 +88,9 @@ type DialerConfig struct {
 	_ struct{}
 }
 
-// NewDefaultDialerConfig creates a new DialerConfig with any default values set
-func NewDefaultDialerConfig() DialerConfig {
-	return DialerConfig{}
+// NewDefaultNpipeConfig creates a new NpipeConfig with any default values set
+func NewDefaultNpipeConfig() NpipeConfig {
+	return NpipeConfig{}
 }
 
 // AddrConfig represents a network endpoint address.
@@ -99,6 +109,10 @@ type AddrConfig struct {
 
 	// DialerConfig contains options for connecting to an address.
 	DialerConfig DialerConfig `mapstructure:"dialer,omitempty"`
+
+	// NpipeConfig contains options specific to the "npipe" transport (Windows named pipes).
+	// Settings in this section are ignored for all other transport types.
+	NpipeConfig NpipeConfig `mapstructure:"npipe,omitempty"`
 	// prevent unkeyed literal initialization
 	_ struct{}
 }
@@ -107,6 +121,7 @@ type AddrConfig struct {
 func NewDefaultAddrConfig() AddrConfig {
 	return AddrConfig{
 		DialerConfig: NewDefaultDialerConfig(),
+		NpipeConfig:  NewDefaultNpipeConfig(),
 	}
 }
 
@@ -122,7 +137,7 @@ func (na *AddrConfig) Dial(ctx context.Context) (net.Conn, error) {
 // Listen equivalent with net.ListenConfig's Listen for this address.
 func (na *AddrConfig) Listen(ctx context.Context) (net.Listener, error) {
 	if na.Transport == TransportTypeNpipe {
-		return listenNpipe(na.Endpoint, na.DialerConfig.SecurityDescriptor)
+		return listenNpipe(na.Endpoint, na.NpipeConfig.SecurityDescriptor)
 	}
 	lc := net.ListenConfig{}
 	return lc.Listen(ctx, string(na.Transport), na.Endpoint)

config/confignet/npipe_windows_test.go

@@ -68,7 +68,7 @@ func TestNpipeListenSecurityDescriptor(t *testing.T) {
 			nas := &AddrConfig{
 				Endpoint:  `\\.\pipe\otel-test-confignet-sd`,
 				Transport: TransportTypeNpipe,
-				DialerConfig: DialerConfig{
+				NpipeConfig: NpipeConfig{
 					SecurityDescriptor: tt.securityDescriptor,
 				},
 			}