lib/libpam/libpam/pam_mod_misc.h

   1 /*-
   2  * Copyright 1998 Juniper Networks, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  *      $FreeBSD$
  27  */
  28
  29 #ifndef PAM_MOD_MISC_H
  30 #define PAM_MOD_MISC_H
  31
  32 #include <sys/cdefs.h>
  33
  34 /* Standard options
  35  */
  36 enum opt { PAM_OPT_DEBUG, PAM_OPT_NO_WARN, PAM_OPT_ECHO_PASS,
  37         PAM_OPT_USE_FIRST_PASS, PAM_OPT_TRY_FIRST_PASS, PAM_OPT_USE_MAPPED_PASS,
  38         PAM_OPT_TRY_MAPPED_PASS, PAM_OPT_EXPOSE_ACCOUNT,
  39         PAM_OPT_STD_MAX /* XXX */ };
  40
  41 #define PAM_MAX_OPTIONS 32
  42
  43 struct opttab {
  44         const char *name;
  45         int value;
  46 };
  47
  48 struct options {
  49         struct {
  50                 const char *name;
  51                 int bool;
  52                 char *arg;
  53         } opt[PAM_MAX_OPTIONS];
  54 };
  55
  56 __BEGIN_DECLS
  57 int     pam_get_pass(pam_handle_t *, const char **, const char *, struct options *);
  58 int     pam_prompt(pam_handle_t *, int, const char *, char **);
  59 void    pam_std_option(struct options *, struct opttab *, int, const char **);
  60 int     pam_test_option(struct options *, enum opt, char **);
  61 void    pam_set_option(struct options *, enum opt);
  62 void    pam_clear_option(struct options *, enum opt);
  63 void    _pam_log(struct options *, const char *, const char *, const char *, ...);
  64 void    _pam_log_retval(struct options *, const char *, const char *, int);
  65 void    _pam_verbose_error(pam_handle_t *, struct options *, const char *,
  66                 const char *, const char *, ...);
  67 __END_DECLS
  68
  69 #define PAM_LOG(args...)                                                \
  70         _pam_log(&options, __FILE__, __FUNCTION__, ##args)
  71
  72 #define PAM_RETURN(arg)                                                 \
  73         do {                                                            \
  74                 _pam_log_retval(&options, __FILE__, __FUNCTION__, arg); \
  75                 return arg;                                             \
  76         } while (0)
  77
  78 #define PAM_VERBOSE_ERROR(args...)                                      \
  79         _pam_verbose_error(pamh, &options, __FILE__, __FUNCTION__, ##args)
  80
  81 #endif