xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_start.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1*0d9d0fd8Schristos.\"	$NetBSD: pam_start.3,v 1.9 2023/06/30 21:46:20 christos Exp $
244269bb5Schristos.\"
38fa0fefeSchristos.\" Generated from pam_start.c by gendoc.pl
4*0d9d0fd8Schristos.Dd June 27, 2023
544269bb5Schristos.Dt PAM_START 3
644269bb5Schristos.Os
744269bb5Schristos.Sh NAME
844269bb5Schristos.Nm pam_start
944269bb5Schristos.Nd initiate a PAM transaction
1044269bb5Schristos.Sh SYNOPSIS
1144269bb5Schristos.In sys/types.h
1244269bb5Schristos.In security/pam_appl.h
1344269bb5Schristos.Ft "int"
1444269bb5Schristos.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh"
1544269bb5Schristos.Sh DESCRIPTION
1644269bb5SchristosThe
17e1b25b17Schristos.Fn pam_start
1844269bb5Schristosfunction creates and initializes a PAM context.
1944269bb5Schristos.Pp
2044269bb5SchristosThe
2144269bb5Schristos.Fa service
2244269bb5Schristosargument specifies the name of the policy to apply, and is
2344269bb5Schristosstored in the
2444269bb5Schristos.Dv PAM_SERVICE
2544269bb5Schristositem in the created context.
2644269bb5Schristos.Pp
2744269bb5SchristosThe
2844269bb5Schristos.Fa user
2944269bb5Schristosargument specifies the name of the target user - the user the
3044269bb5Schristoscreated context will serve to authenticate.
3144269bb5SchristosIt is stored in the
3244269bb5Schristos.Dv PAM_USER
3344269bb5Schristositem in the created context.
3444269bb5Schristos.Pp
3544269bb5SchristosThe
3644269bb5Schristos.Fa pam_conv
3744269bb5Schristosargument points to a
3844269bb5Schristos.Vt struct pam_conv
3944269bb5Schristosdescribing the
4044269bb5Schristosconversation function to use; see
4144269bb5Schristos.Fa pam_conv
4244269bb5Schristosfor details.
4344269bb5Schristos.Sh RETURN VALUES
4444269bb5SchristosThe
45e1b25b17Schristos.Fn pam_start
4644269bb5Schristosfunction returns one of the following values:
4744269bb5Schristos.Bl -tag -width 18n
484cb4af11Schristos.It Bq Er PAM_SUCCESS
494cb4af11SchristosSuccess.
504cb4af11Schristos.It Bq Er PAM_BAD_ITEM
514cb4af11SchristosUnrecognized or restricted item.
5244269bb5Schristos.It Bq Er PAM_BUF_ERR
5344269bb5SchristosMemory buffer error.
5444269bb5Schristos.It Bq Er PAM_SYSTEM_ERR
5544269bb5SchristosSystem error.
5644269bb5Schristos.El
5744269bb5Schristos.Sh SEE ALSO
5844269bb5Schristos.Xr pam 3 ,
5944269bb5Schristos.Xr pam_end 3 ,
6044269bb5Schristos.Xr pam_get_item 3 ,
6144269bb5Schristos.Xr pam_set_item 3 ,
6244269bb5Schristos.Xr pam_strerror 3
6344269bb5Schristos.Sh STANDARDS
6444269bb5Schristos.Rs
6544269bb5Schristos.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
6644269bb5Schristos.%D "June 1997"
6744269bb5Schristos.Re
6844269bb5Schristos.Sh AUTHORS
6944269bb5SchristosThe
70e1b25b17Schristos.Fn pam_start
71e1b25b17Schristosfunction and this manual page were
72e1b25b17Schristosdeveloped for the
7344269bb5Schristos.Fx
74e1b25b17SchristosProject by ThinkSec AS and Network Associates Laboratories, the
7544269bb5SchristosSecurity Research Division of Network Associates, Inc.\& under
7644269bb5SchristosDARPA/SPAWAR contract N66001-01-C-8035
7744269bb5Schristos.Pq Dq CBOSS ,
7844269bb5Schristosas part of the DARPA CHATS research program.
798fa0fefeSchristos.Pp
808fa0fefeSchristosThe OpenPAM library is maintained by
814cb4af11Schristos.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
82