- dtucker@cvs.openbsd.org 2006/07/21 12:43:36
[openssh-git.git] / auth.h
blob6688c3dc56d684d50a29084eecac174669ba7fff
1 /* $OpenBSD: auth.h,v 1.54 2006/07/06 16:03:53 stevesk Exp $ */
3 /*
4 * Copyright (c) 2000 Markus Friedl. All rights reserved.
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.
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.
28 #ifndef AUTH_H
29 #define AUTH_H
31 #include <sys/types.h>
33 #include <signal.h>
34 #include <pwd.h>
36 #include "buffer.h"
37 #include <openssl/rsa.h>
39 #ifdef HAVE_LOGIN_CAP
40 #include <login_cap.h>
41 #endif
42 #ifdef BSD_AUTH
43 #include <bsd_auth.h>
44 #endif
45 #ifdef KRB5
46 #include <krb5.h>
47 #endif
49 #include "key.h"
50 #include "hostfile.h"
52 typedef struct Authctxt Authctxt;
53 typedef struct Authmethod Authmethod;
54 typedef struct KbdintDevice KbdintDevice;
56 struct Authctxt {
57 sig_atomic_t success;
58 int postponed; /* authentication needs another step */
59 int valid; /* user exists and is allowed to login */
60 int attempt;
61 int failures;
62 int force_pwchange;
63 char *user; /* username sent by the client */
64 char *service;
65 struct passwd *pw; /* set if 'valid' */
66 char *style;
67 void *kbdintctxt;
68 #ifdef BSD_AUTH
69 auth_session_t *as;
70 #endif
71 #ifdef KRB5
72 krb5_context krb5_ctx;
73 krb5_ccache krb5_fwd_ccache;
74 krb5_principal krb5_user;
75 char *krb5_ticket_file;
76 char *krb5_ccname;
77 #endif
78 Buffer *loginmsg;
79 void *methoddata;
82 * Every authentication method has to handle authentication requests for
83 * non-existing users, or for users that are not allowed to login. In this
84 * case 'valid' is set to 0, but 'user' points to the username requested by
85 * the client.
88 struct Authmethod {
89 char *name;
90 int (*userauth)(Authctxt *authctxt);
91 int *enabled;
95 * Keyboard interactive device:
96 * init_ctx returns: non NULL upon success
97 * query returns: 0 - success, otherwise failure
98 * respond returns: 0 - success, 1 - need further interaction,
99 * otherwise - failure
101 struct KbdintDevice
103 const char *name;
104 void* (*init_ctx)(Authctxt*);
105 int (*query)(void *ctx, char **name, char **infotxt,
106 u_int *numprompts, char ***prompts, u_int **echo_on);
107 int (*respond)(void *ctx, u_int numresp, char **responses);
108 void (*free_ctx)(void *ctx);
111 int auth_rhosts(struct passwd *, const char *);
113 auth_rhosts2(struct passwd *, const char *, const char *, const char *);
115 int auth_rhosts_rsa(Authctxt *, char *, Key *);
116 int auth_password(Authctxt *, const char *);
117 int auth_rsa(Authctxt *, BIGNUM *);
118 int auth_rsa_challenge_dialog(Key *);
119 BIGNUM *auth_rsa_generate_challenge(Key *);
120 int auth_rsa_verify_response(Key *, BIGNUM *, u_char[]);
121 int auth_rsa_key_allowed(struct passwd *, BIGNUM *, Key **);
123 int auth_rhosts_rsa_key_allowed(struct passwd *, char *, char *, Key *);
124 int hostbased_key_allowed(struct passwd *, const char *, char *, Key *);
125 int user_key_allowed(struct passwd *, Key *);
127 #ifdef KRB5
128 int auth_krb5(Authctxt *authctxt, krb5_data *auth, char **client, krb5_data *);
129 int auth_krb5_tgt(Authctxt *authctxt, krb5_data *tgt);
130 int auth_krb5_password(Authctxt *authctxt, const char *password);
131 void krb5_cleanup_proc(Authctxt *authctxt);
132 #endif /* KRB5 */
134 #if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
135 #include <shadow.h>
136 int auth_shadow_acctexpired(struct spwd *);
137 int auth_shadow_pwexpired(Authctxt *);
138 #endif
140 #include "auth-pam.h"
141 #include "audit.h"
142 void remove_kbdint_device(const char *);
144 void disable_forwarding(void);
146 void do_authentication(Authctxt *);
147 void do_authentication2(Authctxt *);
149 void auth_log(Authctxt *, int, char *, char *);
150 void userauth_finish(Authctxt *, int, char *);
151 void userauth_send_banner(const char *);
152 int auth_root_allowed(char *);
154 char *auth2_read_banner(void);
156 void privsep_challenge_enable(void);
158 int auth2_challenge(Authctxt *, char *);
159 void auth2_challenge_stop(Authctxt *);
160 int bsdauth_query(void *, char **, char **, u_int *, char ***, u_int **);
161 int bsdauth_respond(void *, u_int, char **);
162 int skey_query(void *, char **, char **, u_int *, char ***, u_int **);
163 int skey_respond(void *, u_int, char **);
165 int allowed_user(struct passwd *);
166 struct passwd * getpwnamallow(const char *user);
168 char *get_challenge(Authctxt *);
169 int verify_response(Authctxt *, const char *);
170 void abandon_challenge_response(Authctxt *);
172 char *authorized_keys_file(struct passwd *);
173 char *authorized_keys_file2(struct passwd *);
176 secure_filename(FILE *, const char *, struct passwd *, char *, size_t);
178 HostStatus
179 check_key_in_hostfiles(struct passwd *, Key *, const char *,
180 const char *, const char *);
182 /* hostkey handling */
183 Key *get_hostkey_by_index(int);
184 Key *get_hostkey_by_type(int);
185 int get_hostkey_index(Key *);
186 int ssh1_session_key(BIGNUM *);
188 /* debug messages during authentication */
189 void auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
190 void auth_debug_send(void);
191 void auth_debug_reset(void);
193 struct passwd *fakepw(void);
195 int sys_auth_passwd(Authctxt *, const char *);
197 #define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
199 #define SKEY_PROMPT "\nS/Key Password: "
201 #if defined(KRB5) && !defined(HEIMDAL)
202 #include <krb5.h>
203 krb5_error_code ssh_krb5_cc_gen(krb5_context, krb5_ccache *);
204 #endif
205 #endif