xref: /freebsd/crypto/openssh/auth.h (revision e146993e33182e13df79b5a957f2734f663fd836)
1*e146993eSDag-Erling Smørgrav /* $OpenBSD: auth.h,v 1.69 2011/05/23 03:30:07 djm Exp $ */
2af12a3e7SDag-Erling Smørgrav 
3b66f2d16SKris Kennaway /*
4b66f2d16SKris Kennaway  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
5b66f2d16SKris Kennaway  *
6b66f2d16SKris Kennaway  * Redistribution and use in source and binary forms, with or without
7b66f2d16SKris Kennaway  * modification, are permitted provided that the following conditions
8b66f2d16SKris Kennaway  * are met:
9b66f2d16SKris Kennaway  * 1. Redistributions of source code must retain the above copyright
10b66f2d16SKris Kennaway  *    notice, this list of conditions and the following disclaimer.
11b66f2d16SKris Kennaway  * 2. Redistributions in binary form must reproduce the above copyright
12b66f2d16SKris Kennaway  *    notice, this list of conditions and the following disclaimer in the
13b66f2d16SKris Kennaway  *    documentation and/or other materials provided with the distribution.
14b66f2d16SKris Kennaway  *
15b66f2d16SKris Kennaway  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16b66f2d16SKris Kennaway  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17b66f2d16SKris Kennaway  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18b66f2d16SKris Kennaway  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19b66f2d16SKris Kennaway  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20b66f2d16SKris Kennaway  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21b66f2d16SKris Kennaway  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22b66f2d16SKris Kennaway  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23b66f2d16SKris Kennaway  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24b66f2d16SKris Kennaway  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
255b9b2fafSBrian Feldman  *
26b66f2d16SKris Kennaway  */
27af12a3e7SDag-Erling Smørgrav 
28a04a10f8SKris Kennaway #ifndef AUTH_H
29a04a10f8SKris Kennaway #define AUTH_H
30a04a10f8SKris Kennaway 
31333ee039SDag-Erling Smørgrav #include <signal.h>
32333ee039SDag-Erling Smørgrav 
331e8db6e2SBrian Feldman #include <openssl/rsa.h>
341e8db6e2SBrian Feldman 
351e8db6e2SBrian Feldman #ifdef HAVE_LOGIN_CAP
361e8db6e2SBrian Feldman #include <login_cap.h>
371e8db6e2SBrian Feldman #endif
381e8db6e2SBrian Feldman #ifdef BSD_AUTH
391e8db6e2SBrian Feldman #include <bsd_auth.h>
401e8db6e2SBrian Feldman #endif
41af12a3e7SDag-Erling Smørgrav #ifdef KRB5
42af12a3e7SDag-Erling Smørgrav #include <krb5.h>
43af12a3e7SDag-Erling Smørgrav #endif
441e8db6e2SBrian Feldman 
455b9b2fafSBrian Feldman typedef struct Authctxt Authctxt;
4680628bacSDag-Erling Smørgrav typedef struct Authmethod Authmethod;
47af12a3e7SDag-Erling Smørgrav typedef struct KbdintDevice KbdintDevice;
48af12a3e7SDag-Erling Smørgrav 
495b9b2fafSBrian Feldman struct Authctxt {
50333ee039SDag-Erling Smørgrav 	sig_atomic_t	 success;
51333ee039SDag-Erling Smørgrav 	int		 authenticated;	/* authenticated and alarms cancelled */
52cf2b5f3bSDag-Erling Smørgrav 	int		 postponed;	/* authentication needs another step */
53cf2b5f3bSDag-Erling Smørgrav 	int		 valid;		/* user exists and is allowed to login */
545b9b2fafSBrian Feldman 	int		 attempt;
551e8db6e2SBrian Feldman 	int		 failures;
56*e146993eSDag-Erling Smørgrav 	int		 server_caused_failure;
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;
63cce7d346SDag-Erling Smørgrav 	void		*jpake_ctx;
641e8db6e2SBrian Feldman #ifdef BSD_AUTH
651e8db6e2SBrian Feldman 	auth_session_t	*as;
661e8db6e2SBrian Feldman #endif
67af12a3e7SDag-Erling Smørgrav #ifdef KRB5
68af12a3e7SDag-Erling Smørgrav 	krb5_context	 krb5_ctx;
69af12a3e7SDag-Erling Smørgrav 	krb5_ccache	 krb5_fwd_ccache;
70af12a3e7SDag-Erling Smørgrav 	krb5_principal	 krb5_user;
71af12a3e7SDag-Erling Smørgrav 	char		*krb5_ticket_file;
725962c0e9SDag-Erling Smørgrav 	char		*krb5_ccname;
73af12a3e7SDag-Erling Smørgrav #endif
74aa49c926SDag-Erling Smørgrav 	Buffer		*loginmsg;
75cf2b5f3bSDag-Erling Smørgrav 	void		*methoddata;
765b9b2fafSBrian Feldman };
77cf2b5f3bSDag-Erling Smørgrav /*
78cf2b5f3bSDag-Erling Smørgrav  * Every authentication method has to handle authentication requests for
79cf2b5f3bSDag-Erling Smørgrav  * non-existing users, or for users that are not allowed to login. In this
80cf2b5f3bSDag-Erling Smørgrav  * case 'valid' is set to 0, but 'user' points to the username requested by
81cf2b5f3bSDag-Erling Smørgrav  * the client.
82cf2b5f3bSDag-Erling Smørgrav  */
835b9b2fafSBrian Feldman 
8480628bacSDag-Erling Smørgrav struct Authmethod {
8580628bacSDag-Erling Smørgrav 	char	*name;
8680628bacSDag-Erling Smørgrav 	int	(*userauth)(Authctxt *authctxt);
8780628bacSDag-Erling Smørgrav 	int	*enabled;
8880628bacSDag-Erling Smørgrav };
8980628bacSDag-Erling Smørgrav 
901e8db6e2SBrian Feldman /*
91af12a3e7SDag-Erling Smørgrav  * Keyboard interactive device:
92af12a3e7SDag-Erling Smørgrav  * init_ctx	returns: non NULL upon success
93af12a3e7SDag-Erling Smørgrav  * query	returns: 0 - success, otherwise failure
94af12a3e7SDag-Erling Smørgrav  * respond	returns: 0 - success, 1 - need further interaction,
95af12a3e7SDag-Erling Smørgrav  *		otherwise - failure
961e8db6e2SBrian Feldman  */
97af12a3e7SDag-Erling Smørgrav struct KbdintDevice
98af12a3e7SDag-Erling Smørgrav {
99af12a3e7SDag-Erling Smørgrav 	const char *name;
100af12a3e7SDag-Erling Smørgrav 	void*	(*init_ctx)(Authctxt*);
101af12a3e7SDag-Erling Smørgrav 	int	(*query)(void *ctx, char **name, char **infotxt,
102af12a3e7SDag-Erling Smørgrav 		    u_int *numprompts, char ***prompts, u_int **echo_on);
103af12a3e7SDag-Erling Smørgrav 	int	(*respond)(void *ctx, u_int numresp, char **responses);
104af12a3e7SDag-Erling Smørgrav 	void	(*free_ctx)(void *ctx);
105af12a3e7SDag-Erling Smørgrav };
1061e8db6e2SBrian Feldman 
107af12a3e7SDag-Erling Smørgrav int      auth_rhosts(struct passwd *, const char *);
1081e8db6e2SBrian Feldman int
109af12a3e7SDag-Erling Smørgrav auth_rhosts2(struct passwd *, const char *, const char *, const char *);
1101e8db6e2SBrian Feldman 
1111ec0d754SDag-Erling Smørgrav int	 auth_rhosts_rsa(Authctxt *, char *, Key *);
112af12a3e7SDag-Erling Smørgrav int      auth_password(Authctxt *, const char *);
1131ec0d754SDag-Erling Smørgrav int      auth_rsa(Authctxt *, BIGNUM *);
11480628bacSDag-Erling Smørgrav int      auth_rsa_challenge_dialog(Key *);
11580628bacSDag-Erling Smørgrav BIGNUM	*auth_rsa_generate_challenge(Key *);
11680628bacSDag-Erling Smørgrav int	 auth_rsa_verify_response(Key *, BIGNUM *, u_char[]);
11780628bacSDag-Erling Smørgrav int	 auth_rsa_key_allowed(struct passwd *, BIGNUM *, Key **);
11880628bacSDag-Erling Smørgrav 
11980628bacSDag-Erling Smørgrav int	 auth_rhosts_rsa_key_allowed(struct passwd *, char *, char *, Key *);
12080628bacSDag-Erling Smørgrav int	 hostbased_key_allowed(struct passwd *, const char *, char *, Key *);
12180628bacSDag-Erling Smørgrav int	 user_key_allowed(struct passwd *, Key *);
1221e8db6e2SBrian Feldman 
123af12a3e7SDag-Erling Smørgrav #ifdef KRB5
124f388f5efSDag-Erling Smørgrav int	auth_krb5(Authctxt *authctxt, krb5_data *auth, char **client, krb5_data *);
125af12a3e7SDag-Erling Smørgrav int	auth_krb5_tgt(Authctxt *authctxt, krb5_data *tgt);
126af12a3e7SDag-Erling Smørgrav int	auth_krb5_password(Authctxt *authctxt, const char *password);
1271ec0d754SDag-Erling Smørgrav void	krb5_cleanup_proc(Authctxt *authctxt);
128af12a3e7SDag-Erling Smørgrav #endif /* KRB5 */
129af12a3e7SDag-Erling Smørgrav 
1301ec0d754SDag-Erling Smørgrav #if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
1311ec0d754SDag-Erling Smørgrav #include <shadow.h>
1321ec0d754SDag-Erling Smørgrav int auth_shadow_acctexpired(struct spwd *);
1331ec0d754SDag-Erling Smørgrav int auth_shadow_pwexpired(Authctxt *);
1341ec0d754SDag-Erling Smørgrav #endif
1351ec0d754SDag-Erling Smørgrav 
136989dd127SDag-Erling Smørgrav #include "auth-pam.h"
137aa49c926SDag-Erling Smørgrav #include "audit.h"
138aa49c926SDag-Erling Smørgrav void remove_kbdint_device(const char *);
139aa49c926SDag-Erling Smørgrav 
1401ec0d754SDag-Erling Smørgrav void disable_forwarding(void);
141989dd127SDag-Erling Smørgrav 
1421ec0d754SDag-Erling Smørgrav void	do_authentication(Authctxt *);
1431ec0d754SDag-Erling Smørgrav void	do_authentication2(Authctxt *);
144a04a10f8SKris Kennaway 
145af12a3e7SDag-Erling Smørgrav void	auth_log(Authctxt *, int, char *, char *);
146af12a3e7SDag-Erling Smørgrav void	userauth_finish(Authctxt *, int, char *);
147aa49c926SDag-Erling Smørgrav void	userauth_send_banner(const char *);
148af12a3e7SDag-Erling Smørgrav int	auth_root_allowed(char *);
1495b9b2fafSBrian Feldman 
15080628bacSDag-Erling Smørgrav char	*auth2_read_banner(void);
15180628bacSDag-Erling Smørgrav 
15280628bacSDag-Erling Smørgrav void	privsep_challenge_enable(void);
15380628bacSDag-Erling Smørgrav 
154af12a3e7SDag-Erling Smørgrav int	auth2_challenge(Authctxt *, char *);
155af12a3e7SDag-Erling Smørgrav void	auth2_challenge_stop(Authctxt *);
15680628bacSDag-Erling Smørgrav int	bsdauth_query(void *, char **, char **, u_int *, char ***, u_int **);
15780628bacSDag-Erling Smørgrav int	bsdauth_respond(void *, u_int, char **);
15880628bacSDag-Erling Smørgrav int	skey_query(void *, char **, char **, u_int *, char ***, u_int **);
15980628bacSDag-Erling Smørgrav int	skey_respond(void *, u_int, char **);
160a04a10f8SKris Kennaway 
161cce7d346SDag-Erling Smørgrav void	auth2_jpake_get_pwdata(Authctxt *, BIGNUM **, char **, char **);
162cce7d346SDag-Erling Smørgrav void	auth2_jpake_stop(Authctxt *);
163cce7d346SDag-Erling Smørgrav 
164af12a3e7SDag-Erling Smørgrav int	allowed_user(struct passwd *);
16580628bacSDag-Erling Smørgrav struct passwd * getpwnamallow(const char *user);
1661e8db6e2SBrian Feldman 
167af12a3e7SDag-Erling Smørgrav char	*get_challenge(Authctxt *);
168af12a3e7SDag-Erling Smørgrav int	verify_response(Authctxt *, const char *);
169fc0824d9SDag-Erling Smørgrav void	abandon_challenge_response(Authctxt *);
1701e8db6e2SBrian Feldman 
171*e146993eSDag-Erling Smørgrav char	*expand_authorized_keys(const char *, struct passwd *pw);
172e2f6069cSDag-Erling Smørgrav char	*authorized_principals_file(struct passwd *);
173af12a3e7SDag-Erling Smørgrav 
174d4af9e69SDag-Erling Smørgrav FILE	*auth_openkeyfile(const char *, struct passwd *, int);
175e2f6069cSDag-Erling Smørgrav FILE	*auth_openprincipals(const char *, struct passwd *, int);
176b15c8340SDag-Erling Smørgrav int	 auth_key_is_revoked(Key *);
177af12a3e7SDag-Erling Smørgrav 
178af12a3e7SDag-Erling Smørgrav HostStatus
179af12a3e7SDag-Erling Smørgrav check_key_in_hostfiles(struct passwd *, Key *, const char *,
180af12a3e7SDag-Erling Smørgrav     const char *, const char *);
181af12a3e7SDag-Erling Smørgrav 
18280628bacSDag-Erling Smørgrav /* hostkey handling */
18380628bacSDag-Erling Smørgrav Key	*get_hostkey_by_index(int);
184b15c8340SDag-Erling Smørgrav Key	*get_hostkey_public_by_type(int);
185b15c8340SDag-Erling Smørgrav Key	*get_hostkey_private_by_type(int);
18680628bacSDag-Erling Smørgrav int	 get_hostkey_index(Key *);
18780628bacSDag-Erling Smørgrav int	 ssh1_session_key(BIGNUM *);
18880628bacSDag-Erling Smørgrav 
18980628bacSDag-Erling Smørgrav /* debug messages during authentication */
19080628bacSDag-Erling Smørgrav void	 auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
19180628bacSDag-Erling Smørgrav void	 auth_debug_send(void);
19280628bacSDag-Erling Smørgrav void	 auth_debug_reset(void);
19380628bacSDag-Erling Smørgrav 
194cf2b5f3bSDag-Erling Smørgrav struct passwd *fakepw(void);
195cf2b5f3bSDag-Erling Smørgrav 
196aa49c926SDag-Erling Smørgrav int	 sys_auth_passwd(Authctxt *, const char *);
197aa49c926SDag-Erling Smørgrav 
198a04a10f8SKris Kennaway #define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
199a04a10f8SKris Kennaway 
200989dd127SDag-Erling Smørgrav #define SKEY_PROMPT "\nS/Key Password: "
201d4ecd108SDag-Erling Smørgrav 
202d4ecd108SDag-Erling Smørgrav #if defined(KRB5) && !defined(HEIMDAL)
203d4ecd108SDag-Erling Smørgrav #include <krb5.h>
204d4ecd108SDag-Erling Smørgrav krb5_error_code ssh_krb5_cc_gen(krb5_context, krb5_ccache *);
205d4ecd108SDag-Erling Smørgrav #endif
206a04a10f8SKris Kennaway #endif
207