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

/*	$OpenBSD: auth.h,v 1.49 2004/01/30 09:48:57 markus 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 <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;
#endif
#ifdef SESSION_HOOKS
        char            *session_env_file;
#endif
	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"
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 *);
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	*expand_filename(const char *, struct passwd *);
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);

#define AUTH_FAIL_MAX 6
#define AUTH_FAIL_LOG (AUTH_FAIL_MAX/2)
#define AUTH_FAIL_MSG "Too many authentication failures for %.100s"

#define SKEY_PROMPT "\nS/Key Password: "
#endif
Commit	Line	Data
416fd2a8	1	/* $OpenBSD: auth.h,v 1.49 2004/01/30 09:48:57 markus Exp $ */
e9a17296	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	*/
e9a17296	27
3c0ef626	28	#ifndef AUTH_H
	29	#define AUTH_H
	30
	31	#include "key.h"
	32	#include "hostfile.h"
	33	#include <openssl/rsa.h>
	34
	35	#ifdef HAVE_LOGIN_CAP
	36	#include <login_cap.h>
	37	#endif
	38	#ifdef BSD_AUTH
	39	#include <bsd_auth.h>
	40	#endif
	41	#ifdef KRB5
	42	#include <krb5.h>
	43	#endif
70791e56	44	#ifdef AFS_KRB5
	45	#include <krbafs.h>
	46	#endif
3c0ef626	47
3c0ef626	48	typedef struct Authctxt Authctxt;
ff2d7a98	49	typedef struct Authmethod Authmethod;
3c0ef626	50	typedef struct KbdintDevice KbdintDevice;
	51
	52	struct Authctxt {
	53	int success;
70791e56	54	int postponed; /* authentication needs another step */
70791e56	55	int valid; /* user exists and is allowed to login */
3c0ef626	56	int attempt;
3c0ef626	57	int failures;
416fd2a8	58	int force_pwchange;
70791e56	59	char user; / username sent by the client */
3c0ef626	60	char *service;
70791e56	61	struct passwd pw; / set if 'valid' */
3c0ef626	62	char *style;
	63	void *kbdintctxt;
	64	#ifdef BSD_AUTH
	65	auth_session_t *as;
	66	#endif
3c0ef626	67	#ifdef KRB5
3c0ef626	68	krb5_context krb5_ctx;
3c0ef626	69	krb5_ccache krb5_fwd_ccache;
	70	krb5_principal krb5_user;
	71	char *krb5_ticket_file;
88928908	72	#endif
	73	#ifdef SESSION_HOOKS
	74	char *session_env_file;
3c0ef626	75	#endif
70791e56	76	void *methoddata;
3c0ef626	77	};
70791e56	78	/*
	79	* Every authentication method has to handle authentication requests for
	80	* non-existing users, or for users that are not allowed to login. In this
	81	* case 'valid' is set to 0, but 'user' points to the username requested by
	82	* the client.
	83	*/
3c0ef626	84
ff2d7a98	85	struct Authmethod {
	86	char *name;
	87	int (userauth)(Authctxt authctxt);
	88	int *enabled;
	89	};
	90
3c0ef626	91	/*
3c0ef626	92	* Keyboard interactive device:
e9a17296	93	* init_ctx returns: non NULL upon success
e9a17296	94	* query returns: 0 - success, otherwise failure
3c0ef626	95	* respond returns: 0 - success, 1 - need further interaction,
	96	* otherwise - failure
	97	*/
	98	struct KbdintDevice
	99	{
	100	const char *name;
e9a17296	101	void* (init_ctx)(Authctxt);
	102	int (query)(void ctx, char name, char infotxt,
	103	u_int numprompts, char prompts, u_int echo_on);
	104	int (respond)(void ctx, u_int numresp, char **responses);
	105	void (free_ctx)(void ctx);
3c0ef626	106	};
3c0ef626	107
2980ea68	108	int auth_rhosts(struct passwd , const char );
3c0ef626	109	int
	110	auth_rhosts2(struct passwd , const char , const char , const char );
	111
416fd2a8	112	int auth_rhosts_rsa(Authctxt , char , Key *);
3c0ef626	113	int auth_password(Authctxt , const char );
416fd2a8	114	int auth_rsa(Authctxt , BIGNUM );
2980ea68	115	int auth_rsa_challenge_dialog(Key *);
	116	BIGNUM auth_rsa_generate_challenge(Key );
	117	int auth_rsa_verify_response(Key , BIGNUM , u_char[]);
	118	int auth_rsa_key_allowed(struct passwd , BIGNUM , Key **);
	119
	120	int auth_rhosts_rsa_key_allowed(struct passwd , char , char , Key );
	121	int hostbased_key_allowed(struct passwd , const char , char , Key );
	122	int user_key_allowed(struct passwd , Key );
3c0ef626	123
3c0ef626	124	#ifdef KRB5
e54b3d7c	125	int auth_krb5(Authctxt authctxt, krb5_data auth, char *client, krb5_data );
3c0ef626	126	int auth_krb5_tgt(Authctxt authctxt, krb5_data tgt);
3c0ef626	127	int auth_krb5_password(Authctxt authctxt, const char password);
416fd2a8	128	void krb5_cleanup_proc(Authctxt *authctxt);
3c0ef626	129	#endif /* KRB5 */
3c0ef626	130
416fd2a8	131	#if defined(USE_SHADOW) && defined(HAS_SHADOW_EXPIRE)
	132	#include <shadow.h>
	133	int auth_shadow_acctexpired(struct spwd *);
	134	int auth_shadow_pwexpired(Authctxt *);
	135	#endif
	136
3c0ef626	137	#include "auth-pam.h"
416fd2a8	138	void disable_forwarding(void);
3c0ef626	139
416fd2a8	140	void do_authentication(Authctxt *);
416fd2a8	141	void do_authentication2(Authctxt *);
3c0ef626	142
3c0ef626	143	void auth_log(Authctxt , int, char , char *);
	144	void userauth_finish(Authctxt , int, char );
	145	int auth_root_allowed(char *);
	146
2980ea68	147	char *auth2_read_banner(void);
	148
	149	void privsep_challenge_enable(void);
	150
3c0ef626	151	int auth2_challenge(Authctxt , char );
e9a17296	152	void auth2_challenge_stop(Authctxt *);
2980ea68	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 *);
3c0ef626	157
3c0ef626	158	int allowed_user(struct passwd *);
2980ea68	159	struct passwd * getpwnamallow(const char *user);
3c0ef626	160
	161	char get_challenge(Authctxt );
	162	int verify_response(Authctxt , const char );
70791e56	163	void abandon_challenge_response(Authctxt *);
3c0ef626	164
3c0ef626	165	char expand_filename(const char , struct passwd *);
	166	char authorized_keys_file(struct passwd );
	167	char authorized_keys_file2(struct passwd );
	168
	169	int
	170	secure_filename(FILE , const char , struct passwd , char , size_t);
	171
	172	HostStatus
	173	check_key_in_hostfiles(struct passwd , Key , const char *,
	174	const char , const char );
	175
2980ea68	176	/* hostkey handling */
	177	Key *get_hostkey_by_index(int);
	178	Key *get_hostkey_by_type(int);
	179	int get_hostkey_index(Key *);
	180	int ssh1_session_key(BIGNUM *);
	181
	182	/* debug messages during authentication */
	183	void auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
	184	void auth_debug_send(void);
	185	void auth_debug_reset(void);
	186
70791e56	187	struct passwd *fakepw(void);
70791e56	188
3c0ef626	189	#define AUTH_FAIL_MAX 6
	190	#define AUTH_FAIL_LOG (AUTH_FAIL_MAX/2)
	191	#define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
	192
2980ea68	193	#define SKEY_PROMPT "\nS/Key Password: "
3c0ef626	194	#endif