libssh: priv.h Source File

libssh 0.10.6 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#else /* _WIN32 */
166
167#include <unistd.h>
168
169#define _XCLOSESOCKET close
170
171#endif /* _WIN32 */
172
173#include "libssh/libssh.h"
174#include "libssh/callbacks.h"
175
176/* some constants */
177#ifndef PATH_MAX
178#ifdef MAX_PATH
179#define PATH_MAX MAX_PATH
180#else
181#define PATH_MAX 4096
182#endif
183#endif
184
185#ifndef MAX_PACKET_LEN
186#define MAX_PACKET_LEN 262144
187#endif
188#ifndef ERROR_BUFFERLEN
189#define ERROR_BUFFERLEN 1024
190#endif
191
192#ifndef CLIENT_BANNER_SSH2
193#define CLIENT_BANNER_SSH2 "SSH-2.0-libssh_" SSH_STRINGIFY(LIBSSH_VERSION)
194#endif /* CLIENT_BANNER_SSH2 */
195
196#ifndef KBDINT_MAX_PROMPT
197#define KBDINT_MAX_PROMPT 256 /* more than openssh's :) */
198#endif
199#ifndef MAX_BUF_SIZE
200#define MAX_BUF_SIZE 4096
201#endif
202
203#ifndef HAVE_COMPILER__FUNC__
204# ifdef HAVE_COMPILER__FUNCTION__
205# define __func__ __FUNCTION__
206# else
207# error "Your system must provide a __func__ macro"
208# endif
209#endif
210
211#if defined(HAVE_GCC_THREAD_LOCAL_STORAGE)
212# define LIBSSH_THREAD __thread
213#elif defined(HAVE_MSC_THREAD_LOCAL_STORAGE)
214# define LIBSSH_THREAD __declspec(thread)
215#else
216# define LIBSSH_THREAD
217#endif
218
219/*
220 * This makes sure that the compiler doesn't optimize out the code
221 *
222 * Use it in a macro where the provided variable is 'x'.
223 */
224#if defined(HAVE_GCC_VOLATILE_MEMORY_PROTECTION)
225# define LIBSSH_MEM_PROTECTION __asm__ volatile("" : : "r"(&(x)) : "memory")
226#else
227# define LIBSSH_MEM_PROTECTION
228#endif
229
230/* forward declarations */
231struct ssh_common_struct;
232struct ssh_kex_struct;
233
234enum ssh_digest_e {
235 SSH_DIGEST_AUTO=0,
236 SSH_DIGEST_SHA1=1,
237 SSH_DIGEST_SHA256,
238 SSH_DIGEST_SHA384,
239 SSH_DIGEST_SHA512,
240};
241
242int ssh_get_key_params(ssh_session session,
243 ssh_key *privkey,
244 enum ssh_digest_e *digest);
245
246/* LOGGING */
247void ssh_log_function(int verbosity,
248 const char *function,
249 const char *buffer);
250#define SSH_LOG(priority, ...) \
251 _ssh_log(priority, __func__, __VA_ARGS__)
252
253/* LEGACY */
254void ssh_log_common(struct ssh_common_struct *common,
255 int verbosity,
256 const char *function,
257 const char *format, ...) PRINTF_ATTRIBUTE(4, 5);
258
259
260/* ERROR HANDLING */
261
262/* error handling structure */
263struct error_struct {
264 int error_code;
265 char error_buffer[ERROR_BUFFERLEN];
266};
267
268#define ssh_set_error(error, code, ...) \
269 _ssh_set_error(error, code, __func__, __VA_ARGS__)
270void _ssh_set_error(void *error,
271 int code,
272 const char *function,
273 const char *descr, ...) PRINTF_ATTRIBUTE(4, 5);
274
275#define ssh_set_error_oom(error) \
276 _ssh_set_error_oom(error, __func__)
277void _ssh_set_error_oom(void *error, const char *function);
278
279#define ssh_set_error_invalid(error) \
280 _ssh_set_error_invalid(error, __func__)
281void _ssh_set_error_invalid(void *error, const char *function);
282
283void ssh_reset_error(void *error);
284
285/* server.c */
286#ifdef WITH_SERVER
287int ssh_auth_reply_default(ssh_session session,int partial);
288int ssh_auth_reply_success(ssh_session session, int partial);
289#endif
290/* client.c */
291
292int ssh_send_banner(ssh_session session, int is_server);
293
294/* connect.c */
295socket_t ssh_connect_host_nonblocking(ssh_session session, const char *host,
296 const char *bind_addr, int port);
297
298/* in base64.c */
299 ssh_buffer base64_to_bin(const char *source);
300uint8_t *bin_to_base64(const uint8_t *source, size_t len);
301
302/* gzip.c */
303int compress_buffer(ssh_session session,ssh_buffer buf);
304int decompress_buffer(ssh_session session,ssh_buffer buf, size_t maxlen);
305
306/* match.c */
307int match_pattern_list(const char *string, const char *pattern,
308 size_t len, int dolower);
309int match_hostname(const char *host, const char *pattern, unsigned int len);
310
311/* connector.c */
312int ssh_connector_set_event(ssh_connector connector, ssh_event event);
313int ssh_connector_remove_event(ssh_connector connector);
314
315#ifndef MIN
316#define MIN(a,b) ((a) < (b) ? (a) : (b))
317#endif
318
319#ifndef MAX
320#define MAX(a,b) ((a) > (b) ? (a) : (b))
321#endif
322
324#define SAFE_FREE(x) do { if ((x) != NULL) {free(x); x=NULL;} } while(0)
325
327#define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
328
330#define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
331
333#define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
334
335#ifndef HAVE_EXPLICIT_BZERO
336void explicit_bzero(void *s, size_t n);
337#endif /* !HAVE_EXPLICIT_BZERO */
338
351#define discard_const(ptr) ((void *)((uintptr_t)(ptr)))
352
356#define discard_const_p(type, ptr) ((type *)discard_const(ptr))
357
361/*
362 * Since MSVC 2010 there is a bug in passing __VA_ARGS__ to subsequent
363 * macros as a single token, which results in:
364 * warning C4003: not enough actual parameters for macro '_VA_ARG_N'
365 * and incorrect behavior. This fixes issue.
366 */
367#define VA_APPLY_VARIADIC_MACRO(macro, tuple) macro tuple
368
369#define __VA_NARG__(...) \
370 (__VA_NARG_(__VA_ARGS__, __RSEQ_N()))
371#define __VA_NARG_(...) \
372 VA_APPLY_VARIADIC_MACRO(__VA_ARG_N, (__VA_ARGS__))
373#define __VA_ARG_N( \
374 _1, _2, _3, _4, _5, _6, _7, _8, _9,_10, \
375 _11,_12,_13,_14,_15,_16,_17,_18,_19,_20, \
376 _21,_22,_23,_24,_25,_26,_27,_28,_29,_30, \
377 _31,_32,_33,_34,_35,_36,_37,_38,_39,_40, \
378 _41,_42,_43,_44,_45,_46,_47,_48,_49,_50, \
379 _51,_52,_53,_54,_55,_56,_57,_58,_59,_60, \
380 _61,_62,_63,N,...) N
381#define __RSEQ_N() \
382 63, 62, 61, 60, \
383 59, 58, 57, 56, 55, 54, 53, 52, 51, 50, \
384 49, 48, 47, 46, 45, 44, 43, 42, 41, 40, \
385 39, 38, 37, 36, 35, 34, 33, 32, 31, 30, \
386 29, 28, 27, 26, 25, 24, 23, 22, 21, 20, \
387 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, \
388 9, 8, 7, 6, 5, 4, 3, 2, 1, 0
389
390#define CLOSE_SOCKET(s) do { if ((s) != SSH_INVALID_SOCKET) { _XCLOSESOCKET(s); (s) = SSH_INVALID_SOCKET;} } while(0)
391
392#ifndef HAVE_HTONLL
393# ifdef WORDS_BIGENDIAN
394# define htonll(x) (x)
395# else
396# define htonll(x) \
397 (((uint64_t)htonl((x) & 0xFFFFFFFF) << 32) | htonl((x) >> 32))
398# endif
399#endif
400
401#ifndef HAVE_NTOHLL
402# ifdef WORDS_BIGENDIAN
403# define ntohll(x) (x)
404# else
405# define ntohll(x) \
406 (((uint64_t)ntohl((x) & 0xFFFFFFFF) << 32) | ntohl((x) >> 32))
407# endif
408#endif
409
410#ifndef FALL_THROUGH
411# ifdef HAVE_FALLTHROUGH_ATTRIBUTE
412# define FALL_THROUGH __attribute__ ((fallthrough))
413# else /* HAVE_FALLTHROUGH_ATTRIBUTE */
414# define FALL_THROUGH
415# endif /* HAVE_FALLTHROUGH_ATTRIBUTE */
416#endif /* FALL_THROUGH */
417
418#ifndef __attr_unused__
419# ifdef HAVE_UNUSED_ATTRIBUTE
420# define __attr_unused__ __attribute__((unused))
421# else /* HAVE_UNUSED_ATTRIBUTE */
422# define __attr_unused__
423# endif /* HAVE_UNUSED_ATTRIBUTE */
424#endif /* __attr_unused__ */
425
426#ifndef UNUSED_PARAM
427#define UNUSED_PARAM(param) param __attr_unused__
428#endif /* UNUSED_PARAM */
429
430#ifndef UNUSED_VAR
431#define UNUSED_VAR(var) __attr_unused__ var
432#endif /* UNUSED_VAR */
433
434void ssh_agent_state_free(void *data);
435
436bool is_ssh_initialized(void);
437
438#define SSH_ERRNO_MSG_MAX 1024
439char *ssh_strerror(int err_num, char *buf, size_t buflen);
440
441#ifdef __cplusplus
442}
443#endif
444
445#endif /* _LIBSSH_PRIV_H */
ssh_auth_reply_success
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:1048
error_struct
Definition priv.h:263
ssh_buffer_struct
Definition buffer.c:48
ssh_common_struct
Definition session.h:121
ssh_connector_struct
Definition connector.c:54
ssh_event_struct
Definition poll.c:787
ssh_kex_struct
Definition kex.h:29
ssh_key_struct
Definition pki.h:54
ssh_session_struct
Definition session.h:127