libssh  0.10.90
The SSH library
Loading...
Searching...
No Matches
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 <limits.h>
33#include <stdint.h>
34#include <stdlib.h>
35#include <string.h>
36#include <stdbool.h>
37
38#if !defined(HAVE_STRTOULL)
39# if defined(HAVE___STRTOULL)
40# define strtoull __strtoull
41# elif defined(HAVE__STRTOUI64)
42# define strtoull _strtoui64
43# elif defined(__hpux) && defined(__LP64__)
44# define strtoull strtoul
45# else
46# error "no strtoull function found"
47# endif
48#endif /* !defined(HAVE_STRTOULL) */
49
50#ifdef __cplusplus
51extern "C" {
52#endif
53
54#if !defined(HAVE_STRNDUP)
55char *strndup(const char *s, size_t n);
56#endif /* ! HAVE_STRNDUP */
57
58#ifdef HAVE_BYTESWAP_H
59#include <byteswap.h>
60#endif
61
62#ifdef HAVE_ARPA_INET_H
63#include <arpa/inet.h>
64#endif
65
66#ifndef bswap_32
67#define bswap_32(x) \
68 ((((x) & 0xff000000) >> 24) | (((x) & 0x00ff0000) >> 8) | \
69 (((x) & 0x0000ff00) << 8) | (((x) & 0x000000ff) << 24))
70#endif
71
72#ifdef _WIN32
73
74# ifndef PRIu64
75# if __WORDSIZE == 64
76# define PRIu64 "lu"
77# else
78# define PRIu64 "llu"
79# endif /* __WORDSIZE */
80# endif /* PRIu64 */
81
82# ifndef PRIu32
83# define PRIu32 "u"
84# endif /* PRIu32 */
85
86# ifndef PRIx64
87# if __WORDSIZE == 64
88# define PRIx64 "lx"
89# else
90# define PRIx64 "llx"
91# endif /* __WORDSIZE */
92# endif /* PRIx64 */
93
94# ifndef PRIx32
95# define PRIx32 "x"
96# endif /* PRIx32 */
97
98# ifdef _MSC_VER
99# include <stdio.h>
100# include <stdarg.h> /* va_copy define check */
101
102/* On Microsoft compilers define inline to __inline on all others use inline */
103# undef inline
104# define inline __inline
105
106# ifndef va_copy
107# define va_copy(dest, src) (dest = src)
108# endif
109
110# define strcasecmp _stricmp
111# define strncasecmp _strnicmp
112# if ! defined(HAVE_ISBLANK)
113# define isblank(ch) ((ch) == ' ' || (ch) == '\t' || (ch) == '\n' || (ch) == '\r')
114# endif
115
116# define usleep(X) Sleep(((X)+1000)/1000)
117
118# undef strtok_r
119# define strtok_r strtok_s
120
121# if defined(HAVE__SNPRINTF_S)
122# undef snprintf
123# define snprintf(d, n, ...) _snprintf_s((d), (n), _TRUNCATE, __VA_ARGS__)
124# else /* HAVE__SNPRINTF_S */
125# if defined(HAVE__SNPRINTF)
126# undef snprintf
127# define snprintf _snprintf
128# else /* HAVE__SNPRINTF */
129# if !defined(HAVE_SNPRINTF)
130# error "no snprintf compatible function found"
131# endif /* HAVE_SNPRINTF */
132# endif /* HAVE__SNPRINTF */
133# endif /* HAVE__SNPRINTF_S */
134
135# if defined(HAVE__VSNPRINTF_S)
136# undef vsnprintf
137# define vsnprintf(s, n, f, v) _vsnprintf_s((s), (n), _TRUNCATE, (f), (v))
138# else /* HAVE__VSNPRINTF_S */
139# if defined(HAVE__VSNPRINTF)
140# undef vsnprintf
141# define vsnprintf _vsnprintf
142# else
143# if !defined(HAVE_VSNPRINTF)
144# error "No vsnprintf compatible function found"
145# endif /* HAVE_VSNPRINTF */
146# endif /* HAVE__VSNPRINTF */
147# endif /* HAVE__VSNPRINTF_S */
148
149# ifndef _SSIZE_T_DEFINED
150# undef ssize_t
151# include <BaseTsd.h>
152 typedef _W64 SSIZE_T ssize_t;
153# define _SSIZE_T_DEFINED
154# endif /* _SSIZE_T_DEFINED */
155
156# endif /* _MSC_VER */
157
158struct timeval;
159int ssh_gettimeofday(struct timeval *__p, void *__t);
160
161#define gettimeofday ssh_gettimeofday
162
163#define _XCLOSESOCKET closesocket
164
165# ifdef HAVE_IO_H
166# include <io.h>
167# undef open
168# define open _open
169# undef close
170# define close _close
171# undef read
172# define read _read
173# undef write
174# define write _write
175# undef unlink
176# define unlink _unlink
177# endif /* HAVE_IO_H */
178
179#else /* _WIN32 */
180
181#include <unistd.h>
182
183#define _XCLOSESOCKET close
184
185#endif /* _WIN32 */
186
187#include "libssh/libssh.h"
188#include "libssh/callbacks.h"
189
190/* some constants */
191#ifndef PATH_MAX
192#ifdef MAX_PATH
193#define PATH_MAX MAX_PATH
194#else
195#define PATH_MAX 4096
196#endif
197#endif
198
199#ifndef MAX_PACKET_LEN
200#define MAX_PACKET_LEN 262144
201#endif
202#ifndef ERROR_BUFFERLEN
203#define ERROR_BUFFERLEN 1024
204#endif
205
206#ifndef CLIENT_BANNER_SSH2
207#define CLIENT_BANNER_SSH2 "SSH-2.0-libssh_" SSH_STRINGIFY(LIBSSH_VERSION)
208#endif /* CLIENT_BANNER_SSH2 */
209
210#ifndef KBDINT_MAX_PROMPT
211#define KBDINT_MAX_PROMPT 256 /* more than openssh's :) */
212#endif
213#ifndef MAX_BUF_SIZE
214#define MAX_BUF_SIZE 4096
215#endif
216
217#ifndef HAVE_COMPILER__FUNC__
218# ifdef HAVE_COMPILER__FUNCTION__
219# define __func__ __FUNCTION__
220# else
221# error "Your system must provide a __func__ macro"
222# endif
223#endif
224
225#if defined(HAVE_GCC_THREAD_LOCAL_STORAGE)
226# define LIBSSH_THREAD __thread
227#elif defined(HAVE_MSC_THREAD_LOCAL_STORAGE)
228# define LIBSSH_THREAD __declspec(thread)
229#else
230# define LIBSSH_THREAD
231#endif
232
233/*
234 * This makes sure that the compiler doesn't optimize out the code
235 *
236 * Use it in a macro where the provided variable is 'x'.
237 */
238#if defined(HAVE_GCC_VOLATILE_MEMORY_PROTECTION)
239# define LIBSSH_MEM_PROTECTION __asm__ volatile("" : : "r"(&(x)) : "memory")
240#else
241# define LIBSSH_MEM_PROTECTION
242#endif
243
244/* forward declarations */
245struct ssh_common_struct;
246struct ssh_kex_struct;
247
248enum ssh_digest_e {
249 SSH_DIGEST_AUTO=0,
250 SSH_DIGEST_SHA1=1,
251 SSH_DIGEST_SHA256,
252 SSH_DIGEST_SHA384,
253 SSH_DIGEST_SHA512,
254};
255
256int ssh_get_key_params(ssh_session session,
257 ssh_key *privkey,
258 enum ssh_digest_e *digest);
259
260/* LOGGING */
261void ssh_log_function(int verbosity,
262 const char *function,
263 const char *buffer);
264#define SSH_LOG(priority, ...) \
265 _ssh_log(priority, __func__, __VA_ARGS__)
266
267/* LEGACY */
268void ssh_log_common(struct ssh_common_struct *common,
269 int verbosity,
270 const char *function,
271 const char *format, ...) PRINTF_ATTRIBUTE(4, 5);
272
273
274/* ERROR HANDLING */
275
276/* error handling structure */
277struct error_struct {
278 int error_code;
279 char error_buffer[ERROR_BUFFERLEN];
280};
281
282#define ssh_set_error(error, code, ...) \
283 _ssh_set_error(error, code, __func__, __VA_ARGS__)
284void _ssh_set_error(void *error,
285 int code,
286 const char *function,
287 const char *descr, ...) PRINTF_ATTRIBUTE(4, 5);
288
289#define ssh_set_error_oom(error) \
290 _ssh_set_error_oom(error, __func__)
291void _ssh_set_error_oom(void *error, const char *function);
292
293#define ssh_set_error_invalid(error) \
294 _ssh_set_error_invalid(error, __func__)
295void _ssh_set_error_invalid(void *error, const char *function);
296
297void ssh_reset_error(void *error);
298
299/* server.c */
300#ifdef WITH_SERVER
301int ssh_auth_reply_default(ssh_session session,int partial);
302int ssh_auth_reply_success(ssh_session session, int partial);
303#endif
304/* client.c */
305
306int ssh_send_banner(ssh_session session, int is_server);
307
308/* connect.c */
309socket_t ssh_connect_host_nonblocking(ssh_session session, const char *host,
310 const char *bind_addr, int port);
311
312/* in base64.c */
313ssh_buffer base64_to_bin(const char *source);
314uint8_t *bin_to_base64(const uint8_t *source, size_t len);
315
316/* gzip.c */
317int compress_buffer(ssh_session session,ssh_buffer buf);
318int decompress_buffer(ssh_session session,ssh_buffer buf, size_t maxlen);
319
320/* match.c */
321int match_pattern_list(const char *string, const char *pattern,
322 size_t len, int dolower);
323int match_hostname(const char *host, const char *pattern, unsigned int len);
324
325/* connector.c */
326int ssh_connector_set_event(ssh_connector connector, ssh_event event);
327int ssh_connector_remove_event(ssh_connector connector);
328
329#ifndef MIN
330#define MIN(a,b) ((a) < (b) ? (a) : (b))
331#endif
332
333#ifndef MAX
334#define MAX(a,b) ((a) > (b) ? (a) : (b))
335#endif
336
338#define SAFE_FREE(x) do { if ((x) != NULL) {free(x); x=NULL;} } while(0)
339
341#define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
342
344#define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
345
347#define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
348
349#ifndef HAVE_EXPLICIT_BZERO
350void explicit_bzero(void *s, size_t n);
351#endif /* !HAVE_EXPLICIT_BZERO */
352
365#define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
366
370#define discard_const_p(type, ptr) ((type *)discard_const(ptr))
371
375/*
376 * Since MSVC 2010 there is a bug in passing __VA_ARGS__ to subsequent
377 * macros as a single token, which results in:
378 * warning C4003: not enough actual parameters for macro '_VA_ARG_N'
379 * and incorrect behavior. This fixes issue.
380 */
381#define VA_APPLY_VARIADIC_MACRO(macro, tuple) macro tuple
382
383#define __VA_NARG__(...) \
384 (__VA_NARG_(__VA_ARGS__, __RSEQ_N()))
385#define __VA_NARG_(...) \
386 VA_APPLY_VARIADIC_MACRO(__VA_ARG_N, (__VA_ARGS__))
387#define __VA_ARG_N( \
388 _1, _2, _3, _4, _5, _6, _7, _8, _9,_10, \
389 _11,_12,_13,_14,_15,_16,_17,_18,_19,_20, \
390 _21,_22,_23,_24,_25,_26,_27,_28,_29,_30, \
391 _31,_32,_33,_34,_35,_36,_37,_38,_39,_40, \
392 _41,_42,_43,_44,_45,_46,_47,_48,_49,_50, \
393 _51,_52,_53,_54,_55,_56,_57,_58,_59,_60, \
394 _61,_62,_63,N,...) N
395#define __RSEQ_N() \
396 63, 62, 61, 60, \
397 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, \
398 49, 48, 47, 46, 45, 44, 43, 42, 41, 40, \
399 39, 38, 37, 36, 35, 34, 33, 32, 31, 30, \
400 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, \
401 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, \
402 9, 8, 7, 6, 5, 4, 3, 2, 1, 0
403
404#define CLOSE_SOCKET(s) do { if ((s) != SSH_INVALID_SOCKET) { _XCLOSESOCKET(s); (s) = SSH_INVALID_SOCKET;} } while(0)
405
406#ifndef HAVE_HTONLL
407# ifdef WORDS_BIGENDIAN
408# define htonll(x) (x)
409# else
410# define htonll(x) \
411 (((uint64_t)htonl((x) & 0xFFFFFFFF) << 32) | htonl((x) >> 32))
412# endif
413#endif
414
415#ifndef HAVE_NTOHLL
416# ifdef WORDS_BIGENDIAN
417# define ntohll(x) (x)
418# else
419# define ntohll(x) \
420 (((uint64_t)ntohl((x) & 0xFFFFFFFF) << 32) | ntohl((x) >> 32))
421# endif
422#endif
423
424#ifndef FALL_THROUGH
425# ifdef HAVE_FALLTHROUGH_ATTRIBUTE
426# define FALL_THROUGH __attribute__ ((fallthrough))
427# else /* HAVE_FALLTHROUGH_ATTRIBUTE */
428# define FALL_THROUGH
429# endif /* HAVE_FALLTHROUGH_ATTRIBUTE */
430#endif /* FALL_THROUGH */
431
432#ifndef __attr_unused__
433# ifdef HAVE_UNUSED_ATTRIBUTE
434# define __attr_unused__ __attribute__((unused))
435# else /* HAVE_UNUSED_ATTRIBUTE */
436# define __attr_unused__
437# endif /* HAVE_UNUSED_ATTRIBUTE */
438#endif /* __attr_unused__ */
439
440#ifndef UNUSED_PARAM
441#define UNUSED_PARAM(param) param __attr_unused__
442#endif /* UNUSED_PARAM */
443
444#ifndef UNUSED_VAR
445#define UNUSED_VAR(var) __attr_unused__ var
446#endif /* UNUSED_VAR */
447
448void ssh_agent_state_free(void *data);
449
450bool is_ssh_initialized(void);
451
452#define SSH_ERRNO_MSG_MAX 1024
453char *ssh_strerror(int err_num, char *buf, size_t buflen);
454
455#ifdef __cplusplus
456}
457#endif
458
459#endif /* _LIBSSH_PRIV_H */
int ssh_auth_reply_success(ssh_session session, int partial)
Sends SSH2_MSG_USERAUTH_SUCCESS or SSH2_MSG_USERAUTH_FAILURE message depending on the success of the ...
Definition server.c:1044