xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_set_data.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1*0d9d0fd8Schristos.\"	$NetBSD: pam_set_data.3,v 1.9 2023/06/30 21:46:20 christos Exp $
244269bb5Schristos.\"
38fa0fefeSchristos.\" Generated from pam_set_data.c by gendoc.pl
4*0d9d0fd8Schristos.Dd June 27, 2023
544269bb5Schristos.Dt PAM_SET_DATA 3
644269bb5Schristos.Os
744269bb5Schristos.Sh NAME
844269bb5Schristos.Nm pam_set_data
944269bb5Schristos.Nd set module information
1044269bb5Schristos.Sh SYNOPSIS
1144269bb5Schristos.In sys/types.h
1244269bb5Schristos.In security/pam_appl.h
1344269bb5Schristos.Ft "int"
1444269bb5Schristos.Fn pam_set_data "pam_handle_t *pamh" "const char *module_data_name" "void *data" "void (*cleanup)(pam_handle_t *pamh, void *data, int pam_end_status)"
1544269bb5Schristos.Sh DESCRIPTION
1644269bb5SchristosThe
17e1b25b17Schristos.Fn pam_set_data
1844269bb5Schristosfunction associates a pointer to an opaque object
1944269bb5Schristoswith an arbitrary string specified by the
2044269bb5Schristos.Fa module_data_name
2144269bb5Schristosargument,
2244269bb5Schristosin the PAM context specified by the
2344269bb5Schristos.Fa pamh
2444269bb5Schristosargument.
2544269bb5Schristos.Pp
2644269bb5SchristosIf not
2744269bb5Schristos.Dv NULL ,
2844269bb5Schristosthe
2944269bb5Schristos.Fa cleanup
3044269bb5Schristosargument should point to a function
3144269bb5Schristosresponsible for releasing the resources associated with the object.
3244269bb5Schristos.Pp
3344269bb5SchristosThis function and its counterpart
3444269bb5Schristos.Xr pam_get_data 3
3544269bb5Schristosare useful for managing
3644269bb5Schristosdata that are meaningful only to a particular service module.
3744269bb5Schristos.Sh RETURN VALUES
3844269bb5SchristosThe
39e1b25b17Schristos.Fn pam_set_data
4044269bb5Schristosfunction returns one of the following values:
4144269bb5Schristos.Bl -tag -width 18n
424cb4af11Schristos.It Bq Er PAM_SUCCESS
434cb4af11SchristosSuccess.
4444269bb5Schristos.It Bq Er PAM_BUF_ERR
4544269bb5SchristosMemory buffer error.
4644269bb5Schristos.It Bq Er PAM_SYSTEM_ERR
4744269bb5SchristosSystem error.
4844269bb5Schristos.El
4944269bb5Schristos.Sh SEE ALSO
501ae23164Schristos.Xr openpam_free_data 3 ,
5144269bb5Schristos.Xr pam 3 ,
5244269bb5Schristos.Xr pam_get_data 3 ,
5344269bb5Schristos.Xr pam_strerror 3
5444269bb5Schristos.Sh STANDARDS
5544269bb5Schristos.Rs
5644269bb5Schristos.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
5744269bb5Schristos.%D "June 1997"
5844269bb5Schristos.Re
5944269bb5Schristos.Sh AUTHORS
6044269bb5SchristosThe
61e1b25b17Schristos.Fn pam_set_data
62e1b25b17Schristosfunction and this manual page were
63e1b25b17Schristosdeveloped for the
6444269bb5Schristos.Fx
65e1b25b17SchristosProject by ThinkSec AS and Network Associates Laboratories, the
6644269bb5SchristosSecurity Research Division of Network Associates, Inc.\& under
6744269bb5SchristosDARPA/SPAWAR contract N66001-01-C-8035
6844269bb5Schristos.Pq Dq CBOSS ,
6944269bb5Schristosas part of the DARPA CHATS research program.
708fa0fefeSchristos.Pp
718fa0fefeSchristosThe OpenPAM library is maintained by
724cb4af11Schristos.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
73