doc/documentation/manual-pages/ja/man3/pam_open_session.3
Sergio Carlavilla Delgado 989d921f5d Migrate doc to Hugo/AsciiDoctor
I'm very pleased to announce the release of
our new website and documentation using
the new toolchain with Hugo and AsciiDoctor.

To get more information about the new toolchain
please read the FreeBSD Documentation Project Primer[1],
Hugo docs[2] and AsciiDoctor docs[3].

Acknowledgment:
Benedict Reuschling <bcr@>
Glen Barber <gjb@>
Hiroki Sato <hrs@>
Li-Wen Hsu <lwhsu@>
Sean Chittenden <seanc@>
The FreeBSD Foundation

[1] https://docs.FreeBSD.org/en/books/fdp-primer/
[2] https://gohugo.io/documentation/
[3] https://docs.asciidoctor.org/home/

Approved by:    doceng, core
2021-01-26 00:31:29 +01:00

103 lines
2.5 KiB
Groff

.\" Hey Emacs! This file is -*- nroff -*- source.
.\" $Id: pam_open_session.3,v 1.5 2002-11-03 06:38:28 horikawa Exp $
.\" %FreeBSD: src/contrib/libpam/doc/man/Attic/pam_open_session.3,v 1.2.6.2 2001/06/11 15:28:11 markm Exp %
.\" Copyright (c) Andrew G. Morgan 1997 <morgan@parc.power.net>
.\" $FreeBSD$
.TH PAM_OPEN_SESSION 3 "1997 Jan 4" "PAM 0.55" "App. Programmers' Manual"
.SH 名称
pam_open/close_session \- PAM セッション管理
.SH 書式
.B #include <security/pam_appl.h>
.sp
.BI "int pam_open_session(pam_handle_t " *pamh ", int " flags ");"
.sp
.BI "int pam_close_session(pam_handle_t " *pamh ", int " flags ");"
.sp 2
.SH 解説
PAM には、セッションの初期化と終了を行なう管理ツールがあります。
.TP
.B pam_open_session
この関数を使用すると、認証されたユーザのセッションが始まったことを
通知できます。ユーザが
.BR pam_authenticate "(3)"
で適切に確認され、
必要な場合は
.BR pam_setcred "(3)"
で証明書を与えられた後で呼び出してください。
.br
セッションの初期化に関連した関数には、システム監視のための
ログ作成とディレクトリ (ユーザのホームディレクトリなど) の
マウントがあります。アプリケーションでこれに関わることはありません。
アプリケーションの
.I 実効
uid (
.BR geteuid "(2)"
)
に、このような処理に十分な権限を持つことが必要であることに注意してください。
.TP
.B pam_close_session
.br
この関数を使用すると、ユーザセッションが終了したことを通知できます。
一般的には、初期化関数
(
.BR pam_open_session
)
と同じアプリケーションにこの関数を配置する必要はありません。
.br
典型的には、この関数は、
.BR pam_open_session
のアクションを取り消します。
つまり、ユーザセッションの終了に関わる監視情報を記録し、ユーザの
ホームディレクトリのマウントを解除します。
十分な権限があることは別にして、
セッションの終了の詳細に呼び出しアプリケーションが関わるこはありません。
一方、この呼び出しから戻り次第、当該ユーザの権限での動作を止めることは、
良いプログラミングスタイルです。
.SH 戻り値
このセッション管理関数で問題が発生しなかった場合は、
.BR PAM_SUCCESS
が戻されます。
.br
セッションの開閉でエラーが発生した場合は、
.BR PAM_SESSION_ERR
が戻されます。
その他の戻り値が戻された場合は、エラーを示すものとして扱ってください。
.SH エラー
.BR pam_strerror "(3)"
でテキストに変換できます。
.SH 準拠
OSF-RFC 86.0, October 1995.
.SH バグ
.sp 2
見つかっていません。
.SH 関連項目
.BR pam_start "(3), "
.BR pam_authenticate "(3), "
.BR pam_setcred "(3), "
.BR pam_get_item "(3), "
.BR pam_strerror "(3), "
.BR pam "(3)."
.br
.BR システム管理者
.BR モジュール開発者
.BR アプリケーション開発者
用の
.BR Linux-PAM
ガイドも参照してください。