libssh  0.7.1
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 _WIN32
47 
48 /* Imitate define of inttypes.h */
49 # ifndef PRIdS
50 # define PRIdS "Id"
51 # endif
52 
53 # ifndef PRIu64
54 # if __WORDSIZE == 64
55 # define PRIu64 "lu"
56 # else
57 # define PRIu64 "llu"
58 # endif /* __WORDSIZE */
59 # endif /* PRIu64 */
60 
61 # ifdef _MSC_VER
62 # include <stdio.h>
63 
64 /* On Microsoft compilers define inline to __inline on all others use inline */
65 # undef inline
66 # define inline __inline
67 
68 # ifndef va_copy
69 # define va_copy(dest, src) (dest = src)
70 # endif
71 
72 # define strcasecmp _stricmp
73 # define strncasecmp _strnicmp
74 # if ! defined(HAVE_ISBLANK)
75 # define isblank(ch) ((ch) == ' ' || (ch) == '\t' || (ch) == '\n' || (ch) == '\r')
76 # endif
77 
78 # define usleep(X) Sleep(((X)+1000)/1000)
79 
80 # undef strtok_r
81 # define strtok_r strtok_s
82 
83 # if defined(HAVE__SNPRINTF_S)
84 # undef snprintf
85 # define snprintf(d, n, ...) _snprintf_s((d), (n), _TRUNCATE, __VA_ARGS__)
86 # else /* HAVE__SNPRINTF_S */
87 # if defined(HAVE__SNPRINTF)
88 # undef snprintf
89 # define snprintf _snprintf
90 # else /* HAVE__SNPRINTF */
91 # if !defined(HAVE_SNPRINTF)
92 # error "no snprintf compatible function found"
93 # endif /* HAVE_SNPRINTF */
94 # endif /* HAVE__SNPRINTF */
95 # endif /* HAVE__SNPRINTF_S */
96 
97 # if defined(HAVE__VSNPRINTF_S)
98 # undef vsnprintf
99 # define vsnprintf(s, n, f, v) _vsnprintf_s((s), (n), _TRUNCATE, (f), (v))
100 # else /* HAVE__VSNPRINTF_S */
101 # if defined(HAVE__VSNPRINTF)
102 # undef vsnprintf
103 # define vsnprintf _vsnprintf
104 # else
105 # if !defined(HAVE_VSNPRINTF)
106 # error "No vsnprintf compatible function found"
107 # endif /* HAVE_VSNPRINTF */
108 # endif /* HAVE__VSNPRINTF */
109 # endif /* HAVE__VSNPRINTF_S */
110 
111 # endif /* _MSC_VER */
112 
113 struct timeval;
114 int gettimeofday(struct timeval *__p, void *__t);
115 
116 #define _XCLOSESOCKET closesocket
117 
118 #else /* _WIN32 */
119 
120 #include <unistd.h>
121 #define PRIdS "zd"
122 
123 #define _XCLOSESOCKET close
124 
125 #endif /* _WIN32 */
126 
127 #include "libssh/libssh.h"
128 #include "libssh/callbacks.h"
129 
130 /* some constants */
131 #ifndef MAX_PACKAT_LEN
132 #define MAX_PACKET_LEN 262144
133 #endif
134 #ifndef ERROR_BUFFERLEN
135 #define ERROR_BUFFERLEN 1024
136 #endif
137 #ifndef CLIENTBANNER1
138 #define CLIENTBANNER1 "SSH-1.5-libssh-" SSH_STRINGIFY(LIBSSH_VERSION)
139 #endif
140 #ifndef CLIENTBANNER2
141 #define CLIENTBANNER2 "SSH-2.0-libssh-" SSH_STRINGIFY(LIBSSH_VERSION)
142 #endif
143 #ifndef KBDINT_MAX_PROMPT
144 #define KBDINT_MAX_PROMPT 256 /* more than openssh's :) */
145 #endif
146 #ifndef MAX_BUF_SIZE
147 #define MAX_BUF_SIZE 4096
148 #endif
149 
150 #ifndef HAVE_COMPILER__FUNC__
151 # ifdef HAVE_COMPILER__FUNCTION__
152 # define __func__ __FUNCTION__
153 # else
154 # error "Your system must provide a __func__ macro"
155 # endif
156 #endif
157 
158 #if defined(HAVE_GCC_THREAD_LOCAL_STORAGE)
159 # define LIBSSH_THREAD __thread
160 #elif defined(HAVE_MSC_THREAD_LOCAL_STORAGE)
161 # define LIBSSH_THREAD __declspec(thread)
162 #else
163 # define LIBSSH_THREAD
164 #endif
165 
166 /*
167  * This makes sure that the compiler doesn't optimize out the code
168  *
169  * Use it in a macro where the provided variable is 'x'.
170  */
171 #if defined(HAVE_GCC_VOLATILE_MEMORY_PROTECTION)
172 # define LIBSSH_MEM_PROTECTION __asm__ volatile("" : : "r"(&(x)) : "memory")
173 #else
174 # define LIBSSH_MEM_PROTECTION
175 #endif
176 
177 #ifdef HAVE_SYS_TIME_H
178 #include <sys/time.h>
179 #endif
180 
181 /* forward declarations */
182 struct ssh_common_struct;
183 struct ssh_kex_struct;
184 
185 int ssh_get_key_params(ssh_session session, ssh_key *privkey);
186 
187 /* LOGGING */
188 void ssh_log_function(int verbosity,
189  const char *function,
190  const char *buffer);
191 #define SSH_LOG(priority, ...) \
192  _ssh_log(priority, __func__, __VA_ARGS__)
193 
194 /* LEGACY */
195 void ssh_log_common(struct ssh_common_struct *common,
196  int verbosity,
197  const char *function,
198  const char *format, ...) PRINTF_ATTRIBUTE(4, 5);
199 
200 
201 /* ERROR HANDLING */
202 
203 /* error handling structure */
204 struct error_struct {
205  int error_code;
206  char error_buffer[ERROR_BUFFERLEN];
207 };
208 
209 #define ssh_set_error(error, code, ...) \
210  _ssh_set_error(error, code, __func__, __VA_ARGS__)
211 void _ssh_set_error(void *error,
212  int code,
213  const char *function,
214  const char *descr, ...) PRINTF_ATTRIBUTE(4, 5);
215 
216 #define ssh_set_error_oom(error) \
217  _ssh_set_error_oom(error, __func__)
218 void _ssh_set_error_oom(void *error, const char *function);
219 
220 #define ssh_set_error_invalid(error) \
221  _ssh_set_error_invalid(error, __func__)
222 void _ssh_set_error_invalid(void *error, const char *function);
223 
224 
225 /* server.c */
226 #ifdef WITH_SERVER
227 int ssh_auth_reply_default(ssh_session session,int partial);
228 int ssh_auth_reply_success(ssh_session session, int partial);
229 #endif
230 /* client.c */
231 
232 int ssh_send_banner(ssh_session session, int is_server);
233 
234 /* connect.c */
235 socket_t ssh_connect_host(ssh_session session, const char *host,const char
236  *bind_addr, int port, long timeout, long usec);
237 socket_t ssh_connect_host_nonblocking(ssh_session session, const char *host,
238  const char *bind_addr, int port);
239 
240 /* in base64.c */
241 ssh_buffer base64_to_bin(const char *source);
242 unsigned char *bin_to_base64(const unsigned char *source, int len);
243 
244 /* gzip.c */
245 int compress_buffer(ssh_session session,ssh_buffer buf);
246 int decompress_buffer(ssh_session session,ssh_buffer buf, size_t maxlen);
247 
248 /* match.c */
249 int match_hostname(const char *host, const char *pattern, unsigned int len);
250 
251 #ifndef MIN
252 #define MIN(a,b) ((a) < (b) ? (a) : (b))
253 #endif
254 
256 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); x=NULL;} } while(0)
257 
259 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
260 
262 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
263 
265 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
266 
267 /*
268  * See http://llvm.org/bugs/show_bug.cgi?id=15495
269  */
270 #if defined(HAVE_GCC_VOLATILE_MEMORY_PROTECTION)
271 
272 # define BURN_STRING(x) do { \
273  if ((x) != NULL) \
274  memset((x), '\0', strlen((x))); __asm__ volatile("" : : "r"(&(x)) : "memory"); \
275  } while(0)
276 
278 # define BURN_BUFFER(x, size) do { \
279  if ((x) != NULL) \
280  memset((x), '\0', (size)); __asm__ volatile("" : : "r"(&(x)) : "memory"); \
281  } while(0)
282 #else /* HAVE_GCC_VOLATILE_MEMORY_PROTECTION */
283 
284 # define BURN_STRING(x) do { \
285  if ((x) != NULL) memset((x), '\0', strlen((x))); \
286  } while(0)
287 
289 # define BURN_BUFFER(x, size) do { \
290  if ((x) != NULL) \
291  memset((x), '\0', (size)); \
292  } while(0)
293 #endif /* HAVE_GCC_VOLATILE_MEMORY_PROTECTION */
294 
307 #define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
308 
312 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
313 
317 #ifdef HAVE_GCC_NARG_MACRO
318 /*
319  * Since MSVC 2010 there is a bug in passing __VA_ARGS__ to subsequent
320  * macros as a single token, which results in:
321  * warning C4003: not enough actual parameters for macro '_VA_ARG_N'
322  * and incorrect behavior. This fixes issue.
323  */
324 #define VA_APPLY_VARIADIC_MACRO(macro, tuple) macro tuple
325 
326 #define __VA_NARG__(...) \
327  (__VA_NARG_(_0, ## __VA_ARGS__, __RSEQ_N()) - 1)
328 #define __VA_NARG_(...) \
329  VA_APPLY_VARIADIC_MACRO(__VA_ARG_N, (__VA_ARGS__))
330 #define __VA_ARG_N( \
331  _1, _2, _3, _4, _5, _6, _7, _8, _9,_10, \
332  _11,_12,_13,_14,_15,_16,_17,_18,_19,_20, \
333  _21,_22,_23,_24,_25,_26,_27,_28,_29,_30, \
334  _31,_32,_33,_34,_35,_36,_37,_38,_39,_40, \
335  _41,_42,_43,_44,_45,_46,_47,_48,_49,_50, \
336  _51,_52,_53,_54,_55,_56,_57,_58,_59,_60, \
337  _61,_62,_63,N,...) N
338 #define __RSEQ_N() \
339  63, 62, 61, 60, \
340  59, 58, 57, 56, 55, 54, 53, 52, 51, 50, \
341  49, 48, 47, 46, 45, 44, 43, 42, 41, 40, \
342  39, 38, 37, 36, 35, 34, 33, 32, 31, 30, \
343  29, 28, 27, 26, 25, 24, 23, 22, 21, 20, \
344  19, 18, 17, 16, 15, 14, 13, 12, 11, 10, \
345  9, 8, 7, 6, 5, 4, 3, 2, 1, 0
346 #else
347 /* clang does not support the above construction */
348 #define __VA_NARG__(...) (-1)
349 #endif
350 
351 #define CLOSE_SOCKET(s) do { if ((s) != SSH_INVALID_SOCKET) { _XCLOSESOCKET(s); (s) = SSH_INVALID_SOCKET;} } while(0)
352 
353 #endif /* _LIBSSH_PRIV_H */
354 /* vim: set ts=4 sw=4 et cindent: */