xref: /netbsd-src/crypto/external/bsd/openssh/dist/misc.h (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1 /*	$NetBSD: misc.h,v 1.2 2009/06/07 22:38:46 christos Exp $	*/
2 /* $OpenBSD: misc.h,v 1.38 2008/06/12 20:38:28 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 
44 long long strtonum(const char *, long long, long long, const char **);
45 
46 struct passwd *pwcopy(struct passwd *);
47 const char *ssh_gai_strerror(int);
48 
49 typedef struct arglist arglist;
50 struct arglist {
51 	char    **list;
52 	u_int   num;
53 	u_int   nalloc;
54 };
55 void	 addargs(arglist *, char *, ...)
56 	     __attribute__((format(printf, 2, 3)));
57 void	 replacearg(arglist *, u_int, char *, ...)
58 	     __attribute__((format(printf, 3, 4)));
59 void	 freeargs(arglist *);
60 
61 int	 tun_open(int, int);
62 
63 /* Common definitions for ssh tunnel device forwarding */
64 #define SSH_TUNMODE_NO		0x00
65 #define SSH_TUNMODE_POINTOPOINT	0x01
66 #define SSH_TUNMODE_ETHERNET	0x02
67 #define SSH_TUNMODE_DEFAULT	SSH_TUNMODE_POINTOPOINT
68 #define SSH_TUNMODE_YES		(SSH_TUNMODE_POINTOPOINT|SSH_TUNMODE_ETHERNET)
69 
70 #define SSH_TUNID_ANY		0x7fffffff
71 #define SSH_TUNID_ERR		(SSH_TUNID_ANY - 1)
72 #define SSH_TUNID_MAX		(SSH_TUNID_ANY - 2)
73 
74 /* Functions to extract or store big-endian words of various sizes */
75 u_int64_t	get_u64(const void *)
76 #ifdef __OpenBSD__
77     __attribute__((__bounded__( __minbytes__, 1, 8)))
78 #endif
79     ;
80 u_int32_t	get_u32(const void *)
81 #ifdef __OpenBSD__
82     __attribute__((__bounded__( __minbytes__, 1, 4)))
83 #endif
84     ;
85 u_int16_t	get_u16(const void *)
86 #ifdef __OpenBSD__
87     __attribute__((__bounded__( __minbytes__, 1, 2)))
88 #endif
89     ;
90 void		put_u64(void *, u_int64_t)
91 #ifdef __OpenBSD__
92     __attribute__((__bounded__( __minbytes__, 1, 8)))
93 #endif
94     ;
95 void		put_u32(void *, u_int32_t)
96 #ifdef __OpenBSD__
97     __attribute__((__bounded__( __minbytes__, 1, 4)))
98 #endif
99     ;
100 void		put_u16(void *, u_int16_t)
101 #ifdef __OpenBSD__
102     __attribute__((__bounded__( __minbytes__, 1, 2)))
103 #endif
104     ;
105 
106 
107 /* readpass.c */
108 
109 #define RP_ECHO			0x0001
110 #define RP_ALLOW_STDIN		0x0002
111 #define RP_ALLOW_EOF		0x0004
112 #define RP_USE_ASKPASS		0x0008
113 
114 char	*read_passphrase(const char *, int);
115 int	 ask_permission(const char *, ...) __attribute__((format(printf, 1, 2)));
116 int	 read_keyfile_line(FILE *, const char *, char *, size_t, u_long *);
117 
118 #endif /* _MISC_H */
119