libssh: include/libssh/priv.h Source File

libssh 0.7.5

priv.h
1 /*
2 * This file is part of the SSH Library
3 *
4 * Copyright (c) 2003-2009 by Aris Adamantiadis
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 /*
22 * priv.h file
23 * This include file contains everything you shouldn't deal with in
24 * user programs. Consider that anything in this file might change
25 * without notice; libssh.h file will keep backward compatibility
26 * on binary & source
27 */
28
29 #ifndef _LIBSSH_PRIV_H
30 #define _LIBSSH_PRIV_H
31
32 #include "config.h"
33
34 #if !defined(HAVE_STRTOULL)
35 # if defined(HAVE___STRTOULL)
36 # define strtoull __strtoull
37 # elif defined(HAVE__STRTOUI64)
38 # define strtoull _strtoui64
39 # elif defined(__hpux) && defined(__LP64__)
40 # define strtoull strtoul
41 # else
42 # error "no strtoull function found"
43 # endif
44 #endif /* !defined(HAVE_STRTOULL) */
45
46 #ifdef HAVE_BYTESWAP_H
47 #include <byteswap.h>
48 #endif
49
50 #ifndef bswap_32
51 #define bswap_32(x) \
52 ((((x) & 0xff000000) >> 24) | (((x) & 0x00ff0000) >> 8) | \
53 (((x) & 0x0000ff00) << 8) | (((x) & 0x000000ff) << 24))
54 #endif
55
56 #ifdef _WIN32
57
58 /* Imitate define of inttypes.h */
59 # ifndef PRIdS
60 # define PRIdS "Id"
61 # endif
62
63 # ifndef PRIu64
64 # if __WORDSIZE == 64
65 # define PRIu64 "lu"
66 # else
67 # define PRIu64 "llu"
68 # endif /* __WORDSIZE */
69 # endif /* PRIu64 */
70
71 # ifdef _MSC_VER
72 # include <stdio.h>
73 # include <stdarg.h> /* va_copy define check */
74
75 /* On Microsoft compilers define inline to __inline on all others use inline */
76 # undef inline
77 # define inline __inline
78
79 # ifndef va_copy
80 # define va_copy(dest, src) (dest = src)
81 # endif
82
83 # define strcasecmp _stricmp
84 # define strncasecmp _strnicmp
85 # if ! defined(HAVE_ISBLANK)
86 # define isblank(ch) ((ch) == ' ' || (ch) == '\t' || (ch) == '\n' || (ch) == '\r')
87 # endif
88
89 # define usleep(X) Sleep(((X)+1000)/1000)
90
91 # undef strtok_r
92 # define strtok_r strtok_s
93
94 # if defined(HAVE__SNPRINTF_S)
95 # undef snprintf
96 # define snprintf(d, n, ...) _snprintf_s((d), (n), _TRUNCATE, __VA_ARGS__)
97 # else /* HAVE__SNPRINTF_S */
98 # if defined(HAVE__SNPRINTF)
99 # undef snprintf
100 # define snprintf _snprintf
101 # else /* HAVE__SNPRINTF */
102 # if !defined(HAVE_SNPRINTF)
103 # error "no snprintf compatible function found"
104 # endif /* HAVE_SNPRINTF */
105 # endif /* HAVE__SNPRINTF */
106 # endif /* HAVE__SNPRINTF_S */
107
108 # if defined(HAVE__VSNPRINTF_S)
109 # undef vsnprintf
110 # define vsnprintf(s, n, f, v) _vsnprintf_s((s), (n), _TRUNCATE, (f), (v))
111 # else /* HAVE__VSNPRINTF_S */
112 # if defined(HAVE__VSNPRINTF)
113 # undef vsnprintf
114 # define vsnprintf _vsnprintf
115 # else
116 # if !defined(HAVE_VSNPRINTF)
117 # error "No vsnprintf compatible function found"
118 # endif /* HAVE_VSNPRINTF */
119 # endif /* HAVE__VSNPRINTF */
120 # endif /* HAVE__VSNPRINTF_S */
121
122 # endif /* _MSC_VER */
123
124 struct timeval;
125 int gettimeofday(struct timeval *__p, void *__t);
126
127 #define _XCLOSESOCKET closesocket
128
129 #else /* _WIN32 */
130
131 #include <unistd.h>
132 #define PRIdS "zd"
133
134 #define _XCLOSESOCKET close
135
136 #endif /* _WIN32 */
137
138 #include "libssh/libssh.h"
139 #include "libssh/callbacks.h"
140
141 /* some constants */
142 #ifndef MAX_PACKAT_LEN
143 #define MAX_PACKET_LEN 262144
144 #endif
145 #ifndef ERROR_BUFFERLEN
146 #define ERROR_BUFFERLEN 1024
147 #endif
148 #ifndef CLIENTBANNER1
149 #define CLIENTBANNER1 "SSH-1.5-libssh_" SSH_STRINGIFY(LIBSSH_VERSION)
150 #endif
151 #ifndef CLIENTBANNER2
152 #define CLIENTBANNER2 "SSH-2.0-libssh_" SSH_STRINGIFY(LIBSSH_VERSION)
153 #endif
154 #ifndef KBDINT_MAX_PROMPT
155 #define KBDINT_MAX_PROMPT 256 /* more than openssh's :) */
156 #endif
157 #ifndef MAX_BUF_SIZE
158 #define MAX_BUF_SIZE 4096
159 #endif
160
161 #ifndef HAVE_COMPILER__FUNC__
162 # ifdef HAVE_COMPILER__FUNCTION__
163 # define __func__ __FUNCTION__
164 # else
165 # error "Your system must provide a __func__ macro"
166 # endif
167 #endif
168
169 #if defined(HAVE_GCC_THREAD_LOCAL_STORAGE)
170 # define LIBSSH_THREAD __thread
171 #elif defined(HAVE_MSC_THREAD_LOCAL_STORAGE)
172 # define LIBSSH_THREAD __declspec(thread)
173 #else
174 # define LIBSSH_THREAD
175 #endif
176
177 /*
178 * This makes sure that the compiler doesn't optimize out the code
179 *
180 * Use it in a macro where the provided variable is 'x'.
181 */
182 #if defined(HAVE_GCC_VOLATILE_MEMORY_PROTECTION)
183 # define LIBSSH_MEM_PROTECTION __asm__ volatile("" : : "r"(&(x)) : "memory")
184 #else
185 # define LIBSSH_MEM_PROTECTION
186 #endif
187
188 #ifdef HAVE_SYS_TIME_H
189 #include <sys/time.h>
190 #endif
191
192 /* forward declarations */
193 struct ssh_common_struct;
194 struct ssh_kex_struct;
195
196 int ssh_get_key_params(ssh_session session, ssh_key *privkey);
197
198 /* LOGGING */
199 void ssh_log_function(int verbosity,
200 const char *function,
201 const char *buffer);
202 #define SSH_LOG(priority, ...) \
203 _ssh_log(priority, __func__, __VA_ARGS__)
204
205 /* LEGACY */
206 void ssh_log_common(struct ssh_common_struct *common,
207 int verbosity,
208 const char *function,
209 const char *format, ...) PRINTF_ATTRIBUTE(4, 5);
210
211
212 /* ERROR HANDLING */
213
214 /* error handling structure */
215 struct error_struct {
216 int error_code;
217 char error_buffer[ERROR_BUFFERLEN];
218 };
219
220 #define ssh_set_error(error, code, ...) \
221 _ssh_set_error(error, code, __func__, __VA_ARGS__)
222 void _ssh_set_error(void *error,
223 int code,
224 const char *function,
225 const char *descr, ...) PRINTF_ATTRIBUTE(4, 5);
226
227 #define ssh_set_error_oom(error) \
228 _ssh_set_error_oom(error, __func__)
229 void _ssh_set_error_oom(void *error, const char *function);
230
231 #define ssh_set_error_invalid(error) \
232 _ssh_set_error_invalid(error, __func__)
233 void _ssh_set_error_invalid(void *error, const char *function);
234
235
236 /* server.c */
237 #ifdef WITH_SERVER
238 int ssh_auth_reply_default(ssh_session session,int partial);
239 int ssh_auth_reply_success(ssh_session session, int partial);
240 #endif
241 /* client.c */
242
243 int ssh_send_banner(ssh_session session, int is_server);
244
245 /* connect.c */
246 socket_t ssh_connect_host(ssh_session session, const char *host,const char
247 *bind_addr, int port, long timeout, long usec);
248 socket_t ssh_connect_host_nonblocking(ssh_session session, const char *host,
249 const char *bind_addr, int port);
250
251 /* in base64.c */
252 ssh_buffer base64_to_bin(const char *source);
253 unsigned char *bin_to_base64(const unsigned char *source, int len);
254
255 /* gzip.c */
256 int compress_buffer(ssh_session session,ssh_buffer buf);
257 int decompress_buffer(ssh_session session,ssh_buffer buf, size_t maxlen);
258
259 /* match.c */
260 int match_hostname(const char *host, const char *pattern, unsigned int len);
261
262 #ifndef MIN
263 #define MIN(a,b) ((a) < (b) ? (a) : (b))
264 #endif
265
267 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); x=NULL;} } while(0)
268
270 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
271
273 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
274
276 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
277
278 /*
279 * See http://llvm.org/bugs/show_bug.cgi?id=15495
280 */
281 #if defined(HAVE_GCC_VOLATILE_MEMORY_PROTECTION)
282
283 # define BURN_STRING(x) do { \
284 if ((x) != NULL) \
285 memset((x), '\0', strlen((x))); __asm__ volatile("" : : "r"(&(x)) : "memory"); \
286 } while(0)
287
289 # define BURN_BUFFER(x, size) do { \
290 if ((x) != NULL) \
291 memset((x), '\0', (size)); __asm__ volatile("" : : "r"(&(x)) : "memory"); \
292 } while(0)
293 #else /* HAVE_GCC_VOLATILE_MEMORY_PROTECTION */
294
295 # define BURN_STRING(x) do { \
296 if ((x) != NULL) memset((x), '\0', strlen((x))); \
297 } while(0)
298
300 # define BURN_BUFFER(x, size) do { \
301 if ((x) != NULL) \
302 memset((x), '\0', (size)); \
303 } while(0)
304 #endif /* HAVE_GCC_VOLATILE_MEMORY_PROTECTION */
305
318 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
319
323 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
324
328 #ifdef HAVE_GCC_NARG_MACRO
329 /*
330 * Since MSVC 2010 there is a bug in passing __VA_ARGS__ to subsequent
331 * macros as a single token, which results in:
332 * warning C4003: not enough actual parameters for macro '_VA_ARG_N'
333 * and incorrect behavior. This fixes issue.
334 */
335 #define VA_APPLY_VARIADIC_MACRO(macro, tuple) macro tuple
336
337 #define __VA_NARG__(...) \
338 (__VA_NARG_(_0, ## __VA_ARGS__, __RSEQ_N()) - 1)
339 #define __VA_NARG_(...) \
340 VA_APPLY_VARIADIC_MACRO(__VA_ARG_N, (__VA_ARGS__))
341 #define __VA_ARG_N( \
342 _1, _2, _3, _4, _5, _6, _7, _8, _9,_10, \
343 _11,_12,_13,_14,_15,_16,_17,_18,_19,_20, \
344 _21,_22,_23,_24,_25,_26,_27,_28,_29,_30, \
345 _31,_32,_33,_34,_35,_36,_37,_38,_39,_40, \
346 _41,_42,_43,_44,_45,_46,_47,_48,_49,_50, \
347 _51,_52,_53,_54,_55,_56,_57,_58,_59,_60, \
348 _61,_62,_63,N,...) N
349 #define __RSEQ_N() \
350 63, 62, 61, 60, \
351 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, \
352 49, 48, 47, 46, 45, 44, 43, 42, 41, 40, \
353 39, 38, 37, 36, 35, 34, 33, 32, 31, 30, \
354 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, \
355 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, \
356 9, 8, 7, 6, 5, 4, 3, 2, 1, 0
357 #else
358 /* clang does not support the above construction */
359 #define __VA_NARG__(...) (-1)
360 #endif
361
362 #define CLOSE_SOCKET(s) do { if ((s) != SSH_INVALID_SOCKET) { _XCLOSESOCKET(s); (s) = SSH_INVALID_SOCKET;} } while(0)
363
364 #ifndef HAVE_HTONLL
365 # ifdef WORDS_BIGENDIAN
366 # define htonll(x) (x)
367 # else
368 # define htonll(x) \
369 (((uint64_t)htonl((x) & 0xFFFFFFFF) << 32) | htonl((x) >> 32))
370 # endif
371 #endif
372
373 #ifndef HAVE_NTOHLL
374 # ifdef WORDS_BIGENDIAN
375 # define ntohll(x) (x)
376 # else
377 # define ntohll(x) \
378 (((uint64_t)ntohl((x) & 0xFFFFFFFF) << 32) | ntohl((x) >> 32))
379 # endif
380 #endif
381
382 void ssh_agent_state_free(void *data);
383
384 #endif /* _LIBSSH_PRIV_H */
385 /* vim: set ts=4 sw=4 et cindent: */