Skip to content

Commit

Permalink
Implement AF_UNIX sockets on Windows
Browse files Browse the repository at this point in the history
See moby/moby#36442

Signed-off-by: Marat Radchenko <[email protected]>
  • Loading branch information
slonopotamus committed May 7, 2024
1 parent 5df8d2b commit 11b4407
Show file tree
Hide file tree
Showing 9 changed files with 92 additions and 49 deletions.
23 changes: 22 additions & 1 deletion sockets/sockets.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@
package sockets

import (
"context"
"errors"
"fmt"
"net"
"net/http"
"syscall"
"time"
)

const defaultTimeout = 10 * time.Second
const (
defaultTimeout = 10 * time.Second
maxUnixSocketPathSize = len(syscall.RawSockaddrUnix{}.Path)
)

// ErrProtocolNotAvailable is returned when a given transport protocol is not provided by the operating system.
var ErrProtocolNotAvailable = errors.New("protocol not available")
Expand All @@ -35,3 +41,18 @@ func ConfigureTransport(tr *http.Transport, proto, addr string) error {
}
return nil
}

func configureUnixTransport(tr *http.Transport, proto, addr string) error {
if len(addr) > maxUnixSocketPathSize {
return fmt.Errorf("Unix socket path %q is too long", addr)
}
// No need for compression in local communications.
tr.DisableCompression = true
dialer := &net.Dialer{
Timeout: defaultTimeout,
}
tr.DialContext = func(ctx context.Context, _, _ string) (net.Conn, error) {
return dialer.DialContext(ctx, proto, addr)
}
return nil
}
21 changes: 1 addition & 20 deletions sockets/sockets_unix.go
Original file line number Diff line number Diff line change
@@ -1,33 +1,14 @@
//go:build !windows
//go:build unix

package sockets

import (
"context"
"fmt"
"net"
"net/http"
"syscall"
"time"
)

const maxUnixSocketPathSize = len(syscall.RawSockaddrUnix{}.Path)

func configureUnixTransport(tr *http.Transport, proto, addr string) error {
if len(addr) > maxUnixSocketPathSize {
return fmt.Errorf("unix socket path %q is too long", addr)
}
// No need for compression in local communications.
tr.DisableCompression = true
dialer := &net.Dialer{
Timeout: defaultTimeout,
}
tr.DialContext = func(ctx context.Context, _, _ string) (net.Conn, error) {
return dialer.DialContext(ctx, proto, addr)
}
return nil
}

func configureNpipeTransport(tr *http.Transport, proto, addr string) error {
return ErrProtocolNotAvailable
}
Expand Down
4 changes: 0 additions & 4 deletions sockets/sockets_windows.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ import (
"github.com/Microsoft/go-winio"
)

func configureUnixTransport(tr *http.Transport, proto, addr string) error {
return ErrProtocolNotAvailable
}

func configureNpipeTransport(tr *http.Transport, proto, addr string) error {
// No need for compression in local communications.
tr.DisableCompression = true
Expand Down
4 changes: 1 addition & 3 deletions sockets/unix_socket.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//go:build !windows

/*
Package sockets is a simple unix domain socket wrapper.
Expand Down Expand Up @@ -105,7 +103,7 @@ func NewUnixSocketWithOpts(path string, opts ...SockOption) (net.Listener, error
// an option, and skip changing umask if default permissions are used.
origUmask := syscall.Umask(0o777)

Check failure on line 104 in sockets/unix_socket.go

View workflow job for this annotation

GitHub Actions / Test windows-latest (1.18.x)

undefined: syscall.Umask

Check failure on line 104 in sockets/unix_socket.go

View workflow job for this annotation

GitHub Actions / Test windows-latest (1.20.x)

undefined: syscall.Umask

Check failure on line 104 in sockets/unix_socket.go

View workflow job for this annotation

GitHub Actions / Test windows-latest (1.21.x)

undefined: syscall.Umask
l, err := net.Listen("unix", path)
syscall.Umask(origUmask)
umask(origUmask)

Check failure on line 106 in sockets/unix_socket.go

View workflow job for this annotation

GitHub Actions / Test ubuntu-20.04 (1.18.x)

undefined: umask

Check failure on line 106 in sockets/unix_socket.go

View workflow job for this annotation

GitHub Actions / Test macos-latest (1.18.x)

undefined: umask
if err != nil {
return nil, err
}
Expand Down
29 changes: 8 additions & 21 deletions sockets/unix_socket_test.go
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
//go:build !windows

package sockets

import (
"fmt"
"io/ioutil"
"net"
"os"
"syscall"
"testing"
)

Expand Down Expand Up @@ -52,26 +50,15 @@ func TestNewUnixSocket(t *testing.T) {
}

func TestUnixSocketWithOpts(t *testing.T) {
uid, gid := os.Getuid(), os.Getgid()
perms := os.FileMode(0o660)
path := "/tmp/test.sock"
echoStr := "hello"
l, err := NewUnixSocketWithOpts(path, WithChown(uid, gid), WithChmod(perms))
socketFile, err := ioutil.TempFile("", "test*.sock")
if err != nil {
t.Fatal(err)
}
defer socketFile.Close()

l := createTestUnixSocket(t, socketFile.Name())
defer l.Close()
p, err := os.Stat(path)
if err != nil {
t.Fatal(err)
}
if p.Mode().Perm() != perms {
t.Fatalf("unexpected file permissions: expected: %#o, got: %#o", perms, p.Mode().Perm())
}
if stat, ok := p.Sys().(*syscall.Stat_t); ok {
if stat.Uid != uint32(uid) || stat.Gid != uint32(gid) {
t.Fatalf("unexpected file ownership: expected: %d:%d, got: %d:%d", uid, gid, stat.Uid, stat.Gid)
}
}
runTest(t, path, l, echoStr)

echoStr := "hello"
runTest(t, socketFile.Name(), l, echoStr)
}
32 changes: 32 additions & 0 deletions sockets/unix_socket_test_unix.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
//go:build unix

package sockets

import (
"net"
"os"
"syscall"
"testing"
)

func createTestUnixSocket(t *testing.T, path string) (listener net.Listener) {
uid, gid := os.Getuid(), os.Getgid()
perms := os.FileMode(0660)
l, err := NewUnixSocketWithOpts(path, WithChown(uid, gid), WithChmod(perms))
if err != nil {
t.Fatal(err)
}
p, err := os.Stat(path)
if err != nil {
t.Fatal(err)
}
if p.Mode().Perm() != perms {
t.Fatalf("unexpected file permissions: expected: %#o, got: %#o", perms, p.Mode().Perm())
}
if stat, ok := p.Sys().(*syscall.Stat_t); ok {
if stat.Uid != uint32(uid) || stat.Gid != uint32(gid) {
t.Fatalf("unexpected file ownership: expected: %d:%d, got: %d:%d", uid, gid, stat.Uid, stat.Gid)
}
}
return l
}
14 changes: 14 additions & 0 deletions sockets/unix_socket_test_windows.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package sockets

import (
"net"
"testing"
)

func createTestUnixSocket(t *testing.T, path string) (listener net.Listener) {
l, err := NewUnixSocketWithOpts(path)
if err != nil {
t.Fatal(err)
}
return l
}
9 changes: 9 additions & 0 deletions sockets/unix_socket_unix.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
//go:build unix

package sockets

import "syscall"

func umask(newmask int) (oldmask int) {
return syscall.Umask(0777)
}
5 changes: 5 additions & 0 deletions sockets/unix_socket_windows.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package sockets

func umask(newmask int) (oldmask int) {
return newmask
}

0 comments on commit 11b4407

Please sign in to comment.