[openssh.git] / auth.h

/* $OpenBSD: auth.h,v 1.54 2006/07/06 16:03:53 stevesk 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 <sys/types.h>

#include <signal.h>
#include <pwd.h>

#include "buffer.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

#include "key.h"
#include "hostfile.h"

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