contrib/openpam/lib/libpam/pam_prompt.c

   1 /*-
   2  * Copyright (c) 2002-2003 Networks Associates Technology, Inc.
   3  * Copyright (c) 2004-2011 Dag-Erling Smørgrav
   4  * All rights reserved.
   5  *
   6  * This software was developed for the FreeBSD Project by ThinkSec AS and
   7  * Network Associates Laboratories, the Security Research Division of
   8  * Network Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
   9  * ("CBOSS"), as part of the DARPA CHATS research program.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. The name of the author may not be used to endorse or promote
  20  *    products derived from this software without specific prior written
  21  *    permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  *
  35  * $Id: pam_prompt.c 648 2013-03-05 17:54:27Z des $
  36  */
  37
  38 #ifdef HAVE_CONFIG_H
  39 # include "config.h"
  40 #endif
  41
  42 #include <sys/types.h>
  43
  44 #include <stdarg.h>
  45
  46 #include <security/pam_appl.h>
  47 #include <security/openpam.h>
  48
  49 /*
  50  * OpenPAM extension
  51  *
  52  * Call the conversation function
  53  */
  54
  55 int
  56 pam_prompt(const pam_handle_t *pamh,
  57         int style,
  58         char **resp,
  59         const char *fmt,
  60         ...)
  61 {
  62         va_list ap;
  63         int r;
  64
  65         va_start(ap, fmt);
  66         r = pam_vprompt(pamh, style, resp, fmt, ap);
  67         va_end(ap);
  68         return (r);
  69 }
  70
  71 /*
  72  * Error codes:
  73  *
  74  *     !PAM_SYMBOL_ERR
  75  *      PAM_SYSTEM_ERR
  76  *      PAM_BUF_ERR
  77  *      PAM_CONV_ERR
  78  */
  79
  80 /**
  81  * The =pam_prompt function constructs a message from the specified format
  82  * string and arguments and passes it to the given PAM context's
  83  * conversation function.
  84  *
  85  * A pointer to the response, or =NULL if the conversation function did
  86  * not return one, is stored in the location pointed to by the =resp
  87  * argument.
  88  *
  89  * See =pam_vprompt for further details.
  90  *
  91  * >pam_error
  92  * >pam_info
  93  * >pam_vprompt
  94  */