Linux man pages

HOME Section 1 Section 2 Section 3 Section 4 Section 5 Section 6 Section 7 Section 8 Section 9

Section (1) unshare

Linux manual pages Section 1  

Name

unshare — run program with some namespaces unshared from parent

Synopsis

unshare [options] [ program [arguments] ]

DESCRIPTION

Unshares the indicated namespaces from the parent process and then executes the specified program. If program is not given, then ``${SHELL}_zsingle_quotesz__zsingle_quotesz_ is run (default: /bin/sh).

The namespaces can optionally be made persistent by bind mounting /proc/pid/ns/type files to a filesystem path and entered with nsenter(1) even after the program terminates (except PID namespaces where permanently running init process is required). Once a persistent namespace is no longer needed, it can be unpersisted with umount(8). See the EXAMPLES section for more details.

The namespaces to be unshared are indicated via options. Unshareable namespaces are:

mount namespace

Mounting and unmounting filesystems will not affect the rest of the system, except for filesystems which are explicitly marked as shared (with mount --make-shared; see /proc/self/mountinfo or findmnt -o+PROPAGATION for the shared flags). For further details, see mount_namespaces(7) and the discussion of the CLONE_NEWNS flag in clone(2).

unshare since util-linux version 2.27 automatically sets propagation to private in a new mount namespace to make sure that the new namespace is really unshared. It_zsingle_quotesz_s possible to disable this feature with option −−propagation unchanged. Note that private is the kernel default.

UTS namespace

Setting hostname or domainname will not affect the rest of the system. For further details, see namespaces(7) and the discussion of the CLONE_NEWUTS flag in clone(2).

IPC namespace

The process will have an independent namespace for POSIX message queues as well as System V message queues, semaphore sets and shared memory segments. For further details, see namespaces(7) and the discussion of the CLONE_NEWIPC flag in clone(2).

network namespace

The process will have independent IPv4 and IPv6 stacks, IP routing tables, firewall rules, the /proc/net and /sys/class/net directory trees, sockets, etc. For further details, see namespaces(7) and the discussion of the CLONE_NEWNET flag in clone(2).

PID namespace

Children will have a distinct set of PID-to-process mappings from their parent. For further details, see pid_namespaces(7) and the discussion of the CLONE_NEWPID flag in clone(2).

cgroup namespace

The process will have a virtualized view of /proc/self/cgroup, and new cgroup mounts will be rooted at the namespace cgroup root. For further details, see cgroup_namespaces(7) and the discussion of the CLONE_NEWCGROUP flag in clone(2).

user namespace

The process will have a distinct set of UIDs, GIDs and capabilities. For further details, see user_namespaces(7) and the discussion of the CLONE_NEWUSER flag in clone(2).

OPTIONS

−i, −−ipc[=file]

Unshare the IPC namespace. If file is specified, then a persistent namespace is created by a bind mount.

−m, −−mount[=file]

Unshare the mount namespace. If file is specified, then a persistent namespace is created by a bind mount. Note that file has to be located on a filesystem with the propagation flag set to private. Use the command findmnt -o+PROPAGATION when not sure about the current setting. See also the examples below.

−n, −−net[=file]

Unshare the network namespace. If file is specified, then a persistent namespace is created by a bind mount.

−p, −−pid[=file]

Unshare the PID namespace. If file is specified then persistent namespace is created by a bind mount. See also the −−fork and −−mount−proc options.

−u, −−uts[=file]

Unshare the UTS namespace. If file is specified, then a persistent namespace is created by a bind mount.

−U, −−user[=file]

Unshare the user namespace. If file is specified, then a persistent namespace is created by a bind mount.

−C, −−cgroup[=file]

Unshare the cgroup namespace. If file is specified then persistent namespace is created by bind mount.

−f, −−fork

Fork the specified program as a child process of unshare rather than running it directly. This is useful when creating a new PID namespace.

−−kill−child[=signame]

When unshare terminates, have signame be sent to the forked child process. Combined with −−pid this allows for an easy and reliable killing of the entire process tree below unshare. If not given, signame defaults to SIGKILL. This option implies −−fork.

−−mount−proc[=mountpoint]

Just before running the program, mount the proc filesystem at mountpoint (default is /proc). This is useful when creating a new PID namespace. It also implies creating a new mount namespace since the /proc mount would otherwise mess up existing programs on the system. The new proc filesystem is explicitly mounted as private (with MS_PRIVATE|MS_REC).

−r, −−map−root−user

Run the program only after the current effective user and group IDs have been mapped to the superuser UID and GID in the newly created user namespace. This makes it possible to conveniently gain capabilities needed to manage various aspects of the newly created namespaces (such as configuring interfaces in the network namespace or mounting filesystems in the mount namespace) even when run unprivileged. As a mere convenience feature, it does not support more sophisticated use cases, such as mapping multiple ranges of UIDs and GIDs. This option implies −−setgroups=deny.

−−propagation private|shared|slave|unchanged

Recursively set the mount propagation flag in the new mount namespace. The default is to set the propagation to private. It is possible to disable this feature with the argument unchanged. The option is silently ignored when the mount namespace (−−mount) is not requested.

−−setgroups allow|deny

Allow or deny the setgroups(2) system call in a user namespace.

To be able to call setgroups(2), the calling process must at least have CAP_SETGID. But since Linux 3.19 a further restriction applies: the kernel gives permission to call setgroups(2) only after the GID map (/proc/pidfPfB/gid_map) has been set. The GID map is writable by root when setgroups(2) is enabled (i.e. allow, the default), and the GID map becomes writable by unprivileged processes when setgroups(2) is permanently disabled (with deny).

−V, −−version

Display version information and exit.

−h, −−help

Display help text and exit.

NOTES

The proc and sysfs filesystems mounting as root in a user namespace have to be restricted so that a less privileged user can not get more access to sensitive files that a more privileged user made unavailable. In short the rule for proc and sysfs is as close to a bind mount as possible.

EXAMPLES

# unshare --fork --pid --mount-proc readlink /proc/self
1

Establish a PID namespace, ensure we_zsingle_quotesz_re PID 1 in it against a newly mounted procfs instance.

$ unshare --map-root-user --user sh -c whoami
root

Establish a user namespace as an unprivileged user with a root user within it.

# touch /root/uts-ns
# unshare --uts=/root/uts-ns hostname FOO
# nsenter --uts=/root/uts-ns hostname
FOO
# umount /root/uts-ns

Establish a persistent UTS namespace, and modify the hostname. The namespace is then entered with nsenter. The namespace is destroyed by unmounting the bind reference.

# mount --bind /root/namespaces /root/namespaces
# mount --make-private /root/namespaces
# touch /root/namespaces/mnt
# unshare --mount=/root/namespaces/mnt

Establish a persistent mount namespace referenced by the bind mount /root/namespaces/mnt. This example shows a portable solution, because it makes sure that the bind mount is created on a shared filesystem.

# unshare -pf --kill-child -- bash -c (sleep 999 &) && sleep 1000 &
# pid=$!
# kill $pid

Reliable killing of subprocesses of the program. When unshare gets killed, everything below it gets killed as well. Without it, the children of program would have orphaned and been re-parented to PID 1.

SEE ALSO

clone(2), unshare(2), namespaces(7), mount(8)

AUTHORS

Mikhail Gusarov

Karel Zak

AVAILABILITY

The unshare command is part of the util-linux package and is available from https://www.kernel.org/pub/linux/utils/util-linux/.

Section (2) unshare

Linux manual pages Section 2  

Name

unshare — disassociate parts of the process execution context

Synopsis

#define _GNU_SOURCE
#include <sched.h>
int unshare( int flags);
 

DESCRIPTION

unshare() allows a process (or thread) to disassociate parts of its execution context that are currently being shared with other processes (or threads). Part of the execution context, such as the mount namespace, is shared implicitly when a new process is created using fork(2) or vfork(2), while other parts, such as virtual memory, may be shared by explicit request when creating a process or thread using clone(2).

The main use of unshare() is to allow a process to control its shared execution context without creating a new process.

The flags argument is a bit mask that specifies which parts of the execution context should be unshared. This argument is specified by ORing together zero or more of the following constants:

CLONE_FILES

Reverse the effect of the clone(2) CLONE_FILES flag. Unshare the file descriptor table, so that the calling process no longer shares its file descriptors with any other process.

CLONE_FS

Reverse the effect of the clone(2) CLONE_FS flag. Unshare filesystem attributes, so that the calling process no longer shares its root directory (chroot(2)), current directory (chdir(2)), or umask (umask(2)) attributes with any other process.

CLONE_NEWCGROUP (since Linux 4.6)

This flag has the same effect as the clone(2) CLONE_NEWCGROUP flag. Unshare the cgroup namespace. Use of CLONE_NEWCGROUP requires the CAP_SYS_ADMIN capability.

CLONE_NEWIPC (since Linux 2.6.19)

This flag has the same effect as the clone(2) CLONE_NEWIPC flag. Unshare the IPC namespace, so that the calling process has a private copy of the IPC namespace which is not shared with any other process. Specifying this flag automatically implies CLONE_SYSVSEM as well. Use of CLONE_NEWIPC requires the CAP_SYS_ADMIN capability.

CLONE_NEWNET (since Linux 2.6.24)

This flag has the same effect as the clone(2) CLONE_NEWNET flag. Unshare the network namespace, so that the calling process is moved into a new network namespace which is not shared with any previously existing process. Use of CLONE_NEWNET requires the CAP_SYS_ADMIN capability.

CLONE_NEWNS

This flag has the same effect as the clone(2) CLONE_NEWNS flag. Unshare the mount namespace, so that the calling process has a private copy of its namespace which is not shared with any other process. Specifying this flag automatically implies CLONE_FS as well. Use of CLONE_NEWNS requires the CAP_SYS_ADMIN capability. For further information, see mount_namespaces(7).

CLONE_NEWPID (since Linux 3.8)

This flag has the same effect as the clone(2) CLONE_NEWPID flag. Unshare the PID namespace, so that the calling process has a new PID namespace for its children which is not shared with any previously existing process. The calling process is not moved into the new namespace. The first child created by the calling process will have the process ID 1 and will assume the role of init(1) in the new namespace. CLONE_NEWPID automatically implies CLONE_THREAD as well. Use of CLONE_NEWPID requires the CAP_SYS_ADMIN capability. For further information, see pid_namespaces(7).

CLONE_NEWUSER (since Linux 3.8)

This flag has the same effect as the clone(2) CLONE_NEWUSER flag. Unshare the user namespace, so that the calling process is moved into a new user namespace which is not shared with any previously existing process. As with the child process created by clone(2) with the CLONE_NEWUSER flag, the caller obtains a full set of capabilities in the new namespace.

CLONE_NEWUSER requires that the calling process is not threaded; specifying CLONE_NEWUSER automatically implies CLONE_THREAD. Since Linux 3.9, CLONE_NEWUSER also automatically implies CLONE_FS. CLONE_NEWUSER requires that the user ID and group ID of the calling process are mapped to user IDs and group IDs in the user namespace of the calling process at the time of the call.

For further information on user namespaces, see user_namespaces(7).

CLONE_NEWUTS (since Linux 2.6.19)

This flag has the same effect as the clone(2) CLONE_NEWUTS flag. Unshare the UTS IPC namespace, so that the calling process has a private copy of the UTS namespace which is not shared with any other process. Use of CLONE_NEWUTS requires the CAP_SYS_ADMIN capability.

CLONE_SYSVSEM (since Linux 2.6.26)

This flag reverses the effect of the clone(2) CLONE_SYSVSEM flag. Unshare System V semaphore adjustment (semadj) values, so that the calling process has a new empty semadj list that is not shared with any other process. If this is the last process that has a reference to the process_zsingle_quotesz_s current semadj list, then the adjustments in that list are applied to the corresponding semaphores, as described in semop(2).

In addition, CLONE_THREAD, CLONE_SIGHAND, and CLONE_VM can be specified in flags if the caller is single threaded (i.e., it is not sharing its address space with another process or thread). In this case, these flags have no effect. (Note also that specifying CLONE_THREAD automatically implies CLONE_VM, and specifying CLONE_VM automatically implies CLONE_SIGHAND.) If the process is multithreaded, then the use of these flags results in an error.

If flags is specified as zero, then unshare() is a no-op; no changes are made to the calling process_zsingle_quotesz_s execution context.

RETURN VALUE

On success, zero returned. On failure, −1 is returned and errno is set to indicate the error.

ERRORS

EINVAL

An invalid bit was specified in flags.

EINVAL

CLONE_THREAD, CLONE_SIGHAND, or CLONE_VM was specified in flags, and the caller is multithreaded.

EINVAL

CLONE_NEWIPC was specified in flags, but the kernel was not configured with the CONFIG_SYSVIPC and CONFIG_IPC_NS options.

EINVAL

CLONE_NEWNET was specified in flags, but the kernel was not configured with the CONFIG_NET_NS option.

EINVAL

CLONE_NEWPID was specified in flags, but the kernel was not configured with the CONFIG_PID_NS option.

EINVAL

CLONE_NEWUSER was specified in flags, but the kernel was not configured with the CONFIG_USER_NS option.

EINVAL

CLONE_NEWUTS was specified in flags, but the kernel was not configured with the CONFIG_UTS_NS option.

EINVAL

CLONE_NEWPID was specified in flags, but the process has previously called unshare() with the CLONE_NEWPID flag.

ENOMEM

Cannot allocate sufficient memory to copy parts of caller_zsingle_quotesz_s context that need to be unshared.

ENOSPC (since Linux 3.7)

CLONE_NEWPID was specified in flags, but the limit on the nesting depth of PID namespaces would have been exceeded; see pid_namespaces(7).

ENOSPC (since Linux 4.9; beforehand EUSERS)

CLONE_NEWUSER was specified in flags, and the call would cause the limit on the number of nested user namespaces to be exceeded. See user_namespaces(7).

From Linux 3.11 to Linux 4.8, the error diagnosed in this case was EUSERS.

ENOSPC (since Linux 4.9)

One of the values in flags specified the creation of a new user namespace, but doing so would have caused the limit defined by the corresponding file in /proc/sys/user to be exceeded. For further details, see namespaces(7).

EPERM

The calling process did not have the required privileges for this operation.

EPERM

CLONE_NEWUSER was specified in flags, but either the effective user ID or the effective group ID of the caller does not have a mapping in the parent namespace (see user_namespaces(7)).

EPERM (since Linux 3.9)

CLONE_NEWUSER was specified in flags and the caller is in a chroot environment (i.e., the caller_zsingle_quotesz_s root directory does not match the root directory of the mount namespace in which it resides).

EUSERS (from Linux 3.11 to Linux 4.8)

CLONE_NEWUSER was specified in flags, and the limit on the number of nested user namespaces would be exceeded. See the discussion of the ENOSPC error above.

VERSIONS

The unshare() system call was added to Linux in kernel 2.6.16.

CONFORMING TO

The unshare() system call is Linux-specific.

NOTES

Not all of the process attributes that can be shared when a new process is created using clone(2) can be unshared using unshare(). In particular, as at kernel 3.8, unshare() does not implement flags that reverse the effects of CLONE_SIGHAND, CLONE_THREAD, or CLONE_VM. Such functionality may be added in the future, if required.

EXAMPLE

The program below provides a simple implementation of the unshare(1) command, which unshares one or more namespaces and executes the command supplied in its command-line arguments. Here_zsingle_quotesz_s an example of the use of this program, running a shell in a new mount namespace, and verifying that the original shell and the new shell are in separate mount namespaces:

$ readlink /proc/$$/ns/mnt
mnt:[4026531840]
$ sudo ./unshare -m /bin/bash
# readlink /proc/$$/ns/mnt
mnt:[4026532325]

The differing output of the two readlink(1) commands shows that the two shells are in different mount namespaces.

Program source

/* unshare.c

   A simple implementation of the unshare(1) command: unshare
   namespaces and execute a command.
*/
#define _GNU_SOURCE
#include <sched.h>
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>

/* A simple error−handling function: print an error message based
   on the value in _zsingle_quotesz_errno_zsingle_quotesz_ and terminate the calling process */

#define errExit(msg)    do { perror(msg); exit(EXIT_FAILURE); 
                        } while (0)

static void
usage(char *pname)
{
    fprintf(stderr, Usage: %s [options] program [arg...]
, pname);
    fprintf(stderr, Options can be:
);
    fprintf(stderr,     −i   unshare IPC namespace
);
    fprintf(stderr,     −m   unshare mount namespace
);
    fprintf(stderr,     −n   unshare network namespace
);
    fprintf(stderr,     −p   unshare PID namespace
);
    fprintf(stderr,     −u   unshare UTS namespace
);
    fprintf(stderr,     −U   unshare user namespace
);
    exit(EXIT_FAILURE);
}

int
main(int argc, char *argv[])
{
    int flags, opt;

    flags = 0;

    while ((opt = getopt(argc, argv, imnpuU)) != −1) {
        switch (opt) {
        case _zsingle_quotesz_i_zsingle_quotesz_: flags |= CLONE_NEWIPC;        break;
        case _zsingle_quotesz_m_zsingle_quotesz_: flags |= CLONE_NEWNS;         break;
        case _zsingle_quotesz_n_zsingle_quotesz_: flags |= CLONE_NEWNET;        break;
        case _zsingle_quotesz_p_zsingle_quotesz_: flags |= CLONE_NEWPID;        break;
        case _zsingle_quotesz_u_zsingle_quotesz_: flags |= CLONE_NEWUTS;        break;
        case _zsingle_quotesz_U_zsingle_quotesz_: flags |= CLONE_NEWUSER;       break;
        default:  usage(argv[0]);
        }
    }

    if (optind >= argc)
        usage(argv[0]);

    if (unshare(flags) == −1)
        errExit(unshare);

    execvp(argv[optind], &argv[optind]);
    errExit(execvp);
}

SEE ALSO

unshare(1), clone(2), fork(2), kcmp(2), setns(2), vfork(2), namespaces(7)

Documentation/userspace-api/unshare.rst in the Linux kernel source tree (or Documentation/unshare.txt before Linux 4.12)

COLOPHON

This page is part of release 5.04 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man−pages/.


  Copyright (C) 2006, Janak Desai <janakus.ibm.com>
and Copyright (C) 2006, 2012 Michael Kerrisk <mtk.manpagesgmail.com>

%%%LICENSE_START(GPL_NOVERSION_ONELINE)
Licensed under the GPL
%%%LICENSE_END

Patch Justification:
unshare system call is needed to implement, using PAM,
per-security_context and/or per-user namespace to provide
polyinstantiated directories. Using unshare and bind mounts, a
PAM module can create private namespace with appropriate
directories(based on user_zsingle_quotesz_s security context) bind mounted on
public directories such as /tmp, thus providing an instance of
/tmp that is based on user_zsingle_quotesz_s security context. Without the
unshare system call, namespace separation can only be achieved
by clone, which would require porting and maintaining all commands
such as login, and su, that establish a user session.