man2/setns.2

   1 .\" Copyright (C) 2011, Eric Biederman <ebiederm@xmission.com>
   2 .\" and Copyright (C) 2011, 2012, Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2_ONELINE)
   5 .\" Licensed under the GPLv2
   6 .\" %%%LICENSE_END
   7 .\"
   8 .TH SETNS 2 2017-09-15 "Linux" "Linux Programmer's Manual"
   9 .SH NAME
  10 setns \- reassociate thread with a namespace
  11 .SH SYNOPSIS
  12 .nf
  13 .BR "#define _GNU_SOURCE" "             /* See feature_test_macros(7) */"
  14 .B #include <sched.h>
  15 .PP
  16 .BI "int setns(int " fd ", int " nstype );
  17 .fi
  18 .SH DESCRIPTION
  19 Given a file descriptor referring to a namespace,
  20 reassociate the calling thread with that namespace.
  21 .PP
  22 The
  23 .I fd
  24 argument is a file descriptor referring to one of the namespace entries in a
  25 .I /proc/[pid]/ns/
  26 directory; see
  27 .BR namespaces (7)
  28 for further information on
  29 .IR /proc/[pid]/ns/ .
  30 The calling thread will be reassociated with the corresponding namespace,
  31 subject to any constraints imposed by the
  32 .I nstype
  33 argument.
  34 .PP
  35 The
  36 .I nstype
  37 argument specifies which type of namespace
  38 the calling thread may be reassociated with.
  39 This argument can have one of the following values:
  40 .TP
  41 .BR 0
  42 Allow any type of namespace to be joined.
  43 .TP
  44 .BR CLONE_NEWCGROUP " (since Linux 4.6)"
  45 .I fd
  46 must refer to a cgroup namespace.
  47 .TP
  48 .BR CLONE_NEWIPC " (since Linux 3.0)"
  49 .I fd
  50 must refer to an IPC namespace.
  51 .TP
  52 .BR CLONE_NEWNET " (since Linux 3.0)"
  53 .I fd
  54 must refer to a network namespace.
  55 .TP
  56 .BR CLONE_NEWNS " (since Linux 3.8)"
  57 .I fd
  58 must refer to a mount namespace.
  59 .TP
  60 .BR CLONE_NEWPID " (since Linux 3.8)"
  61 .I fd
  62 must refer to a descendant PID namespace.
  63 .TP
  64 .BR CLONE_NEWUSER " (since Linux 3.8)"
  65 .I fd
  66 must refer to a user namespace.
  67 .TP
  68 .BR CLONE_NEWUTS " (since Linux 3.0)"
  69 .I fd
  70 must refer to a UTS namespace.
  71 .PP
  72 Specifying
  73 .I nstype
  74 as 0 suffices if the caller knows (or does not care)
  75 what type of namespace is referred to by
  76 .IR fd .
  77 Specifying a nonzero value for
  78 .I nstype
  79 is useful if the caller does not know what type of namespace is referred to by
  80 .IR fd
  81 and wants to ensure that the namespace is of a particular type.
  82 (The caller might not know the type of the namespace referred to by
  83 .IR fd
  84 if the file descriptor was opened by another process and, for example,
  85 passed to the caller via a UNIX domain socket.)
  86 .PP
  87 If
  88 .I fd
  89 refers to a PID namespaces, the semantics are somewhat different
  90 from other namespace types:
  91 reassociating the calling thread with a PID namespace changes only
  92 the PID namespace that subsequently created child processes of
  93 the caller will be placed in;
  94 it does not change the PID namespace of the caller itself.
  95 Reassociating with a PID namespace is allowed only if the
  96 PID namespace specified by
  97 .IR fd
  98 is a descendant (child, grandchild, etc.)
  99 of the PID namespace of the caller.
 100 For further details on PID namespaces, see
 101 .BR pid_namespaces (7).
 102 .PP
 103 A process reassociating itself with a user namespace must have the
 104 .B CAP_SYS_ADMIN
 105 .\" See kernel/user_namespace.c:userns_install() [3.8 source]
 106 capability in the target user namespace.
 107 Upon successfully joining a user namespace,
 108 a process is granted all capabilities in that namespace,
 109 regardless of its user and group IDs.
 110 A multithreaded process may not change user namespace with
 111 .BR setns ().
 112 It is not permitted to use
 113 .BR setns ()
 114 to reenter the caller's current user namespace.
 115 This prevents a caller that has dropped capabilities from regaining
 116 those capabilities via a call to
 117 .BR setns ().
 118 For security reasons,
 119 .\" commit e66eded8309ebf679d3d3c1f5820d1f2ca332c71
 120 .\" https://lwn.net/Articles/543273/
 121 a process can't join a new user namespace if it is sharing
 122 filesystem-related attributes
 123 (the attributes whose sharing is controlled by the
 124 .BR clone (2)
 125 .B CLONE_FS
 126 flag) with another process.
 127 For further details on user namespaces, see
 128 .BR user_namespaces (7).
 129 .PP
 130 A process may not be reassociated with a new mount namespace if it is
 131 multithreaded.
 132 .\" Above check is in fs/namespace.c:mntns_install() [3.8 source]
 133 Changing the mount namespace requires that the caller possess both
 134 .B CAP_SYS_CHROOT
 135 and
 136 .BR CAP_SYS_ADMIN
 137 capabilities in its own user namespace and
 138 .BR CAP_SYS_ADMIN
 139 in the target mount namespace.
 140 See
 141 .BR user_namespaces (7)
 142 for details on the interaction of user namespaces and mount namespaces.
 143 .PP
 144 Using
 145 .BR setns ()
 146 to change the caller's cgroup namespace does not change
 147 the caller's cgroup memberships.
 148 .SH RETURN VALUE
 149 On success,
 150 .BR setns ()
 151 returns 0.
 152 On failure, \-1 is returned and
 153 .I errno
 154 is set to indicate the error.
 155 .SH ERRORS
 156 .TP
 157 .B EBADF
 158 .I fd
 159 is not a valid file descriptor.
 160 .TP
 161 .B EINVAL
 162 .I fd
 163 refers to a namespace whose type does not match that specified in
 164 .IR nstype .
 165 .TP
 166 .B EINVAL
 167 There is problem with reassociating
 168 the thread with the specified namespace.
 169 .TP
 170 .\" See kernel/pid_namespace.c::pidns_install() [kernel 3.18 sources]
 171 .B EINVAL
 172 The caller tried to join an ancestor (parent, grandparent, and so on)
 173 PID namespace.
 174 .TP
 175 .B EINVAL
 176 The caller attempted to join the user namespace
 177 in which it is already a member.
 178 .TP
 179 .B EINVAL
 180 .\" commit e66eded8309ebf679d3d3c1f5820d1f2ca332c71
 181 The caller shares filesystem
 182 .RB ( CLONE_FS )
 183 state (in particular, the root directory)
 184 with other processes and tried to join a new user namespace.
 185 .TP
 186 .B EINVAL
 187 .\" See kernel/user_namespace.c::userns_install() [kernel 3.15 sources]
 188 The caller is multithreaded and tried to join a new user namespace.
 189 .TP
 190 .B ENOMEM
 191 Cannot allocate sufficient memory to change the specified namespace.
 192 .TP
 193 .B EPERM
 194 The calling thread did not have the required capability
 195 for this operation.
 196 .SH VERSIONS
 197 The
 198 .BR setns ()
 199 system call first appeared in Linux in kernel 3.0;
 200 library support was added to glibc in version 2.14.
 201 .SH CONFORMING TO
 202 The
 203 .BR setns ()
 204 system call is Linux-specific.
 205 .SH NOTES
 206 Not all of the attributes that can be shared when
 207 a new thread is created using
 208 .BR clone (2)
 209 can be changed using
 210 .BR setns ().
 211 .SH EXAMPLE
 212 The program below takes two or more arguments.
 213 The first argument specifies the pathname of a namespace file in an existing
 214 .I /proc/[pid]/ns/
 215 directory.
 216 The remaining arguments specify a command and its arguments.
 217 The program opens the namespace file, joins that namespace using
 218 .BR setns (),
 219 and executes the specified command inside that namespace.
 220 .PP
 221 The following shell session demonstrates the use of this program
 222 (compiled as a binary named
 223 .IR ns_exec )
 224 in conjunction with the
 225 .BR CLONE_NEWUTS
 226 example program in the
 227 .BR clone (2)
 228 man page (complied as a binary named
 229 .IR newuts ).
 230 .PP
 231 We begin by executing the example program in
 232 .BR clone (2)
 233 in the background.
 234 That program creates a child in a separate UTS namespace.
 235 The child changes the hostname in its namespace,
 236 and then both processes display the hostnames in their UTS namespaces,
 237 so that we can see that they are different.
 238 .PP
 239 .in +4n
 240 .EX
 241 $ \fBsu\fP                   # Need privilege for namespace operations
 242 Password:
 243 # \fB./newuts bizarro &\fP
 244 [1] 3549
 245 clone() returned 3550
 246 uts.nodename in child:  bizarro
 247 uts.nodename in parent: antero
 248 # \fBuname \-n\fP             # Verify hostname in the shell
 249 antero
 250 .EE
 251 .in
 252 .PP
 253 We then run the program shown below,
 254 using it to execute a shell.
 255 Inside that shell, we verify that the hostname is the one
 256 set by the child created by the first program:
 257 .PP
 258 .in +4n
 259 .EX
 260 # \fB./ns_exec /proc/3550/ns/uts /bin/bash\fP
 261 # \fBuname \-n\fP             # Executed in shell started by ns_exec
 262 bizarro
 263 .EE
 264 .in
 265 .SS Program source
 266 .EX
 267 #define _GNU_SOURCE
 268 #include <fcntl.h>
 269 #include <sched.h>
 270 #include <unistd.h>
 271 #include <stdlib.h>
 272 #include <stdio.h>
 273
 274 #define errExit(msg)    do { perror(msg); exit(EXIT_FAILURE); \\
 275                         } while (0)
 276
 277 int
 278 main(int argc, char *argv[])
 279 {
 280     int fd;
 281
 282     if (argc < 3) {
 283         fprintf(stderr, "%s /proc/PID/ns/FILE cmd args...\\n", argv[0]);
 284         exit(EXIT_FAILURE);
 285     }
 286
 287     fd = open(argv[1], O_RDONLY); /* Get file descriptor for namespace */
 288     if (fd == \-1)
 289         errExit("open");
 290
 291     if (setns(fd, 0) == \-1)       /* Join that namespace */
 292         errExit("setns");
 293
 294     execvp(argv[2], &argv[2]);    /* Execute a command in namespace */
 295     errExit("execvp");
 296 }
 297 .EE
 298 .SH SEE ALSO
 299 .BR nsenter (1),
 300 .BR clone (2),
 301 .BR fork (2),
 302 .BR unshare (2),
 303 .BR vfork (2),
 304 .BR namespaces (7),
 305 .BR unix (7)