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