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 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
|
package child
import (
"context"
"errors"
"fmt"
"os"
"os/exec"
"os/signal"
"path/filepath"
"runtime"
"strconv"
"syscall"
"time"
"github.com/containernetworking/plugins/pkg/ns"
"github.com/rootless-containers/rootlesskit/v2/pkg/common"
"github.com/rootless-containers/rootlesskit/v2/pkg/copyup"
"github.com/rootless-containers/rootlesskit/v2/pkg/messages"
"github.com/rootless-containers/rootlesskit/v2/pkg/network"
"github.com/rootless-containers/rootlesskit/v2/pkg/port"
"github.com/rootless-containers/rootlesskit/v2/pkg/sigproxy"
sigproxysignal "github.com/rootless-containers/rootlesskit/v2/pkg/sigproxy/signal"
"github.com/sirupsen/logrus"
"golang.org/x/sys/unix"
)
var propagationStates = map[string]uintptr{
"private": uintptr(unix.MS_PRIVATE),
"rprivate": uintptr(unix.MS_REC | unix.MS_PRIVATE),
"shared": uintptr(unix.MS_SHARED),
"rshared": uintptr(unix.MS_REC | unix.MS_SHARED),
"slave": uintptr(unix.MS_SLAVE),
"rslave": uintptr(unix.MS_REC | unix.MS_SLAVE),
}
func createCmd(targetCmd []string) (*exec.Cmd, error) {
var args []string
if len(targetCmd) > 1 {
args = targetCmd[1:]
}
cmd := exec.Command(targetCmd[0], args...)
cmd.Stdin = os.Stdin
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
cmd.Env = os.Environ()
cmd.SysProcAttr = &syscall.SysProcAttr{
Pdeathsig: syscall.SIGKILL,
}
return cmd, nil
}
// mountSysfs is needed for mounting /sys/class/net
// when netns is unshared.
func mountSysfs(hostNetwork, evacuateCgroup2 bool) error {
const cgroupDir = "/sys/fs/cgroup"
if hostNetwork {
if evacuateCgroup2 {
// We need to mount tmpfs before cgroup2 to avoid EBUSY
if err := unix.Mount("none", cgroupDir, "tmpfs", 0, ""); err != nil {
return fmt.Errorf("failed to mount tmpfs on %s: %w", cgroupDir, err)
}
if err := unix.Mount("none", cgroupDir, "cgroup2", 0, ""); err != nil {
return fmt.Errorf("failed to mount cgroup2 on %s: %w", cgroupDir, err)
}
}
// NOP
return nil
}
tmp, err := os.MkdirTemp("/tmp", "rksys")
if err != nil {
return fmt.Errorf("creating a directory under /tmp: %w", err)
}
defer os.RemoveAll(tmp)
if !evacuateCgroup2 {
if err := unix.Mount(cgroupDir, tmp, "", uintptr(unix.MS_BIND|unix.MS_REC), ""); err != nil {
return fmt.Errorf("failed to create bind mount on %s: %w", cgroupDir, err)
}
}
if err := unix.Mount("none", "/sys", "sysfs", 0, ""); err != nil {
// when the sysfs in the parent namespace is RO,
// we can't mount RW sysfs even in the child namespace.
// https://github.com/rootless-containers/rootlesskit/pull/23#issuecomment-429292632
// https://github.com/torvalds/linux/blob/9f203e2f2f065cd74553e6474f0ae3675f39fb0f/fs/namespace.c#L3326-L3328
logrus.Warnf("failed to mount sysfs, falling back to read-only mount: %v", err)
if err := unix.Mount("none", "/sys", "sysfs", uintptr(unix.MS_RDONLY), ""); err != nil {
// when /sys/firmware is masked, even RO sysfs can't be mounted
logrus.Warnf("failed to mount sysfs: %v", err)
}
}
if evacuateCgroup2 {
if err := unix.Mount("none", cgroupDir, "cgroup2", 0, ""); err != nil {
return fmt.Errorf("failed to mount cgroup2 on %s: %w", cgroupDir, err)
}
} else {
if err := unix.Mount(tmp, cgroupDir, "", uintptr(unix.MS_MOVE), ""); err != nil {
return fmt.Errorf("failed to move mount point from %s to %s: %w", tmp, cgroupDir, err)
}
}
return nil
}
func mountProcfs() error {
if err := unix.Mount("none", "/proc", "proc", 0, ""); err != nil {
logrus.Warnf("failed to mount procfs, falling back to read-only mount: %v", err)
if err := unix.Mount("none", "/proc", "proc", uintptr(unix.MS_RDONLY), ""); err != nil {
logrus.Warnf("failed to mount procfs: %v", err)
}
}
return nil
}
func activateLoopback() error {
cmds := [][]string{
{"ip", "link", "set", "lo", "up"},
}
if err := common.Execs(os.Stderr, os.Environ(), cmds); err != nil {
return fmt.Errorf("executing %v: %w", cmds, err)
}
return nil
}
func activateDev(dev, ip string, netmask int, gateway string, mtu int) error {
cmds := [][]string{
{"ip", "link", "set", dev, "up"},
{"ip", "link", "set", "dev", dev, "mtu", strconv.Itoa(mtu)},
{"ip", "addr", "add", ip + "/" + strconv.Itoa(netmask), "dev", dev},
{"ip", "route", "add", "default", "via", gateway, "dev", dev},
}
if err := common.Execs(os.Stderr, os.Environ(), cmds); err != nil {
return fmt.Errorf("executing %v: %w", cmds, err)
}
return nil
}
func setupCopyDir(driver copyup.ChildDriver, dirs []string) (bool, error) {
if driver != nil {
etcWasCopied := false
copied, err := driver.CopyUp(dirs)
for _, d := range copied {
if d == "/etc" {
etcWasCopied = true
break
}
}
return etcWasCopied, err
}
if len(dirs) != 0 {
return false, errors.New("copy-up driver is not specified")
}
return false, nil
}
// setupNet sets up the network driver.
//
// NOTE: msg is altered during calling driver.ConfigureNetworkChild
func setupNet(stateDir string, msg *messages.ParentInitNetworkDriverCompleted, etcWasCopied bool, driver network.ChildDriver, detachedNetNSPath string) error {
// HostNetwork
if driver == nil {
return nil
}
stateDirResolvConf := filepath.Join(stateDir, "resolv.conf")
hostsContent, err := generateEtcHosts()
if err != nil {
return err
}
stateDirHosts := filepath.Join(stateDir, "hosts")
if err := os.WriteFile(stateDirHosts, hostsContent, 0644); err != nil {
return fmt.Errorf("writing %s: %w", stateDirHosts, err)
}
if detachedNetNSPath == "" {
// non-detached mode
if err := activateLoopback(); err != nil {
return err
}
dev, err := driver.ConfigureNetworkChild(msg, detachedNetNSPath) // alters msg
if err != nil {
return err
}
if err := os.WriteFile(stateDirResolvConf, generateResolvConf(msg.DNS), 0644); err != nil {
return fmt.Errorf("writing %s: %w", stateDirResolvConf, err)
}
if err := activateDev(dev, msg.IP, msg.Netmask, msg.Gateway, msg.MTU); err != nil {
return err
}
if etcWasCopied {
// remove copied-up link
for _, f := range []string{"/etc/resolv.conf", "/etc/hosts"} {
if err := os.RemoveAll(f); err != nil {
return fmt.Errorf("failed to remove copied-up link %q: %w", f, err)
}
if err := os.WriteFile(f, []byte{}, 0644); err != nil {
return fmt.Errorf("writing %s: %w", f, err)
}
}
} else {
logrus.Warn("Mounting /etc/resolv.conf without copying-up /etc. " +
"Note that /etc/resolv.conf in the namespace will be unmounted when it is recreated on the host. " +
"Unless /etc/resolv.conf is statically configured, copying-up /etc is highly recommended. " +
"Please refer to RootlessKit documentation for further information.")
}
if err := unix.Mount(stateDirResolvConf, "/etc/resolv.conf", "", uintptr(unix.MS_BIND), ""); err != nil {
return fmt.Errorf("failed to create bind mount /etc/resolv.conf for %s: %w", stateDirResolvConf, err)
}
if err := unix.Mount(stateDirHosts, "/etc/hosts", "", uintptr(unix.MS_BIND), ""); err != nil {
return fmt.Errorf("failed to create bind mount /etc/hosts for %s: %w", stateDirHosts, err)
}
} else {
// detached mode
if err := ns.WithNetNSPath(detachedNetNSPath, func(_ ns.NetNS) error {
return activateLoopback()
}); err != nil {
return err
}
dev, err := driver.ConfigureNetworkChild(msg, detachedNetNSPath) // alters msg
if err != nil {
return err
}
if err := os.WriteFile(stateDirResolvConf, generateResolvConf(msg.DNS), 0644); err != nil {
return fmt.Errorf("writing %s: %w", stateDirResolvConf, err)
}
if err := ns.WithNetNSPath(detachedNetNSPath, func(_ ns.NetNS) error {
return activateDev(dev, msg.IP, msg.Netmask, msg.Gateway, msg.MTU)
}); err != nil {
return err
}
}
return nil
}
type Opt struct {
PipeFDEnvKey string // needs to be set
StateDirEnvKey string // needs to be set
TargetCmd []string // needs to be set
NetworkDriver network.ChildDriver // nil for HostNetwork
CopyUpDriver copyup.ChildDriver // cannot be nil if len(CopyUpDirs) != 0
CopyUpDirs []string
DetachNetNS bool
PortDriver port.ChildDriver
MountProcfs bool // needs to be set if (and only if) parent.Opt.CreatePIDNS is set
Propagation string // mount propagation type
Reaper bool
EvacuateCgroup2 bool // needs to correspond to parent.Opt.EvacuateCgroup2 is set
}
// statPIDNS is from https://github.com/containerd/containerd/blob/v1.7.2/services/introspection/pidns_linux.go#L25-L36
func statPIDNS(pid int) (uint64, error) {
f := fmt.Sprintf("/proc/%d/ns/pid", pid)
st, err := os.Stat(f)
if err != nil {
return 0, err
}
stSys, ok := st.Sys().(*syscall.Stat_t)
if !ok {
return 0, fmt.Errorf("%T is not *syscall.Stat_t", st.Sys())
}
return stSys.Ino, nil
}
func hasCaps() (bool, error) {
pid := os.Getpid()
hdr := unix.CapUserHeader{
Version: unix.LINUX_CAPABILITY_VERSION_3,
Pid: int32(pid),
}
var data unix.CapUserData
if err := unix.Capget(&hdr, &data); err != nil {
return false, fmt.Errorf("failed to get the current caps: %w", err)
}
logrus.Debugf("Capabilities: %+v", data)
return data.Effective != 0, nil
}
// gainCaps gains the caps inside the user namespace.
// The caps are gained on re-execution after the child's uid_map and gid_map are fully written.
func gainCaps() error {
pid := os.Getpid()
pidns, err := statPIDNS(pid)
if err != nil {
logrus.WithError(err).Debug("Failed to stat pidns (negligible when unsharing pidns)")
pidns = 0
}
envName := fmt.Sprintf("_ROOTLESSKIT_REEXEC_COUNT_%d_%d", pidns, pid)
logrus.Debugf("Re-executing the RootlessKit child process (PID=%d) to gain the caps", pid)
var envValueInt int
if envValueStr := os.Getenv(envName); envValueStr != "" {
var err error
envValueInt, err = strconv.Atoi(envValueStr)
if err != nil {
return fmt.Errorf("failed to parse %s value %q: %w", envName, envValueStr, err)
}
}
if envValueInt > 5 {
time.Sleep(10 * time.Millisecond * time.Duration(envValueInt))
}
if envValueInt > 10 {
return fmt.Errorf("no capabilities was gained after reexecuting the child (%s=%d)", envName, envValueInt)
}
logrus.Debugf("%s: %d->%d", envName, envValueInt, envValueInt+1)
os.Setenv(envName, strconv.Itoa(envValueInt+1))
// PID should be kept after re-execution.
if err := syscall.Exec("/proc/self/exe", os.Args, os.Environ()); err != nil {
return err
}
panic("should not reach here")
}
func Child(opt Opt) error {
if opt.PipeFDEnvKey == "" {
return errors.New("pipe FD env key is not set")
}
pipeFDStr := os.Getenv(opt.PipeFDEnvKey)
if pipeFDStr == "" {
return fmt.Errorf("%s is not set", opt.PipeFDEnvKey)
}
var pipeFD, pipe2FD int
if _, err := fmt.Sscanf(pipeFDStr, "%d,%d", &pipeFD, &pipe2FD); err != nil {
return fmt.Errorf("unexpected fd value: %s: %w", pipeFDStr, err)
}
logrus.Debugf("pipeFD=%d, pipe2FD=%d", pipeFD, pipe2FD)
pipeR := os.NewFile(uintptr(pipeFD), "")
pipe2W := os.NewFile(uintptr(pipe2FD), "")
if opt.StateDirEnvKey == "" {
opt.StateDirEnvKey = "ROOTLESSKIT_STATE_DIR" // for backward compatibility of Go API
}
stateDir := os.Getenv(opt.StateDirEnvKey)
if stateDir == "" {
return errors.New("got empty StateDir")
}
var (
msg *messages.Message
err error
)
if ok, err := hasCaps(); err != nil {
return err
} else if !ok {
msg, err = messages.WaitFor(pipeR, messages.Name(messages.ParentHello{}))
if err != nil {
return err
}
msgChildHello := &messages.Message{
U: messages.U{
ChildHello: &messages.ChildHello{},
},
}
if err := messages.Send(pipe2W, msgChildHello); err != nil {
return err
}
msg, err = messages.WaitFor(pipeR, messages.Name(messages.ParentInitIdmapCompleted{}))
if err != nil {
return err
}
if err := gainCaps(); err != nil {
return fmt.Errorf("failed to gain the caps inside the user namespace: %w", err)
}
}
if opt.MountProcfs {
if err := mountProcfs(); err != nil {
return err
}
}
var detachedNetNSPath string
if opt.DetachNetNS {
detachedNetNSPath = filepath.Join(stateDir, "netns")
if err = NewNetNsWithPathWithoutEnter(detachedNetNSPath); err != nil {
return fmt.Errorf("failed to create a detached netns on %q: %w", detachedNetNSPath, err)
}
}
msgChildInitUserNSCompleted := &messages.Message{
U: messages.U{
ChildInitUserNSCompleted: &messages.ChildInitUserNSCompleted{},
},
}
if err := messages.Send(pipe2W, msgChildInitUserNSCompleted); err != nil {
return err
}
msg, err = messages.WaitFor(pipeR, messages.Name(messages.ParentInitNetworkDriverCompleted{}))
if err != nil {
return err
}
netMsg := msg.U.ParentInitNetworkDriverCompleted
msg, err = messages.WaitFor(pipeR, messages.Name(messages.ParentInitPortDriverCompleted{}))
if err != nil {
return err
}
portMsg := msg.U.ParentInitPortDriverCompleted
// The parent calls child with Pdeathsig, but it is cleared when newuidmap SUID binary is called
// https://github.com/rootless-containers/rootlesskit/issues/65#issuecomment-492343646
runtime.LockOSThread()
err = unix.Prctl(unix.PR_SET_PDEATHSIG, uintptr(unix.SIGKILL), 0, 0, 0)
runtime.UnlockOSThread()
if err != nil {
return err
}
os.Unsetenv(opt.PipeFDEnvKey)
if err := pipeR.Close(); err != nil {
return fmt.Errorf("failed to close fd %d: %w", pipeFD, err)
}
if err := setMountPropagation(opt.Propagation); err != nil {
return err
}
etcWasCopied, err := setupCopyDir(opt.CopyUpDriver, opt.CopyUpDirs)
if err != nil {
return err
}
if detachedNetNSPath == "" {
if err := mountSysfs(opt.NetworkDriver == nil, opt.EvacuateCgroup2); err != nil {
return err
}
}
if err := setupNet(stateDir, netMsg, etcWasCopied, opt.NetworkDriver, detachedNetNSPath); err != nil {
return err
}
portQuitCh := make(chan struct{})
portErrCh := make(chan error)
if opt.PortDriver != nil {
var portDriverOpaque map[string]string
if portMsg != nil {
portDriverOpaque = portMsg.PortDriverOpaque
}
go func() {
portErrCh <- opt.PortDriver.RunChildDriver(portDriverOpaque, portQuitCh, detachedNetNSPath)
}()
}
cmd, err := createCmd(opt.TargetCmd)
if err != nil {
return err
}
if opt.Reaper {
if err := runAndReap(cmd); err != nil {
return fmt.Errorf("command %v exited: %w", opt.TargetCmd, err)
}
} else {
if err := cmd.Start(); err != nil {
return fmt.Errorf("command %v exited: %w", opt.TargetCmd, err)
}
sigc := sigproxy.ForwardAllSignals(context.TODO(), cmd.Process.Pid)
defer sigproxysignal.StopCatch(sigc)
if err := cmd.Wait(); err != nil {
return fmt.Errorf("command %v exited: %w", opt.TargetCmd, err)
}
}
if opt.PortDriver != nil {
portQuitCh <- struct{}{}
return <-portErrCh
}
return nil
}
func setMountPropagation(propagation string) error {
flags, ok := propagationStates[propagation]
if ok {
if err := unix.Mount("none", "/", "", flags, ""); err != nil {
return fmt.Errorf("failed to share mount point: /: %w", err)
}
}
return nil
}
func runAndReap(cmd *exec.Cmd) error {
c := make(chan os.Signal, 32)
signal.Notify(c, syscall.SIGCHLD)
cmd.SysProcAttr.Setsid = true
if err := cmd.Start(); err != nil {
return err
}
sigc := sigproxy.ForwardAllSignals(context.TODO(), cmd.Process.Pid)
defer sigproxysignal.StopCatch(sigc)
result := make(chan error)
go func() {
defer close(result)
for cEntry := range c {
logrus.Debugf("reaper: got signal %q", cEntry)
if wsPtr := reap(cmd.Process.Pid); wsPtr != nil {
ws := *wsPtr
if ws.Exited() && ws.ExitStatus() == 0 {
result <- nil
continue
}
var resultErr common.ErrorWithSys = &reaperErr{
ws: ws,
}
result <- resultErr
}
}
}()
return <-result
}
func reap(myPid int) *syscall.WaitStatus {
var res *syscall.WaitStatus
for {
var ws syscall.WaitStatus
pid, err := syscall.Wait4(-1, &ws, syscall.WNOHANG, nil)
logrus.Debugf("reaper: got ws=%+v, pid=%d, err=%+v", ws, pid, err)
if err != nil || pid <= 0 {
break
}
if pid == myPid {
res = &ws
}
}
return res
}
type reaperErr struct {
ws syscall.WaitStatus
}
func (e *reaperErr) Sys() interface{} {
return e.ws
}
func (e *reaperErr) Error() string {
if e.ws.Exited() {
return fmt.Sprintf("exit status %d", e.ws.ExitStatus())
}
if e.ws.Signaled() {
return fmt.Sprintf("signal: %s", e.ws.Signal())
}
return fmt.Sprintf("exited with WAITSTATUS=0x%08x", e.ws)
}
func NewNetNsWithPathWithoutEnter(p string) error {
if err := os.WriteFile(p, nil, 0400); err != nil {
return err
}
// this is hard (not impossible though) to reimplement in Go: https://github.com/cloudflare/slirpnetstack/commit/d7766a8a77f0093d3cb7a94bd0ccbe3f67d411ba
cmd := exec.Command("unshare", "-n", "mount", "--bind", "/proc/self/ns/net", p)
out, err := cmd.CombinedOutput()
if err != nil {
return fmt.Errorf("failed to execute %v: %w (out=%q)", cmd.Args, err, string(out))
}
return nil
}
|