freebsd-nq/contrib/openpam/doc/man/pam_set_data.3

71 lines
1.7 KiB
Groff
Raw Normal View History

2013-09-07 16:15:30 +00:00
.\" Generated from pam_set_data.c by gendoc.pl
2017-05-01 15:02:58 +00:00
.\" $OpenPAM: pam_set_data.c 938 2017-04-30 21:34:42Z des $
2019-02-24 20:54:06 +00:00
.Dd February 24, 2019
2002-02-23 01:22:51 +00:00
.Dt PAM_SET_DATA 3
.Os
.Sh NAME
.Nm pam_set_data
.Nd set module information
.Sh SYNOPSIS
2003-01-06 16:07:51 +00:00
.In sys/types.h
2002-02-23 01:22:51 +00:00
.In security/pam_appl.h
2003-07-15 07:18:26 +00:00
.Ft "int"
2002-02-23 01:22:51 +00:00
.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)"
.Sh DESCRIPTION
The
2012-05-26 14:23:18 +00:00
.Fn pam_set_data
2002-02-23 01:24:02 +00:00
function associates a pointer to an opaque object
with an arbitrary string specified by the
2005-02-01 10:16:17 +00:00
.Fa module_data_name
2002-02-23 01:24:02 +00:00
argument,
in the PAM context specified by the
2005-02-01 10:16:17 +00:00
.Fa pamh
2002-02-23 01:24:02 +00:00
argument.
.Pp
If not
.Dv NULL ,
the
2005-02-01 10:16:17 +00:00
.Fa cleanup
2002-02-23 01:24:02 +00:00
argument should point to a function
responsible for releasing the resources associated with the object.
.Pp
This function and its counterpart
.Xr pam_get_data 3
are useful for managing
data that are meaningful only to a particular service module.
2002-02-23 01:22:51 +00:00
.Sh RETURN VALUES
The
2012-05-26 14:23:18 +00:00
.Fn pam_set_data
2002-02-23 01:22:51 +00:00
function returns one of the following values:
2002-02-23 01:24:02 +00:00
.Bl -tag -width 18n
2017-05-01 15:02:58 +00:00
.It Bq Er PAM_SUCCESS
Success.
2002-02-23 01:24:02 +00:00
.It Bq Er PAM_BUF_ERR
Memory buffer error.
.It Bq Er PAM_SYSTEM_ERR
System error.
2002-02-23 01:22:51 +00:00
.El
.Sh SEE ALSO
2002-02-23 01:24:02 +00:00
.Xr pam 3 ,
.Xr pam_get_data 3 ,
.Xr pam_strerror 3
2002-02-23 01:22:51 +00:00
.Sh STANDARDS
.Rs
.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
.%D "June 1997"
.Re
.Sh AUTHORS
The
2012-05-26 14:23:18 +00:00
.Fn pam_set_data
function and this manual page were
developed for the
2003-07-15 07:18:26 +00:00
.Fx
2012-05-26 14:23:18 +00:00
Project by ThinkSec AS and Network Associates Laboratories, the
Security Research Division of Network Associates, Inc.\& under
2003-07-15 07:18:26 +00:00
DARPA/SPAWAR contract N66001-01-C-8035
2002-02-23 01:22:51 +00:00
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.
2013-09-07 16:15:30 +00:00
.Pp
The OpenPAM library is maintained by
2017-02-19 21:00:46 +00:00
.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .