admin/gluetun
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename UID and GID to PUID and PGID

Browse Source
This commit is contained in:
Quentin McGaw
2020-12-29 16:44:35 +00:00
parent 8d5f2fec09
commit cb64302294
14 changed files with 68 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Dockerfile
View File

@@ -45,8 +45,8 @@ ENV VPNSP=pia \
OPENVPN_TARGET_IP= \ OPENVPN_TARGET_IP= \
OPENVPN_IPV6=off \ OPENVPN_IPV6=off \
TZ= \ TZ= \
UID=1000 \ PUID= \
GID=1000 \ PGID= \
PUBLICIP_FILE="/tmp/gluetun/ip" \ PUBLICIP_FILE="/tmp/gluetun/ip" \
# PIA, Windscribe, Surfshark, Cyberghost, Vyprvpn, NordVPN, PureVPN only # PIA, Windscribe, Surfshark, Cyberghost, Vyprvpn, NordVPN, PureVPN only
USER= \ USER= \

15
cmd/gluetun/main.go
View File

@@ -131,16 +131,19 @@ func _main(background context.Context, buildInfo models.BuildInformation,
} }
// Should never change // Should never change
uid, gid := allSettings.System.UID, allSettings.System.GID puid, pgid := allSettings.System.PUID, allSettings.System.PGID
const defaultUsername = "nonrootuser" const defaultUsername = "nonrootuser"
nonRootUsername, err := alpineConf.CreateUser(defaultUsername, uid) nonRootUsername, err := alpineConf.CreateUser(defaultUsername, puid)
if err != nil { if err != nil {
logger.Error(err) logger.Error(err)
return 1 return 1
} }
if nonRootUsername != defaultUsername {
logger.Info("using existing username %s corresponding to user id %d", nonRootUsername, puid)
}
if err := os.Chown("/etc/unbound", uid, gid); err != nil { if err := os.Chown("/etc/unbound", puid, pgid); err != nil {
logger.Error(err) logger.Error(err)
return 1 return 1
} }
@@ -233,7 +236,7 @@ func _main(background context.Context, buildInfo models.BuildInformation,
go collectStreamLines(ctx, streamMerger, logger, signalTunnelReady) go collectStreamLines(ctx, streamMerger, logger, signalTunnelReady)
openvpnLooper := openvpn.NewLooper(allSettings.OpenVPN, nonRootUsername, uid, gid, allServers, openvpnLooper := openvpn.NewLooper(allSettings.OpenVPN, nonRootUsername, puid, pgid, allServers,
ovpnConf, firewallConf, routingConf, logger, httpClient, os.OpenFile, streamMerger, cancel) ovpnConf, firewallConf, routingConf, logger, httpClient, os.OpenFile, streamMerger, cancel)
wg.Add(1) wg.Add(1)
// wait for restartOpenvpn // wait for restartOpenvpn
@@ -245,13 +248,13 @@ func _main(background context.Context, buildInfo models.BuildInformation,
// wait for updaterLooper.Restart() or its ticket launched with RunRestartTicker // wait for updaterLooper.Restart() or its ticket launched with RunRestartTicker
go updaterLooper.Run(ctx, wg) go updaterLooper.Run(ctx, wg)
unboundLooper := dns.NewLooper(dnsConf, allSettings.DNS, logger, streamMerger, nonRootUsername, uid, gid) unboundLooper := dns.NewLooper(dnsConf, allSettings.DNS, logger, streamMerger, nonRootUsername, puid, pgid)
wg.Add(1) wg.Add(1)
// wait for unboundLooper.Restart or its ticker launched with RunRestartTicker // wait for unboundLooper.Restart or its ticker launched with RunRestartTicker
go unboundLooper.Run(ctx, wg, signalDNSReady) go unboundLooper.Run(ctx, wg, signalDNSReady)
publicIPLooper := publicip.NewLooper( publicIPLooper := publicip.NewLooper(
httpClient, logger, allSettings.PublicIP, uid, gid, os) httpClient, logger, allSettings.PublicIP, puid, pgid, os)
wg.Add(1) wg.Add(1)
go publicIPLooper.Run(ctx, wg) go publicIPLooper.Run(ctx, wg)
wg.Add(1) wg.Add(1)

4
internal/dns/conf.go
View File

@@ -15,7 +15,7 @@ import (
) )
func (c *configurator) MakeUnboundConf(ctx context.Context, settings settings.DNS, func (c *configurator) MakeUnboundConf(ctx context.Context, settings settings.DNS,
username string, uid, gid int) (err error) { username string, puid, pgid int) (err error) {
c.logger.Info("generating Unbound configuration") c.logger.Info("generating Unbound configuration")
lines, warnings := generateUnboundConf(ctx, settings, username, c.client, c.logger) lines, warnings := generateUnboundConf(ctx, settings, username, c.client, c.logger)
for _, warning := range warnings { for _, warning := range warnings {
@@ -34,7 +34,7 @@ func (c *configurator) MakeUnboundConf(ctx context.Context, settings settings.DN
return err return err
} }
if err := file.Chown(uid, gid); err != nil { if err := file.Chown(puid, pgid); err != nil {
_ = file.Close() _ = file.Close()
return err return err
} }

6
internal/dns/dns.go
View File

@@ -13,9 +13,9 @@ import (
) )
type Configurator interface { type Configurator interface {
DownloadRootHints(ctx context.Context, uid, gid int) error DownloadRootHints(ctx context.Context, puid, pgid int) error
DownloadRootKey(ctx context.Context, uid, gid int) error DownloadRootKey(ctx context.Context, puid, pgid int) error
MakeUnboundConf(ctx context.Context, settings settings.DNS, username string, uid, gid int) (err error) MakeUnboundConf(ctx context.Context, settings settings.DNS, username string, puid, pgid int) (err error)
UseDNSInternally(IP net.IP) UseDNSInternally(IP net.IP)
UseDNSSystemWide(ip net.IP, keepNameserver bool) error UseDNSSystemWide(ip net.IP, keepNameserver bool) error
Start(ctx context.Context, logLevel uint8) (stdout io.ReadCloser, waitFn func() error, err error) Start(ctx context.Context, logLevel uint8) (stdout io.ReadCloser, waitFn func() error, err error)

16
internal/dns/loop.go
View File

@@ -28,8 +28,8 @@ type looper struct {
logger logging.Logger logger logging.Logger
streamMerger command.StreamMerger streamMerger command.StreamMerger
username string username string
uid int puid int
gid int pgid int
loopLock sync.Mutex loopLock sync.Mutex
start chan struct{} start chan struct{}
running chan models.LoopStatus running chan models.LoopStatus
@@ -41,7 +41,7 @@ type looper struct {
} }
func NewLooper(conf Configurator, settings settings.DNS, logger logging.Logger, func NewLooper(conf Configurator, settings settings.DNS, logger logging.Logger,
streamMerger command.StreamMerger, username string, uid, gid int) Looper { streamMerger command.StreamMerger, username string, puid, pgid int) Looper {
return &looper{ return &looper{
state: state{ state: state{
status: constants.Stopped, status: constants.Stopped,
@@ -50,8 +50,8 @@ func NewLooper(conf Configurator, settings settings.DNS, logger logging.Logger,
conf: conf, conf: conf,
logger: logger.WithPrefix("dns over tls: "), logger: logger.WithPrefix("dns over tls: "),
username: username, username: username,
uid: uid, puid: puid,
gid: gid, pgid: pgid,
streamMerger: streamMerger, streamMerger: streamMerger,
start: make(chan struct{}), start: make(chan struct{}),
running: make(chan models.LoopStatus), running: make(chan models.LoopStatus),
@@ -287,14 +287,14 @@ func (l *looper) RunRestartTicker(ctx context.Context, wg *sync.WaitGroup) {
} }
func (l *looper) updateFiles(ctx context.Context) (err error) { func (l *looper) updateFiles(ctx context.Context) (err error) {
if err := l.conf.DownloadRootHints(ctx, l.uid, l.gid); err != nil { if err := l.conf.DownloadRootHints(ctx, l.puid, l.pgid); err != nil {
return err return err
} }
if err := l.conf.DownloadRootKey(ctx, l.uid, l.gid); err != nil { if err := l.conf.DownloadRootKey(ctx, l.puid, l.pgid); err != nil {
return err return err
} }
settings := l.GetSettings() settings := l.GetSettings()
if err := l.conf.MakeUnboundConf(ctx, settings, l.username, l.uid, l.gid); err != nil { if err := l.conf.MakeUnboundConf(ctx, settings, l.username, l.puid, l.pgid); err != nil {
return err return err
} }
return nil return nil

12
internal/dns/roots.go
View File

@@ -10,17 +10,17 @@ import (
"github.com/qdm12/gluetun/internal/constants" "github.com/qdm12/gluetun/internal/constants"
) )
func (c *configurator) DownloadRootHints(ctx context.Context, uid, gid int) error { func (c *configurator) DownloadRootHints(ctx context.Context, puid, pgid int) error {
return c.downloadAndSave(ctx, "root hints", return c.downloadAndSave(ctx, "root hints",
string(constants.NamedRootURL), string(constants.RootHints), uid, gid) string(constants.NamedRootURL), string(constants.RootHints), puid, pgid)
} }
func (c *configurator) DownloadRootKey(ctx context.Context, uid, gid int) error { func (c *configurator) DownloadRootKey(ctx context.Context, puid, pgid int) error {
return c.downloadAndSave(ctx, "root key", return c.downloadAndSave(ctx, "root key",
string(constants.RootKeyURL), string(constants.RootKey), uid, gid) string(constants.RootKeyURL), string(constants.RootKey), puid, pgid)
} }
func (c *configurator) downloadAndSave(ctx context.Context, logName, url, filepath string, uid, gid int) error { func (c *configurator) downloadAndSave(ctx context.Context, logName, url, filepath string, puid, pgid int) error {
c.logger.Info("downloading %s from %s", logName, url) c.logger.Info("downloading %s from %s", logName, url)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil) req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
if err != nil { if err != nil {
@@ -48,7 +48,7 @@ func (c *configurator) downloadAndSave(ctx context.Context, logName, url, filepa
return err return err
} }
err = file.Chown(uid, gid) err = file.Chown(puid, pgid)
if err != nil { if err != nil {
_ = file.Close() _ = file.Close()
return err return err

6
internal/openvpn/auth.go
View File

@@ -9,7 +9,7 @@ import (
) )
// WriteAuthFile writes the OpenVPN auth file to disk with the right permissions. // WriteAuthFile writes the OpenVPN auth file to disk with the right permissions.
func (c *configurator) WriteAuthFile(user, password string, uid, gid int) error { func (c *configurator) WriteAuthFile(user, password string, puid, pgid int) error {
const filepath = string(constants.OpenVPNAuthConf) const filepath = string(constants.OpenVPNAuthConf)
file, err := c.os.OpenFile(filepath, os.O_RDONLY, 0) file, err := c.os.OpenFile(filepath, os.O_RDONLY, 0)
@@ -27,7 +27,7 @@ func (c *configurator) WriteAuthFile(user, password string, uid, gid int) error
_ = file.Close() _ = file.Close()
return err return err
} }
err = file.Chown(uid, gid) err = file.Chown(puid, pgid)
if err != nil { if err != nil {
_ = file.Close() _ = file.Close()
return err return err
@@ -59,7 +59,7 @@ func (c *configurator) WriteAuthFile(user, password string, uid, gid int) error
_ = file.Close() _ = file.Close()
return err return err
} }
err = file.Chown(uid, gid) err = file.Chown(puid, pgid)
if err != nil { if err != nil {
_ = file.Close() _ = file.Close()
return err return err

12
internal/openvpn/loop.go
View File

@@ -35,8 +35,8 @@ type looper struct {
state state state state
// Fixed parameters // Fixed parameters
username string username string
uid int puid int
gid int pgid int
// Configurators // Configurators
conf Configurator conf Configurator
fw firewall.Configurator fw firewall.Configurator
@@ -56,7 +56,7 @@ type looper struct {
} }
func NewLooper(settings settings.OpenVPN, func NewLooper(settings settings.OpenVPN,
username string, uid, gid int, allServers models.AllServers, username string, puid, pgid int, allServers models.AllServers,
conf Configurator, fw firewall.Configurator, routing routing.Routing, conf Configurator, fw firewall.Configurator, routing routing.Routing,
logger logging.Logger, client *http.Client, openFile os.OpenFileFunc, logger logging.Logger, client *http.Client, openFile os.OpenFileFunc,
streamMerger command.StreamMerger, cancel context.CancelFunc) Looper { streamMerger command.StreamMerger, cancel context.CancelFunc) Looper {
@@ -67,8 +67,8 @@ func NewLooper(settings settings.OpenVPN,
allServers: allServers, allServers: allServers,
}, },
username: username, username: username,
uid: uid, puid: puid,
gid: gid, pgid: pgid,
conf: conf, conf: conf,
fw: fw, fw: fw,
routing: routing, routing: routing,
@@ -123,7 +123,7 @@ func (l *looper) Run(ctx context.Context, wg *sync.WaitGroup) {
return return
} }
if err := l.conf.WriteAuthFile(settings.User, settings.Password, l.uid, l.gid); err != nil { if err := l.conf.WriteAuthFile(settings.User, settings.Password, l.puid, l.pgid); err != nil {
l.logger.Error(err) l.logger.Error(err)
l.cancel() l.cancel()
return return

2
internal/openvpn/openvpn.go
View File

@@ -12,7 +12,7 @@ import (
type Configurator interface { type Configurator interface {
Version(ctx context.Context) (string, error) Version(ctx context.Context) (string, error)
WriteAuthFile(user, password string, uid, gid int) error WriteAuthFile(user, password string, puid, pgid int) error
CheckTUN() error CheckTUN() error
CreateTUN() error CreateTUN() error
Start(ctx context.Context) (stdout io.ReadCloser, waitFn func() error, err error) Start(ctx context.Context) (stdout io.ReadCloser, waitFn func() error, err error)

4
internal/params/params.go
View File

@@ -33,8 +33,8 @@ type Reader interface {
GetDNSKeepNameserver() (on bool, err error) GetDNSKeepNameserver() (on bool, err error)
// System // System
GetUID() (uid int, err error) GetPUID() (puid int, err error)
GetGID() (gid int, err error) GetPGID() (pgid int, err error)
GetTimezone() (timezone string, err error) GetTimezone() (timezone string, err error)
GetPublicIPFilepath() (filepath models.Filepath, err error) GetPublicIPFilepath() (filepath models.Filepath, err error)

18
internal/params/system.go
View File

@@ -4,14 +4,20 @@ import (
libparams "github.com/qdm12/golibs/params" libparams "github.com/qdm12/golibs/params"
) )
// GetUID obtains the user ID to use from the environment variable UID. // GetPUID obtains the user ID to use from the environment variable PUID
func (r *reader) GetUID() (uid int, err error) { // with retro compatible variable UID.
return r.envParams.GetEnvIntRange("UID", 0, 65535, libparams.Default("1000")) func (r *reader) GetPUID() (ppuid int, err error) {
return r.envParams.GetEnvIntRange("PUID", 0, 65535,
libparams.Default("1000"),
libparams.RetroKeys([]string{"UID"}, r.onRetroActive))
} }
// GetGID obtains the group ID to use from the environment variable GID. // GetGID obtains the group ID to use from the environment variable PGID
func (r *reader) GetGID() (gid int, err error) { // with retro compatible variable PGID.
return r.envParams.GetEnvIntRange("GID", 0, 65535, libparams.Default("1000")) func (r *reader) GetPGID() (pgid int, err error) {
return r.envParams.GetEnvIntRange("PGID", 0, 65535,
libparams.Default("1000"),
libparams.RetroKeys([]string{"GID"}, r.onRetroActive))
} }
// GetTZ obtains the timezone from the environment variable TZ. // GetTZ obtains the timezone from the environment variable TZ.

4
internal/publicip/fs.go
View File

@@ -3,7 +3,7 @@ package publicip
import "github.com/qdm12/gluetun/internal/os" import "github.com/qdm12/gluetun/internal/os"
func persistPublicIP(openFile os.OpenFileFunc, func persistPublicIP(openFile os.OpenFileFunc,
filepath string, content string, uid, gid int) error { filepath string, content string, puid, pgid int) error {
file, err := openFile( file, err := openFile(
filepath, filepath,
os.O_TRUNC|os.O_WRONLY|os.O_CREATE, os.O_TRUNC|os.O_WRONLY|os.O_CREATE,
@@ -18,7 +18,7 @@ func persistPublicIP(openFile os.OpenFileFunc,
return err return err
} }
if err := file.Chown(uid, gid); err != nil { if err := file.Chown(puid, pgid); err != nil {
_ = file.Close() _ = file.Close()
return err return err
} }

12
internal/publicip/loop.go
View File

@@ -31,8 +31,8 @@ type looper struct {
logger logging.Logger logger logging.Logger
os os.OS os os.OS
// Fixed settings // Fixed settings
uid int puid int
gid int pgid int
// Internal channels and locks // Internal channels and locks
loopLock sync.Mutex loopLock sync.Mutex
start chan struct{} start chan struct{}
@@ -46,7 +46,7 @@ type looper struct {
} }
func NewLooper(client *http.Client, logger logging.Logger, func NewLooper(client *http.Client, logger logging.Logger,
settings settings.PublicIP, uid, gid int, settings settings.PublicIP, puid, pgid int,
os os.OS) Looper { os os.OS) Looper {
return &looper{ return &looper{
state: state{ state: state{
@@ -57,8 +57,8 @@ func NewLooper(client *http.Client, logger logging.Logger,
getter: NewIPGetter(client), getter: NewIPGetter(client),
logger: logger.WithPrefix("ip getter: "), logger: logger.WithPrefix("ip getter: "),
os: os, os: os,
uid: uid, puid: puid,
gid: gid, pgid: pgid,
start: make(chan struct{}), start: make(chan struct{}),
running: make(chan models.LoopStatus), running: make(chan models.LoopStatus),
stop: make(chan struct{}), stop: make(chan struct{}),
@@ -144,7 +144,7 @@ func (l *looper) Run(ctx context.Context, wg *sync.WaitGroup) {
l.state.setPublicIP(ip) l.state.setPublicIP(ip)
l.logger.Info("Public IP address is %s", ip) l.logger.Info("Public IP address is %s", ip)
filepath := string(l.state.settings.IPFilepath) filepath := string(l.state.settings.IPFilepath)
err := persistPublicIP(l.os.OpenFile, filepath, ip.String(), l.uid, l.gid) err := persistPublicIP(l.os.OpenFile, filepath, ip.String(), l.puid, l.pgid)
if err != nil { if err != nil {
l.logger.Error(err) l.logger.Error(err)
} }

12
internal/settings/system.go
View File

@@ -9,18 +9,18 @@ import (
// System contains settings to configure system related elements. // System contains settings to configure system related elements.
type System struct { type System struct {
UID int PUID int
GID int PGID int
Timezone string Timezone string
} }
// GetSystemSettings obtains the System settings using the params functions. // GetSystemSettings obtains the System settings using the params functions.
func GetSystemSettings(paramsReader params.Reader) (settings System, err error) { func GetSystemSettings(paramsReader params.Reader) (settings System, err error) {
settings.UID, err = paramsReader.GetUID() settings.PUID, err = paramsReader.GetPUID()
if err != nil { if err != nil {
return settings, err return settings, err
} }
settings.GID, err = paramsReader.GetGID() settings.PGID, err = paramsReader.GetPGID()
if err != nil { if err != nil {
return settings, err return settings, err
} }
@@ -34,8 +34,8 @@ func GetSystemSettings(paramsReader params.Reader) (settings System, err error)
func (s *System) String() string { func (s *System) String() string {
settingsList := []string{ settingsList := []string{
"System settings:", "System settings:",
fmt.Sprintf("User ID: %d", s.UID), fmt.Sprintf("Process user ID: %d", s.PUID),
fmt.Sprintf("Group ID: %d", s.GID), fmt.Sprintf("Process group ID: %d", s.PGID),
fmt.Sprintf("Timezone: %s", s.Timezone), fmt.Sprintf("Timezone: %s", s.Timezone),
} }
return strings.Join(settingsList, "\n|--") return strings.Join(settingsList, "\n|--")