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