xref: /netbsd-src/crypto/external/bsd/openssh/dist/misc.h (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1 /*	$NetBSD: misc.h,v 1.6 2013/11/08 19:18:25 christos Exp $	*/
2 /* $OpenBSD: misc.h,v 1.49 2013/06/01 13:15:52 dtucker Exp $ */
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 *, ...)
35 #if __GNUC_PREREQ__(4, 0)
36     __attribute__((__sentinel__))
37 #endif
38     ;
39 char	*tohex(const void *, size_t);
40 void	 sanitise_stdfd(void);
41 void	 ms_subtract_diff(struct timeval *, int *);
42 void	 ms_to_timeval(struct timeval *, int);
43 time_t	 monotime(void);
44 
45 int	 timingsafe_bcmp(const void *, const void *, size_t);
46 long long strtonum(const char *, long long, long long, const char **);
47 
48 struct passwd *pwcopy(struct passwd *);
49 const char *ssh_gai_strerror(int);
50 
51 typedef struct arglist arglist;
52 struct arglist {
53 	char    **list;
54 	u_int   num;
55 	u_int   nalloc;
56 };
57 void	 addargs(arglist *, const char *, ...)
58 	     __attribute__((format(printf, 2, 3)));
59 void	 replacearg(arglist *, u_int, const char *, ...)
60 	     __attribute__((format(printf, 3, 4)));
61 void	 freeargs(arglist *);
62 
63 int	 tun_open(int, int);
64 
65 /* Common definitions for ssh tunnel device forwarding */
66 #define SSH_TUNMODE_NO		0x00
67 #define SSH_TUNMODE_POINTOPOINT	0x01
68 #define SSH_TUNMODE_ETHERNET	0x02
69 #define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
70 #define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
71 
72 #define SSH_TUNID_ANY		0x7fffffff
73 #define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
74 #define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)
75 
76 /* Functions to extract or store big-endian words of various sizes */
77 u_int64_t	get_u64(const void *)
78 #ifdef __OpenBSD__
79     __attribute__((__bounded__( __minbytes__, 1, 8)))
80 #endif
81     ;
82 u_int32_t	get_u32(const void *)
83 #ifdef __OpenBSD__
84     __attribute__((__bounded__( __minbytes__, 1, 4)))
85 #endif
86     ;
87 u_int16_t	get_u16(const void *)
88 #ifdef __OpenBSD__
89     __attribute__((__bounded__( __minbytes__, 1, 2)))
90 #endif
91     ;
92 void		put_u64(void *, u_int64_t)
93 #ifdef __OpenBSD__
94     __attribute__((__bounded__( __minbytes__, 1, 8)))
95 #endif
96     ;
97 void		put_u32(void *, u_int32_t)
98 #ifdef __OpenBSD__
99     __attribute__((__bounded__( __minbytes__, 1, 4)))
100 #endif
101     ;
102 void		put_u16(void *, u_int16_t)
103 #ifdef __OpenBSD__
104     __attribute__((__bounded__( __minbytes__, 1, 2)))
105 #endif
106     ;
107 
108 struct bwlimit {
109 	size_t buflen;
110 	u_int64_t rate, thresh, lamt;
111 	struct timeval bwstart, bwend;
112 };
113 
114 void bandwidth_limit_init(struct bwlimit *, u_int64_t, size_t);
115 void bandwidth_limit(struct bwlimit *, size_t);
116 
117 int parse_ipqos(const char *);
118 const char *iptos2str(int);
119 void mktemp_proto(char *, size_t);
120 
121 /* readpass.c */
122 
123 #define RP_ECHO			0x0001
124 #define RP_ALLOW_STDIN		0x0002
125 #define RP_ALLOW_EOF		0x0004
126 #define RP_USE_ASKPASS		0x0008
127 
128 char	*read_passphrase(const char *, int);
129 int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
130 int	 read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
131 
132 #endif /* _MISC_H */
133