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