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

/*	$OpenBSD: auth.h,v 1.41 2002/09/26 11:38:43 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

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

struct Authctxt {
	int		 success;
	int		 postponed;
	int		 valid;
	int		 attempt;
	int		 failures;
	char		*user;
	char		*service;
	struct passwd	*pw;
	char		*style;
	void		*kbdintctxt;
#ifdef BSD_AUTH
	auth_session_t	*as;
#endif
#ifdef KRB4
	char		*krb4_ticket_file;
#endif
#ifdef KRB5
	krb5_context	 krb5_ctx;
	krb5_auth_context krb5_auth_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;
};

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(struct passwd *, char *, Key *);
int      auth_password(Authctxt *, const char *);
int      auth_rsa(struct passwd *, 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 KRB4
#include <krb.h>
int     auth_krb4(Authctxt *, KTEXT, char **, KTEXT);
int	auth_krb4_password(Authctxt *, const char *);
void    krb4_cleanup_proc(void *);

#ifdef AFS
#include <kafs.h>
int     auth_krb4_tgt(Authctxt *, const char *);
int     auth_afs_token(Authctxt *, const char *);
#endif /* AFS */

#endif /* KRB4 */

#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(void *authctxt);
#endif /* KRB5 */

#include "auth-pam.h"
#include "auth2-pam.h"

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

Authctxt *authctxt_new(void);
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 *);

struct passwd * auth_get_user(void);

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);

#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
d03f4262	1	/* $OpenBSD: auth.h,v 1.41 2002/09/26 11:38:43 markus 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"
	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
	44
	45	typedef struct Authctxt Authctxt;
44a053a3	46	typedef struct Authmethod Authmethod;
3c0ef626	47	typedef struct KbdintDevice KbdintDevice;
	48
	49	struct Authctxt {
	50	int success;
	51	int postponed;
	52	int valid;
	53	int attempt;
	54	int failures;
	55	char *user;
	56	char *service;
	57	struct passwd *pw;
	58	char *style;
	59	void *kbdintctxt;
	60	#ifdef BSD_AUTH
	61	auth_session_t *as;
	62	#endif
	63	#ifdef KRB4
	64	char *krb4_ticket_file;
	65	#endif
	66	#ifdef KRB5
	67	krb5_context krb5_ctx;
	68	krb5_auth_context krb5_auth_ctx;
	69	krb5_ccache krb5_fwd_ccache;
	70	krb5_principal krb5_user;
	71	char *krb5_ticket_file;
75be3237	72	#endif
	73	#ifdef SESSION_HOOKS
	74	char *session_env_file;
3c0ef626	75	#endif
5598e598	76	void *methoddata;
3c0ef626	77	};
3c0ef626	78
44a053a3	79	struct Authmethod {
	80	char *name;
	81	int (userauth)(Authctxt authctxt);
	82	int *enabled;
	83	};
	84
3c0ef626	85	/*
3c0ef626	86	* Keyboard interactive device:
e9702f7d	87	* init_ctx returns: non NULL upon success
e9702f7d	88	* query returns: 0 - success, otherwise failure
3c0ef626	89	* respond returns: 0 - success, 1 - need further interaction,
	90	* otherwise - failure
	91	*/
	92	struct KbdintDevice
	93	{
	94	const char *name;
e9702f7d	95	void* (init_ctx)(Authctxt);
	96	int (query)(void ctx, char name, char infotxt,
	97	u_int numprompts, char prompts, u_int echo_on);
	98	int (respond)(void ctx, u_int numresp, char **responses);
	99	void (free_ctx)(void ctx);
3c0ef626	100	};
3c0ef626	101
350391c5	102	int auth_rhosts(struct passwd , const char );
3c0ef626	103	int
	104	auth_rhosts2(struct passwd , const char , const char , const char );
	105
350391c5	106	int auth_rhosts_rsa(struct passwd , char , Key *);
3c0ef626	107	int auth_password(Authctxt , const char );
3c0ef626	108	int auth_rsa(struct passwd , BIGNUM );
350391c5	109	int auth_rsa_challenge_dialog(Key *);
	110	BIGNUM auth_rsa_generate_challenge(Key );
	111	int auth_rsa_verify_response(Key , BIGNUM , u_char[]);
	112	int auth_rsa_key_allowed(struct passwd , BIGNUM , Key **);
	113
	114	int auth_rhosts_rsa_key_allowed(struct passwd , char , char , Key );
	115	int hostbased_key_allowed(struct passwd , const char , char , Key );
	116	int user_key_allowed(struct passwd , Key );
3c0ef626	117
	118	#ifdef KRB4
	119	#include <krb.h>
d03f4262	120	int auth_krb4(Authctxt , KTEXT, char *, KTEXT);
3c0ef626	121	int auth_krb4_password(Authctxt , const char );
	122	void krb4_cleanup_proc(void *);
	123
	124	#ifdef AFS
	125	#include <kafs.h>
	126	int auth_krb4_tgt(Authctxt , const char );
	127	int auth_afs_token(Authctxt , const char );
	128	#endif /* AFS */
	129
	130	#endif /* KRB4 */
	131
	132	#ifdef KRB5
d03f4262	133	int auth_krb5(Authctxt authctxt, krb5_data auth, char *client, krb5_data );
3c0ef626	134	int auth_krb5_tgt(Authctxt authctxt, krb5_data tgt);
	135	int auth_krb5_password(Authctxt authctxt, const char password);
	136	void krb5_cleanup_proc(void *authctxt);
	137	#endif /* KRB5 */
	138
	139	#include "auth-pam.h"
	140	#include "auth2-pam.h"
	141
350391c5	142	Authctxt *do_authentication(void);
350391c5	143	Authctxt *do_authentication2(void);
3c0ef626	144
	145	Authctxt *authctxt_new(void);
	146	void auth_log(Authctxt , int, char , char *);
	147	void userauth_finish(Authctxt , int, char );
	148	int auth_root_allowed(char *);
	149
350391c5	150	char *auth2_read_banner(void);
	151
	152	void privsep_challenge_enable(void);
	153
3c0ef626	154	int auth2_challenge(Authctxt , char );
e9702f7d	155	void auth2_challenge_stop(Authctxt *);
350391c5	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 *);
3c0ef626	160
3c0ef626	161	int allowed_user(struct passwd *);
350391c5	162	struct passwd * getpwnamallow(const char *user);
3c0ef626	163
	164	char get_challenge(Authctxt );
	165	int verify_response(Authctxt , const char );
	166
	167	struct passwd * auth_get_user(void);
	168
	169	char expand_filename(const char , struct passwd *);
	170	char authorized_keys_file(struct passwd );
	171	char authorized_keys_file2(struct passwd );
	172
	173	int
	174	secure_filename(FILE , const char , struct passwd , char , size_t);
	175
	176	HostStatus
	177	check_key_in_hostfiles(struct passwd , Key , const char *,
	178	const char , const char );
	179
350391c5	180	/* hostkey handling */
	181	Key *get_hostkey_by_index(int);
	182	Key *get_hostkey_by_type(int);
	183	int get_hostkey_index(Key *);
	184	int ssh1_session_key(BIGNUM *);
	185
	186	/* debug messages during authentication */
	187	void auth_debug_add(const char *fmt,...) __attribute__((format(printf, 1, 2)));
	188	void auth_debug_send(void);
	189	void auth_debug_reset(void);
	190
3c0ef626	191	#define AUTH_FAIL_MAX 6
	192	#define AUTH_FAIL_LOG (AUTH_FAIL_MAX/2)
	193	#define AUTH_FAIL_MSG "Too many authentication failures for %.100s"
	194
350391c5	195	#define SKEY_PROMPT "\nS/Key Password: "
3c0ef626	196	#endif