Note appropriate krb5 build dependency
[openssh.git] / auth.h
1 /* $OpenBSD: auth.h,v 1.66 2010/05/07 11:30:29 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
45 typedef struct Authctxt Authctxt;
46 typedef struct Authmethod Authmethod;
47 typedef struct KbdintDevice KbdintDevice;
48
49 struct Authctxt {
50         sig_atomic_t     success;
51         int              authenticated; /* authenticated and alarms cancelled */
52         int              postponed;     /* authentication needs another step */
53         int              valid;         /* user exists and is allowed to login */
54         int              attempt;
55         int              failures;
56         int              server_caused_failure; 
57         int              force_pwchange;
58         char            *user;          /* username sent by the client */
59         char            *service;
60         struct passwd   *pw;            /* set if 'valid' */
61         char            *style;
62         char            *role;
63         void            *kbdintctxt;
64         void            *jpake_ctx;
65 #ifdef BSD_AUTH
66         auth_session_t  *as;
67 #endif
68 #ifdef KRB5
69         krb5_context     krb5_ctx;
70         krb5_ccache      krb5_fwd_ccache;
71         krb5_principal   krb5_user;
72         char            *krb5_ticket_file;
73         char            *krb5_ccname;
74 #endif
75         Buffer          *loginmsg;
76         void            *methoddata;
77 };
78 /*
79  * Every authentication method has to handle authentication requests for
80  * non-existing users, or for users that are not allowed to login. In this
81  * case 'valid' is set to 0, but 'user' points to the username requested by
82  * the client.
83  */
84
85 struct Authmethod {
86         char    *name;
87         int     (*userauth)(Authctxt *authctxt);
88         int     *enabled;
89 };
90
91 /*
92  * Keyboard interactive device:
93  * init_ctx     returns: non NULL upon success
94  * query        returns: 0 - success, otherwise failure
95  * respond      returns: 0 - success, 1 - need further interaction,
96  *              otherwise - failure
97  */
98 struct KbdintDevice
99 {
100         const char *name;
101         void*   (*init_ctx)(Authctxt*);
102         int     (*query)(void *ctx, char **name, char **infotxt,
103                     u_int *numprompts, char ***prompts, u_int **echo_on);
104         int     (*respond)(void *ctx, u_int numresp, char **responses);
105         void    (*free_ctx)(void *ctx);
106 };
107
108 int      auth_rhosts(struct passwd *, const char *);
109 int
110 auth_rhosts2(struct passwd *, const char *, const char *, const char *);
111
112 int      auth_rhosts_rsa(Authctxt *, char *, Key *);
113 int      auth_password(Authctxt *, const char *);
114 int      auth_rsa(Authctxt *, BIGNUM *);
115 int      auth_rsa_challenge_dialog(Key *);
116 BIGNUM  *auth_rsa_generate_challenge(Key *);
117 int      auth_rsa_verify_response(Key *, BIGNUM *, u_char[]);
118 int      auth_rsa_key_allowed(struct passwd *, BIGNUM *, Key **);
119
120 int      auth_rhosts_rsa_key_allowed(struct passwd *, char *, char *, Key *);
121 int      hostbased_key_allowed(struct passwd *, const char *, char *, Key *);
122 int      user_key_allowed(struct passwd *, Key *);
123
124 #ifdef KRB5
125 int     auth_krb5(Authctxt *authctxt, krb5_data *auth, char **client, krb5_data *);
126 int     auth_krb5_tgt(Authctxt *authctxt, krb5_data *tgt);
127 int     auth_krb5_password(Authctxt *authctxt, const char *password);
128 void    krb5_cleanup_proc(Authctxt *authctxt);
129 #endif /* KRB5 */
130
131 #if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
132 #include <shadow.h>
133 int auth_shadow_acctexpired(struct spwd *);
134 int auth_shadow_pwexpired(Authctxt *);
135 #endif
136
137 #include "auth-pam.h"
138 #include "audit.h"
139 void remove_kbdint_device(const char *);
140
141 void disable_forwarding(void);
142
143 void    do_authentication(Authctxt *);
144 void    do_authentication2(Authctxt *);
145
146 void    auth_log(Authctxt *, int, char *, char *);
147 void    userauth_finish(Authctxt *, int, char *);
148 void    userauth_send_banner(const char *);
149 int     auth_root_allowed(char *);
150
151 char    *auth2_read_banner(void);
152
153 void    privsep_challenge_enable(void);
154
155 int     auth2_challenge(Authctxt *, char *);
156 void    auth2_challenge_stop(Authctxt *);
157 int     bsdauth_query(void *, char **, char **, u_int *, char ***, u_int **);
158 int     bsdauth_respond(void *, u_int, char **);
159 int     skey_query(void *, char **, char **, u_int *, char ***, u_int **);
160 int     skey_respond(void *, u_int, char **);
161
162 void    auth2_jpake_get_pwdata(Authctxt *, BIGNUM **, char **, char **);
163 void    auth2_jpake_stop(Authctxt *);
164
165 int     allowed_user(struct passwd *);
166 struct passwd * getpwnamallow(const char *user);
167
168 char    *get_challenge(Authctxt *);
169 int     verify_response(Authctxt *, const char *);
170 void    abandon_challenge_response(Authctxt *);
171
172 char    *authorized_keys_file(struct passwd *);
173 char    *authorized_keys_file2(struct passwd *);
174 char    *authorized_principals_file(struct passwd *);
175
176 FILE    *auth_openkeyfile(const char *, struct passwd *, int);
177 FILE    *auth_openprincipals(const char *, struct passwd *, int);
178 int      auth_key_is_revoked(Key *, int);
179
180 HostStatus
181 check_key_in_hostfiles(struct passwd *, Key *, const char *,
182     const char *, const char *);
183
184 /* hostkey handling */
185 Key     *get_hostkey_by_index(int);
186 Key     *get_hostkey_public_by_type(int);
187 Key     *get_hostkey_private_by_type(int);
188 int      get_hostkey_index(Key *);
189 int      ssh1_session_key(BIGNUM *);
190
191 /* debug messages during authentication */
192 void     auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
193 void     auth_debug_send(void);
194 void     auth_debug_reset(void);
195
196 struct passwd *fakepw(void);
197
198 int      sys_auth_passwd(Authctxt *, const char *);
199
200 #define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
201
202 #define SKEY_PROMPT "\nS/Key Password: "
203
204 #if defined(KRB5) && !defined(HEIMDAL)
205 #include <krb5.h>
206 krb5_error_code ssh_krb5_cc_gen(krb5_context, krb5_ccache *);
207 #endif
208 #endif