openssh/auth.h

   1 /* $OpenBSD: auth.h,v 1.62 2008/11/04 08:22:12 djm Exp $ */
   2
   3 /*
   4  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  */
  27
  28 #ifndef AUTH_H
  29 #define AUTH_H
  30
  31 #include <signal.h>
  32
  33 #include <openssl/rsa.h>
  34
  35 #ifdef HAVE_LOGIN_CAP
  36 #include <login_cap.h>
  37 #endif
  38 #ifdef BSD_AUTH
  39 #include <bsd_auth.h>
  40 #endif
  41 #ifdef KRB5
  42 #include <krb5.h>
  43 #endif
  44 #ifdef AFS_KRB5
  45 #include <krbafs.h>
  46 #endif
  47
  48 typedef struct Authctxt Authctxt;
  49 typedef struct Authmethod Authmethod;
  50 typedef struct KbdintDevice KbdintDevice;
  51
  52 struct Authctxt {
  53         sig_atomic_t     success;
  54         int              authenticated; /* authenticated and alarms cancelled */
  55         int              postponed;     /* authentication needs another step */
  56         int              valid;         /* user exists and is allowed to login */
  57         int              attempt;
  58         int              failures;
  59         int              server_caused_failure;
  60         int              force_pwchange;
  61         char            *user;          /* username sent by the client */
  62         char            *service;
  63         struct passwd   *pw;            /* set if 'valid' */
  64         char            *style;
  65         void            *kbdintctxt;
  66         void            *jpake_ctx;
  67 #ifdef BSD_AUTH
  68         auth_session_t  *as;
  69 #endif
  70 #ifdef KRB5
  71         krb5_context     krb5_ctx;
  72         krb5_ccache      krb5_fwd_ccache;
  73         krb5_principal   krb5_user;
  74         char            *krb5_ticket_file;
  75         char            *krb5_ccname;
  76 #endif
  77 #ifdef SESSION_HOOKS
  78         char            *session_env_file;
  79 #endif
  80         Buffer          *loginmsg;
  81         void            *methoddata;
  82 };
  83 /*
  84  * Every authentication method has to handle authentication requests for
  85  * non-existing users, or for users that are not allowed to login. In this
  86  * case 'valid' is set to 0, but 'user' points to the username requested by
  87  * the client.
  88  */
  89
  90 struct Authmethod {
  91         char    *name;
  92         int     (*userauth)(Authctxt *authctxt);
  93         int     *enabled;
  94 };
  95
  96 /*
  97  * Keyboard interactive device:
  98  * init_ctx     returns: non NULL upon success
  99  * query        returns: 0 - success, otherwise failure
 100  * respond      returns: 0 - success, 1 - need further interaction,
 101  *              otherwise - failure
 102  */
 103 struct KbdintDevice
 104 {
 105         const char *name;
 106         void*   (*init_ctx)(Authctxt*);
 107         int     (*query)(void *ctx, char **name, char **infotxt,
 108                     u_int *numprompts, char ***prompts, u_int **echo_on);
 109         int     (*respond)(void *ctx, u_int numresp, char **responses);
 110         void    (*free_ctx)(void *ctx);
 111 };
 112
 113 int      auth_rhosts(struct passwd *, const char *);
 114 int
 115 auth_rhosts2(struct passwd *, const char *, const char *, const char *);
 116
 117 int      auth_rhosts_rsa(Authctxt *, char *, Key *);
 118 int      auth_password(Authctxt *, const char *);
 119 int      auth_rsa(Authctxt *, BIGNUM *);
 120 int      auth_rsa_challenge_dialog(Key *);
 121 BIGNUM  *auth_rsa_generate_challenge(Key *);
 122 int      auth_rsa_verify_response(Key *, BIGNUM *, u_char[]);
 123 int      auth_rsa_key_allowed(struct passwd *, BIGNUM *, Key **);
 124
 125 int      auth_rhosts_rsa_key_allowed(struct passwd *, char *, char *, Key *);
 126 int      hostbased_key_allowed(struct passwd *, const char *, char *, Key *);
 127 int      user_key_allowed(struct passwd *, Key *);
 128
 129 #ifdef KRB5
 130 int     auth_krb5(Authctxt *authctxt, krb5_data *auth, char **client, krb5_data *);
 131 int     auth_krb5_tgt(Authctxt *authctxt, krb5_data *tgt);
 132 int     auth_krb5_password(Authctxt *authctxt, const char *password);
 133 void    krb5_cleanup_proc(Authctxt *authctxt);
 134 #endif /* KRB5 */
 135
 136 #if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
 137 #include <shadow.h>
 138 int auth_shadow_acctexpired(struct spwd *);
 139 int auth_shadow_pwexpired(Authctxt *);
 140 #endif
 141
 142 #include "auth-pam.h"
 143 #include "audit.h"
 144 void remove_kbdint_device(const char *);
 145
 146 void disable_forwarding(void);
 147
 148 void    do_authentication(Authctxt *);
 149 void    do_authentication2(Authctxt *);
 150
 151 void    auth_log(Authctxt *, int, char *, char *);
 152 void    userauth_finish(Authctxt *, int, char *);
 153 void    userauth_send_banner(const char *);
 154 int     auth_root_allowed(char *);
 155 char *expand_authorized_keys(const char *filename, struct passwd *pw);
 156
 157 char    *auth2_read_banner(void);
 158
 159 void    privsep_challenge_enable(void);
 160
 161 int     auth2_challenge(Authctxt *, char *);
 162 void    auth2_challenge_stop(Authctxt *);
 163 int     bsdauth_query(void *, char **, char **, u_int *, char ***, u_int **);
 164 int     bsdauth_respond(void *, u_int, char **);
 165 int     skey_query(void *, char **, char **, u_int *, char ***, u_int **);
 166 int     skey_respond(void *, u_int, char **);
 167
 168 void    auth2_jpake_get_pwdata(Authctxt *, BIGNUM **, char **, char **);
 169 void    auth2_jpake_stop(Authctxt *);
 170
 171 int     allowed_user(struct passwd *);
 172 struct passwd * getpwnamallow(const char *user);
 173
 174 char    *get_challenge(Authctxt *);
 175 int     verify_response(Authctxt *, const char *);
 176 void    abandon_challenge_response(Authctxt *);
 177
 178 char    *authorized_keys_file(struct passwd *);
 179 char    *authorized_keys_file2(struct passwd *);
 180
 181 FILE    *auth_openkeyfile(const char *, struct passwd *, int);
 182
 183 HostStatus
 184 check_key_in_hostfiles(struct passwd *, Key *, const char *,
 185     const char *, const char *);
 186
 187 /* hostkey handling */
 188 Key     *get_hostkey_by_index(int);
 189 Key     *get_hostkey_by_type(int);
 190 int      get_hostkey_index(Key *);
 191 int      ssh1_session_key(BIGNUM *);
 192
 193 /* debug messages during authentication */
 194 void     auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
 195 void     auth_debug_send(void);
 196 void     auth_debug_reset(void);
 197
 198 struct passwd *fakepw(void);
 199
 200 int      sys_auth_passwd(Authctxt *, const char *);
 201
 202 #define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
 203
 204 #define SKEY_PROMPT "\nS/Key Password: "
 205
 206 #if defined(KRB5) && !defined(HEIMDAL)
 207 #include <krb5.h>
 208 krb5_error_code ssh_krb5_cc_gen(krb5_context, krb5_ccache *);
 209 #endif
 210 #endif