Repository navigation
Expand file tree
/
Copy pathlibssh2_priv.h
More file actions
1285 lines (1088 loc) · 43.5 KB
/
Copy pathlibssh2_priv.h
File metadata and controls
1285 lines (1088 loc) · 43.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#ifndef LIBSSH2_PRIV_H
#define LIBSSH2_PRIV_H
/* Copyright (C) Sara Golemon <sarag@libssh2.org>
* Copyright (C) Daniel Stenberg
* Copyright (C) Simon Josefsson
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/* Header used by 'src' and 'tests' */
/* FIXME: Disable warnings for 'src' */
#if !defined(LIBSSH2_TESTS) && !defined(LIBSSH2_WARN_SIGN_CONVERSION)
#if defined(__GNUC__) || defined(__clang__)
#pragma GCC diagnostic ignored "-Wsign-conversion"
#endif
#endif
#define LIBSSH2_LIBRARY
/* platform/compiler-specific setup */
#include "libssh2_setup.h"
#include <stdio.h>
#include <string.h>
#include <time.h>
#include <limits.h>
/* The following CPP block should really only be in session.c and packet.c.
However, AIX have #define's for 'events' and 'revents' and we are using
those names in libssh2.h, so we need to include the AIX headers first, to
make sure all code is compiled with consistent names of these fields.
While arguable the best would to change libssh2.h to use other names, that
would break backwards compatibility. */
#ifdef HAVE_POLL
#include <poll.h>
#elif defined(HAVE_SYS_SELECT_H)
#include <sys/select.h>
#endif
#ifdef HAVE_SYS_UIO_H
#include <sys/uio.h> /* for struct iovec on some platforms */
#endif
#ifndef _WIN32
#include <sys/socket.h>
#endif
#ifdef HAVE_SYS_IOCTL_H
#include <sys/ioctl.h>
#endif
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif
#ifdef LIBSSH2_HAVE_ZLIB
#ifndef ZLIB_CONST
#define ZLIB_CONST /* Use z_const. Supported by v1.2.5.2 and upper. */
#endif
#endif
#include "libssh2.h"
#include "libssh2_publickey.h"
#include "libssh2_sftp.h"
#ifdef _WIN32
/* Detect Windows App environment which has a restricted access
to the Win32 APIs. */
# if (defined(_WIN32_WINNT) && _WIN32_WINNT >= 0x0602) || \
defined(WINAPI_FAMILY)
# include <winapifamily.h>
# if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP) && \
!WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)
# define LIBSSH2_WINDOWS_UWP
# endif
# endif
#endif
#ifndef FALSE
#define FALSE 0
#endif
#ifndef TRUE
#define TRUE 1
#endif
#ifndef UINT32_MAX
#define UINT32_MAX 0xffffffffU
#endif
#ifdef _WIN64
#define SSH2_UNCONST(p) ((void *)(libssh2_uint64_t)(const void *)(p))
#elif defined(_MSC_VER)
#define SSH2_UNCONST(p) ((void *)(unsigned int)(const void *)(p))
#elif defined(__OS400__)
#define SSH2_UNCONST(p) ((void *)(p))
#else
#define SSH2_UNCONST(p) ((void *)(uintptr_t)(const void *)(p))
#endif
#if (defined(__GNUC__) || defined(__clang__)) && \
defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L && \
!defined(LIBSSH2_NO_FMT_CHECKS)
#ifdef __MINGW_PRINTF_FORMAT
#define SSH2_PRINTF(fmt, arg) \
__attribute__((format(__MINGW_PRINTF_FORMAT, fmt, arg)))
#elif !defined(__MINGW32__)
#define SSH2_PRINTF(fmt, arg) \
__attribute__((format(printf, fmt, arg)))
#endif
#endif
#ifndef SSH2_PRINTF
#define SSH2_PRINTF(fmt, arg)
#endif
#ifndef SSH2_FALLTHROUGH
#if (defined(__GNUC__) && __GNUC__ >= 7) || \
(defined(__clang__) && __clang_major__ >= 10)
# define SSH2_FALLTHROUGH() __attribute__((fallthrough))
#else
# define SSH2_FALLTHROUGH() do {} while(0)
#endif
#endif
#ifdef SSH2_INLINE
/* 'SSH2_INLINE' defined, use as-is */
#elif defined(inline)
# define SSH2_INLINE inline /* 'inline' defined, assumed correct */
#elif defined(__cplusplus)
/* The code is compiled with C++ compiler.
C++ always supports 'inline'. */
# define SSH2_INLINE inline /* 'inline' keyword supported */
#elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
/* C99 (and later) supports 'inline' keyword */
# define SSH2_INLINE inline /* 'inline' keyword supported */
#elif defined(__GNUC__) && __GNUC__ >= 3
/* GCC supports '__inline__' as an extension */
# define SSH2_INLINE __inline__
#elif defined(_MSC_VER)
# define SSH2_INLINE __inline
#else
/* Probably 'inline' is not supported by compiler.
Define to the empty string to be on the safe side. */
# define SSH2_INLINE /* empty */
#endif
#include "misc.h"
/* 3DS does not seem to have iovec */
#if defined(_WIN32) || defined(_3DS)
struct iovec {
size_t iov_len;
void *iov_base;
};
#endif
#ifdef __OS400__
/* Force parameter type. */
#define send(s, b, l, f) send(s, (unsigned char *)(b), l, f)
#endif
#include "crypto.h"
#ifndef SIZE_MAX
#if _WIN64
#define SIZE_MAX 0xFFFFFFFFFFFFFFFF
#else
#define SIZE_MAX 0xFFFFFFFF
#endif
#endif
#ifndef UINT_MAX
#define UINT_MAX 0xFFFFFFFF
#endif
#define SSH2_MAX(x, y) ((x) > (y) ? (x) : (y))
#define SSH2_MIN(x, y) ((x) < (y) ? (x) : (y))
/* Compare memory buffer with string literal */
#define SSH2_IS_LITERAL(have, have_len, want) \
((have) && (have_len) == (sizeof(want) - 1) && \
!memcmp(have, want, sizeof(want) - 1))
#define MAX_BLOCKSIZE 32 /* MUST fit biggest crypto block size we use/get */
#define MAX_MACSIZE 64 /* MUST fit biggest MAC length we support */
/* RFC4253 section 6.1 Maximum Packet Length says:
*
* "All implementations MUST be able to process packets with
* uncompressed payload length of 32768 bytes or less and
* total packet size of 35000 bytes or less (including length,
* padding length, payload, padding, and MAC.)."
*/
#define MAX_SSH_PACKET_LEN 35000
#define MAX_SHA_DIGEST_LEN SSH2_SHA512_DIG_LEN
#define SSH2_ALLOC(session, count) \
(session)->alloc(count, &(session)->abstract)
#define SSH2_CALLOC(session, count) ssh2_calloc(session, count)
#define SSH2_REALLOC(session, ptr, count) \
((ptr) ? (session)->realloc(ptr, count, &(session)->abstract) : \
(session)->alloc(count, &(session)->abstract))
#define SSH2_FREE(session, ptr) \
(session)->free(ptr, &(session)->abstract)
#define SSH2_SAFEFREE(session, ptr) \
do { \
SSH2_FREE(session, ptr); \
(ptr) = NULL; \
} while(0)
#define SSH2_IGNORE(session, data, datalen) \
(session)->ssh_msg_ignore(session, data, (int)(datalen), \
&(session)->abstract)
#define SSH2_DEBUG(session, always_display, message, message_len, \
language, language_len) \
(session)->ssh_msg_debug(session, always_display, \
message, (int)(message_len), \
language, (int)(language_len), \
&(session)->abstract)
#define SSH2_DISCONNECT(session, reason, message, message_len, \
language, language_len) \
(session)->ssh_msg_disconnect(session, reason, \
message, (int)(message_len), \
language, (int)(language_len), \
&(session)->abstract)
#define SSH2_MACERROR(session, data, datalen) \
(session)->macerror(session, data, (int)(datalen), &(session)->abstract)
#define SSH2_X11_OPEN(channel, shost, sport) \
(channel)->session->x11((channel)->session, channel, \
shost, sport, &(channel)->session->abstract)
#define SSH2_AUTHAGENT(channel) \
(channel)->session->authagent((channel)->session, channel, \
&(channel)->session->abstract)
#define SSH2_ADD_IDENTITIES(session, buffer, agentPath) \
(session)->addLocalIdentities(session, buffer, \
agentPath, &(session)->abstract)
#define SSH2_AUTHAGENT_SIGN(session, blob, blen, \
data, dlen, sig, sigLen, \
agentPath) \
(session)->agentSignCallback(session, blob, blen, \
data, dlen, sig, sigLen, \
agentPath, &(session)->abstract)
#define SSH2_CHANNEL_CLOSE(session, channel) \
(channel)->close_cb(session, &(session)->abstract, \
channel, &(channel)->abstract)
#define SSH2_SEND_FD(session, fd, buffer, length, flags) \
((session)->send)(fd, buffer, length, flags, &(session)->abstract)
#define SSH2_RECV_FD(session, fd, buffer, length, flags) \
((session)->recv)(fd, buffer, length, flags, &(session)->abstract)
#define SSH2_SEND(session, buffer, length, flags) \
SSH2_SEND_FD(session, (session)->socket_fd, buffer, length, flags)
#define SSH2_RECV(session, buffer, length, flags) \
SSH2_RECV_FD(session, (session)->socket_fd, buffer, length, flags)
/* non-blocking states */
typedef enum {
ssh2_NB_state_idle = 0,
ssh2_NB_state_allocated,
ssh2_NB_state_created,
ssh2_NB_state_sent,
ssh2_NB_state_sent1,
ssh2_NB_state_sent2,
ssh2_NB_state_sent3,
ssh2_NB_state_sent4,
ssh2_NB_state_sent5,
ssh2_NB_state_sent6,
ssh2_NB_state_sent7,
ssh2_NB_state_jump1,
ssh2_NB_state_jump2,
ssh2_NB_state_jump3,
ssh2_NB_state_jump4,
ssh2_NB_state_jump5,
ssh2_NB_state_error_closing,
ssh2_NB_state_end,
ssh2_NB_state_jumpauthagent
} ssh2_NB_states;
#define ssh2_time_t libssh2_int64_t /* us */
#define ssh2_timediff_t libssh2_int64_t /* us */
#define SSH2_TIME_T_FORMAT SSH2_INT64_T_FORMAT
#define ssh2_sec_to_timediff(sec) ((ssh2_time_t)(sec) * 1000000)
#define ssh2_timediff_to_sec(td) ((td) / 1000000)
#define ssh2_timediff_to_usec(td) ((td) % 1000000)
#define ssh2_ms_to_timediff(ms) ((ssh2_time_t)(ms) * 1000)
#define ssh2_timediff_to_ms(td) ((td) / 1000)
ssh2_time_t ssh2_now(void);
struct packet_require_state {
ssh2_NB_states state;
ssh2_time_t start;
};
struct packet_requirev_state {
ssh2_time_t start;
};
struct kmdhgGPshakex_state {
ssh2_NB_states state;
unsigned char *e_packet;
unsigned char *s_packet;
unsigned char *tmp;
unsigned char h_sig_comp[MAX_SHA_DIGEST_LEN];
unsigned char c;
size_t e_packet_len;
size_t s_packet_len;
size_t tmp_len;
ssh2_bn_ctx *ctx;
ssh2_dh_ctx x;
ssh2_bn *e;
ssh2_bn *f;
ssh2_bn *k;
unsigned char *f_value;
unsigned char *k_value;
unsigned char *h_sig;
size_t f_value_len;
size_t k_value_len;
size_t h_sig_len;
struct packet_require_state req_state;
ssh2_NB_states burn_state;
};
struct key_exchange_state_low {
ssh2_NB_states state;
struct packet_require_state req_state;
struct kmdhgGPshakex_state exchange_state;
ssh2_bn *p; /* SSH2 defined value (p_value) */
ssh2_bn *g; /* SSH2 defined value (2) */
/* Request must fit mlkem1024nistp384 keys + 5 bytes overhead */
unsigned char request[SSH2_MLKEM_1024_PUBLIC_KEY_LEN +
SSH2_EC_P384_PUBLIC_KEY_LEN + 5];
unsigned char *data;
size_t request_len;
size_t data_len;
#if LIBSSH2_ECDSA
ssh2_ec_key *private_key; /* SSH2 ecdh private key */
#endif
unsigned char *public_key_oct; /* SSH2 ecdh public key octal value */
size_t public_key_oct_len; /* SSH2 ecdh public key octal value
length */
unsigned char *curve25519_public_key; /* curve25519 public key, 32
bytes */
unsigned char *curve25519_private_key; /* curve25519 private key, 32
bytes */
unsigned char *mlkem_public_key; /* ML-KEM public key */
size_t mlkem_public_key_len;
unsigned char *mlkem_private_key; /* ML-KEM private key */
size_t mlkem_private_key_len;
};
struct key_exchange_state {
ssh2_NB_states state;
struct packet_require_state req_state;
struct key_exchange_state_low key_state_low;
unsigned char *data;
size_t data_len;
unsigned char *oldlocal;
size_t oldlocal_len;
};
#define FwdNotReq "Forward not requested"
struct packet_queue_listener_state {
ssh2_NB_states state;
unsigned char packet[17 + sizeof(FwdNotReq) - 1];
unsigned char *host;
unsigned char *shost;
uint32_t sender_channel;
uint32_t initial_window_size;
uint32_t packet_size;
uint32_t port;
uint32_t sport;
uint32_t host_len;
uint32_t shost_len;
LIBSSH2_CHANNEL *channel;
};
#define X11FwdUnAvil "X11 Forward Unavailable"
struct packet_x11_open_state {
ssh2_NB_states state;
unsigned char packet[17 + sizeof(X11FwdUnAvil) - 1];
unsigned char *shost;
uint32_t sender_channel;
uint32_t initial_window_size;
uint32_t packet_size;
uint32_t sport;
uint32_t shost_len;
LIBSSH2_CHANNEL *channel;
};
#define AuthAgentUnavail "Auth Agent unavailable"
struct packet_authagent_state {
ssh2_NB_states state;
unsigned char packet[17 + sizeof(AuthAgentUnavail) - 1];
uint32_t sender_channel;
uint32_t initial_window_size;
uint32_t packet_size;
LIBSSH2_CHANNEL *channel;
};
struct packet {
struct list_node node; /* linked list header */
/* the raw unencrypted payload */
unsigned char *data;
size_t data_len;
/* Where to start reading data from,
* used for channel data that is been partially consumed */
size_t data_head;
};
struct channel_data {
/* Identifier */
uint32_t id;
/* Limits and restrictions */
uint32_t window_size_initial, window_size, packet_size;
/* Set to 1 when CHANNEL_CLOSE / CHANNEL_EOF sent/received */
char close, eof, extended_data_ignore_mode;
};
#if defined(__clang__) && __clang_major__ >= 13
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wreserved-identifier"
#endif
struct _LIBSSH2_CHANNEL {
struct list_node node;
unsigned char *channel_type;
size_t channel_type_len;
/* channel's program exit status */
int exit_status;
/* channel's program exit signal (without the SIG prefix) */
char *exit_signal;
struct channel_data local, remote;
/* Amount of bytes to be refunded to receive window (but not yet sent) */
uint32_t adjust_queue;
/* Data immediately available for reading */
size_t read_avail;
LIBSSH2_SESSION *session;
void *abstract;
LIBSSH2_CHANNEL_CLOSE_FUNC(*close_cb);
/* State variables used in libssh2_channel_setenv_ex() */
ssh2_NB_states setenv_state;
unsigned char *setenv_packet;
size_t setenv_packet_len;
unsigned char setenv_local_channel[4];
struct packet_requirev_state setenv_packet_requirev_state;
/* State variables used in libssh2_channel_request_pty_ex()
libssh2_channel_request_pty_size_ex() */
ssh2_NB_states reqPTY_state;
unsigned char reqPTY_packet[41 + 256];
size_t reqPTY_packet_len;
unsigned char reqPTY_local_channel[4];
struct packet_requirev_state reqPTY_packet_requirev_state;
/* State variables used in libssh2_channel_x11_req_ex() */
ssh2_NB_states reqX11_state;
unsigned char *reqX11_packet;
size_t reqX11_packet_len;
unsigned char reqX11_local_channel[4];
struct packet_requirev_state reqX11_packet_requirev_state;
/* State variables used in libssh2_channel_process_startup() */
ssh2_NB_states process_state;
unsigned char *process_packet;
size_t process_packet_len;
unsigned char process_local_channel[4];
struct packet_requirev_state process_packet_requirev_state;
/* State variables used in libssh2_channel_flush_ex() */
ssh2_NB_states flush_state;
size_t flush_refund_bytes;
size_t flush_flush_bytes;
/* State variables used in libssh2_channel_receive_window_adjust2() */
ssh2_NB_states adjust_state;
unsigned char adjust_adjust[9]; /* packet_type(1) + channel(4) +
adjustment(4) */
/* State variables used in libssh2_channel_read_ex() */
ssh2_NB_states read_state;
uint32_t read_local_id;
/* State variables used in libssh2_channel_write_ex() */
ssh2_NB_states write_state;
unsigned char write_packet[13];
size_t write_packet_len;
size_t write_bufwrite;
/* State variables used in libssh2_channel_close() */
ssh2_NB_states close_state;
unsigned char close_packet[5];
/* State variables used in channel_wait_eof() */
ssh2_NB_states wait_eof_state;
/* State variables used in libssh2_channel_wait_closed() */
ssh2_NB_states wait_closed_state;
/* State variables used in libssh2_channel_free() */
ssh2_NB_states free_state;
/* State variables used in libssh2_channel_handle_extended_data2() */
ssh2_NB_states extData2_state;
/* State variables used in libssh2_channel_request_auth_agent() */
ssh2_NB_states req_auth_agent_try_state;
ssh2_NB_states req_auth_agent_state;
unsigned char req_auth_agent_packet[36];
size_t req_auth_agent_packet_len;
unsigned char req_auth_agent_local_channel[4];
struct packet_requirev_state req_auth_agent_requirev_state;
/* State variables used in libssh2_channel_signal_ex() */
ssh2_NB_states sendsignal_state;
unsigned char *sendsignal_packet;
size_t sendsignal_packet_len;
};
struct _LIBSSH2_LISTENER {
struct list_node node; /* linked list header */
LIBSSH2_SESSION *session;
char *host;
int port;
/* a list of CHANNELs for this listener */
struct list_head queue;
int queue_size;
int queue_maxsize;
/* State variables used in libssh2_channel_forward_cancel() */
ssh2_NB_states chanFwdCncl_state;
unsigned char *chanFwdCncl_data;
size_t chanFwdCncl_data_len;
};
#if defined(__clang__) && __clang_major__ >= 13
#pragma clang diagnostic pop
#endif
struct endpoint_data {
char *banner;
unsigned char *kexinit;
size_t kexinit_len;
const struct crypt_method *crypt;
void *crypt_abstract;
const struct mac_method *mac;
uint32_t seqno;
void *mac_abstract;
const struct comp_method *comp;
void *comp_abstract;
/* Method Preferences -- NULL yields "load order" */
char *crypt_prefs;
char *mac_prefs;
char *comp_prefs;
char *lang_prefs;
};
#define PACKETBUFSIZE MAX_SSH_PACKET_LEN
struct transportpacket {
/* ------------- for incoming data --------------- */
unsigned char buf[PACKETBUFSIZE];
unsigned char init[5]; /* first 5 bytes of the incoming data stream,
still encrypted */
size_t writeidx; /* at what array index we do the next write into
the buffer */
size_t readidx; /* at what array index we do the next read from
the buffer */
uint32_t packet_length; /* the most recent packet_length as read from the
network data */
uint8_t padding_length; /* the most recent padding_length as read from the
network data */
size_t data_num; /* How much of the total package that has been read
so far. */
size_t total_num; /* How much a total package is supposed to be, in
number of bytes. A full package is
packet_length + padding_length + 4 +
mac_length. */
unsigned char *payload; /* this is a pointer to a SSH2_ALLOC()
area to which we write incoming packet data
which is not yet decrypted in etm mode. */
unsigned char *wptr; /* write pointer into the payload to where we
are currently writing decrypted data */
/* ------------- for outgoing data --------------- */
unsigned char outbuf[MAX_SSH_PACKET_LEN]; /* area for the outgoing data */
ssize_t ototal_num; /* size of outbuf in number of bytes */
const unsigned char *odata; /* original pointer to the data */
size_t olen; /* original size of the data we stored in
outbuf */
size_t osent; /* number of bytes already sent */
};
#if defined(__clang__) && __clang_major__ >= 13
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wreserved-identifier"
#endif
struct _LIBSSH2_PUBLICKEY {
LIBSSH2_CHANNEL *channel;
uint32_t version;
/* State variables used in publickey_packet_receive() */
ssh2_NB_states receive_state;
unsigned char *receive_packet;
size_t receive_packet_len;
/* State variables used in libssh2_publickey_add_ex() */
ssh2_NB_states add_state;
unsigned char *add_packet;
unsigned char *add_s;
/* State variables used in libssh2_publickey_remove_ex() */
ssh2_NB_states remove_state;
unsigned char *remove_packet;
unsigned char *remove_s;
/* State variables used in libssh2_publickey_list_fetch() */
ssh2_NB_states listFetch_state;
unsigned char *listFetch_s;
unsigned char listFetch_buffer[12];
unsigned char *listFetch_data;
size_t listFetch_data_len;
};
#if defined(__clang__) && __clang_major__ >= 13
#pragma clang diagnostic pop
#endif
#define SSH2_SCP_RESPONSE_BUFLEN 256
/* Parse SCP "C" response mode/size; used by scp_recv and unit tests. */
int ssh2_scp_parse_c_fields(const char *buf, size_t len,
long *mode_out, libssh2_int64_t *size_out);
struct flags {
int sigpipe; /* LIBSSH2_FLAG_SIGPIPE */
int compress; /* LIBSSH2_FLAG_COMPRESS */
int quote_paths; /* LIBSSH2_FLAG_QUOTE_PATHS */
};
#if defined(__clang__) && __clang_major__ >= 13
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wreserved-identifier"
#endif
struct _LIBSSH2_SESSION {
/* Memory management callbacks */
void *abstract;
LIBSSH2_ALLOC_FUNC(*alloc);
LIBSSH2_REALLOC_FUNC(*realloc);
LIBSSH2_FREE_FUNC(*free);
/* Other callbacks */
LIBSSH2_IGNORE_FUNC(*ssh_msg_ignore);
LIBSSH2_DEBUG_FUNC(*ssh_msg_debug);
LIBSSH2_DISCONNECT_FUNC(*ssh_msg_disconnect);
LIBSSH2_MACERROR_FUNC(*macerror);
LIBSSH2_X11_OPEN_FUNC(*x11);
LIBSSH2_AUTHAGENT_FUNC(*authagent);
LIBSSH2_ADD_IDENTITIES_FUNC(*addLocalIdentities);
LIBSSH2_AUTHAGENT_SIGN_FUNC(*agentSignCallback);
LIBSSH2_SEND_FUNC(*send);
LIBSSH2_RECV_FUNC(*recv);
/* Method preferences -- NULL yields "load order" */
char *kex_prefs;
char *hostkey_prefs;
int state;
/* Flag options */
struct flags flag;
/* Agreed Key Exchange Method */
const struct kex_method *kex;
unsigned int burn_optimistic_kexinit;
unsigned char *session_id;
uint32_t session_id_len;
/* this is set to TRUE if a blocking API behavior is requested */
int api_block_mode;
/* Timeout used when blocking API behavior is active */
long api_timeout_ms;
/* Server's public key */
const struct hostkey_method *hostkey;
void *server_hostkey_abstract;
/* Either set with libssh2_session_hostkey() (for server mode)
* Or read from server in (eg) KEXDH_INIT (for client mode)
*/
unsigned char *server_hostkey;
uint32_t server_hostkey_len;
#if LIBSSH2_MD5
unsigned char server_hostkey_md5[SSH2_MD5_DIG_LEN];
int server_hostkey_md5_valid;
#endif /* !LIBSSH2_MD5 */
unsigned char server_hostkey_sha1[SSH2_SHA1_DIG_LEN];
int server_hostkey_sha1_valid;
unsigned char server_hostkey_sha256[SSH2_SHA256_DIG_LEN];
int server_hostkey_sha256_valid;
/* public key algorithms accepted as comma separated list */
char *server_sign_algorithms;
/* key signing algorithm preferences -- NULL yields server order */
char *sign_algo_prefs;
/* Whether to use the OpenSSH Strict KEX extension */
int kex_strict;
/* (remote as source of data -- packet_read) */
struct endpoint_data remote;
/* (local as source of data -- packet_write) */
struct endpoint_data local;
/* Inbound Data linked list -- Sometimes the packet that comes in is not
the packet we are ready for */
struct list_head packets;
/* Active connection channels */
struct list_head channels;
uint32_t next_channel;
struct list_head listeners; /* list of LIBSSH2_LISTENER structs */
/* Actual I/O socket */
libssh2_socket_t socket_fd;
int socket_state;
int socket_block_directions;
int socket_prev_blockstate; /* stores the state of the socket blockiness
when libssh2_session_handshake()
is called */
/* Error tracking */
const char *err_msg;
int err_code;
int err_flags;
/* struct members for packet-level reading */
struct transportpacket packet;
#ifdef LIBSSH2DEBUG
int showmask; /* what debug/trace messages to display */
libssh2_trace_handler_func tracehandler; /* callback to display trace
messages */
void *tracehandler_context; /* context for the trace handler */
#endif
/* State variables used in session_banner_receive(),
session_banner_send() */
ssh2_NB_states banner_TxRx_state;
char banner_TxRx_banner[8192];
ssize_t banner_TxRx_total_send;
/* State variables used in kexinit() */
ssh2_NB_states kexinit_state;
unsigned char *kexinit_data;
size_t kexinit_data_len;
/* State variables used in libssh2_session_handshake() */
ssh2_NB_states startup_state;
unsigned char *startup_data;
size_t startup_data_len;
unsigned char startup_service[sizeof("ssh-userauth") + 5 - 1];
size_t startup_service_length;
struct packet_require_state startup_req_state;
struct key_exchange_state startup_key_state;
/* State variables used in libssh2_session_free() */
ssh2_NB_states free_state;
/* State variables used in libssh2_session_disconnect_ex() */
ssh2_NB_states disconnect_state;
unsigned char disconnect_data[256 + 13];
size_t disconnect_data_len;
/* State variables used in ssh2_packet_add() */
ssh2_NB_states readPack_state;
int readPack_encrypted;
/* State variables used in libssh2_userauth_list() */
ssh2_NB_states userauth_list_state;
unsigned char *userauth_list_data;
size_t userauth_list_data_len;
char *userauth_banner;
struct packet_requirev_state userauth_list_packet_requirev_state;
/* State variables used in libssh2_userauth_password_ex() */
ssh2_NB_states userauth_pswd_state;
unsigned char *userauth_pswd_data;
unsigned char userauth_pswd_data0;
size_t userauth_pswd_data_len;
char *userauth_pswd_newpw;
int userauth_pswd_newpw_len;
struct packet_requirev_state userauth_pswd_packet_requirev_state;
/* State variables used in libssh2_userauth_hostbased_fromfile_ex() */
ssh2_NB_states userauth_host_state;
unsigned char *userauth_host_data;
size_t userauth_host_data_len;
unsigned char *userauth_host_packet;
size_t userauth_host_packet_len;
char *userauth_host_method;
unsigned char *userauth_host_s;
struct packet_requirev_state userauth_host_packet_requirev_state;
/* State variables used in libssh2_userauth_publickey_fromfile_ex() */
ssh2_NB_states userauth_pblc_state;
unsigned char *userauth_pblc_data;
size_t userauth_pblc_data_len;
unsigned char *userauth_pblc_packet;
size_t userauth_pblc_packet_len;
char *userauth_pblc_method;
unsigned char *userauth_pblc_s;
unsigned char *userauth_pblc_b;
struct packet_requirev_state userauth_pblc_packet_requirev_state;
/* State variables used in libssh2_userauth_keyboard_interactive_ex() */
ssh2_NB_states userauth_kybd_state;
unsigned char *userauth_kybd_data;
size_t userauth_kybd_data_len;
unsigned char *userauth_kybd_packet;
size_t userauth_kybd_packet_len;
size_t userauth_kybd_auth_name_len;
unsigned char *userauth_kybd_auth_name;
size_t userauth_kybd_auth_instruction_len;
unsigned char *userauth_kybd_auth_instruction;
unsigned int userauth_kybd_num_prompts;
int userauth_kybd_auth_failure;
LIBSSH2_USERAUTH_KBDINT_PROMPT *userauth_kybd_prompts;
LIBSSH2_USERAUTH_KBDINT_RESPONSE *userauth_kybd_responses;
struct packet_requirev_state userauth_kybd_packet_requirev_state;
/* State variables used in libssh2_channel_open_ex() */
ssh2_NB_states open_state;
struct packet_requirev_state open_packet_requirev_state;
LIBSSH2_CHANNEL *open_channel;
unsigned char *open_packet;
size_t open_packet_len;
unsigned char *open_data;
size_t open_data_len;
uint32_t open_local_channel;
/* State variables used in libssh2_channel_direct_tcpip_ex() */
ssh2_NB_states direct_state;
unsigned char *direct_message;
size_t direct_host_len;
size_t direct_shost_len;
size_t direct_message_len;
/* State variables used in libssh2_channel_forward_listen_ex() */
ssh2_NB_states fwdLstn_state;
unsigned char *fwdLstn_packet;
uint32_t fwdLstn_host_len;
uint32_t fwdLstn_packet_len;
struct packet_requirev_state fwdLstn_packet_requirev_state;
/* State variables used in libssh2_publickey_init() */
ssh2_NB_states pkeyInit_state;
LIBSSH2_PUBLICKEY *pkeyInit_pkey;
LIBSSH2_CHANNEL *pkeyInit_channel;
unsigned char *pkeyInit_data;
size_t pkeyInit_data_len;
/* 19 = packet_len(4) + version_len(4) + "version"(7) + version_num(4) */
unsigned char pkeyInit_buffer[4 + 4 + sizeof("version") - 1 + 4];
size_t pkeyInit_buffer_sent; /* how much of buffer that has been sent */
/* State variables used in ssh2_packet_add() */
ssh2_NB_states packAdd_state;
LIBSSH2_CHANNEL *packAdd_channelp; /* keeper of the channel during EAGAIN
states */
struct packet_queue_listener_state packAdd_Qlstn_state;
struct packet_x11_open_state packAdd_x11open_state;
struct packet_authagent_state packAdd_authagent_state;
/* State variables used in transport_fullpacket() */
ssh2_NB_states fullpacket_state;
int fullpacket_macstate;
size_t fullpacket_payload_len;
int fullpacket_packet_type;
uint32_t fullpacket_required_type;
/* State variables used in libssh2_sftp_init() */
ssh2_NB_states sftpInit_state;
LIBSSH2_SFTP *sftpInit_sftp;
LIBSSH2_CHANNEL *sftpInit_channel;
unsigned char sftpInit_buffer[9]; /* sftp_header(5){excludes request_id}
+ version_id(4) */
size_t sftpInit_sent; /* number of bytes from the buffer that have been
sent */
/* State variables used in libssh2_scp_recv2() */
ssh2_NB_states scpRecv_state;
char *scpRecv_command;
size_t scpRecv_command_len;
unsigned char scpRecv_response[SSH2_SCP_RESPONSE_BUFLEN];
size_t scpRecv_response_len;
long scpRecv_mode;
libssh2_int64_t scpRecv_size;
time_t scpRecv_mtime;
time_t scpRecv_atime;
LIBSSH2_CHANNEL *scpRecv_channel;
/* State variables used in libssh2_scp_send_ex() */
ssh2_NB_states scpSend_state;
char *scpSend_command;
size_t scpSend_command_len;
unsigned char scpSend_response[SSH2_SCP_RESPONSE_BUFLEN];
size_t scpSend_response_len;
LIBSSH2_CHANNEL *scpSend_channel;
/* Keepalive variables used by keepalive.c. */
ssh2_timediff_t keepalive_interval;
int keepalive_want_reply;
ssh2_time_t keepalive_last_sent;
/* Configurable timeout for packets. Replaces LIBSSH2_READ_TIMEOUT */
ssh2_timediff_t packet_read_timeout;
};
#if defined(__clang__) && __clang_major__ >= 13
#pragma clang diagnostic pop
#endif
/* session.state bits */
#define SSH2_STATE_INITIAL_KEX 0x00000001
#define SSH2_STATE_EXCHANGING_KEYS 0x00000002
#define SSH2_STATE_NEWKEYS 0x00000004
#define SSH2_STATE_AUTHENTICATED 0x00000008
#define SSH2_STATE_KEX_ACTIVE 0x00000010
/* session.flag helpers */
#ifdef MSG_NOSIGNAL
#define SSH2_SOCKET_SEND_FLAGS(session) \
((session)->flag.sigpipe ? 0 : MSG_NOSIGNAL)
#define SSH2_SOCKET_RECV_FLAGS(session) \
((session)->flag.sigpipe ? 0 : MSG_NOSIGNAL)
#else
/* If MSG_NOSIGNAL is not defined we are SOL on blocking SIGPIPE */
#define SSH2_SOCKET_SEND_FLAGS(session) 0
#define SSH2_SOCKET_RECV_FLAGS(session) 0
#endif
/* --------- */