xref: /freebsd/crypto/openssh/misc.h (revision 13de33a5dc2304b13d595d75d48c51793958474f)
1 /* $OpenBSD: misc.h,v 1.49 2013/06/01 13:15:52 dtucker Exp $ */
2 /* $FreeBSD$ */
3 
4 /*
5  * Author: Tatu Ylonen <ylo@cs.hut.fi>
6  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7  *                    All rights reserved
8  *
9  * As far as I am concerned, the code I have written for this software
10  * can be used freely for any purpose.  Any derived versions of this
11  * software must be clearly marked as such, and if the derived work is
12  * incompatible with the protocol description in the RFC file, it must be
13  * called by a name other than "ssh" or "Secure Shell".
14  */
15 
16 #ifndef _MISC_H
17 #define _MISC_H
18 
19 /* misc.c */
20 
21 char	*chop(char *);
22 char	*strdelim(char **);
23 int	 set_nonblock(int);
24 int	 unset_nonblock(int);
25 void	 set_nodelay(int);
26 int	 a2port(const char *);
27 int	 a2tun(const char *, int *);
28 char	*put_host_port(const char *, u_short);
29 char	*hpdelim(char **);
30 char	*cleanhostname(char *);
31 char	*colon(char *);
32 long	 convtime(const char *);
33 char	*tilde_expand_filename(const char *, uid_t);
34 char	*percent_expand(const char *, ...) __attribute__((__sentinel__));
35 char	*tohex(const void *, size_t);
36 void	 sanitise_stdfd(void);
37 void	 ms_subtract_diff(struct timeval *, int *);
38 void	 ms_to_timeval(struct timeval *, int);
39 time_t	 monotime(void);
40 void	 sock_set_v6only(int);
41 void	 sock_get_rcvbuf(int *, int);
42 
43 struct passwd *pwcopy(struct passwd *);
44 const char *ssh_gai_strerror(int);
45 
46 typedef struct arglist arglist;
47 struct arglist {
48 	char    **list;
49 	u_int   num;
50 	u_int   nalloc;
51 };
52 void	 addargs(arglist *, char *, ...)
53 	     __attribute__((format(printf, 2, 3)));
54 void	 replacearg(arglist *, u_int, char *, ...)
55 	     __attribute__((format(printf, 3, 4)));
56 void	 freeargs(arglist *);
57 
58 int	 tun_open(int, int);
59 
60 /* Common definitions for ssh tunnel device forwarding */
61 #define SSH_TUNMODE_NO		0x00
62 #define SSH_TUNMODE_POINTOPOINT	0x01
63 #define SSH_TUNMODE_ETHERNET	0x02
64 #define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
65 #define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
66 
67 #define SSH_TUNID_ANY		0x7fffffff
68 #define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
69 #define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)
70 
71 /* Functions to extract or store big-endian words of various sizes */
72 u_int64_t	get_u64(const void *)
73     __attribute__((__bounded__( __minbytes__, 1, 8)));
74 u_int32_t	get_u32(const void *)
75     __attribute__((__bounded__( __minbytes__, 1, 4)));
76 u_int16_t	get_u16(const void *)
77     __attribute__((__bounded__( __minbytes__, 1, 2)));
78 void		put_u64(void *, u_int64_t)
79     __attribute__((__bounded__( __minbytes__, 1, 8)));
80 void		put_u32(void *, u_int32_t)
81     __attribute__((__bounded__( __minbytes__, 1, 4)));
82 void		put_u16(void *, u_int16_t)
83     __attribute__((__bounded__( __minbytes__, 1, 2)));
84 
85 struct bwlimit {
86 	size_t buflen;
87 	u_int64_t rate, thresh, lamt;
88 	struct timeval bwstart, bwend;
89 };
90 
91 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
92 void bandwidth_limit(struct bwlimit *, size_t);
93 
94 int parse_ipqos(const char *);
95 const char *iptos2str(int);
96 void mktemp_proto(char *, size_t);
97 
98 /* readpass.c */
99 
100 #define RP_ECHO			0x0001
101 #define RP_ALLOW_STDIN		0x0002
102 #define RP_ALLOW_EOF		0x0004
103 #define RP_USE_ASKPASS		0x0008
104 
105 char	*read_passphrase(const char *, int);
106 int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
107 int	 read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
108 
109 #endif /* _MISC_H */
110