draft/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 .\"*******************************************************************
  34 .\"
  35 .\" This file was generated with po4a. Translate the source file.
  36 .\"
  37 .\"*******************************************************************
  38 .TH GETENV 3 2012\-08\-14 GNU "Linux Programmer's Manual"
  39 .SH 名前
  40 getenv, secure_getenv \- 環境変数を得る
  41 .SH 書式
  42 .nf
  43 \fB#include <stdlib.h>\fP
  44 .sp
  45 \fBchar *getenv(const char *\fP\fIname\fP\fB);\fP
  46
  47 \fBchar *secure_getenv(const char *\fP\fIname\fP\fB);\fP
  48 .fi
  49 .sp
  50 .in -4n
  51 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  52 .in
  53 .sp
  54 \fBsecure_getenv\fP(): _GNU_SOURCE
  55 .SH 説明
  56 関数 \fBgetenv\fP()  は、環境リストから名前が \fIname\fP の環境変数を検索し、対応する \fIvalue\fP 文字列へのポインタを返す。
  57
  58 The GNU\-specific \fBsecure_getenv\fP()  function is just like \fBgetenv\fP()
  59 except that it returns NULL in cases where "secure execution" is required.
  60 Secure execution is required if one of the following conditions was true
  61 when the program run by the calling process was loaded:
  62 .IP * 3
  63 the process's effective user ID did not match its real user ID or the
  64 process's effective group ID did not match its real group ID (typically this
  65 is the result of executing a set\-user\-ID or set\-group\-ID program);
  66 .IP *
  67 the effective capability bit was set on the executable file; or
  68 .IP *
  69 the process has a nonempty permitted capability set.
  70 .PP
  71 Secure execution may also required if triggered by some Linux security
  72 modules.
  73
  74 The \fBsecure_getenv\fP()  function is intended for use in general\-purpose
  75 libraries to avoid vulnerabilities that could occur if set\-user\-ID or
  76 set\-group\-ID programs accidentally trusted the environment.
  77 .SH 返り値
  78 関数 \fBgetenv\fP()  は、環境における値 value へのポインタを返す。 \fIname\fP にマッチする環境変数が存在しないときには NULL
  79 を返す。
  80 .SH バージョン
  81 \fBsecure_getenv\fP() は glibc 2.17 で初めて登場した。
  82 .SH 準拠
  83 \fBgetenv\fP(): SVr4, POSIX.1\-2001, 4.3BSD, C89, C99.
  84
  85 \fBsecure_getenv\fP() は GNU による拡張である。
  86 .SH 注意
  87 環境リストの文字列は \fIname=value\fP という形式をしている。
  88
  89 通常の実装では、 \fBgetenv\fP()  は環境リスト内の文字列へのポインタを返す。 呼び出し元はこの文字列を変更しないように注意しなければならない。
  90 この文字列を変更すると、そのプロセスの環境を変化させることになるからである。
  91
  92 \fBgetenv\fP()  の実装はリエントラント (再入可能) であることを要求されていない。 \fBgetenv\fP()
  93 の返り値により参照される文字列は静的に割り当てられてもよく、 文字列の内容は後続の \fBgetenv\fP(), \fBputenv\fP(3),
  94 \fBsetenv\fP(3), \fBunsetenv\fP(3)  の呼び出しにより変更されることがある。
  95
  96 The "secure execution" mode of \fBsecure_getenv\fP()  is controlled by the
  97 \fBAT_SECURE\fP flag contained in the auxiliary vector passed from the kernel
  98 to user space.
  99 .SH 関連項目
 100 \fBclearenv\fP(3), \fBgetauxval\fP(3), \fBputenv\fP(3), \fBsetenv\fP(3), \fBunsetenv\fP(3),
 101 \fBcapabilities\fP(7), \fBenviron\fP(7)
 102 .SH この文書について
 103 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.51 の一部
 104 である。プロジェクトの説明とバグ報告に関する情報は
 105 http://www.kernel.org/doc/man\-pages/ に書かれている。