blob: 6688c3dc56d684d50a29084eecac174669ba7fff [file] [log] [blame]
Damien Miller9f2abc42006-07-10 20:53:08 +10001/* $OpenBSD: auth.h,v 1.54 2006/07/06 16:03:53 stevesk 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 <sys/types.h>
Damien Miller2bdd1c12006-04-23 12:28:53 +100032
Damien Miller9f2abc42006-07-10 20:53:08 +100033#include <signal.h>
34#include <pwd.h>
35
Darren Tuckerf3bb4342005-03-31 21:39:25 +100036#include "buffer.h"
Ben Lindstrom226cfa02001-01-22 05:34:40 +000037#include <openssl/rsa.h>
38
Damien Miller60396b02001-02-18 17:01:00 +110039#ifdef HAVE_LOGIN_CAP
40#include <login_cap.h>
41#endif
42#ifdef BSD_AUTH
43#include <bsd_auth.h>
44#endif
Ben Lindstromec95ed92001-07-04 04:21:14 +000045#ifdef KRB5
46#include <krb5.h>
47#endif
Damien Miller60396b02001-02-18 17:01:00 +110048
Damien Miller9f2abc42006-07-10 20:53:08 +100049#include "key.h"
50#include "hostfile.h"
51
Damien Miller874d77b2000-10-14 16:23:11 +110052typedef struct Authctxt Authctxt;
Ben Lindstrom511bb242002-06-06 20:52:37 +000053typedef struct Authmethod Authmethod;
Ben Lindstrom551ea372001-06-05 18:56:16 +000054typedef struct KbdintDevice KbdintDevice;
55
Damien Miller874d77b2000-10-14 16:23:11 +110056struct Authctxt {
Damien Miller97c91f62006-04-23 12:08:37 +100057 sig_atomic_t success;
Damien Miller8ce778a2003-05-14 13:43:25 +100058 int postponed; /* authentication needs another step */
59 int valid; /* user exists and is allowed to login */
Ben Lindstromec95ed92001-07-04 04:21:14 +000060 int attempt;
61 int failures;
Darren Tucker23bc8d02004-02-06 16:24:31 +110062 int force_pwchange;
Damien Miller8ce778a2003-05-14 13:43:25 +100063 char *user; /* username sent by the client */
Ben Lindstromec95ed92001-07-04 04:21:14 +000064 char *service;
Damien Miller8ce778a2003-05-14 13:43:25 +100065 struct passwd *pw; /* set if 'valid' */
Ben Lindstromec95ed92001-07-04 04:21:14 +000066 char *style;
67 void *kbdintctxt;
Damien Miller60396b02001-02-18 17:01:00 +110068#ifdef BSD_AUTH
Ben Lindstromec95ed92001-07-04 04:21:14 +000069 auth_session_t *as;
70#endif
Ben Lindstromec95ed92001-07-04 04:21:14 +000071#ifdef KRB5
72 krb5_context krb5_ctx;
Ben Lindstromec95ed92001-07-04 04:21:14 +000073 krb5_ccache krb5_fwd_ccache;
74 krb5_principal krb5_user;
75 char *krb5_ticket_file;
Damien Miller9c870f92004-04-16 22:47:55 +100076 char *krb5_ccname;
Damien Miller60396b02001-02-18 17:01:00 +110077#endif
Darren Tuckerf3bb4342005-03-31 21:39:25 +100078 Buffer *loginmsg;
Darren Tucker0efd1552003-08-26 11:49:55 +100079 void *methoddata;
Damien Miller874d77b2000-10-14 16:23:11 +110080};
Damien Miller8ce778a2003-05-14 13:43:25 +100081/*
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.
86 */
Damien Miller874d77b2000-10-14 16:23:11 +110087
Ben Lindstrom511bb242002-06-06 20:52:37 +000088struct Authmethod {
89 char *name;
90 int (*userauth)(Authctxt *authctxt);
91 int *enabled;
92};
93
Ben Lindstrom226cfa02001-01-22 05:34:40 +000094/*
Ben Lindstrom551ea372001-06-05 18:56:16 +000095 * Keyboard interactive device:
Damien Miller9f0f5c62001-12-21 14:45:46 +110096 * init_ctx returns: non NULL upon success
97 * query returns: 0 - success, otherwise failure
Ben Lindstrom551ea372001-06-05 18:56:16 +000098 * respond returns: 0 - success, 1 - need further interaction,
99 * otherwise - failure
100 */
101struct KbdintDevice
102{
103 const char *name;
Damien Millerb0462112002-02-19 15:24:43 +1100104 void* (*init_ctx)(Authctxt*);
Damien Millera93c6d82002-02-19 15:25:29 +1100105 int (*query)(void *ctx, char **name, char **infotxt,
106 u_int *numprompts, char ***prompts, u_int **echo_on);
Damien Millerb0462112002-02-19 15:24:43 +1100107 int (*respond)(void *ctx, u_int numresp, char **responses);
108 void (*free_ctx)(void *ctx);
Ben Lindstrom551ea372001-06-05 18:56:16 +0000109};
110
Ben Lindstrom08105192002-03-22 02:50:06 +0000111int auth_rhosts(struct passwd *, const char *);
Ben Lindstrom5eabda32001-04-12 23:34:34 +0000112int
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000113auth_rhosts2(struct passwd *, const char *, const char *, const char *);
Ben Lindstrom5eabda32001-04-12 23:34:34 +0000114
Damien Miller3e3b5142003-11-17 21:13:40 +1100115int auth_rhosts_rsa(Authctxt *, char *, Key *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000116int auth_password(Authctxt *, const char *);
Damien Miller3e3b5142003-11-17 21:13:40 +1100117int auth_rsa(Authctxt *, BIGNUM *);
Ben Lindstrom9c8aefe2002-03-22 01:12:58 +0000118int auth_rsa_challenge_dialog(Key *);
Ben Lindstrom08105192002-03-22 02:50:06 +0000119BIGNUM *auth_rsa_generate_challenge(Key *);
120int auth_rsa_verify_response(Key *, BIGNUM *, u_char[]);
121int auth_rsa_key_allowed(struct passwd *, BIGNUM *, Key **);
122
123int auth_rhosts_rsa_key_allowed(struct passwd *, char *, char *, Key *);
124int hostbased_key_allowed(struct passwd *, const char *, char *, Key *);
125int user_key_allowed(struct passwd *, Key *);
Ben Lindstrom226cfa02001-01-22 05:34:40 +0000126
Ben Lindstromec95ed92001-07-04 04:21:14 +0000127#ifdef KRB5
Damien Miller25162f22002-09-12 09:47:29 +1000128int auth_krb5(Authctxt *authctxt, krb5_data *auth, char **client, krb5_data *);
Ben Lindstromec95ed92001-07-04 04:21:14 +0000129int auth_krb5_tgt(Authctxt *authctxt, krb5_data *tgt);
130int auth_krb5_password(Authctxt *authctxt, const char *password);
Darren Tucker3e33cec2003-10-02 16:12:36 +1000131void krb5_cleanup_proc(Authctxt *authctxt);
Ben Lindstromec95ed92001-07-04 04:21:14 +0000132#endif /* KRB5 */
133
Darren Tucker15ee7482004-02-22 09:43:15 +1100134#if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
Darren Tuckeraa0aeca2004-02-22 10:22:05 +1100135#include <shadow.h>
Darren Tucker15ee7482004-02-22 09:43:15 +1100136int auth_shadow_acctexpired(struct spwd *);
Darren Tucker9df3def2004-02-10 13:01:14 +1100137int auth_shadow_pwexpired(Authctxt *);
138#endif
139
Damien Millerb8481582000-12-03 11:51:51 +1100140#include "auth-pam.h"
Darren Tucker269a1ea2005-02-03 00:20:53 +1100141#include "audit.h"
Darren Tucker3c660802005-01-20 22:20:50 +1100142void remove_kbdint_device(const char *);
143
Darren Tuckere3dba822004-02-10 12:50:19 +1100144void disable_forwarding(void);
Damien Millerb8481582000-12-03 11:51:51 +1100145
Darren Tuckerec217ad2003-11-22 12:11:06 +1100146void do_authentication(Authctxt *);
147void do_authentication2(Authctxt *);
Damien Millerefb4afe2000-04-12 18:45:05 +1000148
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000149void auth_log(Authctxt *, int, char *, char *);
150void userauth_finish(Authctxt *, int, char *);
Darren Tucker77fc29e2004-09-11 23:07:03 +1000151void userauth_send_banner(const char *);
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000152int auth_root_allowed(char *);
Damien Millerb38eff82000-04-01 11:09:21 +1000153
Damien Miller5ad9fd92002-05-13 11:07:41 +1000154char *auth2_read_banner(void);
155
Ben Lindstrom7a2073c2002-03-22 02:30:41 +0000156void privsep_challenge_enable(void);
157
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000158int auth2_challenge(Authctxt *, char *);
Damien Milleree116252001-12-21 12:42:34 +1100159void auth2_challenge_stop(Authctxt *);
Ben Lindstrom08105192002-03-22 02:50:06 +0000160int bsdauth_query(void *, char **, char **, u_int *, char ***, u_int **);
161int bsdauth_respond(void *, u_int, char **);
162int skey_query(void *, char **, char **, u_int *, char ***, u_int **);
163int skey_respond(void *, u_int, char **);
Damien Miller874d77b2000-10-14 16:23:11 +1100164
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000165int allowed_user(struct passwd *);
Ben Lindstrom2ae18f42002-03-22 01:24:38 +0000166struct passwd * getpwnamallow(const char *user);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000167
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000168char *get_challenge(Authctxt *);
169int verify_response(Authctxt *, const char *);
Damien Miller4f9f42a2003-05-10 19:28:02 +1000170void abandon_challenge_response(Authctxt *);
Ben Lindstromdb65e8f2001-01-19 04:26:52 +0000171
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000172char *authorized_keys_file(struct passwd *);
173char *authorized_keys_file2(struct passwd *);
Ben Lindstrombfb3a0e2001-06-05 20:25:05 +0000174
Ben Lindstrombfb3a0e2001-06-05 20:25:05 +0000175int
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000176secure_filename(FILE *, const char *, struct passwd *, char *, size_t);
Ben Lindstrombfb3a0e2001-06-05 20:25:05 +0000177
Ben Lindstrom83647ce2001-06-25 04:30:16 +0000178HostStatus
Ben Lindstrom16ae3d02001-07-04 04:02:36 +0000179check_key_in_hostfiles(struct passwd *, Key *, const char *,
180 const char *, const char *);
Ben Lindstrom83647ce2001-06-25 04:30:16 +0000181
Ben Lindstrom08105192002-03-22 02:50:06 +0000182/* hostkey handling */
183Key *get_hostkey_by_index(int);
184Key *get_hostkey_by_type(int);
185int get_hostkey_index(Key *);
186int ssh1_session_key(BIGNUM *);
187
Ben Lindstroma574cda2002-05-15 16:16:14 +0000188/* debug messages during authentication */
189void auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
190void auth_debug_send(void);
191void auth_debug_reset(void);
192
Damien Miller856f0be2003-09-03 07:32:45 +1000193struct passwd *fakepw(void);
194
Darren Tuckerf3bb4342005-03-31 21:39:25 +1000195int sys_auth_passwd(Authctxt *, const char *);
196
Damien Millereba71ba2000-04-29 23:57:08 +1000197#define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
198
Ben Lindstrom7a2073c2002-03-22 02:30:41 +0000199#define SKEY_PROMPT "\nS/Key Password: "
Darren Tuckera916d142005-07-07 11:50:20 +1000200
201#if defined(KRB5) && !defined(HEIMDAL)
202#include <krb5.h>
203krb5_error_code ssh_krb5_cc_gen(krb5_context, krb5_ccache *);
204#endif
Damien Millerb38eff82000-04-01 11:09:21 +1000205#endif