original/man3/getenv.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright (C) 2007, 2012 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" References consulted:
  27 .\"     Linux libc source code
  28 .\"     Lewine's "POSIX Programmer's Guide" (O'Reilly & Associates, 1991)
  29 .\"     386BSD man pages
  30 .\" Modified Sat Jul 24 19:30:29 1993 by Rik Faith (faith@cs.unc.edu)
  31 .\" Modified Fri Feb 14 21:47:50 1997 by Andries Brouwer (aeb@cwi.nl)
  32 .\"
  33 .TH GETENV 3  2012-08-14 "GNU" "Linux Programmer's Manual"
  34 .SH NAME
  35 getenv, secure_getenv \- get an environment variable
  36 .SH SYNOPSIS
  37 .nf
  38 .B #include <stdlib.h>
  39 .sp
  40 .BI "char *getenv(const char *" name );
  41
  42 .BI "char *secure_getenv(const char *" name );
  43 .fi
  44 .sp
  45 .in -4n
  46 Feature Test Macro Requirements for glibc (see
  47 .BR feature_test_macros (7)):
  48 .in
  49 .sp
  50 .BR secure_getenv ():
  51 _GNU_SOURCE
  52 .SH DESCRIPTION
  53 The
  54 .BR getenv ()
  55 function searches the environment list to find the
  56 environment variable
  57 .IR name ,
  58 and returns a pointer to the corresponding
  59 .I value
  60 string.
  61
  62 The GNU-specific
  63 .BR secure_getenv ()
  64 function is just like
  65 .BR getenv ()
  66 except that it returns NULL in cases where "secure execution" is required.
  67 Secure execution is required if one of the following conditions
  68 was true when the program run by the calling process was loaded:
  69 .IP * 3
  70 the process's effective user ID did not match its real user ID or
  71 the process's effective group ID did not match its real group ID
  72 (typically this is the result of executing a set-user-ID or
  73 set-group-ID program);
  74 .IP *
  75 the effective capability bit was set on the executable file; or
  76 .IP *
  77 the process has a nonempty permitted capability set.
  78 .PP
  79 Secure execution may also required if triggered
  80 by some Linux security modules.
  81
  82 The
  83 .BR secure_getenv ()
  84 function is intended for use in general-purpose libraries
  85 to avoid vulnerabilities that could occur if
  86 set-user-ID or set-group-ID programs accidentally
  87 trusted the environment.
  88 .SH RETURN VALUE
  89 The
  90 .BR getenv ()
  91 function returns a pointer to the value in the
  92 environment, or NULL if there is no match.
  93 .SH VERSIONS
  94 .BR secure_getenv ()
  95 first appeared in glibc 2.17.
  96 .SH CONFORMING TO
  97 .BR getenv ():
  98 SVr4, POSIX.1-2001, 4.3BSD, C89, C99.
  99
 100 .BR secure_getenv ()
 101 is a GNU extension.
 102 .SH NOTES
 103 The strings in the environment list are of the form \fIname=value\fP.
 104
 105 As typically implemented,
 106 .BR getenv ()
 107 returns a pointer to a string within the environment list.
 108 The caller must take care not to modify this string,
 109 since that would change the environment of the process.
 110
 111 The implementation of
 112 .BR getenv ()
 113 is not required to be reentrant.
 114 The string pointed to by the return value of
 115 .BR getenv ()
 116 may be statically allocated,
 117 and can be modified by a subsequent call to
 118 .BR getenv (),
 119 .BR putenv (3),
 120 .BR setenv (3),
 121 or
 122 .BR unsetenv (3).
 123
 124 The "secure execution" mode of
 125 .BR secure_getenv ()
 126 is controlled by the
 127 .B AT_SECURE
 128 flag contained in the auxiliary vector passed from the kernel to user space.
 129 .SH SEE ALSO
 130 .BR clearenv (3),
 131 .BR getauxval (3),
 132 .BR putenv (3),
 133 .BR setenv (3),
 134 .BR unsetenv (3),
 135 .BR capabilities (7),
 136 .BR environ (7)
 137 .SH COLOPHON
 138 This page is part of release 3.68 of the Linux
 139 .I man-pages
 140 project.
 141 A description of the project,
 142 information about reporting bugs,
 143 and the latest version of this page,
 144 can be found at
 145 \%http://www.kernel.org/doc/man\-pages/.