リナックスコマンド

getloginのヘルプ・マニュアル

日本語 英語

• help
• man

getlogin --help

man getlogin

GETLOGIN(3) Linux Programmer’s Manual GETLOGIN(3) 名前 getlogin, getlogin_r, cuserid - ユーザー名を取得する 書式 #include char *getlogin(void); int getlogin_r(char *buf, size_t bufsize); #include char *cuserid(char *string); glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照): getlogin_r(): _REENTRANT || _POSIX_C_SOURCE >= 199506L cuserid(): _XOPEN_SOURCE 説明 getlogin() は、現在のプロセスの制御端末にログインしているユーザー名の文 字列へのポインタを返す。ユーザー名が決定できない場合は null ポインタ を 返 す 。 文 字 列 は 静 的 領域に割り当てられており、この後でこの関数や cuserid() が呼び出された際に上書きされることがある。 getlogin_r() は、上記の同じユーザ名を、大きさ bufsize の配列 buf に入れ て返す。 cuserid() は、現在のプロセスの実効ユーザーID に対応するユーザー名の文字 列へのポインタを返す。 string が null ポインタ以外の場合、string は少な く と も L_cuserid 文字を保持できる配列でなければならない。 string が null ポインタの場合には、静的領域に置かれた文字列へのポインタが返される 。 こ の文字列は静的領域に割り当てられており、後でこの関数や getlogin() が呼び出された際に上書きされることがある。 マクロ L_cuserid は integer の定数で、ユーザー名を保持するために必要 な 配列の長さを示す。 L_cuserid は stdio.h で宣言されている。 これらの関数を使うと、プログラムを実行しているユーザー (cuserid()) やこ のセッションにログインしているユーザー (getlogin()) を明確に特定する こ とができる (ただし set-user-ID プログラムでは、状況が違うこともある)。 たいていの目的では、ユーザーの特定には環境変数 LOGNAME を調べるほうが便 利である。LOGNAME 変数はユーザーが自由に設定できるのでより柔軟な対応 が 可能になる。 返り値 getlogin() は成功した場合はユーザ名へのポインタを返し、失敗した場合は NULL を返す。 getlogin_r() は成功すると 0 を返し、失敗すると 0 以外を返 す。 エラー POSIX では以下のエラーが規定されている: EMFILE 呼び出し元プロセスがオープンしているファイル数がすでにプロセスあ たりの上限に達している。 ENFILE システム全体でオープンしているファイル数がすでに上限に達している 。 ENXIO 呼び出し元プロセスには制御端末がない。 ERANGE (getlogin_r) (終端の NULL バイトも含めた) ユーザ名の長さが buf- size よりも長い。 Linux/glibc には以下のエラーもある。 ENOENT utmp ファイルに対応するエントリがなかった。 ENOMEM passwd 構造体を割り当てるのに十分なメモリがない。 ENOTTY 標準入力が端末を参照していない (「バグ」の節を参照)。 ファイル /etc/passwd パスワードデータベースのファイル /var/run/utmp (伝統的には /etc/utmp が 使 わ れ て い る; libc の 中 に は /var/adm/utmp を使うものもある) 準拠 getlogin() と getlogin_r() は POSIX.1-2001 で規定されている。 System V にも cuserid() があるが、これは実効ユーザー ID ではなく、実ユ ーザー ID を使用する。 cuserid() 関数は 1988 年版の POSIX には含まれ て い たが、 1990 年版では削除された。 SUSv2 に存在したが、POSIX.1-2001 で 削除された。 OpenBSD には getlogin() と setlogin() があり、セッションに対応したユ ー ザ 名がある。制御端末がないセッションの場合であっても、対応するユーザ名 がある。 バグ 残念ながら、 getlogin() をだますのはそれほど難しいことではない。別の プ ロ グラムが utmp ファイルを壊してしまうと、全く動作しないこともある。ま たログイン名の最初の 8 文字しか返さないことも多い。またプログラムを制御 している tty に現在ログインしているユーザーは、プログラムを実行したユー ザーでない場合もある。セキュリティの絡む用途には getlogin() を用いる べ きではない。 glibc は POSIX 仕 様 には従っておらず、 /dev/tty ではなく 標準入力 (stdin) を使う。これはバグである。 (SunOS 5.8 や HP-UX 11.11 や FreeBSD 4.8 といった他の最近のシステムはいずれも、 標準入力がリダイレクトされた 場合でもログイン名を返す。) cuserid() が何を行っているのか、実際のところを知っている者は誰もいない; 移植性が求められるプログラムでは cuserid() は使うべきではない。というか どんなプログラムでも使うべきではない: 代わりに getpwuid(geteuid()) を用 い るべきである (これが意図していることならば、だが)。 cuserid() は「使 わない」こと。 関連項目 geteuid(2), getuid(2), utmp(5) GNU 2008-06-29 GETLOGIN(3)

GETLOGIN(3) Linux Programmer’s Manual GETLOGIN(3) NAME getlogin, getlogin_r, cuserid - get username SYNOPSIS #include char *getlogin(void); int getlogin_r(char *buf, size_t bufsize); #include char *cuserid(char *string); Feature Test Macro Requirements for glibc (see feature_test_macros(7)): getlogin_r(): _REENTRANT || _POSIX_C_SOURCE >= 199506L cuserid(): _XOPEN_SOURCE DESCRIPTION getlogin() returns a pointer to a string containing the name of the user logged in on the controlling terminal of the process, or a null pointer if this information cannot be determined. The string is stati- cally allocated and might be overwritten on subsequent calls to this function or to cuserid(). getlogin_r() returns this same username in the array buf of size buf- size. cuserid() returns a pointer to a string containing a username associ- ated with the effective user ID of the process. If string is not a null pointer, it should be an array that can hold at least L_cuserid characters; the string is returned in this array. Otherwise, a pointer to a string in a static area is returned. This string is statically allocated and might be overwritten on subsequent calls to this function or to getlogin(). The macro L_cuserid is an integer constant that indicates how long an array you might need to store a username. L_cuserid is declared in . These functions let your program identify positively the user who is running (cuserid()) or the user who logged in this session (getlo- gin()). (These can differ when set-user-ID programs are involved.) For most purposes, it is more useful to use the environment variable LOGNAME to find out who the user is. This is more flexible precisely because the user can set LOGNAME arbitrarily. RETURN VALUE getlogin() returns a pointer to the username when successful, and NULL on failure. getlogin_r() returns 0 when successful, and non-zero on failure. ERRORS POSIX specifies EMFILE The calling process already has the maximum allowed number of open files. ENFILE The system already has the maximum allowed number of open files. ENXIO The calling process has no controlling tty. ERANGE (getlogin_r) The length of the username, including the terminat- ing null byte, is larger than bufsize. Linux/glibc also has ENOENT There was no corresponding entry in the utmp-file. ENOMEM Insufficient memory to allocate passwd structure. ENOTTY Standard input didn’t refer to a terminal. (See BUGS.) FILES /etc/passwd password database file /var/run/utmp (traditionally /etc/utmp; some libc versions used /var/adm/utmp) CONFORMING TO getlogin() and getlogin_r() specified in POSIX.1-2001. System V has a cuserid() function which uses the real user ID rather than the effective user ID. The cuserid() function was included in the 1988 version of POSIX, but removed from the 1990 version. It was present in SUSv2, but removed in POSIX.1-2001. OpenBSD has getlogin() and setlogin(), and a username associated with a session, even if it has no controlling tty. BUGS Unfortunately, it is often rather easy to fool getlogin(). Sometimes it does not work at all, because some program messed up the utmp file. Often, it gives only the first 8 characters of the login name. The user currently logged in on the controlling tty of our program need not be the user who started it. Avoid getlogin() for security-related pur- poses. Note that glibc does not follow the POSIX specification and uses stdin instead of /dev/tty. A bug. (Other recent systems, like SunOS 5.8 and HP-UX 11.11 and FreeBSD 4.8 all return the login name also when stdin is redirected.) Nobody knows precisely what cuserid() does; avoid it in portable pro- grams. Or avoid it altogether: use getpwuid(geteuid()) instead, if that is what you meant. Do not use cuserid(). SEE ALSO geteuid(2), getuid(2), utmp(5) COLOPHON This page is part of release 3.22 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. GNU 2008-06-29 GETLOGIN(3)