1.\" $NetBSD: openpam_get_option.3,v 1.2 2011/12/25 22:27:55 christos Exp $ 2.\" 3.\"- 4.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 5.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav 6.\" All rights reserved. 7.\" 8.\" This software was developed for the FreeBSD Project by ThinkSec AS and 9.\" Network Associates Laboratories, the Security Research Division of 10.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 11.\" ("CBOSS"), as part of the DARPA CHATS research program. 12.\" 13.\" Redistribution and use in source and binary forms, with or without 14.\" modification, are permitted provided that the following conditions 15.\" are met: 16.\" 1. Redistributions of source code must retain the above copyright 17.\" notice, this list of conditions and the following disclaimer. 18.\" 2. Redistributions in binary form must reproduce the above copyright 19.\" notice, this list of conditions and the following disclaimer in the 20.\" documentation and/or other materials provided with the distribution. 21.\" 3. The name of the author may not be used to endorse or promote 22.\" products derived from this software without specific prior written 23.\" permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35.\" SUCH DAMAGE. 36.\" 37.\" Id 38.\" 39.Dd December 18, 2011 40.Dt OPENPAM_GET_OPTION 3 41.Os 42.Sh NAME 43.Nm openpam_get_option 44.Nd returns the value of a module option 45.Sh LIBRARY 46.Lb libpam 47.Sh SYNOPSIS 48.In sys/types.h 49.In security/pam_appl.h 50.In security/openpam.h 51.Ft "const char *" 52.Fn openpam_get_option "pam_handle_t *pamh" "const char *option" 53.Sh DESCRIPTION 54The 55.Nm 56function returns the value of the specified 57option in the context of the currently executing service module, or 58.Dv NULL 59if the option is not set or no module is currently executing. 60.Sh RETURN VALUES 61The 62.Nm 63function returns 64.Dv NULL 65on failure. 66.Sh SEE ALSO 67.Xr openpam_set_option 3 , 68.Xr pam 3 69.Sh STANDARDS 70The 71.Nm 72function is an OpenPAM extension. 73.Sh AUTHORS 74The 75.Nm 76function and this manual page were developed for the 77.Fx 78Project by 79ThinkSec AS and Network Associates Laboratories, the 80Security Research Division of Network Associates, Inc.\& under 81DARPA/SPAWAR contract N66001-01-C-8035 82.Pq Dq CBOSS , 83as part of the DARPA CHATS research program. 84