contrib/openpam/lib/pam_prompt.c

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