libssh: /build/libssh/src/libssh-0.12.2/include/libssh/libssh.h Source File

libssh 0.12.2 The SSH library

Loading...
Searching...
No Matches
libssh.h
1/*
2 * This file is part of the SSH Library
3 *
4 * Copyright (c) 2003-2026 by Aris Adamantiadis and the libssh team
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#ifndef _LIBSSH_H
22#define _LIBSSH_H
23
24#include <libssh/libssh_version.h>
25
26#if defined _WIN32 || defined __CYGWIN__
27 #ifdef LIBSSH_STATIC
28 #define LIBSSH_API
29 #else
30 #ifdef LIBSSH_EXPORTS
31 #ifdef __GNUC__
32 #define LIBSSH_API __attribute__((dllexport))
33 #else
34 #define LIBSSH_API __declspec(dllexport)
35 #endif
36 #else
37 #ifdef __GNUC__
38 #define LIBSSH_API __attribute__((dllimport))
39 #else
40 #define LIBSSH_API __declspec(dllimport)
41 #endif
42 #endif
43 #endif
44#else
45 #if __GNUC__ >= 4 && !defined(__OS2__)
46 #define LIBSSH_API __attribute__((visibility("default")))
47 #else
48 #define LIBSSH_API
49 #endif
50#endif
51
52#include <inttypes.h>
53#include <stdarg.h>
54#include <stdbool.h>
55#include <stdint.h>
56
57#ifdef _MSC_VER
58 typedef int mode_t;
59#else /* _MSC_VER */
60 #include <unistd.h>
61 #include <sys/types.h>
62#endif /* _MSC_VER */
63
64#ifdef _WIN32
65 #include <winsock2.h>
66#else /* _WIN32 */
67 #include <sys/select.h> /* for fd_set * */
68 #include <netdb.h>
69#endif /* _WIN32 */
70
71#define SSH_STRINGIFY(s) SSH_TOSTRING(s)
72#define SSH_TOSTRING(s) #s
73
74/* GCC have printf type attribute check. */
75#ifdef __GNUC__
76#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
77#else
78#define PRINTF_ATTRIBUTE(a,b)
79#endif /* __GNUC__ */
80
81#if !defined(SSH_SUPPRESS_DEPRECATED) && defined(__GNUC__)
82#define SSH_DEPRECATED __attribute__ ((deprecated))
83#else
84#define SSH_DEPRECATED
85#endif
86
87#ifdef __cplusplus
88extern "C" {
89#endif
90
91struct ssh_counter_struct {
92 uint64_t in_bytes;
93 uint64_t out_bytes;
94 uint64_t in_packets;
95 uint64_t out_packets;
96};
97typedef struct ssh_counter_struct *ssh_counter;
98
99typedef struct ssh_agent_struct* ssh_agent;
100typedef struct ssh_buffer_struct* ssh_buffer;
101typedef struct ssh_channel_struct* ssh_channel;
102typedef struct ssh_message_struct* ssh_message;
103typedef struct ssh_pcap_file_struct* ssh_pcap_file;
104typedef struct ssh_key_struct* ssh_key;
105typedef struct ssh_scp_struct* ssh_scp;
106typedef struct ssh_session_struct* ssh_session;
107typedef struct ssh_string_struct* ssh_string;
108typedef struct ssh_event_struct* ssh_event;
109typedef struct ssh_connector_struct * ssh_connector;
110typedef struct ssh_pki_ctx_struct *ssh_pki_ctx;
111typedef void* ssh_gssapi_creds;
112
113/* Socket type */
114#ifdef _WIN32
115#ifndef socket_t
116typedef SOCKET socket_t;
117#endif /* socket_t */
118#else /* _WIN32 */
119#ifndef socket_t
120typedef int socket_t;
121#endif
122#endif /* _WIN32 */
123
124#define SSH_INVALID_SOCKET ((socket_t) -1)
125
126/* the offsets of methods */
127enum ssh_kex_types_e {
128 SSH_KEX=0,
129 SSH_HOSTKEYS,
130 SSH_CRYPT_C_S,
131 SSH_CRYPT_S_C,
132 SSH_MAC_C_S,
133 SSH_MAC_S_C,
134 SSH_COMP_C_S,
135 SSH_COMP_S_C,
136 SSH_LANG_C_S,
137 SSH_LANG_S_C
138};
139
140#define SSH_CRYPT 2
141#define SSH_MAC 3
142#define SSH_COMP 4
143#define SSH_LANG 5
144
145enum ssh_auth_e {
146 SSH_AUTH_SUCCESS=0,
147 SSH_AUTH_DENIED,
148 SSH_AUTH_PARTIAL,
149 SSH_AUTH_INFO,
150 SSH_AUTH_AGAIN,
151 SSH_AUTH_ERROR=-1
152};
153
154/* auth flags */
155#define SSH_AUTH_METHOD_UNKNOWN 0x0000u
156#define SSH_AUTH_METHOD_NONE 0x0001u
157#define SSH_AUTH_METHOD_PASSWORD 0x0002u
158#define SSH_AUTH_METHOD_PUBLICKEY 0x0004u
159#define SSH_AUTH_METHOD_HOSTBASED 0x0008u
160#define SSH_AUTH_METHOD_INTERACTIVE 0x0010u
161#define SSH_AUTH_METHOD_GSSAPI_MIC 0x0020u
162#define SSH_AUTH_METHOD_GSSAPI_KEYEX 0x0040u
163
164/* messages */
165enum ssh_requests_e {
166 SSH_REQUEST_AUTH=1,
167 SSH_REQUEST_CHANNEL_OPEN,
168 SSH_REQUEST_CHANNEL,
169 SSH_REQUEST_SERVICE,
170 SSH_REQUEST_GLOBAL
171};
172
173enum ssh_channel_type_e {
174 SSH_CHANNEL_UNKNOWN=0,
175 SSH_CHANNEL_SESSION,
176 SSH_CHANNEL_DIRECT_TCPIP,
177 SSH_CHANNEL_FORWARDED_TCPIP,
178 SSH_CHANNEL_X11,
179 SSH_CHANNEL_AUTH_AGENT
180};
181
182enum ssh_channel_requests_e {
183 SSH_CHANNEL_REQUEST_UNKNOWN=0,
184 SSH_CHANNEL_REQUEST_PTY,
185 SSH_CHANNEL_REQUEST_EXEC,
186 SSH_CHANNEL_REQUEST_SHELL,
187 SSH_CHANNEL_REQUEST_ENV,
188 SSH_CHANNEL_REQUEST_SUBSYSTEM,
189 SSH_CHANNEL_REQUEST_WINDOW_CHANGE,
190 SSH_CHANNEL_REQUEST_X11
191};
192
193enum ssh_global_requests_e {
194 SSH_GLOBAL_REQUEST_UNKNOWN=0,
195 SSH_GLOBAL_REQUEST_TCPIP_FORWARD,
196 SSH_GLOBAL_REQUEST_CANCEL_TCPIP_FORWARD,
197 SSH_GLOBAL_REQUEST_KEEPALIVE,
198 SSH_GLOBAL_REQUEST_NO_MORE_SESSIONS
199};
200
201enum ssh_publickey_state_e {
202 SSH_PUBLICKEY_STATE_ERROR=-1,
203 SSH_PUBLICKEY_STATE_NONE=0,
204 SSH_PUBLICKEY_STATE_VALID=1,
205 SSH_PUBLICKEY_STATE_WRONG=2
206};
207
208/* Status flags */
210#define SSH_CLOSED 0x01
212#define SSH_READ_PENDING 0x02
214#define SSH_CLOSED_ERROR 0x04
216#define SSH_WRITE_PENDING 0x08
217
218enum ssh_server_known_e {
219 SSH_SERVER_ERROR=-1,
220 SSH_SERVER_NOT_KNOWN=0,
221 SSH_SERVER_KNOWN_OK,
222 SSH_SERVER_KNOWN_CHANGED,
223 SSH_SERVER_FOUND_OTHER,
224 SSH_SERVER_FILE_NOT_FOUND
225};
226
227enum ssh_known_hosts_e {
231 SSH_KNOWN_HOSTS_ERROR = -2,
232
237 SSH_KNOWN_HOSTS_NOT_FOUND = -1,
238
243 SSH_KNOWN_HOSTS_UNKNOWN = 0,
244
248 SSH_KNOWN_HOSTS_OK,
249
255 SSH_KNOWN_HOSTS_CHANGED,
256
261 SSH_KNOWN_HOSTS_OTHER,
262};
263
264#ifndef MD5_DIGEST_LEN
265 #define MD5_DIGEST_LEN 16
266#endif
267/* errors */
268
269enum ssh_error_types_e {
270 SSH_NO_ERROR=0,
271 SSH_REQUEST_DENIED,
272 SSH_FATAL,
273 SSH_EINTR
274};
275
276/* some types for keys */
277enum ssh_keytypes_e{
278 SSH_KEYTYPE_UNKNOWN=0,
279 SSH_KEYTYPE_DSS=1, /* deprecated */
280 SSH_KEYTYPE_RSA,
281 SSH_KEYTYPE_RSA1,
282 SSH_KEYTYPE_ECDSA, /* deprecated */
283 SSH_KEYTYPE_ED25519,
284 SSH_KEYTYPE_DSS_CERT01, /* deprecated */
285 SSH_KEYTYPE_RSA_CERT01,
286 SSH_KEYTYPE_ECDSA_P256,
287 SSH_KEYTYPE_ECDSA_P384,
288 SSH_KEYTYPE_ECDSA_P521,
289 SSH_KEYTYPE_ECDSA_P256_CERT01,
290 SSH_KEYTYPE_ECDSA_P384_CERT01,
291 SSH_KEYTYPE_ECDSA_P521_CERT01,
292 SSH_KEYTYPE_ED25519_CERT01,
293 SSH_KEYTYPE_SK_ECDSA,
294 SSH_KEYTYPE_SK_ECDSA_CERT01,
295 SSH_KEYTYPE_SK_ED25519,
296 SSH_KEYTYPE_SK_ED25519_CERT01,
297};
298
299enum ssh_keycmp_e {
300 SSH_KEY_CMP_PUBLIC = 0,
301 SSH_KEY_CMP_PRIVATE = 1,
302 SSH_KEY_CMP_CERTIFICATE = 2,
303};
304
305#define SSH_ADDRSTRLEN 46
306
307struct ssh_knownhosts_entry {
308 char *hostname;
309 char *unparsed;
310 ssh_key publickey;
311 char *comment;
312};
313
314
315/* Error return codes */
316#define SSH_OK 0 /* No error */
317#define SSH_ERROR -1 /* Error of some kind */
318#define SSH_AGAIN -2 /* The nonblocking call must be repeated */
319#define SSH_EOF -127 /* We have already a eof */
320
326
327enum {
330 SSH_LOG_NOLOG=0,
333 SSH_LOG_WARNING,
336 SSH_LOG_PROTOCOL,
339 SSH_LOG_PACKET,
342 SSH_LOG_FUNCTIONS
343};
345#define SSH_LOG_RARE SSH_LOG_WARNING
346
353
355#define SSH_LOG_NONE 0
357#define SSH_LOG_WARN 1
359#define SSH_LOG_INFO 2
361#define SSH_LOG_DEBUG 3
363#define SSH_LOG_TRACE 4
364
366
367enum ssh_control_master_options_e {
368 SSH_CONTROL_MASTER_NO,
369 SSH_CONTROL_MASTER_AUTO,
370 SSH_CONTROL_MASTER_YES,
371 SSH_CONTROL_MASTER_ASK,
372 SSH_CONTROL_MASTER_AUTOASK
373};
374
375enum ssh_address_family_options_e {
376 SSH_ADDRESS_FAMILY_ANY,
377 SSH_ADDRESS_FAMILY_INET,
378 SSH_ADDRESS_FAMILY_INET6
379};
380
381enum ssh_options_e {
382 SSH_OPTIONS_HOST,
383 SSH_OPTIONS_PORT,
384 SSH_OPTIONS_PORT_STR,
385 SSH_OPTIONS_FD,
386 SSH_OPTIONS_USER,
387 SSH_OPTIONS_SSH_DIR,
388 SSH_OPTIONS_IDENTITY,
389 SSH_OPTIONS_ADD_IDENTITY,
390 SSH_OPTIONS_KNOWNHOSTS,
391 SSH_OPTIONS_TIMEOUT,
392 SSH_OPTIONS_TIMEOUT_USEC,
393 SSH_OPTIONS_SSH1,
394 SSH_OPTIONS_SSH2,
395 SSH_OPTIONS_LOG_VERBOSITY,
396 SSH_OPTIONS_LOG_VERBOSITY_STR,
397 SSH_OPTIONS_CIPHERS_C_S,
398 SSH_OPTIONS_CIPHERS_S_C,
399 SSH_OPTIONS_COMPRESSION_C_S,
400 SSH_OPTIONS_COMPRESSION_S_C,
401 SSH_OPTIONS_PROXYCOMMAND,
402 SSH_OPTIONS_BINDADDR,
403 SSH_OPTIONS_STRICTHOSTKEYCHECK,
404 SSH_OPTIONS_COMPRESSION,
405 SSH_OPTIONS_COMPRESSION_LEVEL,
406 SSH_OPTIONS_KEY_EXCHANGE,
407 SSH_OPTIONS_HOSTKEYS,
408 SSH_OPTIONS_GSSAPI_SERVER_IDENTITY,
409 SSH_OPTIONS_GSSAPI_CLIENT_IDENTITY,
410 SSH_OPTIONS_GSSAPI_DELEGATE_CREDENTIALS,
411 SSH_OPTIONS_HMAC_C_S,
412 SSH_OPTIONS_HMAC_S_C,
413 SSH_OPTIONS_PASSWORD_AUTH,
414 SSH_OPTIONS_PUBKEY_AUTH,
415 SSH_OPTIONS_KBDINT_AUTH,
416 SSH_OPTIONS_GSSAPI_AUTH,
417 SSH_OPTIONS_GLOBAL_KNOWNHOSTS,
418 SSH_OPTIONS_NODELAY,
419 SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES,
420 SSH_OPTIONS_PROCESS_CONFIG,
421 SSH_OPTIONS_REKEY_DATA,
422 SSH_OPTIONS_REKEY_TIME,
423 SSH_OPTIONS_RSA_MIN_SIZE,
424 SSH_OPTIONS_IDENTITY_AGENT,
425 SSH_OPTIONS_IDENTITIES_ONLY,
426 SSH_OPTIONS_CONTROL_MASTER,
427 SSH_OPTIONS_CONTROL_PATH,
428 SSH_OPTIONS_CERTIFICATE,
429 SSH_OPTIONS_PROXYJUMP,
430 SSH_OPTIONS_PROXYJUMP_CB_LIST_APPEND,
431 SSH_OPTIONS_PKI_CONTEXT,
432 SSH_OPTIONS_ADDRESS_FAMILY,
433 SSH_OPTIONS_GSSAPI_KEY_EXCHANGE,
434 SSH_OPTIONS_GSSAPI_KEY_EXCHANGE_ALGS,
435 SSH_OPTIONS_NEXT_IDENTITY,
436};
437
438enum {
440 SSH_SCP_WRITE,
442 SSH_SCP_READ,
443 SSH_SCP_RECURSIVE=0x10
444};
445
446enum ssh_scp_request_types {
448 SSH_SCP_REQUEST_NEWDIR=1,
450 SSH_SCP_REQUEST_NEWFILE,
452 SSH_SCP_REQUEST_EOF,
454 SSH_SCP_REQUEST_ENDDIR,
456 SSH_SCP_REQUEST_WARNING
457};
458
459enum ssh_connector_flags_e {
461 SSH_CONNECTOR_STDOUT = 1,
462 SSH_CONNECTOR_STDINOUT = 1,
464 SSH_CONNECTOR_STDERR = 2,
466 SSH_CONNECTOR_BOTH = 3
467};
468
469LIBSSH_API int ssh_blocking_flush(ssh_session session, int timeout);
470LIBSSH_API ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms);
471LIBSSH_API int ssh_channel_change_pty_size(ssh_channel channel,int cols,int rows);
472LIBSSH_API int ssh_channel_close(ssh_channel channel);
473#define SSH_CHANNEL_FREE(x) \
474 do { \
475 if ((x) != NULL) { \
476 ssh_channel_free(x); \
477 (x) = NULL; \
478 } \
479 } while (0)
480LIBSSH_API void ssh_channel_free(ssh_channel channel);
481LIBSSH_API int ssh_channel_get_exit_state(ssh_channel channel,
482 uint32_t *pexit_code,
483 char **pexit_signal,
484 int *pcore_dumped);
485SSH_DEPRECATED LIBSSH_API int ssh_channel_get_exit_status(ssh_channel channel);
486LIBSSH_API ssh_session ssh_channel_get_session(ssh_channel channel);
487LIBSSH_API int ssh_channel_is_closed(ssh_channel channel);
488LIBSSH_API int ssh_channel_is_eof(ssh_channel channel);
489LIBSSH_API int ssh_channel_is_open(ssh_channel channel);
490LIBSSH_API ssh_channel ssh_channel_new(ssh_session session);
491LIBSSH_API int ssh_channel_open_auth_agent(ssh_channel channel);
492LIBSSH_API int ssh_channel_open_forward(ssh_channel channel, const char *remotehost,
493 int remoteport, const char *sourcehost, int localport);
494LIBSSH_API int ssh_channel_open_forward_unix(ssh_channel channel, const char *remotepath,
495 const char *sourcehost, int localport);
496LIBSSH_API int ssh_channel_open_session(ssh_channel channel);
497LIBSSH_API int ssh_channel_open_x11(ssh_channel channel, const char *orig_addr, int orig_port);
498LIBSSH_API int ssh_channel_poll(ssh_channel channel, int is_stderr);
499LIBSSH_API int ssh_channel_poll_timeout(ssh_channel channel, int timeout, int is_stderr);
500LIBSSH_API int ssh_channel_read(ssh_channel channel, void *dest, uint32_t count, int is_stderr);
501LIBSSH_API int ssh_channel_read_timeout(ssh_channel channel, void *dest, uint32_t count, int is_stderr, int timeout_ms);
502LIBSSH_API int ssh_channel_read_nonblocking(ssh_channel channel, void *dest, uint32_t count,
503 int is_stderr);
504LIBSSH_API int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value);
505LIBSSH_API int ssh_channel_request_exec(ssh_channel channel, const char *cmd);
506LIBSSH_API int ssh_channel_request_pty(ssh_channel channel);
507LIBSSH_API int ssh_channel_request_pty_size(ssh_channel channel, const char *term,
508 int cols, int rows);
509LIBSSH_API int ssh_channel_request_pty_size_modes(ssh_channel channel, const char *term,
510 int cols, int rows, const unsigned char* modes, size_t modes_len);
511LIBSSH_API int ssh_channel_request_shell(ssh_channel channel);
512LIBSSH_API int ssh_channel_request_send_signal(ssh_channel channel, const char *signum);
513LIBSSH_API int ssh_channel_request_send_break(ssh_channel channel, uint32_t length);
514LIBSSH_API int ssh_channel_request_sftp(ssh_channel channel);
515LIBSSH_API int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem);
516LIBSSH_API int ssh_channel_request_x11(ssh_channel channel, int single_connection, const char *protocol,
517 const char *cookie, int screen_number);
518LIBSSH_API int ssh_channel_request_auth_agent(ssh_channel channel);
519LIBSSH_API int ssh_channel_send_eof(ssh_channel channel);
520LIBSSH_API void ssh_channel_set_blocking(ssh_channel channel, int blocking);
521LIBSSH_API void ssh_channel_set_counter(ssh_channel channel,
522 ssh_counter counter);
523LIBSSH_API int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len);
524LIBSSH_API int ssh_channel_write_stderr(ssh_channel channel,
525 const void *data,
526 uint32_t len);
527LIBSSH_API uint32_t ssh_channel_window_size(ssh_channel channel);
528
529LIBSSH_API char *ssh_basename (const char *path);
530LIBSSH_API void ssh_clean_pubkey_hash(unsigned char **hash);
531LIBSSH_API int ssh_connect(ssh_session session);
532
533LIBSSH_API ssh_connector ssh_connector_new(ssh_session session);
534LIBSSH_API void ssh_connector_free(ssh_connector connector);
535LIBSSH_API int ssh_connector_set_in_channel(ssh_connector connector,
536 ssh_channel channel,
537 enum ssh_connector_flags_e flags);
538LIBSSH_API int ssh_connector_set_out_channel(ssh_connector connector,
539 ssh_channel channel,
540 enum ssh_connector_flags_e flags);
541LIBSSH_API void ssh_connector_set_in_fd(ssh_connector connector, socket_t fd);
542LIBSSH_API void ssh_connector_set_out_fd(ssh_connector connector, socket_t fd);
543
544LIBSSH_API const char *ssh_copyright(void);
545LIBSSH_API void ssh_disconnect(ssh_session session);
546LIBSSH_API char *ssh_dirname (const char *path);
547LIBSSH_API int ssh_finalize(void);
548
549/* REVERSE PORT FORWARDING */
550LIBSSH_API ssh_channel ssh_channel_open_forward_port(ssh_session session,
551 int timeout_ms,
552 int *destination_port,
553 char **originator,
554 int *originator_port);
555SSH_DEPRECATED LIBSSH_API ssh_channel ssh_channel_accept_forward(ssh_session session,
556 int timeout_ms,
557 int *destination_port);
558LIBSSH_API int ssh_channel_cancel_forward(ssh_session session,
559 const char *address,
560 int port);
561LIBSSH_API int ssh_channel_listen_forward(ssh_session session,
562 const char *address,
563 int port,
564 int *bound_port);
565
566LIBSSH_API void ssh_free(ssh_session session);
567LIBSSH_API const char *ssh_get_disconnect_message(ssh_session session);
568LIBSSH_API const char *ssh_get_error(void *error);
569LIBSSH_API int ssh_get_error_code(void *error);
570LIBSSH_API socket_t ssh_get_fd(ssh_session session);
571LIBSSH_API char *ssh_get_hexa(const unsigned char *what, size_t len);
572LIBSSH_API char *ssh_get_issue_banner(ssh_session session);
573LIBSSH_API int ssh_get_openssh_version(ssh_session session);
574LIBSSH_API int ssh_request_no_more_sessions(ssh_session session);
575
576LIBSSH_API int ssh_get_server_publickey(ssh_session session, ssh_key *key);
577
578enum ssh_publickey_hash_type {
579 SSH_PUBLICKEY_HASH_SHA1,
580 SSH_PUBLICKEY_HASH_MD5,
581 SSH_PUBLICKEY_HASH_SHA256
582};
583LIBSSH_API int ssh_get_publickey_hash(const ssh_key key,
584 enum ssh_publickey_hash_type type,
585 unsigned char **hash,
586 size_t *hlen);
587
588/* DEPRECATED FUNCTIONS */
589SSH_DEPRECATED LIBSSH_API int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash);
590SSH_DEPRECATED LIBSSH_API ssh_channel ssh_forward_accept(ssh_session session, int timeout_ms);
591SSH_DEPRECATED LIBSSH_API int ssh_forward_cancel(ssh_session session, const char *address, int port);
592SSH_DEPRECATED LIBSSH_API int ssh_forward_listen(ssh_session session, const char *address, int port, int *bound_port);
593SSH_DEPRECATED LIBSSH_API int ssh_get_publickey(ssh_session session, ssh_key *key);
594SSH_DEPRECATED LIBSSH_API int ssh_write_knownhost(ssh_session session);
595SSH_DEPRECATED LIBSSH_API char *ssh_dump_knownhost(ssh_session session);
596SSH_DEPRECATED LIBSSH_API int ssh_is_server_known(ssh_session session);
597SSH_DEPRECATED LIBSSH_API void ssh_print_hexa(const char *descr, const unsigned char *what, size_t len);
598SSH_DEPRECATED LIBSSH_API int ssh_channel_select(ssh_channel *readchans, ssh_channel *writechans, ssh_channel *exceptchans, struct
599 timeval * timeout);
600
601SSH_DEPRECATED LIBSSH_API int ssh_scp_accept_request(ssh_scp scp);
602SSH_DEPRECATED LIBSSH_API int ssh_scp_close(ssh_scp scp);
603SSH_DEPRECATED LIBSSH_API int ssh_scp_deny_request(ssh_scp scp, const char *reason);
604SSH_DEPRECATED LIBSSH_API void ssh_scp_free(ssh_scp scp);
605SSH_DEPRECATED LIBSSH_API int ssh_scp_init(ssh_scp scp);
606SSH_DEPRECATED LIBSSH_API int ssh_scp_leave_directory(ssh_scp scp);
607SSH_DEPRECATED LIBSSH_API ssh_scp ssh_scp_new(ssh_session session, int mode, const char *location);
608SSH_DEPRECATED LIBSSH_API int ssh_scp_pull_request(ssh_scp scp);
609SSH_DEPRECATED LIBSSH_API int ssh_scp_push_directory(ssh_scp scp, const char *dirname, int mode);
610SSH_DEPRECATED LIBSSH_API int ssh_scp_push_file(ssh_scp scp, const char *filename, size_t size, int perms);
611SSH_DEPRECATED LIBSSH_API int ssh_scp_push_file64(ssh_scp scp, const char *filename, uint64_t size, int perms);
612SSH_DEPRECATED LIBSSH_API int ssh_scp_read(ssh_scp scp, void *buffer, size_t size);
613SSH_DEPRECATED LIBSSH_API const char *ssh_scp_request_get_filename(ssh_scp scp);
614SSH_DEPRECATED LIBSSH_API int ssh_scp_request_get_permissions(ssh_scp scp);
615SSH_DEPRECATED LIBSSH_API size_t ssh_scp_request_get_size(ssh_scp scp);
616SSH_DEPRECATED LIBSSH_API uint64_t ssh_scp_request_get_size64(ssh_scp scp);
617SSH_DEPRECATED LIBSSH_API const char *ssh_scp_request_get_warning(ssh_scp scp);
618SSH_DEPRECATED LIBSSH_API int ssh_scp_write(ssh_scp scp, const void *buffer, size_t len);
619
620
621LIBSSH_API int ssh_get_random(void *where,int len,int strong);
622LIBSSH_API int ssh_get_version(ssh_session session);
623LIBSSH_API int ssh_get_status(ssh_session session);
624LIBSSH_API int ssh_get_poll_flags(ssh_session session);
625LIBSSH_API int ssh_init(void);
626LIBSSH_API int ssh_is_blocking(ssh_session session);
627LIBSSH_API int ssh_is_connected(ssh_session session);
628
629/* KNOWN HOSTS */
630LIBSSH_API void ssh_knownhosts_entry_free(struct ssh_knownhosts_entry *entry);
631#define SSH_KNOWNHOSTS_ENTRY_FREE(e) do { \
632 if ((e) != NULL) { \
633 ssh_knownhosts_entry_free(e); \
634 e = NULL; \
635 } \
636} while(0)
637
638LIBSSH_API int ssh_known_hosts_parse_line(const char *host,
639 const char *line,
640 struct ssh_knownhosts_entry **entry);
641LIBSSH_API enum ssh_known_hosts_e ssh_session_has_known_hosts_entry(ssh_session session);
642
643LIBSSH_API int ssh_session_export_known_hosts_entry(ssh_session session,
644 char **pentry_string);
645LIBSSH_API int ssh_session_update_known_hosts(ssh_session session);
646
647LIBSSH_API enum ssh_known_hosts_e ssh_session_get_known_hosts_entry(ssh_session session,
648 struct ssh_knownhosts_entry **pentry);
649LIBSSH_API enum ssh_known_hosts_e ssh_session_is_known_server(ssh_session session);
650
651/* LOGGING */
652LIBSSH_API int ssh_set_log_level(int level);
653LIBSSH_API int ssh_get_log_level(void);
654LIBSSH_API void *ssh_get_log_userdata(void);
655LIBSSH_API int ssh_set_log_userdata(void *data);
656LIBSSH_API void ssh_vlog(int verbosity,
657 const char *function,
658 const char *format,
659 va_list *va) PRINTF_ATTRIBUTE(3, 0);
660LIBSSH_API void _ssh_log(int verbosity,
661 const char *function,
662 const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
663
664/* legacy */
665SSH_DEPRECATED LIBSSH_API void ssh_log(ssh_session session,
666 int prioriry,
667 const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
668
669LIBSSH_API ssh_channel ssh_message_channel_request_open_reply_accept(ssh_message msg);
670LIBSSH_API int ssh_message_channel_request_open_reply_accept_channel(ssh_message msg, ssh_channel chan);
671LIBSSH_API int ssh_message_channel_request_reply_success(ssh_message msg);
672#define SSH_MESSAGE_FREE(x) \
673 do { if ((x) != NULL) { ssh_message_free(x); (x) = NULL; } } while(0)
674LIBSSH_API void ssh_message_free(ssh_message msg);
675LIBSSH_API ssh_message ssh_message_get(ssh_session session);
676LIBSSH_API int ssh_message_subtype(ssh_message msg);
677LIBSSH_API int ssh_message_type(ssh_message msg);
678LIBSSH_API int ssh_mkdir (const char *pathname, mode_t mode);
679LIBSSH_API ssh_session ssh_new(void);
680
681LIBSSH_API int ssh_options_copy(ssh_session src, ssh_session *dest);
682LIBSSH_API int ssh_options_getopt(ssh_session session, int *argcptr, char **argv);
683LIBSSH_API int ssh_options_parse_config(ssh_session session, const char *filename);
684LIBSSH_API int ssh_options_set(ssh_session session, enum ssh_options_e type,
685 const void *value);
686LIBSSH_API int ssh_options_get(ssh_session session, enum ssh_options_e type,
687 char **value);
688LIBSSH_API int ssh_options_get_port(ssh_session session, unsigned int * port_target);
689LIBSSH_API int ssh_pcap_file_close(ssh_pcap_file pcap);
690LIBSSH_API void ssh_pcap_file_free(ssh_pcap_file pcap);
691LIBSSH_API ssh_pcap_file ssh_pcap_file_new(void);
692LIBSSH_API int ssh_pcap_file_open(ssh_pcap_file pcap, const char *filename);
693
699
713 typedef int (*ssh_auth_callback) (const char *prompt, char *buf, size_t len,
714 int echo, int verify, void *userdata);
715
717
718enum ssh_file_format_e {
719 SSH_FILE_FORMAT_DEFAULT = 0,
720 SSH_FILE_FORMAT_OPENSSH,
721 SSH_FILE_FORMAT_PEM,
722};
723
724LIBSSH_API ssh_key ssh_key_new(void);
725#define SSH_KEY_FREE(x) \
726 do { if ((x) != NULL) { ssh_key_free(x); x = NULL; } } while(0)
727LIBSSH_API void ssh_key_free (ssh_key key);
728LIBSSH_API enum ssh_keytypes_e ssh_key_type(const ssh_key key);
729LIBSSH_API const char *ssh_key_type_to_char(enum ssh_keytypes_e type);
730LIBSSH_API enum ssh_keytypes_e ssh_key_type_from_name(const char *name);
731LIBSSH_API int ssh_key_is_public(const ssh_key k);
732LIBSSH_API int ssh_key_is_private(const ssh_key k);
733LIBSSH_API int ssh_key_cmp(const ssh_key k1,
734 const ssh_key k2,
735 enum ssh_keycmp_e what);
736LIBSSH_API ssh_key ssh_key_dup(const ssh_key key);
737LIBSSH_API uint32_t ssh_key_get_sk_flags(const ssh_key key);
738LIBSSH_API ssh_string ssh_key_get_sk_application(const ssh_key key);
739LIBSSH_API ssh_string ssh_key_get_sk_user_id(const ssh_key key);
740
741SSH_DEPRECATED LIBSSH_API int
742 ssh_pki_generate(enum ssh_keytypes_e type, int parameter, ssh_key *pkey);
743
744LIBSSH_API int ssh_pki_generate_key(enum ssh_keytypes_e type,
745 ssh_pki_ctx pki_context,
746 ssh_key *pkey);
747
748LIBSSH_API int ssh_pki_import_privkey_base64(const char *b64_key,
749 const char *passphrase,
750 ssh_auth_callback auth_fn,
751 void *auth_data,
752 ssh_key *pkey);
753LIBSSH_API int ssh_pki_export_privkey_base64(const ssh_key privkey,
754 const char *passphrase,
755 ssh_auth_callback auth_fn,
756 void *auth_data,
757 char **b64_key);
758LIBSSH_API int
759 ssh_pki_export_privkey_base64_format(const ssh_key privkey,
760 const char *passphrase,
761 ssh_auth_callback auth_fn,
762 void *auth_data,
763 char **b64_key,
764 enum ssh_file_format_e format);
765LIBSSH_API int ssh_pki_import_privkey_file(const char *filename,
766 const char *passphrase,
767 ssh_auth_callback auth_fn,
768 void *auth_data,
769 ssh_key *pkey);
770LIBSSH_API int ssh_pki_export_privkey_file(const ssh_key privkey,
771 const char *passphrase,
772 ssh_auth_callback auth_fn,
773 void *auth_data,
774 const char *filename);
775LIBSSH_API int
776 ssh_pki_export_privkey_file_format(const ssh_key privkey,
777 const char *passphrase,
778 ssh_auth_callback auth_fn,
779 void *auth_data,
780 const char *filename,
781 enum ssh_file_format_e format);
782
783LIBSSH_API int ssh_pki_copy_cert_to_privkey(const ssh_key cert_key,
784 ssh_key privkey);
785
786LIBSSH_API int ssh_pki_import_pubkey_base64(const char *b64_key,
787 enum ssh_keytypes_e type,
788 ssh_key *pkey);
789LIBSSH_API int ssh_pki_import_pubkey_file(const char *filename,
790 ssh_key *pkey);
791
792LIBSSH_API int ssh_pki_import_cert_base64(const char *b64_cert,
793 enum ssh_keytypes_e type,
794 ssh_key *pkey);
795LIBSSH_API int ssh_pki_import_cert_file(const char *filename,
796 ssh_key *pkey);
797
798LIBSSH_API int ssh_pki_export_privkey_to_pubkey(const ssh_key privkey,
799 ssh_key *pkey);
800LIBSSH_API int ssh_pki_export_pubkey_base64(const ssh_key key,
801 char **b64_key);
802LIBSSH_API int ssh_pki_export_pubkey_file(const ssh_key key,
803 const char *filename);
804
805LIBSSH_API const char *ssh_pki_key_ecdsa_name(const ssh_key key);
806
807LIBSSH_API char *ssh_get_fingerprint_hash(enum ssh_publickey_hash_type type,
808 unsigned char *hash,
809 size_t len);
810LIBSSH_API void ssh_print_hash(enum ssh_publickey_hash_type type, unsigned char *hash, size_t len);
811LIBSSH_API int ssh_send_ignore (ssh_session session, const char *data);
812LIBSSH_API int ssh_send_debug (ssh_session session, const char *message, int always_display);
813LIBSSH_API void ssh_gssapi_set_creds(ssh_session session, const ssh_gssapi_creds creds);
814LIBSSH_API int ssh_select(ssh_channel *channels, ssh_channel *outchannels, socket_t maxfd,
815 fd_set *readfds, struct timeval *timeout);
816LIBSSH_API int ssh_service_request(ssh_session session, const char *service);
817LIBSSH_API int ssh_set_agent_channel(ssh_session session, ssh_channel channel);
818LIBSSH_API int ssh_set_agent_socket(ssh_session session, socket_t fd);
819LIBSSH_API void ssh_set_blocking(ssh_session session, int blocking);
820LIBSSH_API void ssh_set_counters(ssh_session session, ssh_counter scounter,
821 ssh_counter rcounter);
822LIBSSH_API void ssh_set_fd_except(ssh_session session);
823LIBSSH_API void ssh_set_fd_toread(ssh_session session);
824LIBSSH_API void ssh_set_fd_towrite(ssh_session session);
825LIBSSH_API void ssh_silent_disconnect(ssh_session session);
826LIBSSH_API int ssh_set_pcap_file(ssh_session session, ssh_pcap_file pcapfile);
827
828/* USERAUTH */
829LIBSSH_API int ssh_userauth_none(ssh_session session, const char *username);
830LIBSSH_API int ssh_userauth_list(ssh_session session, const char *username);
831LIBSSH_API int ssh_userauth_try_publickey(ssh_session session,
832 const char *username,
833 const ssh_key pubkey);
834LIBSSH_API int ssh_userauth_publickey(ssh_session session,
835 const char *username,
836 const ssh_key privkey);
837LIBSSH_API int ssh_userauth_agent(ssh_session session,
838 const char *username);
839LIBSSH_API int ssh_userauth_publickey_auto_get_current_identity(ssh_session session,
840 char** value);
841LIBSSH_API int ssh_userauth_publickey_auto(ssh_session session,
842 const char *username,
843 const char *passphrase);
844LIBSSH_API int ssh_userauth_password(ssh_session session,
845 const char *username,
846 const char *password);
847
848LIBSSH_API int ssh_userauth_kbdint(ssh_session session, const char *user, const char *submethods);
849LIBSSH_API const char *ssh_userauth_kbdint_getinstruction(ssh_session session);
850LIBSSH_API const char *ssh_userauth_kbdint_getname(ssh_session session);
851LIBSSH_API int ssh_userauth_kbdint_getnprompts(ssh_session session);
852LIBSSH_API const char *ssh_userauth_kbdint_getprompt(ssh_session session, unsigned int i, char *echo);
853LIBSSH_API int ssh_userauth_kbdint_getnanswers(ssh_session session);
854LIBSSH_API const char *ssh_userauth_kbdint_getanswer(ssh_session session, unsigned int i);
855LIBSSH_API int ssh_userauth_kbdint_setanswer(ssh_session session, unsigned int i,
856 const char *answer);
857LIBSSH_API int ssh_userauth_gssapi(ssh_session session);
858LIBSSH_API int ssh_userauth_gssapi_keyex(ssh_session session);
859LIBSSH_API const char *ssh_version(int req_version);
860
861LIBSSH_API void ssh_string_burn(ssh_string str);
862LIBSSH_API ssh_string ssh_string_copy(ssh_string str);
863LIBSSH_API void *ssh_string_data(ssh_string str);
864LIBSSH_API int ssh_string_fill(ssh_string str, const void *data, size_t len);
865#define SSH_STRING_FREE(x) \
866 do { if ((x) != NULL) { ssh_string_free(x); x = NULL; } } while(0)
867LIBSSH_API void ssh_string_free(ssh_string str);
868LIBSSH_API ssh_string ssh_string_from_char(const char *what);
869LIBSSH_API ssh_string ssh_string_from_data(const void *data, size_t len);
870LIBSSH_API size_t ssh_string_len(ssh_string str);
871LIBSSH_API ssh_string ssh_string_new(size_t size);
872LIBSSH_API const char *ssh_string_get_char(ssh_string str);
873LIBSSH_API char *ssh_string_to_char(ssh_string str);
874#define SSH_STRING_FREE_CHAR(x) \
875 do { if ((x) != NULL) { ssh_string_free_char(x); x = NULL; } } while(0)
876LIBSSH_API void ssh_string_free_char(char *s);
877LIBSSH_API int ssh_string_cmp(ssh_string s1, ssh_string s2);
878
879LIBSSH_API int ssh_getpass(const char *prompt, char *buf, size_t len, int echo,
880 int verify);
881
882
883typedef int (*ssh_event_callback)(socket_t fd, int revents, void *userdata);
884
885LIBSSH_API ssh_event ssh_event_new(void);
886LIBSSH_API int ssh_event_add_fd(ssh_event event, socket_t fd, short events,
887 ssh_event_callback cb, void *userdata);
888LIBSSH_API int ssh_event_add_session(ssh_event event, ssh_session session);
889LIBSSH_API int ssh_event_add_connector(ssh_event event, ssh_connector connector);
890LIBSSH_API int ssh_event_dopoll(ssh_event event, int timeout);
891LIBSSH_API int ssh_event_remove_fd(ssh_event event, socket_t fd);
892LIBSSH_API int ssh_event_remove_session(ssh_event event, ssh_session session);
893LIBSSH_API int ssh_event_remove_connector(ssh_event event, ssh_connector connector);
894LIBSSH_API void ssh_event_free(ssh_event event);
895LIBSSH_API const char* ssh_get_clientbanner(ssh_session session);
896LIBSSH_API const char* ssh_get_serverbanner(ssh_session session);
897LIBSSH_API const char* ssh_get_kex_algo(ssh_session session);
898LIBSSH_API bool ssh_session_kex_is_gss(ssh_session session);
899LIBSSH_API const char* ssh_get_cipher_in(ssh_session session);
900LIBSSH_API const char* ssh_get_cipher_out(ssh_session session);
901LIBSSH_API const char* ssh_get_hmac_in(ssh_session session);
902LIBSSH_API const char* ssh_get_hmac_out(ssh_session session);
903LIBSSH_API const char *ssh_get_supported_methods(enum ssh_kex_types_e type);
904
905LIBSSH_API ssh_buffer ssh_buffer_new(void);
906LIBSSH_API void ssh_buffer_free(ssh_buffer buffer);
907#define SSH_BUFFER_FREE(x) \
908 do { if ((x) != NULL) { ssh_buffer_free(x); x = NULL; } } while(0)
909LIBSSH_API int ssh_buffer_reinit(ssh_buffer buffer);
910LIBSSH_API int ssh_buffer_add_data(ssh_buffer buffer, const void *data, uint32_t len);
911LIBSSH_API uint32_t ssh_buffer_get_data(ssh_buffer buffer, void *data, uint32_t requestedlen);
912LIBSSH_API void *ssh_buffer_get(ssh_buffer buffer);
913LIBSSH_API uint32_t ssh_buffer_get_len(ssh_buffer buffer);
914LIBSSH_API int ssh_session_set_disconnect_message(ssh_session session, const char *message);
915
916/* SSHSIG hashes data independently from the key used, so we use a new enum
917 to avoid confusion. See
918 https://gitlab.com/jas/ietf-sshsig-format/-/blob/cc70a225cbd695d5a6f20aaebdb4b92b0818e43a/ietf-sshsig-format.md#L137
919 */
920enum sshsig_digest_e {
921 SSHSIG_DIGEST_SHA2_256 = 0,
922 SSHSIG_DIGEST_SHA2_512 = 1,
923};
924
925LIBSSH_API int sshsig_sign(const void *data,
926 size_t data_length,
927 ssh_key privkey,
928 ssh_pki_ctx pki_context,
929 const char *sig_namespace,
930 enum sshsig_digest_e hash_alg,
931 char **signature);
932LIBSSH_API int sshsig_verify(const void *data,
933 size_t data_length,
934 const char *signature,
935 const char *sig_namespace,
936 ssh_key *sign_key);
937
938/* PKI context API */
939
940enum ssh_pki_options_e {
941 SSH_PKI_OPTION_RSA_KEY_SIZE,
942
943 /* Security Key options */
944 SSH_PKI_OPTION_SK_APPLICATION,
945 SSH_PKI_OPTION_SK_FLAGS,
946 SSH_PKI_OPTION_SK_USER_ID,
947 SSH_PKI_OPTION_SK_CHALLENGE,
948 SSH_PKI_OPTION_SK_CALLBACKS,
949};
950
951/* FIDO2/U2F Operation Flags */
952
954#ifndef SSH_SK_USER_PRESENCE_REQD
955#define SSH_SK_USER_PRESENCE_REQD 0x01
956#endif
957
959#ifndef SSH_SK_USER_VERIFICATION_REQD
960#define SSH_SK_USER_VERIFICATION_REQD 0x04
961#endif
962
965#ifndef SSH_SK_FORCE_OPERATION
966#define SSH_SK_FORCE_OPERATION 0x10
967#endif
968
970#ifndef SSH_SK_RESIDENT_KEY
971#define SSH_SK_RESIDENT_KEY 0x20
972#endif
973
974LIBSSH_API ssh_pki_ctx ssh_pki_ctx_new(void);
975
976LIBSSH_API int ssh_pki_ctx_options_set(ssh_pki_ctx context,
977 enum ssh_pki_options_e option,
978 const void *value);
979
980LIBSSH_API int ssh_pki_ctx_set_sk_pin_callback(ssh_pki_ctx context,
981 ssh_auth_callback pin_callback,
982 void *userdata);
983
984#define SSH_SK_OPTION_NAME_DEVICE_PATH "device"
985#define SSH_SK_OPTION_NAME_USER_ID "user"
986
987LIBSSH_API int ssh_pki_ctx_sk_callbacks_option_set(ssh_pki_ctx context,
988 const char *name,
989 const char *value,
990 bool required);
991
992LIBSSH_API int ssh_pki_ctx_sk_callbacks_options_clear(ssh_pki_ctx context);
993
994LIBSSH_API int
995 ssh_pki_ctx_get_sk_attestation_buffer(const struct ssh_pki_ctx_struct *context,
996 ssh_buffer *attestation_buffer);
997
998LIBSSH_API void ssh_pki_ctx_free(ssh_pki_ctx context);
999
1000#define SSH_PKI_CTX_FREE(x) \
1001 do { \
1002 if ((x) != NULL) { \
1003 ssh_pki_ctx_free(x); \
1004 x = NULL; \
1005 } \
1006 } while (0)
1007
1008/* Security key resident keys API */
1009
1010LIBSSH_API int
1011 ssh_sk_resident_keys_load(const struct ssh_pki_ctx_struct *pki_context,
1012 ssh_key **resident_keys_result,
1013 size_t *num_keys_found_result);
1014
1015#ifndef LIBSSH_LEGACY_0_4
1016#include "libssh/legacy.h"
1017#endif
1018
1019#ifdef __cplusplus
1020}
1021#endif
1022#endif /* _LIBSSH_H */
ssh_userauth_kbdint_getprompt
LIBSSH_API const char * ssh_userauth_kbdint_getprompt(ssh_session session, unsigned int i, char *echo)
Get a prompt from a message block.
Definition auth.c:2299
ssh_userauth_gssapi
LIBSSH_API int ssh_userauth_gssapi(ssh_session session)
Try to authenticate through the "gssapi-with-mic" method.
Definition auth.c:2426
ssh_userauth_list
LIBSSH_API int ssh_userauth_list(ssh_session session, const char *username)
Get available authentication methods from the server.
Definition auth.c:392
ssh_userauth_kbdint_getnanswers
LIBSSH_API int ssh_userauth_kbdint_getnanswers(ssh_session session)
Get the number of answers the client has given.
Definition auth.c:2327
ssh_auth_callback
int(* ssh_auth_callback)(const char *prompt, char *buf, size_t len, int echo, int verify, void *userdata)
SSH authentication callback for password and publickey auth.
Definition libssh.h:713
ssh_userauth_kbdint_getanswer
LIBSSH_API const char * ssh_userauth_kbdint_getanswer(ssh_session session, unsigned int i)
Get the answer to a question from a message block.
Definition auth.c:2345
ssh_userauth_password
LIBSSH_API int ssh_userauth_password(ssh_session session, const char *username, const char *password)
Try to authenticate by password.
Definition auth.c:1741
ssh_userauth_publickey_auto
LIBSSH_API int ssh_userauth_publickey_auto(ssh_session session, const char *username, const char *passphrase)
Tries to automatically authenticate with public key and "none".
Definition auth.c:1388
ssh_userauth_none
LIBSSH_API int ssh_userauth_none(ssh_session session, const char *username)
Try to authenticate through the "none" method.
Definition auth.c:422
ssh_userauth_try_publickey
LIBSSH_API int ssh_userauth_try_publickey(ssh_session session, const char *username, const ssh_key pubkey)
Try to authenticate with the given public key.
Definition auth.c:610
ssh_set_agent_channel
LIBSSH_API int ssh_set_agent_channel(ssh_session session, ssh_channel channel)
sets the SSH agent channel. The SSH agent channel will be used to authenticate this client using an a...
Definition agent.c:178
ssh_userauth_kbdint_getname
LIBSSH_API const char * ssh_userauth_kbdint_getname(ssh_session session)
Get the "name" of the message block.
Definition auth.c:2238
ssh_userauth_kbdint
LIBSSH_API int ssh_userauth_kbdint(ssh_session session, const char *user, const char *submethods)
Try to authenticate through the "keyboard-interactive" method.
Definition auth.c:2171
ssh_userauth_kbdint_setanswer
LIBSSH_API int ssh_userauth_kbdint_setanswer(ssh_session session, unsigned int i, const char *answer)
Set the answer for a question from a message block.
Definition auth.c:2378
ssh_userauth_agent
LIBSSH_API int ssh_userauth_agent(ssh_session session, const char *username)
Try to do public key authentication with ssh agent.
Definition auth.c:1025
ssh_userauth_publickey_auto_get_current_identity
LIBSSH_API int ssh_userauth_publickey_auto_get_current_identity(ssh_session session, char **value)
Get the identity that is currently being processed by ssh_userauth_publickey_auto().
Definition auth.c:1325
ssh_set_agent_socket
LIBSSH_API int ssh_set_agent_socket(ssh_session session, socket_t fd)
sets the SSH agent socket. The SSH agent will be used to authenticate this client using the given soc...
Definition agent.c:201
ssh_userauth_publickey
LIBSSH_API int ssh_userauth_publickey(ssh_session session, const char *username, const ssh_key privkey)
Authenticate with public/private key or certificate.
Definition auth.c:739
ssh_userauth_kbdint_getnprompts
LIBSSH_API int ssh_userauth_kbdint_getnprompts(ssh_session session)
Get the number of prompts (questions) the server has given.
Definition auth.c:2215
ssh_userauth_gssapi_keyex
LIBSSH_API int ssh_userauth_gssapi_keyex(ssh_session session)
Try to authenticate through the "gssapi-keyex" method.
Definition auth.c:2487
ssh_userauth_kbdint_getinstruction
LIBSSH_API const char * ssh_userauth_kbdint_getinstruction(ssh_session session)
Get the "instruction" of the message block.
Definition auth.c:2262
ssh_buffer_new
LIBSSH_API ssh_buffer ssh_buffer_new(void)
Create a new SSH buffer.
Definition buffer.c:120
ssh_channel_request_subsystem
LIBSSH_API int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem)
Request a subsystem (for example "sftp").
Definition channels.c:2205
ssh_channel_send_eof
LIBSSH_API int ssh_channel_send_eof(ssh_channel channel)
Send an end of file on the channel.
Definition channels.c:1405
ssh_channel_select
SSH_DEPRECATED LIBSSH_API int ssh_channel_select(ssh_channel *readchans, ssh_channel *writechans, ssh_channel *exceptchans, struct timeval *timeout)
Act like the standard select(2) on channels.
Definition channels.c:3685
ssh_channel_poll
LIBSSH_API int ssh_channel_poll(ssh_channel channel, int is_stderr)
Polls a channel for data to read.
Definition channels.c:3343
ssh_channel_get_exit_state
LIBSSH_API int ssh_channel_get_exit_state(ssh_channel channel, uint32_t *pexit_code, char **pexit_signal, int *pcore_dumped)
Get the exit state of the channel (error code from the executed instruction or signal).
Definition channels.c:3508
ssh_channel_set_blocking
LIBSSH_API void ssh_channel_set_blocking(ssh_channel channel, int blocking)
Put the channel into blocking or nonblocking mode.
Definition channels.c:1817
ssh_channel_close
LIBSSH_API int ssh_channel_close(ssh_channel channel)
Close a channel.
Definition channels.c:1466
ssh_channel_request_pty_size_modes
LIBSSH_API int ssh_channel_request_pty_size_modes(ssh_channel channel, const char *term, int cols, int rows, const unsigned char *modes, size_t modes_len)
Request a pty with a specific type and size.
Definition channels.c:2027
ssh_channel_read_timeout
LIBSSH_API int ssh_channel_read_timeout(ssh_channel channel, void *dest, uint32_t count, int is_stderr, int timeout_ms)
Reads data from a channel.
Definition channels.c:3172
ssh_channel_request_pty
LIBSSH_API int ssh_channel_request_pty(ssh_channel channel)
Request a PTY.
Definition channels.c:2122
ssh_channel_cancel_forward
LIBSSH_API int ssh_channel_cancel_forward(ssh_session session, const char *address, int port)
Sends the "cancel-tcpip-forward" global request to ask the server to cancel the tcpip-forward request...
Definition channels.c:2752
ssh_channel_request_sftp
LIBSSH_API int ssh_channel_request_sftp(ssh_channel channel)
Request sftp subsystem on the channel.
Definition channels.c:2255
ssh_channel_accept_forward
SSH_DEPRECATED LIBSSH_API ssh_channel ssh_channel_accept_forward(ssh_session session, int timeout_ms, int *destination_port)
Accept an incoming TCP/IP forwarding channel and get some information about incoming connection.
Definition channels.c:2709
ssh_channel_open_forward_port
LIBSSH_API ssh_channel ssh_channel_open_forward_port(ssh_session session, int timeout_ms, int *destination_port, char **originator, int *originator_port)
Accept an incoming TCP/IP forwarding channel and get information about incoming connection.
Definition channels.c:2733
ssh_channel_accept_x11
LIBSSH_API ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms)
Accept an X11 forwarding channel.
Definition channels.c:2433
ssh_channel_request_exec
LIBSSH_API int ssh_channel_request_exec(ssh_channel channel, const char *cmd)
Run a shell command without an interactive shell.
Definition channels.c:2881
ssh_channel_write
LIBSSH_API int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel.
Definition channels.c:1748
ssh_channel_open_auth_agent
LIBSSH_API int ssh_channel_open_auth_agent(ssh_channel channel)
Open an agent authentication forwarding channel. This type of channel can be opened by a server towar...
Definition channels.c:1123
ssh_channel_get_session
LIBSSH_API ssh_session ssh_channel_get_session(ssh_channel channel)
Recover the session in which belongs a channel.
Definition channels.c:3457
ssh_channel_listen_forward
LIBSSH_API int ssh_channel_listen_forward(ssh_session session, const char *address, int port, int *bound_port)
Sends the "tcpip-forward" global request to ask the server to begin listening for inbound connections...
Definition channels.c:2643
ssh_channel_request_env
LIBSSH_API int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value)
Set environment variables.
Definition channels.c:2804
ssh_channel_write_stderr
LIBSSH_API int ssh_channel_write_stderr(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel stderr.
Definition channels.c:3858
ssh_channel_open_forward_unix
LIBSSH_API int ssh_channel_open_forward_unix(ssh_channel channel, const char *remotepath, const char *sourcehost, int localport)
Open a TCP/IP - UNIX domain socket forwarding channel.
Definition channels.c:1234
ssh_channel_get_exit_status
SSH_DEPRECATED LIBSSH_API int ssh_channel_get_exit_status(ssh_channel channel)
Get the exit status of the channel (error code from the executed instruction).
Definition channels.c:3576
ssh_channel_request_send_signal
LIBSSH_API int ssh_channel_request_send_signal(ssh_channel channel, const char *signum)
Send a signal to remote process (as described in RFC 4254, section 6.9).
Definition channels.c:2947
ssh_channel_is_open
LIBSSH_API int ssh_channel_is_open(ssh_channel channel)
Check if the channel is open or not.
Definition channels.c:1762
ssh_channel_read_nonblocking
LIBSSH_API int ssh_channel_read_nonblocking(ssh_channel channel, void *dest, uint32_t count, int is_stderr)
Do a nonblocking read on the channel.
Definition channels.c:3282
ssh_channel_set_counter
LIBSSH_API void ssh_channel_set_counter(ssh_channel channel, ssh_counter counter)
Set the channel data counter.
Definition channels.c:3837
ssh_channel_is_closed
LIBSSH_API int ssh_channel_is_closed(ssh_channel channel)
Check if the channel is closed or not.
Definition channels.c:1779
ssh_channel_request_auth_agent
LIBSSH_API int ssh_channel_request_auth_agent(ssh_channel channel)
Send an "auth-agent-req" channel request over an existing session channel.
Definition channels.c:2450
ssh_channel_is_eof
LIBSSH_API int ssh_channel_is_eof(ssh_channel channel)
Check if remote has sent an EOF.
Definition channels.c:1794
ssh_channel_poll_timeout
LIBSSH_API int ssh_channel_poll_timeout(ssh_channel channel, int timeout, int is_stderr)
Polls a channel for data to read, waiting for a certain timeout.
Definition channels.c:3398
ssh_channel_request_pty_size
LIBSSH_API int ssh_channel_request_pty_size(ssh_channel channel, const char *term, int cols, int rows)
Request a PTY with a specific size using current TTY modes.
Definition channels.c:2093
ssh_channel_read
LIBSSH_API int ssh_channel_read(ssh_channel channel, void *dest, uint32_t count, int is_stderr)
Reads data from a channel.
Definition channels.c:3143
ssh_channel_free
LIBSSH_API void ssh_channel_free(ssh_channel channel)
Close and free a channel.
Definition channels.c:1298
ssh_channel_new
LIBSSH_API ssh_channel ssh_channel_new(ssh_session session)
Allocate a new channel.
Definition channels.c:90
ssh_channel_window_size
LIBSSH_API uint32_t ssh_channel_window_size(ssh_channel channel)
Get the remote window size.
Definition channels.c:1730
ssh_channel_request_x11
LIBSSH_API int ssh_channel_request_x11(ssh_channel channel, int single_connection, const char *protocol, const char *cookie, int screen_number)
Sends the "x11-req" channel request over an existing session channel.
Definition channels.c:2309
ssh_channel_open_x11
LIBSSH_API int ssh_channel_open_x11(ssh_channel channel, const char *orig_addr, int orig_port)
Open a X11 channel.
Definition channels.c:3953
ssh_channel_open_forward
LIBSSH_API int ssh_channel_open_forward(ssh_channel channel, const char *remotehost, int remoteport, const char *sourcehost, int localport)
Open a TCP/IP forwarding channel.
Definition channels.c:1161
ssh_channel_request_shell
LIBSSH_API int ssh_channel_request_shell(ssh_channel channel)
Request a shell.
Definition channels.c:2182
ssh_channel_request_send_break
LIBSSH_API int ssh_channel_request_send_break(ssh_channel channel, uint32_t length)
Send a break signal to the server (as described in RFC 4335).
Definition channels.c:2991
ssh_channel_open_session
LIBSSH_API int ssh_channel_open_session(ssh_channel channel)
Open a session channel (suited for a shell, not TCP forwarding).
Definition channels.c:1095
ssh_channel_change_pty_size
LIBSSH_API int ssh_channel_change_pty_size(ssh_channel channel, int cols, int rows)
Change the size of the terminal associated to a channel.
Definition channels.c:2142
ssh_get_error_code
LIBSSH_API int ssh_get_error_code(void *error)
Retrieve the error code from the last error.
Definition error.c:148
ssh_get_error
LIBSSH_API const char * ssh_get_error(void *error)
Retrieve the error text message from the last error.
Definition error.c:128
ssh_set_log_userdata
LIBSSH_API int ssh_set_log_userdata(void *data)
Set the userdata for the logging function.
Definition log.c:255
ssh_get_log_userdata
LIBSSH_API void * ssh_get_log_userdata(void)
Get the userdata of the logging function.
Definition log.c:239
ssh_set_log_level
LIBSSH_API int ssh_set_log_level(int level)
Set the log level of the library.
Definition log.c:195
ssh_get_log_level
LIBSSH_API int ssh_get_log_level(void)
Get the log level of the library.
Definition log.c:210
SSH_LOG_WARNING
@ SSH_LOG_WARNING
Definition libssh.h:333
SSH_LOG_PACKET
@ SSH_LOG_PACKET
Definition libssh.h:339
SSH_LOG_PROTOCOL
@ SSH_LOG_PROTOCOL
Definition libssh.h:336
SSH_LOG_FUNCTIONS
@ SSH_LOG_FUNCTIONS
Definition libssh.h:342
SSH_LOG_NOLOG
@ SSH_LOG_NOLOG
Definition libssh.h:330
ssh_message_type
LIBSSH_API int ssh_message_type(ssh_message msg)
Get the type of the message.
Definition messages.c:637
ssh_message_subtype
LIBSSH_API int ssh_message_subtype(ssh_message msg)
Get the subtype of the message.
Definition messages.c:652
ssh_message_get
LIBSSH_API ssh_message ssh_message_get(ssh_session session)
Retrieve a SSH message from a SSH session.
Definition messages.c:604
ssh_message_free
LIBSSH_API void ssh_message_free(ssh_message msg)
Free a SSH message.
Definition messages.c:676
ssh_dirname
LIBSSH_API char * ssh_dirname(const char *path)
Parse directory component.
Definition misc.c:991
ssh_print_hexa
SSH_DEPRECATED LIBSSH_API void ssh_print_hexa(const char *descr, const unsigned char *what, size_t len)
Definition misc.c:547
ssh_mkdir
LIBSSH_API int ssh_mkdir(const char *pathname, mode_t mode)
Attempts to create a directory with the given pathname.
Definition misc.c:1102
ssh_get_random
LIBSSH_API int ssh_get_random(void *where, int len, int strong)
Get random bytes.
Definition getrandom_crypto.c:47
ssh_get_hexa
LIBSSH_API char * ssh_get_hexa(const unsigned char *what, size_t len)
Convert a buffer into a colon separated hex string. The caller has to free the memory.
Definition misc.c:539
ssh_getpass
LIBSSH_API int ssh_getpass(const char *prompt, char *buf, size_t len, int echo, int verify)
Get a password from the console.
Definition getpass.c:214
ssh_version
LIBSSH_API const char * ssh_version(int req_version)
Check if libssh is the required version or get the version string.
Definition misc.c:769
ssh_basename
LIBSSH_API char * ssh_basename(const char *path)
basename - parse filename component.
Definition misc.c:1050
ssh_key_free
LIBSSH_API void ssh_key_free(ssh_key key)
deallocate a SSH key
Definition pki.c:260
ssh_key_is_private
LIBSSH_API int ssh_key_is_private(const ssh_key k)
Check if the key is a private key.
Definition pki.c:826
ssh_pki_export_privkey_base64_format
LIBSSH_API int ssh_pki_export_privkey_base64_format(const ssh_key privkey, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, char **b64_key, enum ssh_file_format_e format)
Convert a private key to a base64 encoded key in given format.
Definition pki.c:1070
ssh_sk_resident_keys_load
LIBSSH_API int ssh_sk_resident_keys_load(const struct ssh_pki_ctx_struct *pki_context, ssh_key **resident_keys_result, size_t *num_keys_found_result)
Load resident keys from FIDO2 security keys.
Definition pki_sk.c:770
ssh_pki_key_ecdsa_name
LIBSSH_API const char * ssh_pki_key_ecdsa_name(const ssh_key key)
returns the ECDSA key name ("ecdsa-sha2-nistp256" for example)
Definition pki.c:94
ssh_pki_import_privkey_file
LIBSSH_API int ssh_pki_import_privkey_file(const char *filename, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, ssh_key *pkey)
Import a private key from a file or a PKCS #11 device.
Definition pki.c:1188
ssh_pki_export_pubkey_base64
LIBSSH_API int ssh_pki_export_pubkey_base64(const ssh_key key, char **b64_key)
Convert a public key to a base64 encoded key.
Definition pki.c:2649
ssh_pki_export_privkey_base64
LIBSSH_API int ssh_pki_export_privkey_base64(const ssh_key privkey, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, char **b64_key)
Convert a private key to a pem base64 encoded key, or OpenSSH format for keytype ssh-ed25519.
Definition pki.c:1151
ssh_pki_ctx_sk_callbacks_option_set
LIBSSH_API int ssh_pki_ctx_sk_callbacks_option_set(ssh_pki_ctx context, const char *name, const char *value, bool required)
Set a security key (FIDO2/U2F) callback option in the context. These options are passed to the sk_cal...
Definition pki_context.c:349
ssh_pki_export_privkey_file
LIBSSH_API int ssh_pki_export_privkey_file(const ssh_key privkey, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, const char *filename)
Export a private key to a pem file on disk, or OpenSSH format for keytype ssh-ed25519.
Definition pki.c:1384
ssh_key_type_from_name
LIBSSH_API enum ssh_keytypes_e ssh_key_type_from_name(const char *name)
Convert a ssh key name to a ssh key type.
Definition pki.c:731
ssh_key_cmp
LIBSSH_API int ssh_key_cmp(const ssh_key k1, const ssh_key k2, enum ssh_keycmp_e what)
Compare keys if they are equal.
Definition pki.c:849
ssh_pki_generate_key
LIBSSH_API int ssh_pki_generate_key(enum ssh_keytypes_e type, ssh_pki_ctx pki_context, ssh_key *pkey)
Generates a key pair.
Definition pki.c:2419
ssh_pki_ctx_set_sk_pin_callback
LIBSSH_API int ssh_pki_ctx_set_sk_pin_callback(ssh_pki_ctx context, ssh_auth_callback pin_callback, void *userdata)
Set the PIN callback function to get the PIN for security key authenticator access.
Definition pki_context.c:302
ssh_pki_export_pubkey_file
LIBSSH_API int ssh_pki_export_pubkey_file(const ssh_key key, const char *filename)
Export public key to file.
Definition pki.c:2687
ssh_pki_export_privkey_to_pubkey
LIBSSH_API int ssh_pki_export_privkey_to_pubkey(const ssh_key privkey, ssh_key *pkey)
Create a public key from a private key.
Definition pki.c:2488
ssh_pki_ctx_sk_callbacks_options_clear
LIBSSH_API int ssh_pki_ctx_sk_callbacks_options_clear(ssh_pki_ctx context)
Clear all sk_callbacks options.
Definition pki_context.c:431
ssh_pki_import_privkey_base64
LIBSSH_API int ssh_pki_import_privkey_base64(const char *b64_key, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, ssh_key *pkey)
import a base64 formatted key from a memory c-string
Definition pki.c:1003
ssh_key_type_to_char
LIBSSH_API const char * ssh_key_type_to_char(enum ssh_keytypes_e type)
Convert a key type to a string.
Definition pki.c:410
ssh_key_get_sk_flags
LIBSSH_API uint32_t ssh_key_get_sk_flags(const ssh_key key)
Get security key (FIDO2) flags for a security key backed ssh_key.
Definition pki.c:298
ssh_pki_ctx_new
LIBSSH_API ssh_pki_ctx ssh_pki_ctx_new(void)
Allocate a new generic PKI context container.
Definition pki_context.c:48
sshsig_verify
LIBSSH_API int sshsig_verify(const void *data, size_t data_length, const char *signature, const char *sig_namespace, ssh_key *sign_key)
Verifies an sshsig formatted signature against data.
Definition pki.c:3614
ssh_pki_copy_cert_to_privkey
LIBSSH_API int ssh_pki_copy_cert_to_privkey(const ssh_key cert_key, ssh_key privkey)
Copy the certificate part of a public key into a private key.
Definition pki.c:2756
ssh_pki_import_cert_base64
LIBSSH_API int ssh_pki_import_cert_base64(const char *b64_cert, enum ssh_keytypes_e type, ssh_key *pkey)
Import a base64 formatted certificate from a memory c-string.
Definition pki.c:2213
sshsig_sign
LIBSSH_API int sshsig_sign(const void *data, size_t data_length, ssh_key privkey, ssh_pki_ctx pki_context, const char *sig_namespace, enum sshsig_digest_e hash_alg, char **signature)
Signs data in sshsig compatible format.
Definition pki.c:3443
ssh_key_get_sk_application
LIBSSH_API ssh_string ssh_key_get_sk_application(const ssh_key key)
Get the application (RP ID) associated with a security key.
Definition pki.c:320
ssh_pki_import_cert_file
LIBSSH_API int ssh_pki_import_cert_file(const char *filename, ssh_key *pkey)
Import a certificate from the given filename.
Definition pki.c:2254
ssh_key_is_public
LIBSSH_API int ssh_key_is_public(const ssh_key k)
Check if the key has/is a public key.
Definition pki.c:810
ssh_key_type
LIBSSH_API enum ssh_keytypes_e ssh_key_type(const ssh_key key)
returns the type of a ssh key
Definition pki.c:279
ssh_key_new
LIBSSH_API ssh_key ssh_key_new(void)
creates a new empty SSH key
Definition pki.c:112
ssh_pki_ctx_free
LIBSSH_API void ssh_pki_ctx_free(ssh_pki_ctx context)
Free a generic PKI context container.
Definition pki_context.c:85
ssh_pki_import_pubkey_base64
LIBSSH_API int ssh_pki_import_pubkey_base64(const char *b64_key, enum ssh_keytypes_e type, ssh_key *pkey)
Import a base64 formatted public key from a memory c-string.
Definition pki.c:1902
ssh_pki_ctx_get_sk_attestation_buffer
LIBSSH_API int ssh_pki_ctx_get_sk_attestation_buffer(const struct ssh_pki_ctx_struct *context, ssh_buffer *attestation_buffer)
Get a copy of the attestation buffer from a PKI context.
Definition pki_context.c:469
ssh_key_get_sk_user_id
LIBSSH_API ssh_string ssh_key_get_sk_user_id(const ssh_key key)
Get a copy of the user ID associated with a resident security key credential.
Definition pki.c:347
ssh_pki_export_privkey_file_format
LIBSSH_API int ssh_pki_export_privkey_file_format(const ssh_key privkey, const char *passphrase, ssh_auth_callback auth_fn, void *auth_data, const char *filename, enum ssh_file_format_e format)
Export a private key to a file in format specified in the argument.
Definition pki.c:1293
ssh_pki_generate
SSH_DEPRECATED LIBSSH_API int ssh_pki_generate(enum ssh_keytypes_e type, int parameter, ssh_key *pkey)
Generates a key pair.
Definition pki.c:2394
ssh_key_dup
LIBSSH_API ssh_key ssh_key_dup(const ssh_key key)
duplicates the key
Definition pki.c:208
ssh_pki_ctx_options_set
LIBSSH_API int ssh_pki_ctx_options_set(ssh_pki_ctx context, enum ssh_pki_options_e option, const void *value)
Set various options for a PKI context.
Definition pki_context.c:180
ssh_pki_import_pubkey_file
LIBSSH_API int ssh_pki_import_pubkey_file(const char *filename, ssh_key *pkey)
Import a public key from a file or a PKCS #11 device.
Definition pki.c:2066
ssh_event_free
LIBSSH_API void ssh_event_free(ssh_event event)
Free an event context.
Definition poll.c:1185
ssh_event_new
LIBSSH_API ssh_event ssh_event_new(void)
Create a new event context. It could be associated with many ssh_session objects and socket fd which ...
Definition poll.c:831
ssh_event_add_fd
LIBSSH_API int ssh_event_add_fd(ssh_event event, socket_t fd, short events, ssh_event_callback cb, void *userdata)
Add a fd to the event and assign it a callback, when used in blocking mode.
Definition poll.c:890
ssh_event_add_session
LIBSSH_API int ssh_event_add_session(ssh_event event, ssh_session session)
remove the poll handle from session and assign them to an event, when used in blocking mode.
Definition poll.c:965
ssh_event_remove_session
LIBSSH_API int ssh_event_remove_session(ssh_event event, ssh_session session)
Remove a session object from an event context.
Definition poll.c:1114
ssh_event_dopoll
LIBSSH_API int ssh_event_dopoll(ssh_event event, int timeout)
Poll all the sockets and sessions associated through an event object.
Definition poll.c:1047
ssh_event_remove_connector
LIBSSH_API int ssh_event_remove_connector(ssh_event event, ssh_connector connector)
Remove a connector from an event context.
Definition poll.c:1171
ssh_event_add_connector
LIBSSH_API int ssh_event_add_connector(ssh_event event, ssh_connector connector)
Add a connector to the SSH event loop.
Definition poll.c:1022
ssh_event_remove_fd
LIBSSH_API int ssh_event_remove_fd(ssh_event event, socket_t fd)
Remove a socket fd from an event context.
Definition poll.c:1067
ssh_scp_read
SSH_DEPRECATED LIBSSH_API int ssh_scp_read(ssh_scp scp, void *buffer, size_t size)
Read from a remote scp file.
Definition scp.c:1039
ssh_scp_write
SSH_DEPRECATED LIBSSH_API int ssh_scp_write(ssh_scp scp, const void *buffer, size_t len)
Write into a remote scp file.
Definition scp.c:682
ssh_scp_close
SSH_DEPRECATED LIBSSH_API int ssh_scp_close(ssh_scp scp)
Close the scp channel.
Definition scp.c:261
ssh_scp_init
SSH_DEPRECATED LIBSSH_API int ssh_scp_init(ssh_scp scp)
Initialize the scp channel.
Definition scp.c:126
ssh_scp_leave_directory
SSH_DEPRECATED LIBSSH_API int ssh_scp_leave_directory(ssh_scp scp)
Leave a directory.
Definition scp.c:435
ssh_scp_request_get_permissions
SSH_DEPRECATED LIBSSH_API int ssh_scp_request_get_permissions(ssh_scp scp)
Get the permissions of the directory or file being pushed from the other party.
Definition scp.c:1129
ssh_scp_request_get_warning
SSH_DEPRECATED LIBSSH_API const char * ssh_scp_request_get_warning(ssh_scp scp)
Get the warning string from a scp handle.
Definition scp.c:1213
ssh_scp_push_file64
SSH_DEPRECATED LIBSSH_API int ssh_scp_push_file64(ssh_scp scp, const char *filename, uint64_t size, int perms)
Initialize the sending of a file to a scp in sink mode, using a 64-bit size.
Definition scp.c:484
ssh_scp_push_file
SSH_DEPRECATED LIBSSH_API int ssh_scp_push_file(ssh_scp scp, const char *filename, size_t size, int perms)
Initialize the sending of a file to a scp in sink mode.
Definition scp.c:587
ssh_scp_request_get_filename
SSH_DEPRECATED LIBSSH_API const char * ssh_scp_request_get_filename(ssh_scp scp)
Get the name of the directory or file being pushed from the other party.
Definition scp.c:1112
ssh_scp_request_get_size
SSH_DEPRECATED LIBSSH_API size_t ssh_scp_request_get_size(ssh_scp scp)
Get the size of the file being pushed from the other party.
Definition scp.c:1148
ssh_scp_new
SSH_DEPRECATED LIBSSH_API ssh_scp ssh_scp_new(ssh_session session, int mode, const char *location)
Create a new scp session.
Definition scp.c:66
ssh_scp_push_directory
SSH_DEPRECATED LIBSSH_API int ssh_scp_push_directory(ssh_scp scp, const char *dirname, int mode)
Create a directory in a scp in sink mode.
Definition scp.c:344
ssh_scp_pull_request
SSH_DEPRECATED LIBSSH_API int ssh_scp_pull_request(ssh_scp scp)
Wait for a scp request (file, directory).
Definition scp.c:821
ssh_scp_free
SSH_DEPRECATED LIBSSH_API void ssh_scp_free(ssh_scp scp)
Free a scp context.
Definition scp.c:308
ssh_scp_deny_request
SSH_DEPRECATED LIBSSH_API int ssh_scp_deny_request(ssh_scp scp, const char *reason)
Deny the transfer of a file or creation of a directory coming from the remote party.
Definition scp.c:951
ssh_scp_accept_request
SSH_DEPRECATED LIBSSH_API int ssh_scp_accept_request(ssh_scp scp)
Accepts transfer of a file or creation of a directory coming from the remote party.
Definition scp.c:997
ssh_scp_request_get_size64
SSH_DEPRECATED LIBSSH_API uint64_t ssh_scp_request_get_size64(ssh_scp scp)
Get the size of the file being pushed from the other party.
Definition scp.c:1163
ssh_get_cipher_out
LIBSSH_API const char * ssh_get_cipher_out(ssh_session session)
get the name of the output cipher for the given session.
Definition session.c:568
ssh_connect
LIBSSH_API int ssh_connect(ssh_session session)
Connect to the ssh server.
Definition client.c:555
ssh_set_fd_except
LIBSSH_API void ssh_set_fd_except(ssh_session session)
Tell the session it has an exception to catch on the file descriptor.
Definition session.c:770
ssh_clean_pubkey_hash
LIBSSH_API void ssh_clean_pubkey_hash(unsigned char **hash)
Deallocate the hash obtained by ssh_get_pubkey_hash.
Definition session.c:1265
ssh_get_disconnect_message
LIBSSH_API const char * ssh_get_disconnect_message(ssh_session session)
Get the disconnect message from the server.
Definition session.c:992
ssh_is_blocking
LIBSSH_API int ssh_is_blocking(ssh_session session)
Return the blocking mode of libssh.
Definition session.c:662
ssh_set_fd_toread
LIBSSH_API void ssh_set_fd_toread(ssh_session session)
Tell the session it has data to read on the file descriptor without blocking.
Definition session.c:744
ssh_disconnect
LIBSSH_API void ssh_disconnect(ssh_session session)
Disconnect from a session (client or server).
Definition client.c:812
ssh_get_serverbanner
LIBSSH_API const char * ssh_get_serverbanner(ssh_session session)
get the server banner
Definition session.c:458
ssh_get_hmac_in
LIBSSH_API const char * ssh_get_hmac_in(ssh_session session)
get the name of the input HMAC algorithm for the given session.
Definition session.c:584
ssh_get_issue_banner
LIBSSH_API char * ssh_get_issue_banner(ssh_session session)
Get the issue banner from the server.
Definition client.c:710
ssh_set_blocking
LIBSSH_API void ssh_set_blocking(ssh_session session, int blocking)
Set the session in blocking/nonblocking mode.
Definition session.c:647
ssh_get_fingerprint_hash
LIBSSH_API char * ssh_get_fingerprint_hash(enum ssh_publickey_hash_type type, unsigned char *hash, size_t len)
Get a hash as a human-readable hex- or base64-string.
Definition dh.c:742
ssh_set_fd_towrite
LIBSSH_API void ssh_set_fd_towrite(ssh_session session)
Tell the session it may write to the file descriptor without blocking.
Definition session.c:757
ssh_is_connected
LIBSSH_API int ssh_is_connected(ssh_session session)
Check if we are connected.
Definition session.c:712
ssh_get_kex_algo
LIBSSH_API const char * ssh_get_kex_algo(ssh_session session)
get the name of the current key exchange algorithm.
Definition session.c:472
ssh_session_export_known_hosts_entry
LIBSSH_API int ssh_session_export_known_hosts_entry(ssh_session session, char **pentry_string)
Export the current session information to a known_hosts string.
Definition knownhosts.c:949
ssh_get_server_publickey
LIBSSH_API int ssh_get_server_publickey(ssh_session session, ssh_key *key)
Get the server public key from a session.
Definition session.c:1282
ssh_dump_knownhost
SSH_DEPRECATED LIBSSH_API char * ssh_dump_knownhost(ssh_session session)
This function is deprecated.
Definition known_hosts.c:446
ssh_send_debug
LIBSSH_API int ssh_send_debug(ssh_session session, const char *message, int always_display)
Send a debug message.
Definition session.c:1114
ssh_blocking_flush
LIBSSH_API int ssh_blocking_flush(ssh_session session, int timeout)
Blocking flush of the outgoing buffer.
Definition session.c:687
ssh_get_cipher_in
LIBSSH_API const char * ssh_get_cipher_in(ssh_session session)
get the name of the input cipher for the given session.
Definition session.c:552
ssh_copyright
LIBSSH_API const char * ssh_copyright(void)
Copyright information.
Definition client.c:923
ssh_get_clientbanner
LIBSSH_API const char * ssh_get_clientbanner(ssh_session session)
get the client banner
Definition session.c:443
ssh_is_server_known
SSH_DEPRECATED LIBSSH_API int ssh_is_server_known(ssh_session session)
This function is deprecated.
Definition known_hosts.c:304
ssh_get_publickey_hash
LIBSSH_API int ssh_get_publickey_hash(const ssh_key key, enum ssh_publickey_hash_type type, unsigned char **hash, size_t *hlen)
Allocates a buffer with the hash of the public key.
Definition session.c:1337
ssh_options_set
LIBSSH_API int ssh_options_set(ssh_session session, enum ssh_options_e type, const void *value)
This function can set all possible ssh options.
Definition options.c:834
ssh_options_parse_config
LIBSSH_API int ssh_options_parse_config(ssh_session session, const char *filename)
Parse the ssh config file.
Definition options.c:2126
ssh_get_publickey
SSH_DEPRECATED LIBSSH_API int ssh_get_publickey(ssh_session session, ssh_key *key)
Definition session.c:1304
ssh_get_version
LIBSSH_API int ssh_get_version(ssh_session session)
Get the protocol version of the session.
Definition session.c:1017
ssh_set_counters
LIBSSH_API void ssh_set_counters(ssh_session session, ssh_counter scounter, ssh_counter rcounter)
Set the session data counters.
Definition session.c:1170
ssh_select
LIBSSH_API int ssh_select(ssh_channel *channels, ssh_channel *outchannels, socket_t maxfd, fd_set *readfds, struct timeval *timeout)
A wrapper for the select syscall.
Definition connect.c:391
ssh_session_get_known_hosts_entry
LIBSSH_API enum ssh_known_hosts_e ssh_session_get_known_hosts_entry(ssh_session session, struct ssh_knownhosts_entry **pentry)
Get the known_hosts entry for the currently connected session.
Definition knownhosts.c:1194
ssh_print_hash
LIBSSH_API void ssh_print_hash(enum ssh_publickey_hash_type type, unsigned char *hash, size_t len)
Print a hash as a human-readable hex- or base64-string.
Definition dh.c:814
ssh_options_getopt
LIBSSH_API int ssh_options_getopt(ssh_session session, int *argcptr, char **argv)
Parse command line arguments.
Definition options.c:1929
ssh_session_update_known_hosts
LIBSSH_API int ssh_session_update_known_hosts(ssh_session session)
Adds the currently connected server to the user known_hosts file.
Definition knownhosts.c:1022
ssh_knownhosts_entry_free
LIBSSH_API void ssh_knownhosts_entry_free(struct ssh_knownhosts_entry *entry)
Free an allocated ssh_knownhosts_entry.
Definition knownhosts.c:156
ssh_request_no_more_sessions
LIBSSH_API int ssh_request_no_more_sessions(ssh_session session)
Most SSH connections will only ever request a single session, but an attacker may abuse a running ssh...
Definition client.c:758
ssh_options_get_port
LIBSSH_API int ssh_options_get_port(ssh_session session, unsigned int *port_target)
This function can get ssh the ssh port. It must only be used on a valid ssh session....
Definition options.c:1674
ssh_known_hosts_parse_line
LIBSSH_API int ssh_known_hosts_parse_line(const char *host, const char *line, struct ssh_knownhosts_entry **entry)
Parse a line from a known_hosts entry into a structure.
Definition knownhosts.c:673
ssh_options_get
LIBSSH_API int ssh_options_get(ssh_session session, enum ssh_options_e type, char **value)
This function can get ssh options, it does not support all options provided for ssh options set,...
Definition options.c:1781
ssh_new
LIBSSH_API ssh_session ssh_new(void)
Create a new ssh session.
Definition session.c:65
ssh_get_hmac_out
LIBSSH_API const char * ssh_get_hmac_out(ssh_session session)
get the name of the output HMAC algorithm for the given session.
Definition session.c:599
ssh_send_ignore
LIBSSH_API int ssh_send_ignore(ssh_session session, const char *data)
Send a message that should be ignored.
Definition session.c:1079
ssh_session_set_disconnect_message
LIBSSH_API int ssh_session_set_disconnect_message(ssh_session session, const char *message)
Add disconnect message when ssh_session is disconnected To add a disconnect message to give peer a be...
Definition client.c:776
ssh_session_kex_is_gss
LIBSSH_API bool ssh_session_kex_is_gss(ssh_session session)
Check if current session keys were exchanged using a GSSAPI key exchange method.
Definition session.c:538
ssh_get_status
LIBSSH_API int ssh_get_status(ssh_session session)
Get session status.
Definition session.c:934
ssh_get_openssh_version
LIBSSH_API int ssh_get_openssh_version(ssh_session session)
Get the version of the OpenSSH server, if it is not an OpenSSH server then 0 will be returned.
Definition client.c:737
ssh_session_is_known_server
LIBSSH_API enum ssh_known_hosts_e ssh_session_is_known_server(ssh_session session)
Check if the servers public key for the connected session is known.
Definition knownhosts.c:1334
ssh_silent_disconnect
LIBSSH_API void ssh_silent_disconnect(ssh_session session)
Disconnect impolitely from a remote host by closing the socket.
Definition session.c:630
ssh_free
LIBSSH_API void ssh_free(ssh_session session)
Deallocate a SSH session handle.
Definition session.c:251
ssh_get_poll_flags
LIBSSH_API int ssh_get_poll_flags(ssh_session session)
Get poll flags for an external mainloop.
Definition session.c:972
ssh_options_copy
LIBSSH_API int ssh_options_copy(ssh_session src, ssh_session *dest)
Duplicate the options of a session structure.
Definition options.c:76
ssh_write_knownhost
SSH_DEPRECATED LIBSSH_API int ssh_write_knownhost(ssh_session session)
This function is deprecated.
Definition known_hosts.c:515
ssh_get_pubkey_hash
SSH_DEPRECATED LIBSSH_API int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash)
Definition session.c:1181
ssh_get_fd
LIBSSH_API socket_t ssh_get_fd(ssh_session session)
Get the fd of a connection.
Definition session.c:730
ssh_session_has_known_hosts_entry
LIBSSH_API enum ssh_known_hosts_e ssh_session_has_known_hosts_entry(ssh_session session)
Check if the set hostname and port match an entry in known_hosts.
Definition knownhosts.c:844
ssh_string_from_char
LIBSSH_API ssh_string ssh_string_from_char(const char *what)
Create a ssh string using a C string.
Definition string.c:108
ssh_string_from_data
LIBSSH_API ssh_string ssh_string_from_data(const void *data, size_t len)
Create a ssh string from an arbitrary data buffer.
Definition string.c:143
ssh_string_new
LIBSSH_API ssh_string ssh_string_new(size_t size)
Create a new SSH String object.
Definition string.c:56
ssh_string_free_char
LIBSSH_API void ssh_string_free_char(char *s)
Deallocate a char string object.
Definition string.c:251
ssh_init
LIBSSH_API int ssh_init(void)
Initialize global cryptographic data structures.
Definition init.c:156
ssh_finalize
LIBSSH_API int ssh_finalize(void)
Finalize and clean up all libssh and cryptographic data structures.
Definition init.c:241
ssh_pki_ctx_struct
Security key context structure.
Definition pki_context.h:33