blob: 124e597436f88beebc3d8568d309ba854e07200c [file] [log] [blame]
Damien Miller7cc194f2014-02-04 11:12:56 +11001/* $OpenBSD: auth.h,v 1.77 2014/01/29 06:18:35 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
Damien Miller874d77b2000-10-14 16:23:11 +110045typedef struct Authctxt Authctxt;
Ben Lindstrom511bb242002-06-06 20:52:37 +000046typedef struct Authmethod Authmethod;
Ben Lindstrom551ea372001-06-05 18:56:16 +000047typedef struct KbdintDevice KbdintDevice;
48
Damien Miller874d77b2000-10-14 16:23:11 +110049struct Authctxt {
Damien Miller97c91f62006-04-23 12:08:37 +100050 sig_atomic_t success;
Damien Miller3f8123c2006-08-19 00:32:46 +100051 int authenticated; /* authenticated and alarms cancelled */
Damien Miller8ce778a2003-05-14 13:43:25 +100052 int postponed; /* authentication needs another step */
53 int valid; /* user exists and is allowed to login */
Ben Lindstromec95ed92001-07-04 04:21:14 +000054 int attempt;
55 int failures;
Damien Millerb2da7d12011-05-05 14:04:50 +100056 int server_caused_failure;
Darren Tucker23bc8d02004-02-06 16:24:31 +110057 int force_pwchange;
Damien Miller8ce778a2003-05-14 13:43:25 +100058 char *user; /* username sent by the client */
Ben Lindstromec95ed92001-07-04 04:21:14 +000059 char *service;
Damien Miller8ce778a2003-05-14 13:43:25 +100060 struct passwd *pw; /* set if 'valid' */
Ben Lindstromec95ed92001-07-04 04:21:14 +000061 char *style;
62 void *kbdintctxt;
Darren Tucker0acca372013-06-02 07:41:51 +100063 char *info; /* Extra info for next auth_log */
Damien Miller60396b02001-02-18 17:01:00 +110064#ifdef BSD_AUTH
Ben Lindstromec95ed92001-07-04 04:21:14 +000065 auth_session_t *as;
66#endif
Damien Millera6e3f012012-11-04 23:21:40 +110067 char **auth_methods; /* modified from server config */
68 u_int num_auth_methods;
Ben Lindstromec95ed92001-07-04 04:21:14 +000069#ifdef KRB5
70 krb5_context krb5_ctx;
Ben Lindstromec95ed92001-07-04 04:21:14 +000071 krb5_ccache krb5_fwd_ccache;
72 krb5_principal krb5_user;
73 char *krb5_ticket_file;
Damien Miller9c870f92004-04-16 22:47:55 +100074 char *krb5_ccname;
Damien Miller60396b02001-02-18 17:01:00 +110075#endif
Darren Tuckerf3bb4342005-03-31 21:39:25 +100076 Buffer *loginmsg;
Darren Tucker0efd1552003-08-26 11:49:55 +100077 void *methoddata;
Damien Miller874d77b2000-10-14 16:23:11 +110078};
Damien Miller8ce778a2003-05-14 13:43:25 +100079/*
80 * Every authentication method has to handle authentication requests for
81 * non-existing users, or for users that are not allowed to login. In this
82 * case 'valid' is set to 0, but 'user' points to the username requested by
83 * the client.
84 */
Damien Miller874d77b2000-10-14 16:23:11 +110085
Ben Lindstrom511bb242002-06-06 20:52:37 +000086struct Authmethod {
87 char *name;
88 int (*userauth)(Authctxt *authctxt);
89 int *enabled;
90};
91
Ben Lindstrom226cfa02001-01-22 05:34:40 +000092/*
Ben Lindstrom551ea372001-06-05 18:56:16 +000093 * Keyboard interactive device:
Damien Miller9f0f5c62001-12-21 14:45:46 +110094 * init_ctx returns: non NULL upon success
95 * query returns: 0 - success, otherwise failure
Ben Lindstrom551ea372001-06-05 18:56:16 +000096 * respond returns: 0 - success, 1 - need further interaction,
97 * otherwise - failure
98 */
99struct KbdintDevice
100{
101 const char *name;
Damien Millerb0462112002-02-19 15:24:43 +1100102 void* (*init_ctx)(Authctxt*);
Damien Millera93c6d82002-02-19 15:25:29 +1100103 int (*query)(void *ctx, char **name, char **infotxt,
104 u_int *numprompts, char ***prompts, u_int **echo_on);
Damien Millerb0462112002-02-19 15:24:43 +1100105 int (*respond)(void *ctx, u_int numresp, char **responses);
106 void (*free_ctx)(void *ctx);
Ben Lindstrom551ea372001-06-05 18:56:16 +0000107};
108
Ben Lindstrom08105192002-03-22 02:50:06 +0000109int auth_rhosts(struct passwd *, const char *);
Ben Lindstrom5eabda32001-04-12 23:34:34 +0000110int
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000111auth_rhosts2(struct passwd *, const char *, const char *, const char *);
Ben Lindstrom5eabda32001-04-12 23:34:34 +0000112
Damien Miller3e3b5142003-11-17 21:13:40 +1100113int auth_rhosts_rsa(Authctxt *, char *, Key *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000114int auth_password(Authctxt *, const char *);
Damien Miller3e3b5142003-11-17 21:13:40 +1100115int auth_rsa(Authctxt *, BIGNUM *);
Ben Lindstrom9c8aefe2002-03-22 01:12:58 +0000116int auth_rsa_challenge_dialog(Key *);
Ben Lindstrom08105192002-03-22 02:50:06 +0000117BIGNUM *auth_rsa_generate_challenge(Key *);
118int auth_rsa_verify_response(Key *, BIGNUM *, u_char[]);
119int auth_rsa_key_allowed(struct passwd *, BIGNUM *, Key **);
120
121int auth_rhosts_rsa_key_allowed(struct passwd *, char *, char *, Key *);
122int hostbased_key_allowed(struct passwd *, const char *, char *, Key *);
123int user_key_allowed(struct passwd *, Key *);
Damien Miller20bdcd72013-07-18 16:10:09 +1000124void pubkey_auth_info(Authctxt *, const Key *, const char *, ...)
125 __attribute__((__format__ (printf, 3, 4)));
Ben Lindstrom226cfa02001-01-22 05:34:40 +0000126
Damien Miller09d3e122012-10-31 08:58:58 +1100127struct stat;
128int auth_secure_path(const char *, struct stat *, const char *, uid_t,
129 char *, size_t);
130
Ben Lindstromec95ed92001-07-04 04:21:14 +0000131#ifdef KRB5
Damien Miller25162f22002-09-12 09:47:29 +1000132int auth_krb5(Authctxt *authctxt, krb5_data *auth, char **client, krb5_data *);
Ben Lindstromec95ed92001-07-04 04:21:14 +0000133int auth_krb5_tgt(Authctxt *authctxt, krb5_data *tgt);
134int auth_krb5_password(Authctxt *authctxt, const char *password);
Darren Tucker3e33cec2003-10-02 16:12:36 +1000135void krb5_cleanup_proc(Authctxt *authctxt);
Ben Lindstromec95ed92001-07-04 04:21:14 +0000136#endif /* KRB5 */
137
Darren Tucker15ee7482004-02-22 09:43:15 +1100138#if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
Darren Tuckeraa0aeca2004-02-22 10:22:05 +1100139#include <shadow.h>
Darren Tucker15ee7482004-02-22 09:43:15 +1100140int auth_shadow_acctexpired(struct spwd *);
Darren Tucker9df3def2004-02-10 13:01:14 +1100141int auth_shadow_pwexpired(Authctxt *);
142#endif
143
Damien Millerb8481582000-12-03 11:51:51 +1100144#include "auth-pam.h"
Darren Tucker269a1ea2005-02-03 00:20:53 +1100145#include "audit.h"
Darren Tucker3c660802005-01-20 22:20:50 +1100146void remove_kbdint_device(const char *);
147
Darren Tuckere3dba822004-02-10 12:50:19 +1100148void disable_forwarding(void);
Damien Millerb8481582000-12-03 11:51:51 +1100149
Darren Tuckerec217ad2003-11-22 12:11:06 +1100150void do_authentication(Authctxt *);
151void do_authentication2(Authctxt *);
Damien Millerefb4afe2000-04-12 18:45:05 +1000152
Darren Tucker0acca372013-06-02 07:41:51 +1000153void auth_info(Authctxt *authctxt, const char *, ...)
154 __attribute__((__format__ (printf, 2, 3)))
155 __attribute__((__nonnull__ (2)));
156void auth_log(Authctxt *, int, int, const char *, const char *);
Damien Miller15b05cf2012-12-03 09:53:20 +1100157void userauth_finish(Authctxt *, int, const char *, const char *);
158int auth_root_allowed(const char *);
159
Darren Tucker77fc29e2004-09-11 23:07:03 +1000160void userauth_send_banner(const char *);
Damien Millerb38eff82000-04-01 11:09:21 +1000161
Damien Miller5ad9fd92002-05-13 11:07:41 +1000162char *auth2_read_banner(void);
Damien Millera6e3f012012-11-04 23:21:40 +1100163int auth2_methods_valid(const char *, int);
Damien Miller91a55f22013-04-23 15:18:10 +1000164int auth2_update_methods_lists(Authctxt *, const char *, const char *);
Damien Millera6e3f012012-11-04 23:21:40 +1100165int auth2_setup_methods_lists(Authctxt *);
Damien Miller91a55f22013-04-23 15:18:10 +1000166int auth2_method_allowed(Authctxt *, const char *, const char *);
Damien Miller5ad9fd92002-05-13 11:07:41 +1000167
Ben Lindstrom7a2073c2002-03-22 02:30:41 +0000168void privsep_challenge_enable(void);
169
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000170int auth2_challenge(Authctxt *, char *);
Damien Milleree116252001-12-21 12:42:34 +1100171void auth2_challenge_stop(Authctxt *);
Ben Lindstrom08105192002-03-22 02:50:06 +0000172int bsdauth_query(void *, char **, char **, u_int *, char ***, u_int **);
173int bsdauth_respond(void *, u_int, char **);
174int skey_query(void *, char **, char **, u_int *, char ***, u_int **);
175int skey_respond(void *, u_int, char **);
Damien Miller874d77b2000-10-14 16:23:11 +1100176
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000177int allowed_user(struct passwd *);
Ben Lindstrom2ae18f42002-03-22 01:24:38 +0000178struct passwd * getpwnamallow(const char *user);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000179
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000180char *get_challenge(Authctxt *);
181int verify_response(Authctxt *, const char *);
Damien Miller4f9f42a2003-05-10 19:28:02 +1000182void abandon_challenge_response(Authctxt *);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000183
Damien Millerd8478b62011-05-29 21:39:36 +1000184char *expand_authorized_keys(const char *, struct passwd *pw);
Damien Miller30da3442010-05-10 11:58:03 +1000185char *authorized_principals_file(struct passwd *);
Ben Lindstrombfb3a0e2001-06-05 20:25:05 +0000186
Darren Tucker33c787f2008-07-02 22:37:30 +1000187FILE *auth_openkeyfile(const char *, struct passwd *, int);
Damien Miller30da3442010-05-10 11:58:03 +1000188FILE *auth_openprincipals(const char *, struct passwd *, int);
Damien Miller1aed65e2010-03-04 21:53:35 +1100189int auth_key_is_revoked(Key *);
Ben Lindstrombfb3a0e2001-06-05 20:25:05 +0000190
Ben Lindstrom83647ce2001-06-25 04:30:16 +0000191HostStatus
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000192check_key_in_hostfiles(struct passwd *, Key *, const char *,
193 const char *, const char *);
Ben Lindstrom83647ce2001-06-25 04:30:16 +0000194
Ben Lindstrom08105192002-03-22 02:50:06 +0000195/* hostkey handling */
196Key *get_hostkey_by_index(int);
Damien Miller85b45e02013-07-20 13:21:52 +1000197Key *get_hostkey_public_by_index(int);
Damien Miller0a80ca12010-02-27 07:55:05 +1100198Key *get_hostkey_public_by_type(int);
199Key *get_hostkey_private_by_type(int);
Ben Lindstrom08105192002-03-22 02:50:06 +0000200int get_hostkey_index(Key *);
201int ssh1_session_key(BIGNUM *);
Damien Miller85b45e02013-07-20 13:21:52 +1000202void sshd_hostkey_sign(Key *, Key *, u_char **, u_int *, u_char *, u_int);
Ben Lindstrom08105192002-03-22 02:50:06 +0000203
Ben Lindstroma574cda2002-05-15 16:16:14 +0000204/* debug messages during authentication */
205void auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
206void auth_debug_send(void);
207void auth_debug_reset(void);
208
Damien Miller856f0be2003-09-03 07:32:45 +1000209struct passwd *fakepw(void);
210
Darren Tuckerf3bb4342005-03-31 21:39:25 +1000211int sys_auth_passwd(Authctxt *, const char *);
212
Damien Millereba71ba2000-04-29 23:57:08 +1000213#define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
214
Ben Lindstrom7a2073c2002-03-22 02:30:41 +0000215#define SKEY_PROMPT "\nS/Key Password: "
Darren Tuckera916d142005-07-07 11:50:20 +1000216
217#if defined(KRB5) && !defined(HEIMDAL)
218#include <krb5.h>
219krb5_error_code ssh_krb5_cc_gen(krb5_context, krb5_ccache *);
220#endif
Damien Millerb38eff82000-04-01 11:09:21 +1000221#endif