.\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl) and
.\" Walter Harms (walter.harms@informatik.uni-oldenburg.de)
.\"
.\" Distributed under GPL
.\"
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.TH GETSPNAM 3 2010\-02\-25 GNU "Linux Programmer's Manual"
.SH 名前
getspnam, getspnam_r, getspent, getspent_r, setspent, endspent,fgetspent,
fgetspent_r, sgetspent, sgetspent_r, putspent, lckpwdf, ulckpwdf \- shadow
パスワードファイルのエントリを取得する
.SH 書式
.nf
/* 一般的な shadow パスワードファイル API */
.br
\fB#include <shadow.h>\fP
.sp
\fBstruct spwd *getspnam(const char *\fP\fIname\fP\fB);\fP
.sp
\fBstruct spwd *getspent(void);\fP
.sp
\fBvoid setspent(void);\fP
.sp
\fBvoid endspent(void);\fP
.sp
\fBstruct spwd *fgetspent(FILE *\fP\fIfp\fP\fB);\fP
.sp
\fBstruct spwd *sgetspent(const char *\fP\fIs\fP\fB);\fP
.sp
\fBint putspent(struct spwd *\fP\fIp\fP\fB, FILE *\fP\fIfp\fP\fB);\fP
.sp
\fBint lckpwdf(void);\fP
.sp
\fBint ulckpwdf(void);\fP
.sp
/* GNU 版における拡張 */
.br
\fB#include <shadow.h>\fP
.sp
\fBint getspent_r(struct spwd *\fP\fIspbuf\fP\fB,\fP
.br
\fB        char *\fP\fIbuf\fP\fB, size_t \fP\fIbuflen\fP\fB, struct spwd **\fP\fIspbufp\fP\fB);\fP
.sp
\fBint getspnam_r(const char *\fP\fIname\fP\fB, struct spwd *\fP\fIspbuf\fP\fB,\fP
.br
\fB        char *\fP\fIbuf\fP\fB, size_t \fP\fIbuflen\fP\fB, struct spwd **\fP\fIspbufp\fP\fB);\fP
.sp
\fBint fgetspent_r(FILE *\fP\fIfp\fP\fB, struct spwd *\fP\fIspbuf\fP\fB,\fP
.br
\fB        char *\fP\fIbuf\fP\fB, size_t \fP\fIbuflen\fP\fB, struct spwd **\fP\fIspbufp\fP\fB);\fP
.sp
\fBint sgetspent_r(const char *\fP\fIs\fP\fB, struct spwd *\fP\fIspbuf\fP\fB,\fP
.br
\fB        char *\fP\fIbuf\fP\fB, size_t \fP\fIbuflen\fP\fB, struct spwd **\fP\fIspbufp\fP\fB);\fP
.fi
.sp
.in -4n
glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
.in
.sp
.ad l
\fBgetspent_r\fP(), \fBgetspnam_r\fP(), \fBfgetspent_r\fP(), \fBsgetspent_r\fP():
.RS 4
_BSD_SOURCE || _SVID_SOURCE
.RE
.ad b
.SH 説明
昔は暗号化されたパスワードをパスワードファイルに 見えるように公開しておいても安全だと考えられていた。 Julianne Frances Haugh は
shadow パスワード・スイートを実装した。 これは暗号化されたパスワードを、root のみが読むことができる shadow パスワード・データベース
(例えば、 ローカルの shadow パスワードファイル \fI/etc/shadow\fP, NIS, LDAP)  に保持する。
.LP
.\" FIXME I've commented out the following for the
.\" moment.  The relationship between PAM and nsswitch.conf needs
.\" to be clearly documented in one place, which is pointed to by
.\" the pages for the user, group, and shadow password functions.
.\" (Jul 2005, mtk)
.\"
.\" This shadow password setup has been superseded by PAM
.\" (pluggable authentication modules), and the file
.\" .I /etc/nsswitch.conf
.\" now describes the sources to be used.
以下で説明する関数は、伝統的なパスワード・データベースに対する 関数に似ている (例えば \fBgetpwnam\fP(3)  や
\fBgetpwent\fP(3)  を参照)。
.LP
\fBgetspnam\fP()  関数は、ユーザ名 \fIname\fP にマッチする shadow パスワード・データベースのエントリを
要素毎に分解し、各要素を格納した構造体へのポインタを返す。
.LP
.\" some systems require a call of setspent() before the first getspent()
.\" glibc does not
\fBgetspent\fP()  関数は shadow パスワード・データベースにおける次のエントリへのポインタを返す。 入力ストリームにおける位置は、
\fBsetspent\fP()  で初期化される。 読み込みが終わった後に、 \fBendspent\fP()  を呼び出すと、リソースを解放できる。
.LP
\fBfgetspent\fP()  関数は \fBgetspent\fP()  に似ているが、 \fBsetspent\fP()
で暗黙のうちにオープンされるストリームではなく、与えられたストリームを使う。
.LP
\fBsgetspent\fP()  関数は与えられた文字列 \fIs\fP を解析し struct \fIspwd\fP に格納する。
.LP
\fBputspent\fP()  関数は与えられた struct \fIspwd\fP \fI*p\fP の内容を shadow
パスワードファイル形式のテキスト行でストリーム \fIfp\fP に書き出す。 空文字列として、 値が NULL の文字列エントリと値が \-1
の数値エントリが 書き出される。
.LP
\fBlckpwdf\fP()  関数は、 shadow パスワード・データベースを 多重同時アクセスから守るためのものである。
この関数はロックの獲得を試み、 成功した場合は 0 を返す。 失敗した場合 (15 秒以内にロックが取得できなかった場合) は \-1 を返す。
\fBulckpwdf\fP()  関数はロックを再び解放する。 shadow パスワードファイルへの直接アクセスから 保護する手段がない点に注意すること。
\fBlckpwdf\fP()  を使うプログラムだけがロックを通知できる。
.LP
.\" Also in libc5
.\" SUN doesn't have sgetspent()
これらの関数はオリジナルの shadow API を構成していた関数であり、 いろいろなシステムで広く利用可能である。
.SS リエントラント版
パスワード・データベースに対するリエントラント版と同じように、 glibc には shadow パスワードファイルに対してリエントラント版がある。
\fBgetspnam_r\fP()  関数は \fBgetspnam\fP()  と似ているが、取得した shadow パスワード構造体を \fIspbuf\fP
が指す領域に格納する。 shadow パスワード構造体は文字列群へのポインタを含み、 これらの文字列群はサイズ \fIbuflen\fP のバッファ
\fIbuf\fP に格納される。 \fI*spbufp\fP には (成功した場合は) 結果へのポインタが格納され、
(エントリが見つからなかった場合またはエラーが起こった場合は)  NULL が格納される。
.LP
関数 \fBgetspent_r\fP(), \fBfgetspent_r\fP(), \fBsgetspent_r\fP()
はそれぞれリエントラントでないバージョンと同様の機能を持つ。
.LP
.\" SUN doesn't have sgetspent_r()
glibc でないシステムにもこれらと同じ名前の関数があるが、 プロトタイプが異なることも多い。
.SS 構造体
shadow パスワード構造体は \fI<shadow.h>\fP で以下のように定義されている:
.sp
.in +4n
.nf
struct spwd {
    char *sp_namp;     /* ログイン名 */
    char *sp_pwdp;     /* 暗号化されたパスワード */
    long  sp_lstchg;   /* 最終更新日
                          (1970\-01\-01 00:00:00 +0000 (UTC)) からの日数) */
    long  sp_min;      /* 変更が出来るようになるまでの最短日数 */
    long  sp_max;      /* 変更をしなくてもよい最長日数 */
    long  sp_warn;     /* パスワードが期限切れになる前に
                          ユーザに変更の警告を出す日数 */
    long  sp_inact;    /* パスワードが期限切れになってから
                          アカウントが無効になるまでの日数 */
    long  sp_expire;   /* アカウントが無効になる日付
                          (1970\-01\-01 00:00:00 +0000 (UTC)) からの日数) */
    unsigned long sp_flag;  /* 予約フィールド */
};
.fi
.in
.SH 返り値
ポインタを返す関数は、これ以上エントリがない場合や 処理中にエラーが発生した場合 NULL を返す。 \fIint\fP を返り値として持つ関数は、
成功した場合 0 を返し、失敗した場合 \-1 を返す。
.LP
リエントラント版でない関数では、返り値が静的な領域を指しており、 引き続いてこれらの関数を呼び出した場合に上書きされる可能性がある。
.LP
リエントラント版の関数は、成功した場合に 0 を返す。 エラーの場合は、エラー番号が返される。
.SH エラー
.TP 
\fBERANGE\fP
与えられたバッファが小さすぎる。
.SH ファイル
.TP 
\fI/etc/shadow\fP
ローカルの shadow パスワード・データベースファイル
.TP 
\fI/etc/.pwd.lock\fP
ロックファイル
.LP
インクルードファイル \fI<paths.h>\fP は定数 \fB_PATH_SHADOW\fP を定義している。 これは shadow
パスワードファイルのパス名である。
.SH 準拠
shadow パスワード・データベースと関連 API は POSIX.1\-2001 には記載されていない。しかしながら、多くの他のシステムでも 同様の
API が提供されている。
.SH 関連項目
\fBgetgrnam\fP(3), \fBgetpwnam\fP(3), \fBgetpwnam_r\fP(3), \fBshadow\fP(5)