1.\" $NetBSD: pam_start.3,v 1.9 2023/06/30 21:46:20 christos Exp $ 2.\" 3.\" Generated from pam_start.c by gendoc.pl 4.Dd June 27, 2023 5.Dt PAM_START 3 6.Os 7.Sh NAME 8.Nm pam_start 9.Nd initiate a PAM transaction 10.Sh SYNOPSIS 11.In sys/types.h 12.In security/pam_appl.h 13.Ft "int" 14.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh" 15.Sh DESCRIPTION 16The 17.Fn pam_start 18function creates and initializes a PAM context. 19.Pp 20The 21.Fa service 22argument specifies the name of the policy to apply, and is 23stored in the 24.Dv PAM_SERVICE 25item in the created context. 26.Pp 27The 28.Fa user 29argument specifies the name of the target user - the user the 30created context will serve to authenticate. 31It is stored in the 32.Dv PAM_USER 33item in the created context. 34.Pp 35The 36.Fa pam_conv 37argument points to a 38.Vt struct pam_conv 39describing the 40conversation function to use; see 41.Fa pam_conv 42for details. 43.Sh RETURN VALUES 44The 45.Fn pam_start 46function returns one of the following values: 47.Bl -tag -width 18n 48.It Bq Er PAM_SUCCESS 49Success. 50.It Bq Er PAM_BAD_ITEM 51Unrecognized or restricted item. 52.It Bq Er PAM_BUF_ERR 53Memory buffer error. 54.It Bq Er PAM_SYSTEM_ERR 55System error. 56.El 57.Sh SEE ALSO 58.Xr pam 3 , 59.Xr pam_end 3 , 60.Xr pam_get_item 3 , 61.Xr pam_set_item 3 , 62.Xr pam_strerror 3 63.Sh STANDARDS 64.Rs 65.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 66.%D "June 1997" 67.Re 68.Sh AUTHORS 69The 70.Fn pam_start 71function and this manual page were 72developed for the 73.Fx 74Project by ThinkSec AS and Network Associates Laboratories, the 75Security Research Division of Network Associates, Inc.\& under 76DARPA/SPAWAR contract N66001-01-C-8035 77.Pq Dq CBOSS , 78as part of the DARPA CHATS research program. 79.Pp 80The OpenPAM library is maintained by 81.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no . 82