original/man2/setns.2

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