xref: /freebsd/crypto/openssh/openbsd-compat/openbsd-compat.h (revision 47dd1d1b619cc035b82b49a91a25544309ff95ae)
1 /*
2  * Copyright (c) 1999-2003 Damien Miller.  All rights reserved.
3  * Copyright (c) 2003 Ben Lindstrom. All rights reserved.
4  * Copyright (c) 2002 Tim Rice.  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  */
26 
27 #ifndef _OPENBSD_COMPAT_H
28 #define _OPENBSD_COMPAT_H
29 
30 #include "includes.h"
31 
32 #include <sys/types.h>
33 #include <pwd.h>
34 
35 #include <sys/socket.h>
36 
37 #include <stddef.h>  /* for wchar_t */
38 
39 /* OpenBSD function replacements */
40 #include "base64.h"
41 #include "sigact.h"
42 #include "readpassphrase.h"
43 #include "vis.h"
44 #include "getrrsetbyname.h"
45 #include "sha1.h"
46 #include "sha2.h"
47 #include "rmd160.h"
48 #include "md5.h"
49 #include "blf.h"
50 
51 #ifndef HAVE_BASENAME
52 char *basename(const char *path);
53 #endif
54 
55 #ifndef HAVE_BINDRESVPORT_SA
56 int bindresvport_sa(int sd, struct sockaddr *sa);
57 #endif
58 
59 #ifndef HAVE_CLOSEFROM
60 void closefrom(int);
61 #endif
62 
63 #ifndef HAVE_GETPAGESIZE
64 int getpagesize(void);
65 #endif
66 
67 #ifndef HAVE_GETCWD
68 char *getcwd(char *pt, size_t size);
69 #endif
70 
71 #ifndef HAVE_REALLOCARRAY
72 void *reallocarray(void *, size_t, size_t);
73 #endif
74 
75 #ifndef HAVE_RECALLOCARRAY
76 void *recallocarray(void *, size_t, size_t, size_t);
77 #endif
78 
79 #if !defined(HAVE_REALPATH) || defined(BROKEN_REALPATH)
80 /*
81  * glibc's FORTIFY_SOURCE can redefine this and prevent us picking up the
82  * compat version.
83  */
84 # ifdef BROKEN_REALPATH
85 #  define realpath(x, y) _ssh_compat_realpath(x, y)
86 # endif
87 
88 char *realpath(const char *path, char *resolved);
89 #endif
90 
91 #ifndef HAVE_RRESVPORT_AF
92 int rresvport_af(int *alport, sa_family_t af);
93 #endif
94 
95 #ifndef HAVE_STRLCPY
96 size_t strlcpy(char *dst, const char *src, size_t siz);
97 #endif
98 
99 #ifndef HAVE_STRLCAT
100 size_t strlcat(char *dst, const char *src, size_t siz);
101 #endif
102 
103 #ifndef HAVE_STRCASESTR
104 char *strcasestr(const char *, const char *);
105 #endif
106 
107 #ifndef HAVE_SETENV
108 int setenv(register const char *name, register const char *value, int rewrite);
109 #endif
110 
111 #ifndef HAVE_STRMODE
112 void strmode(int mode, char *p);
113 #endif
114 
115 #ifndef HAVE_STRPTIME
116 #include  <time.h>
117 char *strptime(const char *buf, const char *fmt, struct tm *tm);
118 #endif
119 
120 #if !defined(HAVE_MKDTEMP) || defined(HAVE_STRICT_MKSTEMP)
121 int mkstemps(char *path, int slen);
122 int mkstemp(char *path);
123 char *mkdtemp(char *path);
124 #endif
125 
126 #ifndef HAVE_DAEMON
127 int daemon(int nochdir, int noclose);
128 #endif
129 
130 #ifndef HAVE_DIRNAME
131 char *dirname(const char *path);
132 #endif
133 
134 #ifndef HAVE_FMT_SCALED
135 #define	FMT_SCALED_STRSIZE	7
136 int	fmt_scaled(long long number, char *result);
137 #endif
138 
139 #ifndef HAVE_SCAN_SCALED
140 int	scan_scaled(char *, long long *);
141 #endif
142 
143 #if defined(BROKEN_INET_NTOA) || !defined(HAVE_INET_NTOA)
144 char *inet_ntoa(struct in_addr in);
145 #endif
146 
147 #ifndef HAVE_INET_NTOP
148 const char *inet_ntop(int af, const void *src, char *dst, socklen_t size);
149 #endif
150 
151 #ifndef HAVE_INET_ATON
152 int inet_aton(const char *cp, struct in_addr *addr);
153 #endif
154 
155 #ifndef HAVE_STRSEP
156 char *strsep(char **stringp, const char *delim);
157 #endif
158 
159 #ifndef HAVE_SETPROCTITLE
160 void setproctitle(const char *fmt, ...);
161 void compat_init_setproctitle(int argc, char *argv[]);
162 #endif
163 
164 #ifndef HAVE_GETGROUPLIST
165 int getgrouplist(const char *, gid_t, gid_t *, int *);
166 #endif
167 
168 #if !defined(HAVE_GETOPT) || !defined(HAVE_GETOPT_OPTRESET)
169 int BSDgetopt(int argc, char * const *argv, const char *opts);
170 #include "openbsd-compat/getopt.h"
171 #endif
172 
173 #if ((defined(HAVE_DECL_READV) && HAVE_DECL_READV == 0) || \
174     (defined(HAVE_DECL_WRITEV) && HAVE_DECL_WRITEV == 0))
175 # include <sys/types.h>
176 # include <sys/uio.h>
177 
178 # if defined(HAVE_DECL_READV) && HAVE_DECL_READV == 0
179 int readv(int, struct iovec *, int);
180 # endif
181 
182 # if defined(HAVE_DECL_WRITEV) && HAVE_DECL_WRITEV == 0
183 int writev(int, struct iovec *, int);
184 # endif
185 #endif
186 
187 /* Home grown routines */
188 #include "bsd-misc.h"
189 #include "bsd-setres_id.h"
190 #include "bsd-signal.h"
191 #include "bsd-statvfs.h"
192 #include "bsd-waitpid.h"
193 #include "bsd-poll.h"
194 
195 #ifndef HAVE_GETPEEREID
196 int getpeereid(int , uid_t *, gid_t *);
197 #endif
198 
199 #ifdef HAVE_ARC4RANDOM
200 # ifndef HAVE_ARC4RANDOM_STIR
201 #  define arc4random_stir()
202 # endif
203 #else
204 unsigned int arc4random(void);
205 void arc4random_stir(void);
206 #endif /* !HAVE_ARC4RANDOM */
207 
208 #ifndef HAVE_ARC4RANDOM_BUF
209 void arc4random_buf(void *, size_t);
210 #endif
211 
212 #ifndef HAVE_ARC4RANDOM_UNIFORM
213 u_int32_t arc4random_uniform(u_int32_t);
214 #endif
215 
216 #ifndef HAVE_ASPRINTF
217 int asprintf(char **, const char *, ...);
218 #endif
219 
220 #ifndef HAVE_OPENPTY
221 # include <sys/ioctl.h>	/* for struct winsize */
222 int openpty(int *, int *, char *, struct termios *, struct winsize *);
223 #endif /* HAVE_OPENPTY */
224 
225 #ifndef HAVE_SNPRINTF
226 int snprintf(char *, size_t, SNPRINTF_CONST char *, ...);
227 #endif
228 
229 #ifndef HAVE_STRTOLL
230 long long strtoll(const char *, char **, int);
231 #endif
232 
233 #ifndef HAVE_STRTOUL
234 unsigned long strtoul(const char *, char **, int);
235 #endif
236 
237 #ifndef HAVE_STRTOULL
238 unsigned long long strtoull(const char *, char **, int);
239 #endif
240 
241 #ifndef HAVE_STRTONUM
242 long long strtonum(const char *, long long, long long, const char **);
243 #endif
244 
245 /* multibyte character support */
246 #ifndef HAVE_MBLEN
247 # define mblen(x, y)	(1)
248 #endif
249 
250 #ifndef HAVE_WCWIDTH
251 # define wcwidth(x)	(((x) >= 0x20 && (x) <= 0x7e) ? 1 : -1)
252 /* force our no-op nl_langinfo and mbtowc */
253 # undef HAVE_NL_LANGINFO
254 # undef HAVE_MBTOWC
255 # undef HAVE_LANGINFO_H
256 #endif
257 
258 #ifndef HAVE_NL_LANGINFO
259 # define nl_langinfo(x)	""
260 #endif
261 
262 #ifndef HAVE_MBTOWC
263 int mbtowc(wchar_t *, const char*, size_t);
264 #endif
265 
266 #if !defined(HAVE_VASPRINTF) || !defined(HAVE_VSNPRINTF)
267 # include <stdarg.h>
268 #endif
269 
270 /*
271  * Some platforms unconditionally undefine va_copy() so we define VA_COPY()
272  * instead.  This is known to be the case on at least some configurations of
273  * AIX with the xlc compiler.
274  */
275 #ifndef VA_COPY
276 # ifdef HAVE_VA_COPY
277 #  define VA_COPY(dest, src) va_copy(dest, src)
278 # else
279 #  ifdef HAVE___VA_COPY
280 #   define VA_COPY(dest, src) __va_copy(dest, src)
281 #  else
282 #   define VA_COPY(dest, src) (dest) = (src)
283 #  endif
284 # endif
285 #endif
286 
287 #ifndef HAVE_VASPRINTF
288 int vasprintf(char **, const char *, va_list);
289 #endif
290 
291 #ifndef HAVE_VSNPRINTF
292 int vsnprintf(char *, size_t, const char *, va_list);
293 #endif
294 
295 #ifndef HAVE_USER_FROM_UID
296 char *user_from_uid(uid_t, int);
297 #endif
298 
299 #ifndef HAVE_GROUP_FROM_GID
300 char *group_from_gid(gid_t, int);
301 #endif
302 
303 #ifndef HAVE_TIMINGSAFE_BCMP
304 int timingsafe_bcmp(const void *, const void *, size_t);
305 #endif
306 
307 #ifndef HAVE_BCRYPT_PBKDF
308 int	bcrypt_pbkdf(const char *, size_t, const u_int8_t *, size_t,
309     u_int8_t *, size_t, unsigned int);
310 #endif
311 
312 #ifndef HAVE_EXPLICIT_BZERO
313 void explicit_bzero(void *p, size_t n);
314 #endif
315 
316 #ifndef HAVE_FREEZERO
317 void freezero(void *, size_t);
318 #endif
319 
320 char *xcrypt(const char *password, const char *salt);
321 char *shadow_pw(struct passwd *pw);
322 
323 /* rfc2553 socket API replacements */
324 #include "fake-rfc2553.h"
325 
326 /* Routines for a single OS platform */
327 #include "bsd-cygwin_util.h"
328 
329 #include "port-aix.h"
330 #include "port-irix.h"
331 #include "port-linux.h"
332 #include "port-solaris.h"
333 #include "port-net.h"
334 #include "port-uw.h"
335 
336 /* _FORTIFY_SOURCE breaks FD_ISSET(n)/FD_SET(n) for n > FD_SETSIZE. Avoid. */
337 #if defined(HAVE_FEATURES_H) && defined(_FORTIFY_SOURCE)
338 # include <features.h>
339 # if defined(__GNU_LIBRARY__) && defined(__GLIBC_PREREQ)
340 #  if __GLIBC_PREREQ(2, 15) && (_FORTIFY_SOURCE > 0)
341 #   include <sys/socket.h>  /* Ensure include guard is defined */
342 #   undef FD_SET
343 #   undef FD_ISSET
344 #   define FD_SET(n, set)	kludge_FD_SET(n, set)
345 #   define FD_ISSET(n, set)	kludge_FD_ISSET(n, set)
346 void kludge_FD_SET(int, fd_set *);
347 int kludge_FD_ISSET(int, fd_set *);
348 #  endif /* __GLIBC_PREREQ(2, 15) && (_FORTIFY_SOURCE > 0) */
349 # endif /* __GNU_LIBRARY__ && __GLIBC_PREREQ */
350 #endif /* HAVE_FEATURES_H && _FORTIFY_SOURCE */
351 
352 #endif /* _OPENBSD_COMPAT_H */
353