From owner-p4-projects  Thu May  9 10:54: 0 2002
Delivered-To: p4-projects@freebsd.org
Received: by hub.freebsd.org (Postfix, from userid 32767)
	id 97DD037B408; Thu,  9 May 2002 10:53:37 -0700 (PDT)
Delivered-To: perforce@freebsd.org
Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21])
	by hub.freebsd.org (Postfix) with ESMTP id 07FFE37B407
	for <perforce@freebsd.org>; Thu,  9 May 2002 10:53:33 -0700 (PDT)
Received: (from perforce@localhost)
	by freefall.freebsd.org (8.11.6/8.11.6) id g49HrWd71226
	for perforce@freebsd.org; Thu, 9 May 2002 10:53:32 -0700 (PDT)
	(envelope-from des@freebsd.org)
Date: Thu, 9 May 2002 10:53:32 -0700 (PDT)
Message-Id: <200205091753.g49HrWd71226@freefall.freebsd.org>
X-Authentication-Warning: freefall.freebsd.org: perforce set sender to des@freebsd.org using -f
From: Dag-Erling Smorgrav <des@FreeBSD.org>
Subject: PERFORCE change 11054 for review
To: Perforce Change Reviews <perforce@freebsd.org>
Sender: owner-p4-projects@FreeBSD.ORG
Precedence: bulk
List-ID: <p4-projects.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20p4-projects>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20p4-projects>
X-Loop: FreeBSD.ORG

http://people.freebsd.org/~peter/p4db/chv.cgi?CH=11054

Change 11054 by des@des.at.des.thinksec.com on 2002/05/09 10:52:55

	Add documentation.
	
	Sponsored by:	DARPA, NAI Labs

Affected files ...

... //depot/projects/openpam/lib/openpam_nullconv.c#2 edit
... //depot/projects/openpam/lib/openpam_ttyconv.c#11 edit

Differences ...

==== //depot/projects/openpam/lib/openpam_nullconv.c#2 (text+ko) ====

@@ -31,7 +31,7 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $P4: //depot/projects/openpam/lib/openpam_nullconv.c#1 $
+ * $P4: //depot/projects/openpam/lib/openpam_nullconv.c#2 $
  */
 
 #include <sys/types.h>
@@ -66,3 +66,19 @@
  *
  *	PAM_CONV_ERR
  */
+
+/**
+ * The =openpam_nullconv function is a null conversation function suitable
+ * for applications that want to use PAM but don't support interactive
+ * dialog with the user.  Such applications should set =PAM_AUTHTOK to
+ * whatever authentication token they've obtained on their own before
+ * calling =pam_authenticate and / or =pam_chauthtok, and their PAM
+ * configuration should specify the ;use_first_pass option for all modules
+ * that require access to the authentication token, to make sure they use
+ * =PAM_AUTHTOK rather than try to query the user.
+ *
+ * >openpam_ttyconv
+ * >pam_prompt
+ * >pam_set_item
+ * >pam_vprompt
+ */

==== //depot/projects/openpam/lib/openpam_ttyconv.c#11 (text+ko) ====

@@ -31,7 +31,7 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $P4: //depot/projects/openpam/lib/openpam_ttyconv.c#10 $
+ * $P4: //depot/projects/openpam/lib/openpam_ttyconv.c#11 $
  */
 
 #include <sys/types.h>
@@ -192,3 +192,17 @@
  *	PAM_BUF_ERR
  *	PAM_CONV_ERR
  */
+
+/**
+ * The =openpam_ttyconv function is a standard conversation function
+ * suitable for use on TTY devices.  It should be adequate for the needs
+ * of most text-based interactive programs.
+ *
+ * The =openpam_ttyconv function allows the application to specify a
+ * timeout for user input by setting the global variable
+ * :openpam_ttyconv_timeout to the length of the timeout in seconds.
+ *
+ * >openpam_nullconv
+ * >pam_prompt
+ * >pam_vprompt
+ */

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe p4-projects" in the body of the message