xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_verror.3 (revision 7788a0781fe6ff2cce37368b4578a7ade0850cb1)
1.\"	$NetBSD: pam_verror.3,v 1.3 2013/04/06 02:20:30 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 May 26, 2012
40.Dt PAM_VERROR 3
41.Os
42.Sh NAME
43.Nm pam_verror
44.Nd display an error message
45.Sh LIBRARY
46.Lb libpam
47.Sh SYNOPSIS
48.In sys/types.h
49.In security/pam_appl.h
50.Ft "int"
51.Fn pam_verror "const pam_handle_t *pamh" "const char *fmt" "va_list ap"
52.Sh DESCRIPTION
53The
54.Fn pam_verror
55function passes its arguments to
56.Xr pam_vprompt 3
57with a
58style argument of
59.Dv PAM_ERROR_MSG ,
60and discards the response.
61.Sh RETURN VALUES
62The
63.Fn pam_verror
64function returns one of the following values:
65.Bl -tag -width 18n
66.It Bq Er PAM_BUF_ERR
67Memory buffer error.
68.It Bq Er PAM_CONV_ERR
69Conversation failure.
70.It Bq Er PAM_SYSTEM_ERR
71System error.
72.El
73.Sh SEE ALSO
74.Xr pam 3 ,
75.Xr pam_error 3 ,
76.Xr pam_strerror 3 ,
77.Xr pam_vinfo 3 ,
78.Xr pam_vprompt 3
79.Sh STANDARDS
80The
81.Fn pam_verror
82function is an OpenPAM extension.
83.Sh AUTHORS
84The
85.Fn pam_verror
86function and this manual page were
87developed for the
88.Fx
89Project by ThinkSec AS and Network Associates Laboratories, the
90Security Research Division of Network Associates, Inc.\& under
91DARPA/SPAWAR contract N66001-01-C-8035
92.Pq Dq CBOSS ,
93as part of the DARPA CHATS research program.
94