[openssh.git] / misc.h

/* $OpenBSD: misc.h,v 1.37 2007/12/27 14:22:08 dtucker Exp $ */

/*
 * Author: Tatu Ylonen <ylo@cs.hut.fi>
 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
 *                    All rights reserved
 *
 * As far as I am concerned, the code I have written for this software
 * can be used freely for any purpose.  Any derived versions of this
 * software must be clearly marked as such, and if the derived work is
 * incompatible with the protocol description in the RFC file, it must be
 * called by a name other than "ssh" or "Secure Shell".
 */

#ifndef _MISC_H
#define _MISC_H

/* misc.c */

char	*chop(char *);
char	*strdelim(char **);
int	 set_nonblock(int);
int	 unset_nonblock(int);
void	 set_nodelay(int);
int	 a2port(const char *);
int	 a2tun(const char *, int *);
char	*put_host_port(const char *, u_short);
char	*hpdelim(char **);
char	*cleanhostname(char *);
char	*colon(char *);
long	 convtime(const char *);
char	*tilde_expand_filename(const char *, uid_t);
char	*percent_expand(const char *, ...) __attribute__((__sentinel__));
char	*tohex(const void *, size_t);
void	 sanitise_stdfd(void);

struct passwd *pwcopy(struct passwd *);
const char *ssh_gai_strerror(int);

typedef struct arglist arglist;
struct arglist {
	char    **list;
	u_int   num;
	u_int   nalloc;
};
void	 addargs(arglist *, char *, ...)
	     __attribute__((format(printf, 2, 3)));
void	 replacearg(arglist *, u_int, char *, ...)
	     __attribute__((format(printf, 3, 4)));
void	 freeargs(arglist *);

int	 tun_open(int, int);

/* Common definitions for ssh tunnel device forwarding */
#define SSH_TUNMODE_NO		0x00
#define SSH_TUNMODE_POINTOPOINT	0x01
#define SSH_TUNMODE_ETHERNET	0x02
#define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
#define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)

#define SSH_TUNID_ANY		0x7fffffff
#define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
#define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)

/* Functions to extract or store big-endian words of various sizes */
u_int64_t	get_u64(const void *)
    __attribute__((__bounded__( __minbytes__, 1, 8)));
u_int32_t	get_u32(const void *)
    __attribute__((__bounded__( __minbytes__, 1, 4)));
u_int16_t	get_u16(const void *)
    __attribute__((__bounded__( __minbytes__, 1, 2)));
void		put_u64(void *, u_int64_t)
    __attribute__((__bounded__( __minbytes__, 1, 8)));
void		put_u32(void *, u_int32_t)
    __attribute__((__bounded__( __minbytes__, 1, 4)));
void		put_u16(void *, u_int16_t)
    __attribute__((__bounded__( __minbytes__, 1, 2)));


/* readpass.c */

#define RP_ECHO			0x0001
#define RP_ALLOW_STDIN		0x0002
#define RP_ALLOW_EOF		0x0004
#define RP_USE_ASKPASS		0x0008

char	*read_passphrase(const char *, int);
int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
int	 read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);

#endif /* _MISC_H */
Commit	Line	Data
bb4626fe	1	/* $OpenBSD: misc.h,v 1.37 2007/12/27 14:22:08 dtucker Exp $ */
23c2a7a5	2
42f11eb2	3	/*
	4	* Author: Tatu Ylonen <ylo@cs.hut.fi>
	5	* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
	6	* All rights reserved
	7	*
	8	* As far as I am concerned, the code I have written for this software
	9	* can be used freely for any purpose. Any derived versions of this
	10	* software must be clearly marked as such, and if the derived work is
	11	* incompatible with the protocol description in the RFC file, it must be
	12	* called by a name other than "ssh" or "Secure Shell".
	13	*/
42f11eb2	14
51e7a012	15	#ifndef _MISC_H
	16	#define _MISC_H
	17
58ae9cb8	18	/* misc.c */
58ae9cb8	19
ac96ca42	20	char chop(char );
ac96ca42	21	char strdelim(char *);
170694d7	22	int set_nonblock(int);
170694d7	23	int unset_nonblock(int);
bcc0381e	24	void set_nodelay(int);
ac96ca42	25	int a2port(const char *);
d20f3c9e	26	int a2tun(const char , int );
d4530052	27	char put_host_port(const char , u_short);
3867aa0a	28	char hpdelim(char *);
ac96ca42	29	char cleanhostname(char );
	30	char colon(char );
	31	long convtime(const char *);
49e71137	32	char tilde_expand_filename(const char , uid_t);
8912ae0e	33	char percent_expand(const char , ...) __attribute__((__sentinel__));
51e7a012	34	char tohex(const void , size_t);
fd6168c1	35	void sanitise_stdfd(void);
ac96ca42	36
ac96ca42	37	struct passwd pwcopy(struct passwd );
bb4626fe	38	const char *ssh_gai_strerror(int);
42f11eb2	39
8a624ebf	40	typedef struct arglist arglist;
8a624ebf	41	struct arglist {
762715ce	42	char **list;
9a995072	43	u_int num;
9a995072	44	u_int nalloc;
8a624ebf	45	};
4116f5c0	46	void addargs(arglist , char , ...)
	47	__attribute__((format(printf, 2, 3)));
	48	void replacearg(arglist , u_int, char , ...)
	49	__attribute__((format(printf, 3, 4)));
	50	void freeargs(arglist *);
07d80252	51
a4f24bf8	52	int tun_open(int, int);
	53
	54	/* Common definitions for ssh tunnel device forwarding */
	55	#define SSH_TUNMODE_NO 0x00
	56	#define SSH_TUNMODE_POINTOPOINT 0x01
	57	#define SSH_TUNMODE_ETHERNET 0x02
	58	#define SSH_TUNMODE_DEFAULT SSH_TUNMODE_POINTOPOINT
	59	#define SSH_TUNMODE_YES (SSH_TUNMODE_POINTOPOINT\|SSH_TUNMODE_ETHERNET)
	60
	61	#define SSH_TUNID_ANY 0x7fffffff
	62	#define SSH_TUNID_ERR (SSH_TUNID_ANY - 1)
	63	#define SSH_TUNID_MAX (SSH_TUNID_ANY - 2)
51e7a012	64
	65	/* Functions to extract or store big-endian words of various sizes */
	66	u_int64_t get_u64(const void *)
	67	__attribute__((__bounded__( __minbytes__, 1, 8)));
	68	u_int32_t get_u32(const void *)
	69	__attribute__((__bounded__( __minbytes__, 1, 4)));
	70	u_int16_t get_u16(const void *)
	71	__attribute__((__bounded__( __minbytes__, 1, 2)));
	72	void put_u64(void *, u_int64_t)
	73	__attribute__((__bounded__( __minbytes__, 1, 8)));
	74	void put_u32(void *, u_int32_t)
	75	__attribute__((__bounded__( __minbytes__, 1, 4)));
	76	void put_u16(void *, u_int16_t)
	77	__attribute__((__bounded__( __minbytes__, 1, 2)));
	78
51e7a012	79
b2af4ca8	80	/* readpass.c */
	81
	82	#define RP_ECHO 0x0001
	83	#define RP_ALLOW_STDIN 0x0002
	84	#define RP_ALLOW_EOF 0x0004
	85	#define RP_USE_ASKPASS 0x0008
	86
	87	char read_passphrase(const char , int);
	88	int ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
	89	int read_keyfile_line(FILE , const char , char , size_t, u_long );
	90
	91	#endif /* _MISC_H */