[gssapi-openssh.git] / openssh / auth.h

/*	$OpenBSD: auth.h,v 1.51 2005/06/06 11:20:36 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 "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
#ifdef AFS_KRB5
#include <krbafs.h>
#endif

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

struct Authctxt {
	int		 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
#ifdef SESSION_HOOKS
        char            *session_env_file;
#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
2ce0bfe4	1	/* $OpenBSD: auth.h,v 1.51 2005/06/06 11:20:36 djm Exp $ */
e9702f7d	2
3c0ef626	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.
	25	*
3c0ef626	26	*/
e9702f7d	27
3c0ef626	28	#ifndef AUTH_H
	29	#define AUTH_H
	30
	31	#include "key.h"
	32	#include "hostfile.h"
8b32eddc	33	#include "buffer.h"
3c0ef626	34	#include <openssl/rsa.h>
	35
	36	#ifdef HAVE_LOGIN_CAP
	37	#include <login_cap.h>
	38	#endif
	39	#ifdef BSD_AUTH
	40	#include <bsd_auth.h>
	41	#endif
	42	#ifdef KRB5
	43	#include <krb5.h>
	44	#endif
7cac2b65	45	#ifdef AFS_KRB5
	46	#include <krbafs.h>
	47	#endif
3c0ef626	48
3c0ef626	49	typedef struct Authctxt Authctxt;
44a053a3	50	typedef struct Authmethod Authmethod;
3c0ef626	51	typedef struct KbdintDevice KbdintDevice;
	52
	53	struct Authctxt {
	54	int success;
7cac2b65	55	int postponed; /* authentication needs another step */
7cac2b65	56	int valid; /* user exists and is allowed to login */
3c0ef626	57	int attempt;
3c0ef626	58	int failures;
540d72c3	59	int force_pwchange;
7cac2b65	60	char user; / username sent by the client */
3c0ef626	61	char *service;
7cac2b65	62	struct passwd pw; / set if 'valid' */
3c0ef626	63	char *style;
	64	void *kbdintctxt;
	65	#ifdef BSD_AUTH
	66	auth_session_t *as;
	67	#endif
3c0ef626	68	#ifdef KRB5
3c0ef626	69	krb5_context krb5_ctx;
3c0ef626	70	krb5_ccache krb5_fwd_ccache;
	71	krb5_principal krb5_user;
	72	char *krb5_ticket_file;
12a403af	73	char *krb5_ccname;
75be3237	74	#endif
	75	#ifdef SESSION_HOOKS
	76	char *session_env_file;
3c0ef626	77	#endif
8b32eddc	78	Buffer *loginmsg;
7cac2b65	79	void *methoddata;
3c0ef626	80	};
7cac2b65	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	*/
3c0ef626	87
44a053a3	88	struct Authmethod {
	89	char *name;
	90	int (userauth)(Authctxt authctxt);
	91	int *enabled;
	92	};
	93
3c0ef626	94	/*
3c0ef626	95	* Keyboard interactive device:
e9702f7d	96	* init_ctx returns: non NULL upon success
e9702f7d	97	* query returns: 0 - success, otherwise failure
3c0ef626	98	* respond returns: 0 - success, 1 - need further interaction,
	99	* otherwise - failure
	100	*/
	101	struct KbdintDevice
	102	{
	103	const char *name;
e9702f7d	104	void* (init_ctx)(Authctxt);
	105	int (query)(void ctx, char name, char infotxt,
	106	u_int numprompts, char prompts, u_int echo_on);
	107	int (respond)(void ctx, u_int numresp, char **responses);
	108	void (free_ctx)(void ctx);
3c0ef626	109	};
3c0ef626	110
350391c5	111	int auth_rhosts(struct passwd , const char );
3c0ef626	112	int
	113	auth_rhosts2(struct passwd , const char , const char , const char );
	114
540d72c3	115	int auth_rhosts_rsa(Authctxt , char , Key *);
3c0ef626	116	int auth_password(Authctxt , const char );
540d72c3	117	int auth_rsa(Authctxt , BIGNUM );
350391c5	118	int auth_rsa_challenge_dialog(Key *);
	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 );
3c0ef626	126
3c0ef626	127	#ifdef KRB5
d03f4262	128	int auth_krb5(Authctxt authctxt, krb5_data auth, char *client, krb5_data );
3c0ef626	129	int auth_krb5_tgt(Authctxt authctxt, krb5_data tgt);
3c0ef626	130	int auth_krb5_password(Authctxt authctxt, const char password);
540d72c3	131	void krb5_cleanup_proc(Authctxt *authctxt);
3c0ef626	132	#endif /* KRB5 */
3c0ef626	133
540d72c3	134	#if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
	135	#include <shadow.h>
	136	int auth_shadow_acctexpired(struct spwd *);
	137	int auth_shadow_pwexpired(Authctxt *);
	138	#endif
	139
3c0ef626	140	#include "auth-pam.h"
dfddba3d	141	#include "audit.h"
	142	void remove_kbdint_device(const char *);
	143
540d72c3	144	void disable_forwarding(void);
3c0ef626	145
540d72c3	146	void do_authentication(Authctxt *);
540d72c3	147	void do_authentication2(Authctxt *);
3c0ef626	148
3c0ef626	149	void auth_log(Authctxt , int, char , char *);
3c0ef626	150	void userauth_finish(Authctxt , int, char );
dfddba3d	151	void userauth_send_banner(const char *);
3c0ef626	152	int auth_root_allowed(char *);
3c0ef626	153
350391c5	154	char *auth2_read_banner(void);
	155
	156	void privsep_challenge_enable(void);
	157
3c0ef626	158	int auth2_challenge(Authctxt , char );
e9702f7d	159	void auth2_challenge_stop(Authctxt *);
350391c5	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 *);
3c0ef626	164
3c0ef626	165	int allowed_user(struct passwd *);
350391c5	166	struct passwd * getpwnamallow(const char *user);
3c0ef626	167
	168	char get_challenge(Authctxt );
	169	int verify_response(Authctxt , const char );
7cac2b65	170	void abandon_challenge_response(Authctxt *);
3c0ef626	171
3c0ef626	172	char authorized_keys_file(struct passwd );
	173	char authorized_keys_file2(struct passwd );
	174
	175	int
	176	secure_filename(FILE , const char , struct passwd , char , size_t);
	177
	178	HostStatus
	179	check_key_in_hostfiles(struct passwd , Key , const char *,
	180	const char , const char );
	181
350391c5	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
	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
7cac2b65	193	struct passwd *fakepw(void);
7cac2b65	194
8b32eddc	195	int sys_auth_passwd(Authctxt , const char );
8b32eddc	196
3c0ef626	197	#define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
3c0ef626	198
350391c5	199	#define SKEY_PROMPT "\nS/Key Password: "
2ce0bfe4	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
3c0ef626	205	#endif