diff --git a/LICENSE b/LICENSE index 2bb060c..aa39852 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (C) 2017 Marius Schellenberger +Copyright (C) 2022 Marius Schellenberger All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/README.md b/README.md index 011c0da..bcd5479 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # godrop - drop privileges -Godrop is a simple library to drop privileges on linux maschines. +Godrop is a simple library to drop privileges on Linux and OpenBSD. See the examples directory on how to use the `Drop` and `MultiDrop` functions. diff --git a/go.mod b/go.mod index 1d3f890..c939651 100644 --- a/go.mod +++ b/go.mod @@ -1 +1,5 @@ module git.giftfish.de/ston1th/godrop/v2 + +go 1.19 + +require golang.org/x/sys v0.24.0 diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..d88e7bd --- /dev/null +++ b/go.sum @@ -0,0 +1,2 @@ +golang.org/x/sys v0.24.0 h1:Twjiwq9dn6R1fQcyiK+wQyHWfaz/BJB+YIpzU/Cv3Xg= +golang.org/x/sys v0.24.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= diff --git a/godrop.go b/godrop.go index f1cf20e..37c7e75 100644 --- a/godrop.go +++ b/godrop.go @@ -1,11 +1,13 @@ -// Copyright (C) 2018 Marius Schellenberger +// Copyright (C) 2022 Marius Schellenberger +//go:build go1.11 // +build go1.11 -// Package godrop provides a simple privileges dropping library +// Package godrop provides a simple library to drop privileges on Linux and OpenBSD. package godrop import ( + "errors" "fmt" "net" "os" @@ -14,10 +16,6 @@ import ( "syscall" ) -func errf(i interface{}) error { - return fmt.Errorf("godrop: %s", i) -} - // Config represents the drop config type Config struct { // User is the user to drop privileges to. @@ -43,21 +41,21 @@ func Drop(c Config, f func() (net.Listener, error)) error { func MultiDrop(c Config, f func() ([]net.Listener, error)) error { uid, err := userID(c.User) if err != nil { - return errf(err) + return errors.New("godrop: " + err.Error()) } if uid == 0 { - return errf("unable to drop privileges to uid 0 (root)") + return fmt.Errorf("godrop: you can't drop privileges to uid 0 (%s)", c.User) } gid, err := groupID(c.Group) if err != nil { - return errf(err) + return errors.New("godrop: " + err.Error()) } switch os.Getuid() { case 0: cmd := exec.Command(os.Args[0], os.Args[1:]...) ln, err := f() if err != nil { - return errf(err) + return errors.New("godrop: " + err.Error()) } for i, v := range ln { var f *os.File @@ -69,10 +67,10 @@ func MultiDrop(c Config, f func() ([]net.Listener, error)) error { f, err = l.File() l.Close() default: - return errf(fmt.Sprintf("index %d listener is not type of either *net.TCPListener or *net.UnixListener", i)) + return fmt.Errorf("godrop: index %d listener is not type of either *net.TCPListener or *net.UnixListener", i) } if err != nil { - return errf(fmt.Sprintf("index %d %s", i, err)) + return fmt.Errorf("godrop: index %d %s", i, err) } cmd.ExtraFiles = append(cmd.ExtraFiles, f) } @@ -93,7 +91,7 @@ func MultiDrop(c Config, f func() ([]net.Listener, error)) error { } if err := cmd.Start(); err != nil { - return errf(err) + return errors.New("godrop: " + err.Error()) } if c.Foreground { @@ -120,7 +118,7 @@ func MultiDrop(c Config, f func() ([]net.Listener, error)) error { case uid: return nil } - return errf("dropping priviledges failed") + return errors.New("godrop: dropping priviledges failed") } // GetListener returns the listener socket of file descriptor 3 @@ -131,7 +129,7 @@ func GetListener() (net.Listener, error) { // GetListenerFd returns the listener socket of the given file descriptor func GetListenerFd(fd int) (net.Listener, error) { if fd < 3 { - return nil, errf("fd is less than 3") + return nil, errors.New("godrop: fd is less than 3") } f := os.NewFile(uintptr(fd), "") defer f.Close() diff --git a/lookup.go b/lookup.go index 2d0e1a9..725dc82 100644 --- a/lookup.go +++ b/lookup.go @@ -1,5 +1,6 @@ -// Copyright (C) 2018 Marius Schellenberger +// Copyright (C) 2022 Marius Schellenberger +//go:build go1.11 // +build go1.11 package godrop diff --git a/lookup_test.go b/lookup_test.go index bdcf7bd..49d2a78 100644 --- a/lookup_test.go +++ b/lookup_test.go @@ -1,4 +1,4 @@ -// Copyright (C) 2018 Marius Schellenberger +// Copyright (C) 2022 Marius Schellenberger package godrop diff --git a/pledge.go b/pledge.go new file mode 100644 index 0000000..8c97aba --- /dev/null +++ b/pledge.go @@ -0,0 +1,15 @@ +// Copyright (C) 2022 Marius Schellenberger + +//go:build !openbsd +// +build !openbsd + +package godrop + +// Pledge is currently only supported on OpenBSD. +func Pledge(promises, execpromises string) error { return nil } + +// PledgePromises is currently only supported on OpenBSD. +func PledgePromises(promises string) error { return nil } + +// PledgeExecPromises is currently only supported on OpenBSD. +func PledgeExecpromises(execpromises string) error { return nil } diff --git a/pledge_openbsd.go b/pledge_openbsd.go new file mode 100644 index 0000000..0af656a --- /dev/null +++ b/pledge_openbsd.go @@ -0,0 +1,44 @@ +// Copyright (C) 2022 Marius Schellenberger + +//go:build openbsd +// +build openbsd + +package godrop + +import ( + "errors" + "golang.org/x/sys/unix" +) + +// Pledge is a wrapper for x/sys/unix Pledge. +// +// See https://go.googlesource.com/sys/+/master/unix/openbsd_pledge.go for usage. +func Pledge(promises, execpromises string) (err error) { + err = unix.Pledge(promises, execpromises) + if err != nil { + err = errors.New("pledge: " + err.Error()) + } + return +} + +// PledgePromises is a wrapper for x/sys/unix PledgePromises. +// +// See https://go.googlesource.com/sys/+/master/unix/openbsd_pledge.go for usage. +func PledgePromises(promises string) (err error) { + err = unix.PledgePromises(promises) + if err != nil { + err = errors.New("pledge: " + err.Error()) + } + return +} + +// PledgeExecpromises is a wrapper for x/sys/unix PledgeExecpromises. +// +// See https://go.googlesource.com/sys/+/master/unix/openbsd_pledge.go for usage. +func PledgeExecpromises(execpromises string) (err error) { + err = unix.PledgeExecpromises(execpromises) + if err != nil { + err = errors.New("pledge: " + err.Error()) + } + return +} diff --git a/unveil.go b/unveil.go new file mode 100644 index 0000000..412851b --- /dev/null +++ b/unveil.go @@ -0,0 +1,12 @@ +// Copyright (C) 2022 Marius Schellenberger + +//go:build !openbsd +// +build !openbsd + +package godrop + +// Unveil is currently only supported on OpenBSD. +func Unveil(path, flags string) error { return nil } + +// UnveilBlock is currently only supported on OpenBSD. +func UnveilBlock() error { return nil } diff --git a/unveil_openbsd.go b/unveil_openbsd.go new file mode 100644 index 0000000..f1e4bbc --- /dev/null +++ b/unveil_openbsd.go @@ -0,0 +1,33 @@ +// Copyright (C) 2022 Marius Schellenberger + +//go:build openbsd +// +build openbsd + +package godrop + +import ( + "errors" + "golang.org/x/sys/unix" +) + +// Unveil is a wrapper for x/sys/unix Unveil. +// +// See https://go.googlesource.com/sys/+/master/unix/openbsd_unveil.go for usage. +func Unveil(path, flags string) (err error) { + err = unix.Unveil(path, flags) + if err != nil { + err = errors.New("unveil: " + err.Error()) + } + return +} + +// UnveilBlock is a wrapper for x/sys/unix UnveilBlock. +// +// See https://go.googlesource.com/sys/+/master/unix/openbsd_unveil.go for usage. +func UnveilBlock() (err error) { + err = unix.UnveilBlock() + if err != nil { + err = errors.New("unveil: " + err.Error()) + } + return +}