xref: /freebsd/crypto/openssh/auth.h (revision d4ecd1085791f1e31b106a2546b08647fd6a2a17)
1d4ecd108SDag-Erling Smørgrav /*	$OpenBSD: auth.h,v 1.51 2005/06/06 11:20:36 djm Exp $	*/
2edb557f8SDag-Erling Smørgrav /*	$FreeBSD$	*/
3af12a3e7SDag-Erling Smørgrav 
4b66f2d16SKris Kennaway /*
5b66f2d16SKris Kennaway  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
6b66f2d16SKris Kennaway  *
7b66f2d16SKris Kennaway  * Redistribution and use in source and binary forms, with or without
8b66f2d16SKris Kennaway  * modification, are permitted provided that the following conditions
9b66f2d16SKris Kennaway  * are met:
10b66f2d16SKris Kennaway  * 1. Redistributions of source code must retain the above copyright
11b66f2d16SKris Kennaway  *    notice, this list of conditions and the following disclaimer.
12b66f2d16SKris Kennaway  * 2. Redistributions in binary form must reproduce the above copyright
13b66f2d16SKris Kennaway  *    notice, this list of conditions and the following disclaimer in the
14b66f2d16SKris Kennaway  *    documentation and/or other materials provided with the distribution.
15b66f2d16SKris Kennaway  *
16b66f2d16SKris Kennaway  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17b66f2d16SKris Kennaway  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18b66f2d16SKris Kennaway  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19b66f2d16SKris Kennaway  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20b66f2d16SKris Kennaway  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21b66f2d16SKris Kennaway  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22b66f2d16SKris Kennaway  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23b66f2d16SKris Kennaway  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24b66f2d16SKris Kennaway  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25b66f2d16SKris Kennaway  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
265b9b2fafSBrian Feldman  *
27b66f2d16SKris Kennaway  */
28af12a3e7SDag-Erling Smørgrav 
29a04a10f8SKris Kennaway #ifndef AUTH_H
30a04a10f8SKris Kennaway #define AUTH_H
31a04a10f8SKris Kennaway 
32af12a3e7SDag-Erling Smørgrav #include "key.h"
33af12a3e7SDag-Erling Smørgrav #include "hostfile.h"
34aa49c926SDag-Erling Smørgrav #include "buffer.h"
351e8db6e2SBrian Feldman #include <openssl/rsa.h>
361e8db6e2SBrian Feldman 
371e8db6e2SBrian Feldman #ifdef HAVE_LOGIN_CAP
381e8db6e2SBrian Feldman #include <login_cap.h>
391e8db6e2SBrian Feldman #endif
401e8db6e2SBrian Feldman #ifdef BSD_AUTH
411e8db6e2SBrian Feldman #include <bsd_auth.h>
421e8db6e2SBrian Feldman #endif
43af12a3e7SDag-Erling Smørgrav #ifdef KRB5
44af12a3e7SDag-Erling Smørgrav #include <krb5.h>
45af12a3e7SDag-Erling Smørgrav #endif
461e8db6e2SBrian Feldman 
475b9b2fafSBrian Feldman typedef struct Authctxt Authctxt;
4880628bacSDag-Erling Smørgrav typedef struct Authmethod Authmethod;
49af12a3e7SDag-Erling Smørgrav typedef struct KbdintDevice KbdintDevice;
50af12a3e7SDag-Erling Smørgrav 
515b9b2fafSBrian Feldman struct Authctxt {
525b9b2fafSBrian Feldman 	int		 success;
53cf2b5f3bSDag-Erling Smørgrav 	int		 postponed;	/* authentication needs another step */
54cf2b5f3bSDag-Erling Smørgrav 	int		 valid;		/* user exists and is allowed to login */
555b9b2fafSBrian Feldman 	int		 attempt;
561e8db6e2SBrian Feldman 	int		 failures;
571ec0d754SDag-Erling Smørgrav 	int		 force_pwchange;
58cf2b5f3bSDag-Erling Smørgrav 	char		*user;		/* username sent by the client */
595b9b2fafSBrian Feldman 	char		*service;
60cf2b5f3bSDag-Erling Smørgrav 	struct passwd	*pw;		/* set if 'valid' */
611e8db6e2SBrian Feldman 	char		*style;
62af12a3e7SDag-Erling Smørgrav 	void		*kbdintctxt;
631e8db6e2SBrian Feldman #ifdef BSD_AUTH
641e8db6e2SBrian Feldman 	auth_session_t	*as;
651e8db6e2SBrian Feldman #endif
66af12a3e7SDag-Erling Smørgrav #ifdef KRB5
67af12a3e7SDag-Erling Smørgrav 	krb5_context	 krb5_ctx;
68af12a3e7SDag-Erling Smørgrav 	krb5_ccache	 krb5_fwd_ccache;
69af12a3e7SDag-Erling Smørgrav 	krb5_principal	 krb5_user;
70af12a3e7SDag-Erling Smørgrav 	char		*krb5_ticket_file;
715962c0e9SDag-Erling Smørgrav 	char		*krb5_ccname;
72af12a3e7SDag-Erling Smørgrav #endif
73aa49c926SDag-Erling Smørgrav 	Buffer		*loginmsg;
74cf2b5f3bSDag-Erling Smørgrav 	void		*methoddata;
755b9b2fafSBrian Feldman };
76cf2b5f3bSDag-Erling Smørgrav /*
77cf2b5f3bSDag-Erling Smørgrav  * Every authentication method has to handle authentication requests for
78cf2b5f3bSDag-Erling Smørgrav  * non-existing users, or for users that are not allowed to login. In this
79cf2b5f3bSDag-Erling Smørgrav  * case 'valid' is set to 0, but 'user' points to the username requested by
80cf2b5f3bSDag-Erling Smørgrav  * the client.
81cf2b5f3bSDag-Erling Smørgrav  */
825b9b2fafSBrian Feldman 
8380628bacSDag-Erling Smørgrav struct Authmethod {
8480628bacSDag-Erling Smørgrav 	char	*name;
8580628bacSDag-Erling Smørgrav 	int	(*userauth)(Authctxt *authctxt);
8680628bacSDag-Erling Smørgrav 	int	*enabled;
8780628bacSDag-Erling Smørgrav };
8880628bacSDag-Erling Smørgrav 
891e8db6e2SBrian Feldman /*
90af12a3e7SDag-Erling Smørgrav  * Keyboard interactive device:
91af12a3e7SDag-Erling Smørgrav  * init_ctx	returns: non NULL upon success
92af12a3e7SDag-Erling Smørgrav  * query	returns: 0 - success, otherwise failure
93af12a3e7SDag-Erling Smørgrav  * respond	returns: 0 - success, 1 - need further interaction,
94af12a3e7SDag-Erling Smørgrav  *		otherwise - failure
951e8db6e2SBrian Feldman  */
96af12a3e7SDag-Erling Smørgrav struct KbdintDevice
97af12a3e7SDag-Erling Smørgrav {
98af12a3e7SDag-Erling Smørgrav 	const char *name;
99af12a3e7SDag-Erling Smørgrav 	void*	(*init_ctx)(Authctxt*);
100af12a3e7SDag-Erling Smørgrav 	int	(*query)(void *ctx, char **name, char **infotxt,
101af12a3e7SDag-Erling Smørgrav 		    u_int *numprompts, char ***prompts, u_int **echo_on);
102af12a3e7SDag-Erling Smørgrav 	int	(*respond)(void *ctx, u_int numresp, char **responses);
103af12a3e7SDag-Erling Smørgrav 	void	(*free_ctx)(void *ctx);
104af12a3e7SDag-Erling Smørgrav };
1051e8db6e2SBrian Feldman 
106af12a3e7SDag-Erling Smørgrav int      auth_rhosts(struct passwd *, const char *);
1071e8db6e2SBrian Feldman int
108af12a3e7SDag-Erling Smørgrav auth_rhosts2(struct passwd *, const char *, const char *, const char *);
1091e8db6e2SBrian Feldman 
1101ec0d754SDag-Erling Smørgrav int	 auth_rhosts_rsa(Authctxt *, char *, Key *);
111af12a3e7SDag-Erling Smørgrav int      auth_password(Authctxt *, const char *);
1121ec0d754SDag-Erling Smørgrav int      auth_rsa(Authctxt *, BIGNUM *);
11380628bacSDag-Erling Smørgrav int      auth_rsa_challenge_dialog(Key *);
11480628bacSDag-Erling Smørgrav BIGNUM	*auth_rsa_generate_challenge(Key *);
11580628bacSDag-Erling Smørgrav int	 auth_rsa_verify_response(Key *, BIGNUM *, u_char[]);
11680628bacSDag-Erling Smørgrav int	 auth_rsa_key_allowed(struct passwd *, BIGNUM *, Key **);
11780628bacSDag-Erling Smørgrav 
11880628bacSDag-Erling Smørgrav int	 auth_rhosts_rsa_key_allowed(struct passwd *, char *, char *, Key *);
11980628bacSDag-Erling Smørgrav int	 hostbased_key_allowed(struct passwd *, const char *, char *, Key *);
12080628bacSDag-Erling Smørgrav int	 user_key_allowed(struct passwd *, Key *);
1211e8db6e2SBrian Feldman 
122af12a3e7SDag-Erling Smørgrav #ifdef KRB5
123f388f5efSDag-Erling Smørgrav int	auth_krb5(Authctxt *authctxt, krb5_data *auth, char **client, krb5_data *);
124af12a3e7SDag-Erling Smørgrav int	auth_krb5_tgt(Authctxt *authctxt, krb5_data *tgt);
125af12a3e7SDag-Erling Smørgrav int	auth_krb5_password(Authctxt *authctxt, const char *password);
1261ec0d754SDag-Erling Smørgrav void	krb5_cleanup_proc(Authctxt *authctxt);
127af12a3e7SDag-Erling Smørgrav #endif /* KRB5 */
128af12a3e7SDag-Erling Smørgrav 
1291ec0d754SDag-Erling Smørgrav #if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
1301ec0d754SDag-Erling Smørgrav #include <shadow.h>
1311ec0d754SDag-Erling Smørgrav int auth_shadow_acctexpired(struct spwd *);
1321ec0d754SDag-Erling Smørgrav int auth_shadow_pwexpired(Authctxt *);
1331ec0d754SDag-Erling Smørgrav #endif
1341ec0d754SDag-Erling Smørgrav 
135989dd127SDag-Erling Smørgrav #include "auth-pam.h"
136aa49c926SDag-Erling Smørgrav #include "audit.h"
137aa49c926SDag-Erling Smørgrav void remove_kbdint_device(const char *);
138aa49c926SDag-Erling Smørgrav 
1391ec0d754SDag-Erling Smørgrav void disable_forwarding(void);
140989dd127SDag-Erling Smørgrav 
1411ec0d754SDag-Erling Smørgrav void	do_authentication(Authctxt *);
1421ec0d754SDag-Erling Smørgrav void	do_authentication2(Authctxt *);
143a04a10f8SKris Kennaway 
144af12a3e7SDag-Erling Smørgrav void	auth_log(Authctxt *, int, char *, char *);
145af12a3e7SDag-Erling Smørgrav void	userauth_finish(Authctxt *, int, char *);
146aa49c926SDag-Erling Smørgrav void	userauth_send_banner(const char *);
147af12a3e7SDag-Erling Smørgrav int	auth_root_allowed(char *);
1485b9b2fafSBrian Feldman 
14980628bacSDag-Erling Smørgrav char	*auth2_read_banner(void);
15080628bacSDag-Erling Smørgrav 
15180628bacSDag-Erling Smørgrav void	privsep_challenge_enable(void);
15280628bacSDag-Erling Smørgrav 
153af12a3e7SDag-Erling Smørgrav int	auth2_challenge(Authctxt *, char *);
154af12a3e7SDag-Erling Smørgrav void	auth2_challenge_stop(Authctxt *);
15580628bacSDag-Erling Smørgrav int	bsdauth_query(void *, char **, char **, u_int *, char ***, u_int **);
15680628bacSDag-Erling Smørgrav int	bsdauth_respond(void *, u_int, char **);
15780628bacSDag-Erling Smørgrav int	skey_query(void *, char **, char **, u_int *, char ***, u_int **);
15880628bacSDag-Erling Smørgrav int	skey_respond(void *, u_int, char **);
159a04a10f8SKris Kennaway 
160af12a3e7SDag-Erling Smørgrav int	allowed_user(struct passwd *);
16180628bacSDag-Erling Smørgrav struct passwd * getpwnamallow(const char *user);
1621e8db6e2SBrian Feldman 
163af12a3e7SDag-Erling Smørgrav char	*get_challenge(Authctxt *);
164af12a3e7SDag-Erling Smørgrav int	verify_response(Authctxt *, const char *);
165fc0824d9SDag-Erling Smørgrav void	abandon_challenge_response(Authctxt *);
1661e8db6e2SBrian Feldman 
167af12a3e7SDag-Erling Smørgrav char	*authorized_keys_file(struct passwd *);
168af12a3e7SDag-Erling Smørgrav char	*authorized_keys_file2(struct passwd *);
169af12a3e7SDag-Erling Smørgrav 
170af12a3e7SDag-Erling Smørgrav int
171af12a3e7SDag-Erling Smørgrav secure_filename(FILE *, const char *, struct passwd *, char *, size_t);
172af12a3e7SDag-Erling Smørgrav 
173af12a3e7SDag-Erling Smørgrav HostStatus
174af12a3e7SDag-Erling Smørgrav check_key_in_hostfiles(struct passwd *, Key *, const char *,
175af12a3e7SDag-Erling Smørgrav     const char *, const char *);
176af12a3e7SDag-Erling Smørgrav 
17780628bacSDag-Erling Smørgrav /* hostkey handling */
17880628bacSDag-Erling Smørgrav Key	*get_hostkey_by_index(int);
17980628bacSDag-Erling Smørgrav Key	*get_hostkey_by_type(int);
18080628bacSDag-Erling Smørgrav int	 get_hostkey_index(Key *);
18180628bacSDag-Erling Smørgrav int	 ssh1_session_key(BIGNUM *);
18280628bacSDag-Erling Smørgrav 
18380628bacSDag-Erling Smørgrav /* debug messages during authentication */
18480628bacSDag-Erling Smørgrav void	 auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
18580628bacSDag-Erling Smørgrav void	 auth_debug_send(void);
18680628bacSDag-Erling Smørgrav void	 auth_debug_reset(void);
18780628bacSDag-Erling Smørgrav 
188cf2b5f3bSDag-Erling Smørgrav struct passwd *fakepw(void);
189cf2b5f3bSDag-Erling Smørgrav 
190aa49c926SDag-Erling Smørgrav int	 sys_auth_passwd(Authctxt *, const char *);
191aa49c926SDag-Erling Smørgrav 
192a04a10f8SKris Kennaway #define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
193a04a10f8SKris Kennaway 
194edb557f8SDag-Erling Smørgrav #ifdef SKEY
195edb557f8SDag-Erling Smørgrav #ifdef OPIE
196edb557f8SDag-Erling Smørgrav #define SKEY_PROMPT "\nOPIE Password: "
197edb557f8SDag-Erling Smørgrav #else
198989dd127SDag-Erling Smørgrav #define SKEY_PROMPT "\nS/Key Password: "
199d4ecd108SDag-Erling Smørgrav 
200d4ecd108SDag-Erling Smørgrav #if defined(KRB5) && !defined(HEIMDAL)
201d4ecd108SDag-Erling Smørgrav #include <krb5.h>
202d4ecd108SDag-Erling Smørgrav krb5_error_code ssh_krb5_cc_gen(krb5_context, krb5_ccache *);
203d4ecd108SDag-Erling Smørgrav #endif
204a04a10f8SKris Kennaway #endif
205edb557f8SDag-Erling Smørgrav #endif
206edb557f8SDag-Erling Smørgrav 
207edb557f8SDag-Erling Smørgrav #endif
208