utmpのヘルプ・マニュアル
日本語 英語
utmp --help
man utmp
UTMP(5) Linux Programmer’s Manual UTMP(5)
名前
utmp, wtmp - ログイン記録
書式
#include
説明
utmp ファイルを見ることで、現在誰がシステムを使っているかという情報が得
られる。ただすべてのプログラムが utmp ファイルを更新しているわけでは な
いので、実際にはそれ以上のユーザーがシステムを使っている可能性がある。
警告: (愚かにも) 多くのシステムプログラムがその整合性に依存しているので
、 utmp ファイルは "other" に分類されるユーザに対して書き込み可能にして
はならない。ファイルの所有者とグループオーナー以外のユーザに対して utmp
ファイルを書き込み可能な状態にしておくと、システムのログファイルを偽 造
さ れたり、システムファイルの改ざんを受けるといったリスクを犯すことにな
る。
このファイルは utmp 構造体の繰り返しで構成される。この構造体は
で 以下のように定義されている (ここに記述してあるのは幾つかの大まかな定
義のみで、詳細は libc のバージョンにより変わることに注意が必要である)。
/* Values for ut_type field, below */
#define EMPTY 0 /* Record does not contain valid info
(formerly known as UT_UNKNOWN on Linux) */
#define RUN_LVL 1 /* Change in system run-level (see
init(8)) */
#define BOOT_TIME 2 /* Time of system boot (in ut_tv) */
#define NEW_TIME 3 /* Time after system clock change
(in ut_tv) */
#define OLD_TIME 4 /* Time before system clock change
(in ut_tv) */
#define INIT_PROCESS 5 /* Process spawned by init(8) */
#define LOGIN_PROCESS 6 /* Session leader process for user login */
#define USER_PROCESS 7 /* Normal process */
#define DEAD_PROCESS 8 /* Terminated process */
#define ACCOUNTING 9 /* Not implemented */
#define UT_LINESIZE 32
#define UT_NAMESIZE 32
#define UT_HOSTSIZE 256
struct exit_status { /* Type for ut_exit, below */
short int e_termination; /* Process termination status */
short int e_exit; /* Process exit status */
};
struct utmp {
short ut_type; /* Type of record */
pid_t ut_pid; /* PID of login process */
char ut_line[UT_LINESIZE]; /* Device name of tty - "/dev/" */
char ut_id[4]; /* Terminal name suffix,
or inittab(5) ID */
char ut_user[UT_NAMESIZE]; /* Username */
char ut_host[UT_HOSTSIZE]; /* Hostname for remote login, or
kernel version for run-level
messages */
struct exit_status ut_exit; /* Exit status of a process
marked as DEAD_PROCESS; not
used by Linux init(8) */
/* ut_session と ut_tv フィールドは、32ビットでコンパイルされた場合と
64ビットでコンパイルされた場合で同じサイズでなければならない。
こうすることで、32ビットと64ビットのアプリケーションで、
データファイルと共有メモリを共有することができるようになる。 */
#if __WORDSIZE == 64 && defined __WORDSIZE_COMPAT32
int32_t ut_session; /* Session ID (getsid(2)),
used for windowing */
struct {
int32_t tv_sec; /* Seconds */
int32_t tv_usec; /* Microseconds */
} ut_tv; /* Time entry was made */
#else
long ut_session; /* Session ID */
struct timeval ut_tv; /* Time entry was made */
#endif
int32_t ut_addr_v6[4]; /* Internet address of remote
host; IPv4 address uses
just ut_addr_v6[0] */
char __unused[20]; /* Reserved for future use */
};
/* Backwards compatibility hacks */
#define ut_name ut_user
#ifndef _NO_UT_TIME
#define ut_time ut_tv.tv_sec
#endif
#define ut_xtime ut_tv.tv_sec
#define ut_addr ut_addr_v6[0]
こ の構造体からユーザーの使っている端末のスペシャルファイル名、ユーザー
のログイン名、 (time(2) 形式での)ログイン時刻がわかる。文字列フィールド
は、フィールドの長さより文字列が短い場合には、'\0' によって終端される。
最初のエントリは init(8) コマンドが inittab(5) を処理することで作られる
。 あるエントリを処理する前に、 init(8) は ut_type を DEAD_PROCESS に初
期化する。レコードの ut_type が DEAD_PROCESS と RUN_LVL のいずれでも な
く 、かつ PID が ut_pid であるプロセスがいない場合は、ut_user, ut_host,
ut_time をヌルバイトでクリアして初期化を行う。必要な ut_id を持つ空のレ
コ ードを見つけられなかった場合、 init(8) は新しいレコードを作る。init-
tab から ut_id を設定し、 ut_pid および ut_time を現在値に、 ut_type を
INIT_PROCESS に設定する。
mingetty(8) ( または agetty(8)) は pid でエントリを特定し、 ut_type を
LOGIN_PROCESS に変更し、 ut_time を更新し、ut_lineを設定した後、接続 が
確 立 されるのを待つ。 login(1) はユーザー認証が終了すると、 ut_type を
USER_PROCESS に変更し、 ut_time を更新し、ut_host と ut_addrを設定す る
。 mingetty(8) (または agetty(8)) と login(1) により異なるが、 ut_pid
の代わりに ut_line を使ってレコードの特定が行われることもあ る (ut_pid
を使う方が望ましい) 。
init(8) はプロセスの終了を検出した場合、 ut_pid をキーとして utmp のエ
ントリを特定し、 ut_type を DEAD_PROCESS に設定し、 ut_user, ut_host,
ut_time をヌルバイトでクリアする。
xterm(1) コマンドや他の端末エミュレータは直接 USER_PROCESS のレコードを
作り、端末名のサフィックス文字列 (/dev/[pt]ty に続く文字列) を 使 っ て
ut_id の値を生成する。この id を持つエントリが DEAD_PROCESS であった場
合には再利用し、それ以外の場合には新しいエントリが作られる。可能な場 合
に は プ ロセス終了時に DEAD_PROCESS と設定し、さらに ut_line, ut_time,
ut_user, ut_host をヌルバイトでクリアすることが奨励されている。
telnetd(8) は LOGIN_PROCESS を設定するだけでよく、残りの処理は通常通 り
login(1) に任せればよい。 telnet のセッションが終了した後、前述のように
telnetd(8) が utmp のエントリを初期化する。
wtmp ファイルには、すべてのログインとログアウトが記録される。そのフォー
マ ットは、ログアウト済の端末でユーザー名がヌルとなること以外は utmp と
まったく同じである。ユーザー名が shutdown もしくは reboot である端末 名
~ はシステムの停止 (shutdown) または再起動 (reboot) を意味する。またそ
の端末名が | と } の対は date(1) コマンドで変更した新／旧のシステム時刻
を記録している。 wtmp ファイルは login(1), init(8) やいくつかのバージョ
ンの getty(8) (mingetty(8) または agetty(8)) により管理されている。これ
ら のプログラムはどれもファイルを新たに作成しないので、ファイルを削除す
ることで情報の記録 (record-keeping) を止めることができる。
ファイル
/var/run/utmp
/var/log/wtmp
準拠
POSIX.1 では、 utmp 構造体ではなく、 utmpx 構造体を規定している。 utmpx
構造体で規定されているのは、フィールド ut_type, ut_pid, ut_line, ut_id,
ut_user, ut_tv である。 POSIX.1 では、フィールド ut_line と ut_user の
長さは規定されていない。
Linux では、 utmpx 構造体の定義は utmp 構造体と同じである。
過去のシステムとの比較
Linux での utmp のエントリは v7/BSD や System V のいずれにも準拠してお
らず、その両方が混在したものである。
v7/BSD ではより少しの項目しかない; もっとも重要なことは、ut_type が無い
こ とである。そのため v7/BSD 系のプログラムでは (たとえば) 死んだ状態の
エントリやログイン状態のエントリまで表示されてしまうことになった。さ ら
にセッション用のスロットを割り当てるための設定ファイルがない。 BSD に設
定ファイルがあるのは ut_id がないからである。
Linux (System V 系)では、設定ファイルを必要とせずセッション用のスロット
を割り当てるので、一旦設定されてしまうとレコードの ut_id は決して変更さ
れない。 ut_id をクリアすると競合状態におちいり、 utmp のエントリを壊し
た り、潜在的なセキュリティホールになる可能性がある。上述のフィールドを
NULL バイトで埋めてクリアしておくのは、 System V での取り決めでは必要と
はされていないが、 BSD での取り決めを前提としていて、かつ utmp を更新し
ない多くのプログラムが動作するようにするためである。 Linux ではここまで
記述してきたように、行内容の表示は BSD の慣例に従っている。
UT_UNKNOWN は Linux で作られたもののようである。 System V には ut_host
も ut_addr_v6 も存在しない。
注意
ファイルを削除することで utmp への記録を止められる他の様々なシステム と
は 違い、Linux では utmp ファイルを必ずおいておく必要がある。 who(1) コ
マンドが機能しないようにしたい場合には、 utmp ファイルの全ユーザーに 対
する読み取り許可を設定しないようにする。
フ ァイルのフォーマットはマシンに依存するので、ファイルが作られたマシン
もしくは同一アーキテクチャのマシン上でのみ処理することを推奨する。
注意すべき点としては、 biarch なプラットフォーム、つまり 32ビットと 64
ビ ッ ト の 両 方のアプリケーションを実行できるシステム (x86-64, ppc64,
s390x など) では、 ut_tv のサイズは 32ビットモードと 64ビットモードで同
じである。 ut_session と ut_time も、存在する場合には同様に同じサイズで
ある。これにより、32ビットアプリケーションと 64ビットアプリケーションの
間 でデータファイルと共有メモリを共有することが可能になる。そのためには
、 ut_session を int32_t 型に、 ut_tv を 2つの int32_t 型のフィー ル ド
tv_sec, tv_usec を持つ構造体に変更すればよい ut_tv は struct timeval と
同じサイズとは限らないので、
gettimeofday((struct timeval *) &ut.ut_tv, NULL);
のような呼び出しをするのではなく、以下のように各フィールドを設定する 方
法が推奨される:
struct utmp ut;
struct timeval tv;
gettimeofday(&tv, NULL);
ut.ut_tv.tv_sec = tv.tv_sec;
ut.ut_tv.tv_usec = tv.tv_usec;
utmp 構造体は libc5 から libc6 で変更された。そのため昔の libc5 の構造
体を使ったプログラムは /var/run/utmp や /var/log/wtmp ファイルを壊し て
しまう。
バグ
こ の man ページは libc5 に基づいて作られていて、最新のものでは違ってい
るかもしれない。
関連項目
ac(1), date(1), last(1), login(1), who(1), getutent(3), getutmp(3),
login(3), logout(3), logwtmp(3), updwtmp(3), init(8)
Linux 2008-10-10 UTMP(5)
UTMP(5) Linux Programmer’s Manual UTMP(5)
NAME
utmp, wtmp - login records
SYNOPSIS
#include
DESCRIPTION
The utmp file allows one to discover information about who is currently
using the system. There may be more users currently using the system,
because not all programs use utmp logging.
Warning: utmp must not be writable by the user class "other", because
many system programs (foolishly) depend on its integrity. You risk
faked system logfiles and modifications of system files if you leave
utmp writable to any user other than the owner and group owner of the
file.
The file is a sequence of utmp structures, declared as follows in
(note that this is only one of several definitions around;
details depend on the version of libc):
/* Values for ut_type field, below */
#define EMPTY 0 /* Record does not contain valid info
(formerly known as UT_UNKNOWN on Linux) */
#define RUN_LVL 1 /* Change in system run-level (see
init(8)) */
#define BOOT_TIME 2 /* Time of system boot (in ut_tv) */
#define NEW_TIME 3 /* Time after system clock change
(in ut_tv) */
#define OLD_TIME 4 /* Time before system clock change
(in ut_tv) */
#define INIT_PROCESS 5 /* Process spawned by init(8) */
#define LOGIN_PROCESS 6 /* Session leader process for user login */
#define USER_PROCESS 7 /* Normal process */
#define DEAD_PROCESS 8 /* Terminated process */
#define ACCOUNTING 9 /* Not implemented */
#define UT_LINESIZE 32
#define UT_NAMESIZE 32
#define UT_HOSTSIZE 256
struct exit_status { /* Type for ut_exit, below */
short int e_termination; /* Process termination status */
short int e_exit; /* Process exit status */
};
struct utmp {
short ut_type; /* Type of record */
pid_t ut_pid; /* PID of login process */
char ut_line[UT_LINESIZE]; /* Device name of tty - "/dev/" */
char ut_id[4]; /* Terminal name suffix,
or inittab(5) ID */
char ut_user[UT_NAMESIZE]; /* Username */
char ut_host[UT_HOSTSIZE]; /* Hostname for remote login, or
kernel version for run-level
messages */
struct exit_status ut_exit; /* Exit status of a process
marked as DEAD_PROCESS; not
used by Linux init(8) */
/* The ut_session and ut_tv fields must be the same size when
compiled 32- and 64-bit. This allows data files and shared
memory to be shared between 32- and 64-bit applications. */
#if __WORDSIZE == 64 && defined __WORDSIZE_COMPAT32
int32_t ut_session; /* Session ID (getsid(2)),
used for windowing */
struct {
int32_t tv_sec; /* Seconds */
int32_t tv_usec; /* Microseconds */
} ut_tv; /* Time entry was made */
#else
long ut_session; /* Session ID */
struct timeval ut_tv; /* Time entry was made */
#endif
int32_t ut_addr_v6[4]; /* Internet address of remote
host; IPv4 address uses
just ut_addr_v6[0] */
char __unused[20]; /* Reserved for future use */
};
/* Backwards compatibility hacks */
#define ut_name ut_user
#ifndef _NO_UT_TIME
#define ut_time ut_tv.tv_sec
#endif
#define ut_xtime ut_tv.tv_sec
#define ut_addr ut_addr_v6[0]
This structure gives the name of the special file associated with the
user’s terminal, the user’s login name, and the time of login in the
form of time(2). String fields are terminated by '\0' if they are
shorter than the size of the field.
The first entries ever created result from init(8) processing init-
tab(5). Before an entry is processed, though, init(8) cleans up utmp
by setting ut_type to DEAD_PROCESS, clearing ut_user, ut_host, and
ut_time with null bytes for each record which ut_type is not DEAD_PRO-
CESS or RUN_LVL and where no process with PID ut_pid exists. If no
empty record with the needed ut_id can be found, init(8) creates a new
one. It sets ut_id from the inittab, ut_pid and ut_time to the current
values, and ut_type to INIT_PROCESS.
mingetty(8) (or agetty(8)) locates the entry by the PID, changes
ut_type to LOGIN_PROCESS, changes ut_time, sets ut_line, and waits for
connection to be established. login(1), after a user has been authen-
ticated, changes ut_type to USER_PROCESS, changes ut_time, and sets
ut_host and ut_addr. Depending on mingetty(8) (or agetty(8)) and
login(1), records may be located by ut_line instead of the preferable
ut_pid.
When init(8) finds that a process has exited, it locates its utmp entry
by ut_pid, sets ut_type to DEAD_PROCESS, and clears ut_user, ut_host
and ut_time with null bytes.
xterm(1) and other terminal emulators directly create a USER_PROCESS
record and generate the ut_id by using the string that suffix part of
the terminal name (the characters following /dev/[pt]ty). If they find
a DEAD_PROCESS for this ID, they recycle it, otherwise they create a
new entry. If they can, they will mark it as DEAD_PROCESS on exiting
and it is advised that they null ut_line, ut_time, ut_user, and ut_host
as well.
telnetd(8) sets up a LOGIN_PROCESS entry and leaves the rest to
login(1) as usual. After the telnet session ends, telnetd(8) cleans up
utmp in the described way.
The wtmp file records all logins and logouts. Its format is exactly
like utmp except that a null username indicates a logout on the associ-
ated terminal. Furthermore, the terminal name ~ with username shutdown
or reboot indicates a system shutdown or reboot and the pair of termi-
nal names |/} logs the old/new system time when date(1) changes it.
wtmp is maintained by login(1), init(8), and some versions of getty(8)
(e.g., mingetty(8) or agetty(8)). None of these programs creates the
file, so if it is removed, record-keeping is turned off.
FILES
/var/run/utmp
/var/log/wtmp
CONFORMING TO
POSIX.1 does not specify a utmp structure, but rather one named utmpx,
with specifications for the fields ut_type, ut_pid, ut_line, ut_id,
ut_user, and ut_tv. POSIX.1 does not specify the lengths of the
ut_line and ut_user fields.
Linux defines the utmpx structure to be the same as the utmp structure.
Comparison with Historical Systems
Linux utmp entries conform neither to v7/BSD nor to System V; they are
a mix of the two.
v7/BSD has fewer fields; most importantly it lacks ut_type, which
causes native v7/BSD-like programs to display (for example) dead or
login entries. Further, there is no configuration file which allocates
slots to sessions. BSD does so because it lacks ut_id fields.
In Linux (as in System V), the ut_id field of a record will never
change once it has been set, which reserves that slot without needing a
configuration file. Clearing ut_id may result in race conditions lead-
ing to corrupted utmp entries and potential security holes. Clearing
the abovementioned fields by filling them with null bytes is not
required by System V semantics, but makes it possible to run many pro-
grams which assume BSD semantics and which do not modify utmp. Linux
uses the BSD conventions for line contents, as documented above.
System V has no ut_host or ut_addr_v6 fields.
NOTES
Unlike various other systems, where utmp logging can be disabled by
removing the file, utmp must always exist on Linux. If you want to
disable who(1) then do not make utmp world readable.
The file format is machine-dependent, so it is recommended that it be
processed only on the machine architecture where it was created.
Note that on biarch platforms, that is, systems which can run both
32-bit and 64-bit applications (x86-64, ppc64, s390x, etc.), ut_tv is
the same size in 32-bit mode as in 64-bit mode. The same goes for
ut_session and ut_time if they are present. This allows data files and
shared memory to be shared between 32-bit and 64-bit applications.
This is achieved by changing the type of ut_session to int32_t, and
that of ut_tv to a struct with two int32_t fields tv_sec and tv_usec.
Since ut_tv may not be the same as struct timeval, then instead of the
call:
gettimeofday((struct timeval *) &ut.ut_tv, NULL);
the following method of setting this field is recommended:
struct utmp ut;
struct timeval tv;
gettimeofday(&tv, NULL);
ut.ut_tv.tv_sec = tv.tv_sec;
ut.ut_tv.tv_usec = tv.tv_usec;
Note that the utmp struct from libc5 has changed in libc6. Because of
this, binaries using the old libc5 struct will corrupt /var/run/utmp
and/or /var/log/wtmp.
BUGS
This man page is based on the libc5 one, things may work differently
now.
SEE ALSO
ac(1), date(1), last(1), login(1), who(1), getutent(3), getutmp(3),
login(3), logout(3), logwtmp(3), updwtmp(3), init(8)
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/.
Linux 2008-10-10 UTMP(5)