[openssh.git] / auth.h

/* $OpenBSD: auth.h,v 1.53 2006/04/20 09:27:09 djm 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 "key.h"
#include "hostfile.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

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