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