xref: /freebsd/contrib/openpam/doc/man/pam_set_data.3 (revision aa1a8ff2d6dbc51ef058f46f3db5a8bb77967145)
1.\" Generated from pam_set_data.c by gendoc.pl
2.Dd June 27, 2023
3.Dt PAM_SET_DATA 3
4.Os
5.Sh NAME
6.Nm pam_set_data
7.Nd set module information
8.Sh SYNOPSIS
9.In sys/types.h
10.In security/pam_appl.h
11.Ft "int"
12.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)"
13.Sh DESCRIPTION
14The
15.Fn pam_set_data
16function associates a pointer to an opaque object
17with an arbitrary string specified by the
18.Fa module_data_name
19argument,
20in the PAM context specified by the
21.Fa pamh
22argument.
23.Pp
24If not
25.Dv NULL ,
26the
27.Fa cleanup
28argument should point to a function
29responsible for releasing the resources associated with the object.
30.Pp
31This function and its counterpart
32.Xr pam_get_data 3
33are useful for managing
34data that are meaningful only to a particular service module.
35.Sh RETURN VALUES
36The
37.Fn pam_set_data
38function returns one of the following values:
39.Bl -tag -width 18n
40.It Bq Er PAM_SUCCESS
41Success.
42.It Bq Er PAM_BUF_ERR
43Memory buffer error.
44.It Bq Er PAM_SYSTEM_ERR
45System error.
46.El
47.Sh SEE ALSO
48.Xr pam 3 ,
49.Xr pam_get_data 3 ,
50.Xr pam_strerror 3
51.Sh STANDARDS
52.Rs
53.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
54.%D "June 1997"
55.Re
56.Sh AUTHORS
57The
58.Fn pam_set_data
59function and this manual page were
60developed for the
61.Fx
62Project by ThinkSec AS and Network Associates Laboratories, the
63Security Research Division of Network Associates, Inc.\& under
64DARPA/SPAWAR contract N66001-01-C-8035
65.Pq Dq CBOSS ,
66as part of the DARPA CHATS research program.
67.Pp
68The OpenPAM library is maintained by
69.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
70