lib/libpam/libpam/security/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: src/lib/libpam/libpam/security/pam_mod_misc.h,v 1.10.2.2 2002/07/03 21:45:44 des Exp $
  27  *      $DragonFly: src/lib/libpam/libpam/security/Attic/pam_mod_misc.h,v 1.3 2005/02/17 13:59:35 joerg Exp $
  28  */
  29
  30 #ifndef PAM_MOD_MISC_H
  31 #define PAM_MOD_MISC_H
  32
  33 #include <sys/cdefs.h>
  34
  35 /* Standard options
  36  */
  37 enum opt { PAM_OPT_DEBUG, PAM_OPT_NO_WARN, PAM_OPT_ECHO_PASS,
  38         PAM_OPT_USE_FIRST_PASS, PAM_OPT_TRY_FIRST_PASS, PAM_OPT_USE_MAPPED_PASS,
  39         PAM_OPT_TRY_MAPPED_PASS, PAM_OPT_EXPOSE_ACCOUNT,
  40         PAM_OPT_STD_MAX /* XXX */ };
  41
  42 #define PAM_MAX_OPTIONS 32
  43
  44 struct opttab {
  45         const char *name;
  46         int value;
  47 };
  48
  49 struct options {
  50         struct {
  51                 const char *name;
  52                 int bool;
  53                 char *arg;
  54         } opt[PAM_MAX_OPTIONS];
  55 };
  56
  57 __BEGIN_DECLS
  58 int     pam_get_pass(pam_handle_t *, const char **, const char *, struct options *);
  59 int     pam_prompt(pam_handle_t *, int, const char *, char **);
  60 void    pam_std_option(struct options *, struct opttab *, int, const char **);
  61 int     pam_test_option(struct options *, enum opt, char **);
  62 void    pam_set_option(struct options *, enum opt);
  63 void    pam_clear_option(struct options *, enum opt);
  64 __END_DECLS
  65
  66 #define PAM_LOG(args...)                                                \
  67         _pam_log(&options, __FILE__, __func__, ##args)
  68
  69 #define PAM_RETURN(arg)                                                 \
  70         do {                                                            \
  71                 _pam_log_retval(&options, __FILE__, __func__, arg); \
  72                 return arg;                                             \
  73         } while (0)
  74
  75 #define PAM_VERBOSE_ERROR(args...)                                      \
  76         _pam_verbose_error(pamh, &options, __FILE__, __func__, ##args)
  77
  78 #ifdef NGROUPS_MAX
  79 #define PAM_SAVED_CRED "pam_saved_cred"
  80 struct pam_saved_cred {
  81         uid_t    euid;
  82         gid_t    egid;
  83         gid_t    groups[NGROUPS_MAX];
  84         int      ngroups;
  85 };
  86 #endif
  87
  88 #endif