blob: b235906cf9ba1cecfe4059ec5f056bf3e6de9bd5 [file] [log] [blame]
djm@openbsd.org7d4c7512015-11-11 01:48:01 +00001/* $OpenBSD: auth.h,v 1.85 2015/11/11 01:48:01 djm Exp $ */
Ben Lindstrom05764b92002-03-05 01:53:02 +00002
Damien Millere4340be2000-09-16 13:29:08 +11003/*
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.
Ben Lindstrom4dccfa52000-12-28 16:40:05 +000025 *
Damien Millere4340be2000-09-16 13:29:08 +110026 */
Ben Lindstrom05764b92002-03-05 01:53:02 +000027
Damien Millerb38eff82000-04-01 11:09:21 +100028#ifndef AUTH_H
29#define AUTH_H
30
Damien Miller9f2abc42006-07-10 20:53:08 +100031#include <signal.h>
Damien Miller9f2abc42006-07-10 20:53:08 +100032
Ben Lindstrom226cfa02001-01-22 05:34:40 +000033#include <openssl/rsa.h>
34
Damien Miller60396b02001-02-18 17:01:00 +110035#ifdef HAVE_LOGIN_CAP
36#include <login_cap.h>
37#endif
38#ifdef BSD_AUTH
39#include <bsd_auth.h>
40#endif
Ben Lindstromec95ed92001-07-04 04:21:14 +000041#ifdef KRB5
42#include <krb5.h>
43#endif
Damien Miller60396b02001-02-18 17:01:00 +110044
markus@openbsd.org57d10cb2015-01-19 20:16:15 +000045struct ssh;
djm@openbsd.orgf69b69b2014-12-22 07:51:30 +000046struct sshkey;
47
Damien Miller874d77b2000-10-14 16:23:11 +110048typedef struct Authctxt Authctxt;
Ben Lindstrom511bb242002-06-06 20:52:37 +000049typedef struct Authmethod Authmethod;
Ben Lindstrom551ea372001-06-05 18:56:16 +000050typedef struct KbdintDevice KbdintDevice;
51
Damien Miller874d77b2000-10-14 16:23:11 +110052struct Authctxt {
Damien Miller97c91f62006-04-23 12:08:37 +100053 sig_atomic_t success;
Damien Miller3f8123c2006-08-19 00:32:46 +100054 int authenticated; /* authenticated and alarms cancelled */
Damien Miller8ce778a2003-05-14 13:43:25 +100055 int postponed; /* authentication needs another step */
56 int valid; /* user exists and is allowed to login */
Ben Lindstromec95ed92001-07-04 04:21:14 +000057 int attempt;
58 int failures;
djm@openbsd.org2b64c492015-05-08 06:41:56 +000059 int server_caused_failure;
Darren Tucker23bc8d02004-02-06 16:24:31 +110060 int force_pwchange;
Damien Miller8ce778a2003-05-14 13:43:25 +100061 char *user; /* username sent by the client */
Ben Lindstromec95ed92001-07-04 04:21:14 +000062 char *service;
Damien Miller8ce778a2003-05-14 13:43:25 +100063 struct passwd *pw; /* set if 'valid' */
Ben Lindstromec95ed92001-07-04 04:21:14 +000064 char *style;
65 void *kbdintctxt;
Darren Tucker0acca372013-06-02 07:41:51 +100066 char *info; /* Extra info for next auth_log */
Damien Miller60396b02001-02-18 17:01:00 +110067#ifdef BSD_AUTH
Ben Lindstromec95ed92001-07-04 04:21:14 +000068 auth_session_t *as;
69#endif
Damien Millera6e3f012012-11-04 23:21:40 +110070 char **auth_methods; /* modified from server config */
71 u_int num_auth_methods;
Ben Lindstromec95ed92001-07-04 04:21:14 +000072#ifdef KRB5
73 krb5_context krb5_ctx;
Ben Lindstromec95ed92001-07-04 04:21:14 +000074 krb5_ccache krb5_fwd_ccache;
75 krb5_principal krb5_user;
76 char *krb5_ticket_file;
Damien Miller9c870f92004-04-16 22:47:55 +100077 char *krb5_ccname;
Damien Miller60396b02001-02-18 17:01:00 +110078#endif
Darren Tuckerf3bb4342005-03-31 21:39:25 +100079 Buffer *loginmsg;
Darren Tucker0efd1552003-08-26 11:49:55 +100080 void *methoddata;
djm@openbsd.orgf69b69b2014-12-22 07:51:30 +000081
82 struct sshkey **prev_userkeys;
83 u_int nprev_userkeys;
Damien Miller874d77b2000-10-14 16:23:11 +110084};
Damien Miller8ce778a2003-05-14 13:43:25 +100085/*
86 * Every authentication method has to handle authentication requests for
87 * non-existing users, or for users that are not allowed to login. In this
88 * case 'valid' is set to 0, but 'user' points to the username requested by
89 * the client.
90 */
Damien Miller874d77b2000-10-14 16:23:11 +110091
Ben Lindstrom511bb242002-06-06 20:52:37 +000092struct Authmethod {
93 char *name;
94 int (*userauth)(Authctxt *authctxt);
95 int *enabled;
96};
97
Ben Lindstrom226cfa02001-01-22 05:34:40 +000098/*
Ben Lindstrom551ea372001-06-05 18:56:16 +000099 * Keyboard interactive device:
Damien Miller9f0f5c62001-12-21 14:45:46 +1100100 * init_ctx returns: non NULL upon success
101 * query returns: 0 - success, otherwise failure
Ben Lindstrom551ea372001-06-05 18:56:16 +0000102 * respond returns: 0 - success, 1 - need further interaction,
103 * otherwise - failure
104 */
105struct KbdintDevice
106{
107 const char *name;
Damien Millerb0462112002-02-19 15:24:43 +1100108 void* (*init_ctx)(Authctxt*);
Damien Millera93c6d82002-02-19 15:25:29 +1100109 int (*query)(void *ctx, char **name, char **infotxt,
110 u_int *numprompts, char ***prompts, u_int **echo_on);
Damien Millerb0462112002-02-19 15:24:43 +1100111 int (*respond)(void *ctx, u_int numresp, char **responses);
112 void (*free_ctx)(void *ctx);
Ben Lindstrom551ea372001-06-05 18:56:16 +0000113};
114
Ben Lindstrom08105192002-03-22 02:50:06 +0000115int auth_rhosts(struct passwd *, const char *);
Ben Lindstrom5eabda32001-04-12 23:34:34 +0000116int
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000117auth_rhosts2(struct passwd *, const char *, const char *, const char *);
Ben Lindstrom5eabda32001-04-12 23:34:34 +0000118
Damien Miller3e3b5142003-11-17 21:13:40 +1100119int auth_rhosts_rsa(Authctxt *, char *, Key *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000120int auth_password(Authctxt *, const char *);
Damien Miller3e3b5142003-11-17 21:13:40 +1100121int auth_rsa(Authctxt *, BIGNUM *);
Ben Lindstrom9c8aefe2002-03-22 01:12:58 +0000122int auth_rsa_challenge_dialog(Key *);
Ben Lindstrom08105192002-03-22 02:50:06 +0000123BIGNUM *auth_rsa_generate_challenge(Key *);
124int auth_rsa_verify_response(Key *, BIGNUM *, u_char[]);
125int auth_rsa_key_allowed(struct passwd *, BIGNUM *, Key **);
126
127int auth_rhosts_rsa_key_allowed(struct passwd *, char *, char *, Key *);
128int hostbased_key_allowed(struct passwd *, const char *, char *, Key *);
djm@openbsd.org179be0f2015-05-01 03:23:51 +0000129int user_key_allowed(struct passwd *, Key *, int);
Damien Miller20bdcd72013-07-18 16:10:09 +1000130void pubkey_auth_info(Authctxt *, const Key *, const char *, ...)
131 __attribute__((__format__ (printf, 3, 4)));
djm@openbsd.orgf69b69b2014-12-22 07:51:30 +0000132void auth2_record_userkey(Authctxt *, struct sshkey *);
133int auth2_userkey_already_used(Authctxt *, struct sshkey *);
Ben Lindstrom226cfa02001-01-22 05:34:40 +0000134
Damien Miller09d3e122012-10-31 08:58:58 +1100135struct stat;
136int auth_secure_path(const char *, struct stat *, const char *, uid_t,
137 char *, size_t);
138
Ben Lindstromec95ed92001-07-04 04:21:14 +0000139#ifdef KRB5
Damien Miller25162f22002-09-12 09:47:29 +1000140int auth_krb5(Authctxt *authctxt, krb5_data *auth, char **client, krb5_data *);
Ben Lindstromec95ed92001-07-04 04:21:14 +0000141int auth_krb5_tgt(Authctxt *authctxt, krb5_data *tgt);
142int auth_krb5_password(Authctxt *authctxt, const char *password);
Darren Tucker3e33cec2003-10-02 16:12:36 +1000143void krb5_cleanup_proc(Authctxt *authctxt);
Ben Lindstromec95ed92001-07-04 04:21:14 +0000144#endif /* KRB5 */
145
Darren Tucker15ee7482004-02-22 09:43:15 +1100146#if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
Darren Tuckeraa0aeca2004-02-22 10:22:05 +1100147#include <shadow.h>
Darren Tucker15ee7482004-02-22 09:43:15 +1100148int auth_shadow_acctexpired(struct spwd *);
Darren Tucker9df3def2004-02-10 13:01:14 +1100149int auth_shadow_pwexpired(Authctxt *);
150#endif
151
Damien Millerb8481582000-12-03 11:51:51 +1100152#include "auth-pam.h"
Darren Tucker269a1ea2005-02-03 00:20:53 +1100153#include "audit.h"
Darren Tucker3c660802005-01-20 22:20:50 +1100154void remove_kbdint_device(const char *);
155
Darren Tuckere3dba822004-02-10 12:50:19 +1100156void disable_forwarding(void);
Damien Millerb8481582000-12-03 11:51:51 +1100157
Darren Tuckerec217ad2003-11-22 12:11:06 +1100158void do_authentication(Authctxt *);
159void do_authentication2(Authctxt *);
Damien Millerefb4afe2000-04-12 18:45:05 +1000160
Darren Tucker0acca372013-06-02 07:41:51 +1000161void auth_info(Authctxt *authctxt, const char *, ...)
162 __attribute__((__format__ (printf, 2, 3)))
163 __attribute__((__nonnull__ (2)));
164void auth_log(Authctxt *, int, int, const char *, const char *);
Damien Miller686feb52014-07-03 21:29:38 +1000165void auth_maxtries_exceeded(Authctxt *) __attribute__((noreturn));
Damien Miller15b05cf2012-12-03 09:53:20 +1100166void userauth_finish(Authctxt *, int, const char *, const char *);
167int auth_root_allowed(const char *);
168
Darren Tucker77fc29e2004-09-11 23:07:03 +1000169void userauth_send_banner(const char *);
Damien Millerb38eff82000-04-01 11:09:21 +1000170
Damien Miller5ad9fd92002-05-13 11:07:41 +1000171char *auth2_read_banner(void);
Damien Millera6e3f012012-11-04 23:21:40 +1100172int auth2_methods_valid(const char *, int);
Damien Miller91a55f22013-04-23 15:18:10 +1000173int auth2_update_methods_lists(Authctxt *, const char *, const char *);
Damien Millera6e3f012012-11-04 23:21:40 +1100174int auth2_setup_methods_lists(Authctxt *);
Damien Miller91a55f22013-04-23 15:18:10 +1000175int auth2_method_allowed(Authctxt *, const char *, const char *);
Damien Miller5ad9fd92002-05-13 11:07:41 +1000176
Ben Lindstrom7a2073c2002-03-22 02:30:41 +0000177void privsep_challenge_enable(void);
178
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000179int auth2_challenge(Authctxt *, char *);
Damien Milleree116252001-12-21 12:42:34 +1100180void auth2_challenge_stop(Authctxt *);
Ben Lindstrom08105192002-03-22 02:50:06 +0000181int bsdauth_query(void *, char **, char **, u_int *, char ***, u_int **);
182int bsdauth_respond(void *, u_int, char **);
Damien Miller6283cc72015-11-30 10:37:03 +1100183int skey_query(void *, char **, char **, u_int *, char ***, u_int **);
184int skey_respond(void *, u_int, char **);
Damien Miller874d77b2000-10-14 16:23:11 +1100185
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000186int allowed_user(struct passwd *);
Ben Lindstrom2ae18f42002-03-22 01:24:38 +0000187struct passwd * getpwnamallow(const char *user);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000188
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000189char *get_challenge(Authctxt *);
190int verify_response(Authctxt *, const char *);
Damien Miller4f9f42a2003-05-10 19:28:02 +1000191void abandon_challenge_response(Authctxt *);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000192
Damien Millerd8478b62011-05-29 21:39:36 +1000193char *expand_authorized_keys(const char *, struct passwd *pw);
Damien Miller30da3442010-05-10 11:58:03 +1000194char *authorized_principals_file(struct passwd *);
Ben Lindstrombfb3a0e2001-06-05 20:25:05 +0000195
Darren Tucker33c787f2008-07-02 22:37:30 +1000196FILE *auth_openkeyfile(const char *, struct passwd *, int);
Damien Miller30da3442010-05-10 11:58:03 +1000197FILE *auth_openprincipals(const char *, struct passwd *, int);
Damien Miller1aed65e2010-03-04 21:53:35 +1100198int auth_key_is_revoked(Key *);
Ben Lindstrombfb3a0e2001-06-05 20:25:05 +0000199
Ben Lindstrom83647ce2001-06-25 04:30:16 +0000200HostStatus
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000201check_key_in_hostfiles(struct passwd *, Key *, const char *,
202 const char *, const char *);
Ben Lindstrom83647ce2001-06-25 04:30:16 +0000203
Ben Lindstrom08105192002-03-22 02:50:06 +0000204/* hostkey handling */
205Key *get_hostkey_by_index(int);
markus@openbsd.org57d10cb2015-01-19 20:16:15 +0000206Key *get_hostkey_public_by_index(int, struct ssh *);
djm@openbsd.org5104db72015-01-26 06:10:03 +0000207Key *get_hostkey_public_by_type(int, int, struct ssh *);
208Key *get_hostkey_private_by_type(int, int, struct ssh *);
djm@openbsd.org523463a2015-02-16 22:13:32 +0000209int get_hostkey_index(Key *, int, struct ssh *);
Ben Lindstrom08105192002-03-22 02:50:06 +0000210int ssh1_session_key(BIGNUM *);
djm@openbsd.org523463a2015-02-16 22:13:32 +0000211int sshd_hostkey_sign(Key *, Key *, u_char **, size_t *,
212 const u_char *, size_t, u_int);
Ben Lindstrom08105192002-03-22 02:50:06 +0000213
Ben Lindstroma574cda2002-05-15 16:16:14 +0000214/* debug messages during authentication */
215void auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
216void auth_debug_send(void);
217void auth_debug_reset(void);
218
Damien Miller856f0be2003-09-03 07:32:45 +1000219struct passwd *fakepw(void);
220
Darren Tuckerf3bb4342005-03-31 21:39:25 +1000221int sys_auth_passwd(Authctxt *, const char *);
222
Ben Lindstrom7a2073c2002-03-22 02:30:41 +0000223#define SKEY_PROMPT "\nS/Key Password: "
Darren Tuckera916d142005-07-07 11:50:20 +1000224
225#if defined(KRB5) && !defined(HEIMDAL)
226#include <krb5.h>
227krb5_error_code ssh_krb5_cc_gen(krb5_context, krb5_ccache *);
228#endif
Damien Millerb38eff82000-04-01 11:09:21 +1000229#endif