[openssh.git] / auth.h

/* $OpenBSD: auth.h,v 1.57 2006/08/03 03:34:41 deraadt Exp $ */

/*
 * Copyright (c) 2000 Markus Friedl.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef AUTH_H
#define AUTH_H

#include <signal.h>

#include <openssl/rsa.h>

#ifdef HAVE_LOGIN_CAP
#include <login_cap.h>
#endif
#ifdef BSD_AUTH
#include <bsd_auth.h>
#endif
#ifdef KRB5
#include <krb5.h>
#endif

typedef struct Authctxt Authctxt;
typedef struct Authmethod Authmethod;
typedef struct KbdintDevice KbdintDevice;

struct Authctxt {
	sig_atomic_t	 success;
	int		 postponed;	/* authentication needs another step */
	int		 valid;		/* user exists and is allowed to login */
	int		 attempt;
	int		 failures;
	int		 force_pwchange;
	char		*user;		/* username sent by the client */
	char		*service;
	struct passwd	*pw;		/* set if 'valid' */
	char		*style;
	void		*kbdintctxt;
#ifdef BSD_AUTH
	auth_session_t	*as;
#endif
#ifdef KRB5
	krb5_context	 krb5_ctx;
	krb5_ccache	 krb5_fwd_ccache;
	krb5_principal	 krb5_user;
	char		*krb5_ticket_file;
	char		*krb5_ccname;
#endif
	Buffer		*loginmsg;
	void		*methoddata;
};
/*
 * Every authentication method has to handle authentication requests for
 * non-existing users, or for users that are not allowed to login. In this
 * case 'valid' is set to 0, but 'user' points to the username requested by
 * the client.
 */

struct Authmethod {
	char	*name;
	int	(*userauth)(Authctxt *authctxt);
	int	*enabled;
};

/*
 * Keyboard interactive device:
 * init_ctx	returns: non NULL upon success
 * query	returns: 0 - success, otherwise failure
 * respond	returns: 0 - success, 1 - need further interaction,
 *		otherwise - failure
 */
struct KbdintDevice
{
	const char *name;
	void*	(*init_ctx)(Authctxt*);
	int	(*query)(void *ctx, char **name, char **infotxt,
		    u_int *numprompts, char ***prompts, u_int **echo_on);
	int	(*respond)(void *ctx, u_int numresp, char **responses);
	void	(*free_ctx)(void *ctx);
};

int      auth_rhosts(struct passwd *, const char *);
int
auth_rhosts2(struct passwd *, const char *, const char *, const char *);

int	 auth_rhosts_rsa(Authctxt *, char *, Key *);
int      auth_password(Authctxt *, const char *);
int      auth_rsa(Authctxt *, BIGNUM *);
int      auth_rsa_challenge_dialog(Key *);
BIGNUM	*auth_rsa_generate_challenge(Key *);
int	 auth_rsa_verify_response(Key *, BIGNUM *, u_char[]);
int	 auth_rsa_key_allowed(struct passwd *, BIGNUM *, Key **);

int	 auth_rhosts_rsa_key_allowed(struct passwd *, char *, char *, Key *);
int	 hostbased_key_allowed(struct passwd *, const char *, char *, Key *);
int	 user_key_allowed(struct passwd *, Key *);

#ifdef KRB5
int	auth_krb5(Authctxt *authctxt, krb5_data *auth, char **client, krb5_data *);
int	auth_krb5_tgt(Authctxt *authctxt, krb5_data *tgt);
int	auth_krb5_password(Authctxt *authctxt, const char *password);
void	krb5_cleanup_proc(Authctxt *authctxt);
#endif /* KRB5 */

#if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
#include <shadow.h>
int auth_shadow_acctexpired(struct spwd *);
int auth_shadow_pwexpired(Authctxt *);
#endif

#include "auth-pam.h"
#include "audit.h"
void remove_kbdint_device(const char *);

void disable_forwarding(void);

void	do_authentication(Authctxt *);
void	do_authentication2(Authctxt *);

void	auth_log(Authctxt *, int, char *, char *);
void	userauth_finish(Authctxt *, int, char *);
void	userauth_send_banner(const char *);
int	auth_root_allowed(char *);

char	*auth2_read_banner(void);

void	privsep_challenge_enable(void);

int	auth2_challenge(Authctxt *, char *);
void	auth2_challenge_stop(Authctxt *);
int	bsdauth_query(void *, char **, char **, u_int *, char ***, u_int **);
int	bsdauth_respond(void *, u_int, char **);
int	skey_query(void *, char **, char **, u_int *, char ***, u_int **);
int	skey_respond(void *, u_int, char **);

int	allowed_user(struct passwd *);
struct passwd * getpwnamallow(const char *user);

char	*get_challenge(Authctxt *);
int	verify_response(Authctxt *, const char *);
void	abandon_challenge_response(Authctxt *);

char	*authorized_keys_file(struct passwd *);
char	*authorized_keys_file2(struct passwd *);

int
secure_filename(FILE *, const char *, struct passwd *, char *, size_t);

HostStatus
check_key_in_hostfiles(struct passwd *, Key *, const char *,
    const char *, const char *);

/* hostkey handling */
Key	*get_hostkey_by_index(int);
Key	*get_hostkey_by_type(int);
int	 get_hostkey_index(Key *);
int	 ssh1_session_key(BIGNUM *);

/* debug messages during authentication */
void	 auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
void	 auth_debug_send(void);
void	 auth_debug_reset(void);

struct passwd *fakepw(void);

int	 sys_auth_passwd(Authctxt *, const char *);

#define AUTH_FAIL_MSG "Too many authentication failures for %.100s"

#define SKEY_PROMPT "\nS/Key Password: "

#if defined(KRB5) && !defined(HEIMDAL)
#include <krb5.h>
krb5_error_code ssh_krb5_cc_gen(krb5_context, krb5_ccache *);
#endif
#endif
Commit	Line	Data
31652869	1	/* $OpenBSD: auth.h,v 1.57 2006/08/03 03:34:41 deraadt Exp $ */
93c3b6de	2
bcbf86ec	3	/*
	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.
8abcdba4	25	*
bcbf86ec	26	*/
93c3b6de	27
7368a6c8	28	#ifndef AUTH_H
	29	#define AUTH_H
	30
519fc2b7	31	#include <signal.h>
0ca1dcaf	32
42f11eb2	33	#include <openssl/rsa.h>
42f11eb2	34
af774732	35	#ifdef HAVE_LOGIN_CAP
	36	#include <login_cap.h>
	37	#endif
	38	#ifdef BSD_AUTH
	39	#include <bsd_auth.h>
	40	#endif
ced49be2	41	#ifdef KRB5
	42	#include <krb5.h>
	43	#endif
af774732	44
94ec8c6b	45	typedef struct Authctxt Authctxt;
01c24737	46	typedef struct Authmethod Authmethod;
5ba55ada	47	typedef struct KbdintDevice KbdintDevice;
5ba55ada	48
94ec8c6b	49	struct Authctxt {
50394f26	50	sig_atomic_t success;
927e9f8b	51	int postponed; /* authentication needs another step */
927e9f8b	52	int valid; /* user exists and is allowed to login */
ced49be2	53	int attempt;
ced49be2	54	int failures;
37656beb	55	int force_pwchange;
927e9f8b	56	char user; / username sent by the client */
ced49be2	57	char *service;
927e9f8b	58	struct passwd pw; / set if 'valid' */
ced49be2	59	char *style;
ced49be2	60	void *kbdintctxt;
af774732	61	#ifdef BSD_AUTH
ced49be2	62	auth_session_t *as;
ced49be2	63	#endif
ced49be2	64	#ifdef KRB5
ced49be2	65	krb5_context krb5_ctx;
ced49be2	66	krb5_ccache krb5_fwd_ccache;
	67	krb5_principal krb5_user;
	68	char *krb5_ticket_file;
6490a5d5	69	char *krb5_ccname;
af774732	70	#endif
1b394137	71	Buffer *loginmsg;
7364bd04	72	void *methoddata;
94ec8c6b	73	};
927e9f8b	74	/*
	75	* Every authentication method has to handle authentication requests for
	76	* non-existing users, or for users that are not allowed to login. In this
	77	* case 'valid' is set to 0, but 'user' points to the username requested by
	78	* the client.
	79	*/
94ec8c6b	80
01c24737	81	struct Authmethod {
	82	char *name;
	83	int (userauth)(Authctxt authctxt);
	84	int *enabled;
	85	};
	86
5ba55ada	87	/*
5ba55ada	88	* Keyboard interactive device:
184eed6a	89	* init_ctx returns: non NULL upon success
184eed6a	90	* query returns: 0 - success, otherwise failure
5ba55ada	91	* respond returns: 0 - success, 1 - need further interaction,
	92	* otherwise - failure
	93	*/
	94	struct KbdintDevice
	95	{
	96	const char *name;
ef2839b9	97	void* (init_ctx)(Authctxt);
d96be24d	98	int (query)(void ctx, char name, char infotxt,
d96be24d	99	u_int numprompts, char prompts, u_int echo_on);
ef2839b9	100	int (respond)(void ctx, u_int numresp, char **responses);
ef2839b9	101	void (free_ctx)(void ctx);
5ba55ada	102	};
5ba55ada	103
51aeb639	104	int auth_rhosts(struct passwd , const char );
8002af61	105	int
2a1e4639	106	auth_rhosts2(struct passwd , const char , const char , const char );
8002af61	107
fdaef11e	108	int auth_rhosts_rsa(Authctxt , char , Key *);
255cabd9	109	int auth_password(Authctxt , const char );
fdaef11e	110	int auth_rsa(Authctxt , BIGNUM );
46f1eece	111	int auth_rsa_challenge_dialog(Key *);
51aeb639	112	BIGNUM auth_rsa_generate_challenge(Key );
	113	int auth_rsa_verify_response(Key , BIGNUM , u_char[]);
	114	int auth_rsa_key_allowed(struct passwd , BIGNUM , Key **);
	115
	116	int auth_rhosts_rsa_key_allowed(struct passwd , char , char , Key );
	117	int hostbased_key_allowed(struct passwd , const char , char , Key );
	118	int user_key_allowed(struct passwd , Key );
42f11eb2	119
ced49be2	120	#ifdef KRB5
696f6bef	121	int auth_krb5(Authctxt authctxt, krb5_data auth, char *client, krb5_data );
ced49be2	122	int auth_krb5_tgt(Authctxt authctxt, krb5_data tgt);
ced49be2	123	int auth_krb5_password(Authctxt authctxt, const char password);
2362db19	124	void krb5_cleanup_proc(Authctxt *authctxt);
ced49be2	125	#endif /* KRB5 */
ced49be2	126
f14ca4a4	127	#if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
8318c702	128	#include <shadow.h>
f14ca4a4	129	int auth_shadow_acctexpired(struct spwd *);
5a8bd0c3	130	int auth_shadow_pwexpired(Authctxt *);
	131	#endif
	132
8c9fe09e	133	#include "auth-pam.h"
c00e4d75	134	#include "audit.h"
c384a74c	135	void remove_kbdint_device(const char *);
c384a74c	136
cadfc759	137	void disable_forwarding(void);
8c9fe09e	138
bd7af13d	139	void do_authentication(Authctxt *);
bd7af13d	140	void do_authentication2(Authctxt *);
e78a59f5	141
2a1e4639	142	void auth_log(Authctxt , int, char , char *);
2a1e4639	143	void userauth_finish(Authctxt , int, char );
ba6dd90e	144	void userauth_send_banner(const char *);
2a1e4639	145	int auth_root_allowed(char *);
94ec8c6b	146
94a73cdc	147	char *auth2_read_banner(void);
94a73cdc	148
1853d1ef	149	void privsep_challenge_enable(void);
1853d1ef	150
2a1e4639	151	int auth2_challenge(Authctxt , char );
2f293d43	152	void auth2_challenge_stop(Authctxt *);
51aeb639	153	int bsdauth_query(void , char , char , u_int , char *, u_int );
	154	int bsdauth_respond(void , u_int, char *);
	155	int skey_query(void , char , char , u_int , char *, u_int );
	156	int skey_respond(void , u_int, char *);
7368a6c8	157
2a1e4639	158	int allowed_user(struct passwd *);
443fa1cd	159	struct passwd * getpwnamallow(const char *user);
59c97189	160
2a1e4639	161	char get_challenge(Authctxt );
2a1e4639	162	int verify_response(Authctxt , const char );
05114c74	163	void abandon_challenge_response(Authctxt *);
59c97189	164
2a1e4639	165	char authorized_keys_file(struct passwd );
2a1e4639	166	char authorized_keys_file2(struct passwd );
c8445989	167
c8445989	168	int
2a1e4639	169	secure_filename(FILE , const char , struct passwd , char , size_t);
c8445989	170
d0c8ca5c	171	HostStatus
2a1e4639	172	check_key_in_hostfiles(struct passwd , Key , const char *,
2a1e4639	173	const char , const char );
d0c8ca5c	174
51aeb639	175	/* hostkey handling */
	176	Key *get_hostkey_by_index(int);
	177	Key *get_hostkey_by_type(int);
	178	int get_hostkey_index(Key *);
	179	int ssh1_session_key(BIGNUM *);
	180
01dafcb5	181	/* debug messages during authentication */
	182	void auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
	183	void auth_debug_send(void);
	184	void auth_debug_reset(void);
	185
96d0bf74	186	struct passwd *fakepw(void);
96d0bf74	187
1b394137	188	int sys_auth_passwd(Authctxt , const char );
1b394137	189
a306f2dd	190	#define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
a306f2dd	191
1853d1ef	192	#define SKEY_PROMPT "\nS/Key Password: "
937eb918	193
	194	#if defined(KRB5) && !defined(HEIMDAL)
	195	#include <krb5.h>
	196	krb5_error_code ssh_krb5_cc_gen(krb5_context, krb5_ccache *);
	197	#endif
7368a6c8	198	#endif