release/man3/getlogin.3

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright 1995  James R. Van Zandt <jrv@vanzandt.mv.com>
   4 .\"
   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 .\"
  25 .\" Changed Tue Sep 19 01:49:29 1995, aeb: moved from man2 to man3
  26 .\"  added ref to /etc/utmp, added BUGS section, etc.
  27 .\" modified 2003 Walter Harms, aeb - added getlogin_r, note on stdin use
  28 .\"
  29 .\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
  30 .\" Translated 1998-03-01, NAKANO Takeo <nakano@apm.seikei.ac.jp>
  31 .\" Updated & Modified 1999-08-21, NAKANO Takeo <nakano@apm.seikei.ac.jp>
  32 .\" Updated & Modified 2005-03-18, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
  33 .\"
  34 .TH GETLOGIN 3 2008-06-29 "GNU" "Linux Programmer's Manual"
  35 .SH 名前
  36 getlogin, getlogin_r, cuserid \- ユーザー名を取得する
  37 .SH 書式
  38 .B #include <unistd.h>
  39 .sp
  40 .B "char *getlogin(void);"
  41 .br
  42 .BI "int getlogin_r(char *" buf ", size_t " bufsize );
  43 .sp
  44 .B #include <stdio.h>
  45 .sp
  46 .BI "char *cuserid(char *" string );
  47 .sp
  48 .in -4n
  49 glibc 向けの機能検査マクロの要件
  50 .RB ( feature_test_macros (7)
  51 参照):
  52 .in
  53 .sp
  54 .BR getlogin_r ():
  55 _REENTRANT || _POSIX_C_SOURCE\ >=\ 199506L
  56 .br
  57 .BR cuserid ():
  58 _XOPEN_SOURCE
  59 .SH 説明
  60 .BR getlogin ()
  61 は、現在のプロセスの制御端末にログインしているユーザー名の文字列への
  62 ポインタを返す。ユーザー名が決定できない場合は NULL ポインタを返す。
  63 文字列は静的領域に割り当てられており、この後でこの関数や
  64 .BR cuserid ()
  65 が呼び出された際に上書きされることがある。
  66 .PP
  67 .BR getlogin_r ()
  68 は、上記の同じユーザ名を、大きさ
  69 .I bufsize
  70 の配列
  71 .I buf
  72 に入れて返す。
  73 .PP
  74 .BR cuserid ()
  75 は、現在のプロセスの実効ユーザーID に対応するユーザー名の
  76 文字列へのポインタを返す。
  77 \fIstring\fP が NULL ポインタ以外の場合、\fIstring\fP は少なくとも
  78 \fBL_cuserid\fP 文字を保持できる配列でなければならない。
  79 \fIstring\fP が NULL ポインタの場合には、静的領域に置かれた文字列への
  80 ポインタが返される。この文字列は静的領域に割り当てられており、後で
  81 この関数や
  82 .BR getlogin ()
  83 が呼び出された際に上書きされることがある。
  84 .PP
  85 マクロ \fBL_cuserid\fP は integer の定数で、ユーザー名を保持するために
  86 必要な配列の長さを示す。 \fBL_cuserid\fP は \fBstdio.h\fP で宣言されて
  87 いる。
  88 .PP
  89 これらの関数を使うと、プログラムを実行しているユーザー
  90 .RB ( cuserid ())
  91 や
  92 このセッションにログインしているユーザー
  93 .RB ( getlogin ())
  94 を明確に特定することができる
  95 (ただし set-user-ID プログラムでは、状況が違うこともある)。
  96 .PP
  97 たいていの目的では、ユーザーの特定には環境変数 \fBLOGNAME\fP を調べ
  98 るほうが便利である。LOGNAME 変数はユーザーが自由に設定できるので
  99 より柔軟な対応が可能になる。
 100 .SH 返り値
 101 .BR getlogin ()
 102 は成功した場合はユーザ名へのポインタを返し、失敗した場合は NULL を返す。
 103 .BR getlogin_r ()
 104 は成功すると 0 を返し、失敗すると 0 以外を返す。
 105 .SH エラー
 106 POSIX では以下のエラーが規定されている:
 107 .TP
 108 .B EMFILE
 109 呼び出し元プロセスがオープンしているファイル数がすでにプロセスあたりの
 110 上限に達している。
 111 .TP
 112 .B ENFILE
 113 システム全体でオープンしているファイル数がすでに上限に達している。
 114 .TP
 115 .B ENXIO
 116 呼び出し元プロセスには制御端末がない。
 117 .TP
 118 .B ERANGE
 119 (getlogin_r)
 120 (終端の NULL バイトも含めた) ユーザ名の長さが
 121 .I bufsize
 122 よりも長い。
 123 .LP
 124 Linux/glibc には以下のエラーもある。
 125 .TP
 126 .B ENOENT
 127 utmp ファイルに対応するエントリがなかった。
 128 .TP
 129 .B ENOMEM
 130 passwd 構造体を割り当てるのに十分なメモリがない。
 131 .TP
 132 .B ENOTTY
 133 標準入力が端末を参照していない (「バグ」の節を参照)。
 134 .SH ファイル
 135 .TP
 136 \fI/etc/passwd\fP
 137 パスワードデータベースのファイル
 138 .TP
 139 \fI/var/run/utmp\fP
 140 (伝統的には \fI/etc/utmp\fP が使われている;
 141 libc の中には \fI/var/adm/utmp\fP を使うものもある)
 142 .SH 準拠
 143 .BR getlogin ()
 144 と
 145 .BR getlogin_r ()
 146 は POSIX.1-2001 で規定されている。
 147
 148 System V にも
 149 .BR cuserid ()
 150 があるが、
 151 これは実効ユーザー ID ではなく、実ユーザー ID を使用する。
 152 .BR cuserid ()
 153 関数は 1988 年版の POSIX には含まれていたが、
 154 1990 年版では削除された。
 155 SUSv2 に存在したが、POSIX.1-2001 で削除された。
 156 .LP
 157 OpenBSD には
 158 .BR getlogin ()
 159 と
 160 .BR setlogin ()
 161 があり、
 162 セッションに対応したユーザ名がある。制御端末がない
 163 セッションの場合であっても、対応するユーザ名がある。
 164 .SH バグ
 165 残念ながら、
 166 .BR getlogin ()
 167 をだますのはそれほど難しいことではない。別のプログラムが utmp ファイルを
 168 壊してしまうと、全く動作しないこともある。またログイン名の最初の 8 文字
 169 しか返さないことも多い。またプログラムを制御している tty に
 170 現在ログインしているユーザーは、プログラムを実行した
 171 ユーザーでない場合もある。
 172 セキュリティの絡む用途には
 173 .BR getlogin ()
 174 を用いるべきではない。
 175 .LP
 176 glibc は POSIX 仕様には従っておらず、
 177 .I /dev/tty
 178 ではなく
 179 .I "標準入力 (stdin)"
 180 を使う。これはバグである。
 181 (SunOS 5.8 や HP-UX 11.11 や FreeBSD 4.8 といった他の最近のシステムはいずれも、
 182 .I 標準入力
 183 がリダイレクトされた場合でもログイン名を返す。)
 184 .LP
 185 .BR cuserid ()
 186 が何を行っているのか、実際のところを知っている者は誰もいない;
 187 移植性が求められるプログラムでは
 188 .BR cuserid ()
 189 は使うべきではない。
 190 というかどんなプログラムでも使うべきではない:
 191 代わりに
 192 .I getpwuid(geteuid())
 193 を用いるべきである
 194 (これが意図していることならば、だが)。
 195 .BR cuserid ()
 196 は「使わない」こと。
 197 .SH 関連項目
 198 .BR geteuid (2),
 199 .BR getuid (2),
 200 .BR utmp (5)