.\" Copyright (c) 1989, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)getlogin.2	8.1 (Berkeley) 6/9/93
.\" %FreeBSD: src/lib/libc/sys/getlogin.2,v 1.27 2004/07/02 23:52:13 ru Exp %
.\"
.\" $FreeBSD$
.Dd June 9, 1993
.Dt GETLOGIN 2
.Os
.Sh 名称
.Nm getlogin ,
.Nm getlogin_r ,
.Nm setlogin
.Nd ログイン名を取得 / 設定する
.Sh ライブラリ
.Lb libc
.Sh 書式
.In unistd.h
.Ft char *
.Fn getlogin void
.In sys/param.h
.Ft int
.Fn getlogin_r "char *name" "int len"
.Ft int
.Fn setlogin "const char *name"
.Sh 解説
.Fn getlogin
ルーチンは、
.Fn setlogin
で設定した現在のセッションに対応するユーザのログイン名を返します。
通常、名前はセッションが作成された時点でログインシェルに対応し、
ログインシェルから派生する全てのプロセスに継承されます
(これらのプロセスが別のユーザ ID を想定している場合、たとえば、
.Xr su 1
が使用されるときでも該当します)。
.Pp
.Fn getlogin_r
関数は
.Fn getlogin
と同様のサービスを提供しますが、呼び出し側は結果を保持するための長さ
.Fa len
バイトのバッファ
.Fa name
を用意しなければなりません。
バッファは少なくとも
.Dv MAXLOGNAME
バイトの長さがあるべきです。
.Pp
.Fn setlogin
システムコールは、現在のセッションに対応するユーザのログイン名を
.Fa name
に対応させます。
このシステムコールはスーパユーザに制限されており、
新しいセッションがユーザのために
作成されるときにだけ使用されるのが普通です
(たとえば、ログイン時、またはリモートシェルが起動されるときです)。
.Pp
.Em 注釈 :
セッションごとに 1 つのログイン名しかありません。
.Pp
プロセスが、確実に親のセッションから切り離されるような
適切なステップを取った後にのみ、
.Fn setlogin
が呼び出されるようにすることは
.Em 非常に
重要です。
.Fn setsid
システムコールを行うのがこれをする
.Em 唯一の
方法です。
.Xr daemon 3
関数は
.Fn setsid
を呼び出しますが、これは制御端末を切り離して
フォークでバックグラウンドに入る理想的な方法です。
.Pp
特に、
.Fn ioctl ttyfd TIOCNOTTY ...\&
または
.Fn setpgrp ...\&
では十分では
.Em ありません。
.Pp
親プロセスがいったん
.Fn setsid
システムコールを行えば、セッションリーダでないそのプロセスの子が
.Fn setlogin
を行うことも受け入れられますが、親を含めてセッション内のすべての
プロセスが同時にログイン名を変更されることに注意してください。
.Pp
これは特権を継承する従来の UNIX の動作と同じではありません。
.Pp
.Fn setlogin
システムコールはスーパユーザに制限されているので、セキュリティ侵犯を
防止するために (他の特権のあるすべてのプログラムと同じように)
プログラマが適切な注意を払うものだと仮定しています。
.Sh 戻り値
.Fn getlogin
の呼び出しが成功すると、静的バッファ内のヌル文字で終わる文字列への
ポインタが返されます。
名前が設定されていない場合は、
.Dv NULL
が返されます。
.Fn getlogin_r
関数の呼び出しが成功すると、0 が返されます。
失敗するとエラー番号が返されます。
.Pp
.Rv -std setlogin
.Sh エラー
これらの呼び出しによって以下のエラーが返される可能性があります:
.Bl -tag -width Er
.It Bq Er EFAULT
.Fa name
引数が無効なアドレスを与えました。
.It Bq Er EINVAL
.Fa name
引数が長すぎる文字列を指しています。
ログイン名は
.In ( sys/param.h
の)
.Dv MAXLOGNAME
文字までに制限されます。
現時点ではヌルを含めて 17 文字です。
.It Bq Er EPERM
ログイン名を設定しようとした呼び出し元が
スーパユーザではありませんでした。
.It Bq Er ERANGE
返される結果よりバッファのサイズが小さすぎます。
.El
.Sh 関連項目
.Xr setsid 2 ,
.Xr daemon 3
.Sh バグ
システムの以前のバージョンでは、
.Fn getlogin
はプロセスがログイン端末に対応していない限り処理に失敗しました。
現在では、
.Pf ( Fn setlogin
を使用して) プロセスに制御端末がないときでも getlogin は正常に完了します。
初期のバージョンでは、
.Fn getlogin
が返す値はユーザ ID をチェックせずには信頼することができませんでした。
移植性の高いプログラムはおそらくまだこのチェックを行っているはずです。
.Sh 歴史
.Fn getlogin
システムコールは
.Bx 4.4
ではじめて登場しました。
.Fn getlogin_r
の戻り値は
.St -p1003.1-96
に適合するために
.Fx
の初期のバージョンから変更されました。
.Sh 規格
.Fn getlogin
システムコールと
.Fn getlogin_r
関数は
.St -p1003.1-96
に適合しています。