libssh 0.8.5 The SSH library

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