aboutsummaryrefslogtreecommitdiffhomepage
path: root/internal/app/sppulse.go
blob: fe63f3668c373c1efd01bee2b9d258209df0b226 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
package app

import (
	"encoding/gob"
	"errors"
	"fmt"
	"io"
	"io/fs"
	"os"
	"strconv"
	"syscall"

	"hakurei.app/container/check"
	"hakurei.app/hst"
	"hakurei.app/message"
)

const pulseCookieSizeMax = 1 << 8

func init() { gob.Register(new(spPulseOp)) }

// spPulseOp exports the PulseAudio server to the container.
// Runs after spRuntimeOp.
type spPulseOp struct {
	// PulseAudio cookie data, populated during toSystem if a cookie is present.
	Cookie *[pulseCookieSizeMax]byte
	// PulseAudio cookie size, populated during toSystem if a cookie is present.
	CookieSize int
}

func (s *spPulseOp) toSystem(state *outcomeStateSys) error {
	if state.et&hst.EPulse == 0 {
		return errNotEnabled
	}

	pulseRuntimeDir, pulseSocket := s.commonPaths(state.outcomeState)

	if _, err := state.k.stat(pulseRuntimeDir.String()); err != nil {
		if !errors.Is(err, fs.ErrNotExist) {
			return &hst.AppError{Step: fmt.Sprintf("access PulseAudio directory %q", pulseRuntimeDir), Err: err}
		}
		return newWithMessageError(fmt.Sprintf("PulseAudio directory %q not found", pulseRuntimeDir), err)
	}

	if fi, err := state.k.stat(pulseSocket.String()); err != nil {
		if !errors.Is(err, fs.ErrNotExist) {
			return &hst.AppError{Step: fmt.Sprintf("access PulseAudio socket %q", pulseSocket), Err: err}
		}
		return newWithMessageError(fmt.Sprintf("PulseAudio directory %q found but socket does not exist", pulseRuntimeDir), err)
	} else {
		if m := fi.Mode(); m&0o006 != 0o006 {
			return newWithMessage(fmt.Sprintf("unexpected permissions on %q: %s", pulseSocket, m))
		}
	}

	// pulse socket is world writable and its parent directory DAC permissions prevents access;
	// hard link to target-executable share directory to grant access
	state.sys.Link(pulseSocket, state.runtime().Append("pulse"))

	// load up to pulseCookieSizeMax bytes of pulse cookie for transmission to shim
	if a, err := discoverPulseCookie(state.k); err != nil {
		return err
	} else if a != nil {
		s.Cookie = new([pulseCookieSizeMax]byte)
		if s.CookieSize, err = loadFile(state.msg, state.k, "PulseAudio cookie", a.String(), s.Cookie[:]); err != nil {
			return err
		}
	} else {
		state.msg.Verbose("cannot locate PulseAudio cookie (tried " +
			"$PULSE_COOKIE, " +
			"$XDG_CONFIG_HOME/pulse/cookie, " +
			"$HOME/.pulse-cookie)")
	}

	return nil
}

func (s *spPulseOp) toContainer(state *outcomeStateParams) error {
	innerPulseSocket := state.runtimeDir.Append("pulse", "native")
	state.params.Bind(state.runtimePath().Append("pulse"), innerPulseSocket, 0)
	state.env["PULSE_SERVER"] = "unix:" + innerPulseSocket.String()

	if s.Cookie != nil {
		innerDst := hst.AbsPrivateTmp.Append("/pulse-cookie")

		if s.CookieSize < 0 || s.CookieSize > pulseCookieSizeMax {
			return newWithMessage("unexpected PulseAudio cookie size")
		}
		state.env["PULSE_COOKIE"] = innerDst.String()
		state.params.Place(innerDst, s.Cookie[:s.CookieSize])
	}

	return nil
}

func (s *spPulseOp) commonPaths(state *outcomeState) (pulseRuntimeDir, pulseSocket *check.Absolute) {
	// PulseAudio runtime directory (usually `/run/user/%d/pulse`)
	pulseRuntimeDir = state.sc.RuntimePath.Append("pulse")
	// PulseAudio socket (usually `/run/user/%d/pulse/native`)
	pulseSocket = pulseRuntimeDir.Append("native")
	return
}

// discoverPulseCookie attempts to discover the pathname of the PulseAudio cookie of the current user.
// If both returned pathname and error are nil, the cookie is likely unavailable and can be silently skipped.
func discoverPulseCookie(k syscallDispatcher) (*check.Absolute, error) {
	const paLocateStep = "locate PulseAudio cookie"

	// from environment
	if p, ok := k.lookupEnv("PULSE_COOKIE"); ok {
		if a, err := check.NewAbs(p); err != nil {
			return nil, &hst.AppError{Step: paLocateStep, Err: err}
		} else {
			// this takes precedence, do not verify whether the file is accessible
			return a, nil
		}
	}

	// $HOME/.pulse-cookie
	if p, ok := k.lookupEnv("HOME"); ok {
		var pulseCookiePath *check.Absolute
		if a, err := check.NewAbs(p); err != nil {
			return nil, &hst.AppError{Step: paLocateStep, Err: err}
		} else {
			pulseCookiePath = a.Append(".pulse-cookie")
		}

		if fi, err := k.stat(pulseCookiePath.String()); err != nil {
			if !errors.Is(err, fs.ErrNotExist) {
				return nil, &hst.AppError{Step: "access PulseAudio cookie", Err: err}
			}
			// fallthrough
		} else if fi.IsDir() {
			// fallthrough
		} else {
			return pulseCookiePath, nil
		}
	}

	// $XDG_CONFIG_HOME/pulse/cookie
	if p, ok := k.lookupEnv("XDG_CONFIG_HOME"); ok {
		var pulseCookiePath *check.Absolute
		if a, err := check.NewAbs(p); err != nil {
			return nil, &hst.AppError{Step: paLocateStep, Err: err}
		} else {
			pulseCookiePath = a.Append("pulse", "cookie")
		}

		if fi, err := k.stat(pulseCookiePath.String()); err != nil {
			if !errors.Is(err, fs.ErrNotExist) {
				return nil, &hst.AppError{Step: "access PulseAudio cookie", Err: err}
			}
			// fallthrough
		} else if fi.IsDir() {
			// fallthrough
		} else {
			return pulseCookiePath, nil
		}
	}

	// cookie not present
	// not fatal: authentication is disabled
	return nil, nil
}

// loadFile reads up to len(buf) bytes from the file at pathname.
func loadFile(
	msg message.Msg, k syscallDispatcher,
	description, pathname string, buf []byte,
) (int, error) {
	n := len(buf)
	if n == 0 {
		return -1, errors.New("invalid buffer")
	}

	if fi, err := k.stat(pathname); err != nil {
		return -1, &hst.AppError{Step: "access " + description, Err: err}
	} else {
		if fi.IsDir() {
			return -1, &hst.AppError{Step: "read " + description,
				Err: &os.PathError{Op: "stat", Path: pathname, Err: syscall.EISDIR}}
		}
		if s := fi.Size(); s > int64(n) {
			return -1, newWithMessageError(
				description+" at "+strconv.Quote(pathname)+" exceeds expected size",
				&os.PathError{Op: "stat", Path: pathname, Err: syscall.ENOMEM},
			)
		} else if s < int64(n) {
			msg.Verbosef("%s at %q is %d bytes shorter than expected", description, pathname, int64(n)-s)
		} else {
			msg.Verbosef("loading %d bytes from %q", n, pathname)
		}
	}

	if f, err := k.open(pathname); err != nil {
		return -1, &hst.AppError{Step: "open " + description, Err: err}
	} else {
		if n, err = f.Read(buf); err != nil {
			if !errors.Is(err, io.EOF) {
				_ = f.Close()
				return n, &hst.AppError{Step: "read " + description, Err: err}
			}
		}

		if err = f.Close(); err != nil {
			return n, &hst.AppError{Step: "close " + description, Err: err}
		}
		return n, nil
	}
}