libssh  0.8.90
The SSH library
libssh.h
1 /*
2  * This file is part of the SSH Library
3  *
4  * Copyright (c) 2003-2009 by Aris Adamantiadis
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 #ifndef _LIBSSH_H
22 #define _LIBSSH_H
23 
24 #if defined _WIN32 || defined __CYGWIN__
25  #ifdef LIBSSH_STATIC
26  #define LIBSSH_API
27  #else
28  #ifdef LIBSSH_EXPORTS
29  #ifdef __GNUC__
30  #define LIBSSH_API __attribute__((dllexport))
31  #else
32  #define LIBSSH_API __declspec(dllexport)
33  #endif
34  #else
35  #ifdef __GNUC__
36  #define LIBSSH_API __attribute__((dllimport))
37  #else
38  #define LIBSSH_API __declspec(dllimport)
39  #endif
40  #endif
41  #endif
42 #else
43  #if __GNUC__ >= 4 && !defined(__OS2__)
44  #define LIBSSH_API __attribute__((visibility("default")))
45  #else
46  #define LIBSSH_API
47  #endif
48 #endif
49 
50 #ifdef _MSC_VER
51  /* Visual Studio hasn't inttypes.h so it doesn't know uint32_t */
52  typedef int int32_t;
53  typedef unsigned int uint32_t;
54  typedef unsigned short uint16_t;
55  typedef unsigned char uint8_t;
56  typedef unsigned long long uint64_t;
57  typedef int mode_t;
58 #else /* _MSC_VER */
59  #include <unistd.h>
60  #include <inttypes.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 /* libssh version macros */
75 #define SSH_VERSION_INT(a, b, c) ((a) << 16 | (b) << 8 | (c))
76 #define SSH_VERSION_DOT(a, b, c) a ##.## b ##.## c
77 #define SSH_VERSION(a, b, c) SSH_VERSION_DOT(a, b, c)
78 
79 /* libssh version */
80 #define LIBSSH_VERSION_MAJOR 0
81 #define LIBSSH_VERSION_MINOR 8
82 #define LIBSSH_VERSION_MICRO 90
83 
84 #define LIBSSH_VERSION_INT SSH_VERSION_INT(LIBSSH_VERSION_MAJOR, \
85  LIBSSH_VERSION_MINOR, \
86  LIBSSH_VERSION_MICRO)
87 #define LIBSSH_VERSION SSH_VERSION(LIBSSH_VERSION_MAJOR, \
88  LIBSSH_VERSION_MINOR, \
89  LIBSSH_VERSION_MICRO)
90 
91 /* GCC have printf type attribute check. */
92 #ifdef __GNUC__
93 #define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
94 #else
95 #define PRINTF_ATTRIBUTE(a,b)
96 #endif /* __GNUC__ */
97 
98 #ifdef __GNUC__
99 #define SSH_DEPRECATED __attribute__ ((deprecated))
100 #else
101 #define SSH_DEPRECATED
102 #endif
103 
104 #ifdef __cplusplus
105 extern "C" {
106 #endif
107 
109  uint64_t in_bytes;
110  uint64_t out_bytes;
111  uint64_t in_packets;
112  uint64_t out_packets;
113 };
114 typedef struct ssh_counter_struct *ssh_counter;
115 
116 typedef struct ssh_agent_struct* ssh_agent;
117 typedef struct ssh_buffer_struct* ssh_buffer;
118 typedef struct ssh_channel_struct* ssh_channel;
119 typedef struct ssh_message_struct* ssh_message;
120 typedef struct ssh_pcap_file_struct* ssh_pcap_file;
121 typedef struct ssh_key_struct* ssh_key;
122 typedef struct ssh_scp_struct* ssh_scp;
123 typedef struct ssh_session_struct* ssh_session;
124 typedef struct ssh_string_struct* ssh_string;
125 typedef struct ssh_event_struct* ssh_event;
126 typedef struct ssh_connector_struct * ssh_connector;
127 typedef void* ssh_gssapi_creds;
128 
129 /* Socket type */
130 #ifdef _WIN32
131 #ifndef socket_t
132 typedef SOCKET socket_t;
133 #endif /* socket_t */
134 #else /* _WIN32 */
135 #ifndef socket_t
136 typedef int socket_t;
137 #endif
138 #endif /* _WIN32 */
139 
140 #define SSH_INVALID_SOCKET ((socket_t) -1)
141 
142 /* the offsets of methods */
143 enum ssh_kex_types_e {
144  SSH_KEX=0,
145  SSH_HOSTKEYS,
146  SSH_CRYPT_C_S,
147  SSH_CRYPT_S_C,
148  SSH_MAC_C_S,
149  SSH_MAC_S_C,
150  SSH_COMP_C_S,
151  SSH_COMP_S_C,
152  SSH_LANG_C_S,
153  SSH_LANG_S_C
154 };
155 
156 #define SSH_CRYPT 2
157 #define SSH_MAC 3
158 #define SSH_COMP 4
159 #define SSH_LANG 5
160 
161 enum ssh_auth_e {
162  SSH_AUTH_SUCCESS=0,
163  SSH_AUTH_DENIED,
164  SSH_AUTH_PARTIAL,
165  SSH_AUTH_INFO,
166  SSH_AUTH_AGAIN,
167  SSH_AUTH_ERROR=-1
168 };
169 
170 /* auth flags */
171 #define SSH_AUTH_METHOD_UNKNOWN 0
172 #define SSH_AUTH_METHOD_NONE 0x0001
173 #define SSH_AUTH_METHOD_PASSWORD 0x0002
174 #define SSH_AUTH_METHOD_PUBLICKEY 0x0004
175 #define SSH_AUTH_METHOD_HOSTBASED 0x0008
176 #define SSH_AUTH_METHOD_INTERACTIVE 0x0010
177 #define SSH_AUTH_METHOD_GSSAPI_MIC 0x0020
178 
179 /* messages */
180 enum ssh_requests_e {
181  SSH_REQUEST_AUTH=1,
182  SSH_REQUEST_CHANNEL_OPEN,
183  SSH_REQUEST_CHANNEL,
184  SSH_REQUEST_SERVICE,
185  SSH_REQUEST_GLOBAL
186 };
187 
188 enum ssh_channel_type_e {
189  SSH_CHANNEL_UNKNOWN=0,
190  SSH_CHANNEL_SESSION,
191  SSH_CHANNEL_DIRECT_TCPIP,
192  SSH_CHANNEL_FORWARDED_TCPIP,
193  SSH_CHANNEL_X11,
194  SSH_CHANNEL_AUTH_AGENT
195 };
196 
197 enum ssh_channel_requests_e {
198  SSH_CHANNEL_REQUEST_UNKNOWN=0,
199  SSH_CHANNEL_REQUEST_PTY,
200  SSH_CHANNEL_REQUEST_EXEC,
201  SSH_CHANNEL_REQUEST_SHELL,
202  SSH_CHANNEL_REQUEST_ENV,
203  SSH_CHANNEL_REQUEST_SUBSYSTEM,
204  SSH_CHANNEL_REQUEST_WINDOW_CHANGE,
205  SSH_CHANNEL_REQUEST_X11
206 };
207 
208 enum ssh_global_requests_e {
209  SSH_GLOBAL_REQUEST_UNKNOWN=0,
210  SSH_GLOBAL_REQUEST_TCPIP_FORWARD,
211  SSH_GLOBAL_REQUEST_CANCEL_TCPIP_FORWARD,
212  SSH_GLOBAL_REQUEST_KEEPALIVE
213 };
214 
215 enum ssh_publickey_state_e {
216  SSH_PUBLICKEY_STATE_ERROR=-1,
217  SSH_PUBLICKEY_STATE_NONE=0,
218  SSH_PUBLICKEY_STATE_VALID=1,
219  SSH_PUBLICKEY_STATE_WRONG=2
220 };
221 
222 /* Status flags */
224 #define SSH_CLOSED 0x01
225 
226 #define SSH_READ_PENDING 0x02
227 
228 #define SSH_CLOSED_ERROR 0x04
229 
230 #define SSH_WRITE_PENDING 0x08
231 
232 enum ssh_server_known_e {
233  SSH_SERVER_ERROR=-1,
234  SSH_SERVER_NOT_KNOWN=0,
235  SSH_SERVER_KNOWN_OK,
236  SSH_SERVER_KNOWN_CHANGED,
237  SSH_SERVER_FOUND_OTHER,
238  SSH_SERVER_FILE_NOT_FOUND
239 };
240 
241 enum ssh_known_hosts_e {
245  SSH_KNOWN_HOSTS_ERROR = -2,
246 
251  SSH_KNOWN_HOSTS_NOT_FOUND = -1,
252 
257  SSH_KNOWN_HOSTS_UNKNOWN = 0,
258 
262  SSH_KNOWN_HOSTS_OK,
263 
269  SSH_KNOWN_HOSTS_CHANGED,
270 
275  SSH_KNOWN_HOSTS_OTHER,
276 };
277 
278 #ifndef MD5_DIGEST_LEN
279  #define MD5_DIGEST_LEN 16
280 #endif
281 /* errors */
282 
283 enum ssh_error_types_e {
284  SSH_NO_ERROR=0,
285  SSH_REQUEST_DENIED,
286  SSH_FATAL,
287  SSH_EINTR
288 };
289 
290 /* some types for keys */
291 enum ssh_keytypes_e{
292  SSH_KEYTYPE_UNKNOWN=0,
293  SSH_KEYTYPE_DSS=1,
294  SSH_KEYTYPE_RSA,
295  SSH_KEYTYPE_RSA1,
296  SSH_KEYTYPE_ECDSA,
297  SSH_KEYTYPE_ED25519,
298  SSH_KEYTYPE_DSS_CERT01,
299  SSH_KEYTYPE_RSA_CERT01
300 };
301 
302 enum ssh_keycmp_e {
303  SSH_KEY_CMP_PUBLIC = 0,
304  SSH_KEY_CMP_PRIVATE
305 };
306 
307 #define SSH_ADDRSTRLEN 46
308 
310  char *hostname;
311  char *unparsed;
312  ssh_key publickey;
313  char *comment;
314 };
315 
316 
317 /* Error return codes */
318 #define SSH_OK 0 /* No error */
319 #define SSH_ERROR -1 /* Error of some kind */
320 #define SSH_AGAIN -2 /* The nonblocking call must be repeated */
321 #define SSH_EOF -127 /* We have already a eof */
322 
329 enum {
345 };
347 #define SSH_LOG_RARE SSH_LOG_WARNING
348 
357 #define SSH_LOG_NONE 0
358 
359 #define SSH_LOG_WARN 1
360 
361 #define SSH_LOG_INFO 2
362 
363 #define SSH_LOG_DEBUG 3
364 
365 #define SSH_LOG_TRACE 4
366 
369 enum ssh_options_e {
370  SSH_OPTIONS_HOST,
371  SSH_OPTIONS_PORT,
372  SSH_OPTIONS_PORT_STR,
373  SSH_OPTIONS_FD,
374  SSH_OPTIONS_USER,
375  SSH_OPTIONS_SSH_DIR,
376  SSH_OPTIONS_IDENTITY,
377  SSH_OPTIONS_ADD_IDENTITY,
378  SSH_OPTIONS_KNOWNHOSTS,
379  SSH_OPTIONS_TIMEOUT,
380  SSH_OPTIONS_TIMEOUT_USEC,
381  SSH_OPTIONS_SSH1,
382  SSH_OPTIONS_SSH2,
383  SSH_OPTIONS_LOG_VERBOSITY,
384  SSH_OPTIONS_LOG_VERBOSITY_STR,
385  SSH_OPTIONS_CIPHERS_C_S,
386  SSH_OPTIONS_CIPHERS_S_C,
387  SSH_OPTIONS_COMPRESSION_C_S,
388  SSH_OPTIONS_COMPRESSION_S_C,
389  SSH_OPTIONS_PROXYCOMMAND,
390  SSH_OPTIONS_BINDADDR,
391  SSH_OPTIONS_STRICTHOSTKEYCHECK,
392  SSH_OPTIONS_COMPRESSION,
393  SSH_OPTIONS_COMPRESSION_LEVEL,
394  SSH_OPTIONS_KEY_EXCHANGE,
395  SSH_OPTIONS_HOSTKEYS,
396  SSH_OPTIONS_GSSAPI_SERVER_IDENTITY,
397  SSH_OPTIONS_GSSAPI_CLIENT_IDENTITY,
398  SSH_OPTIONS_GSSAPI_DELEGATE_CREDENTIALS,
399  SSH_OPTIONS_HMAC_C_S,
400  SSH_OPTIONS_HMAC_S_C,
401  SSH_OPTIONS_PASSWORD_AUTH,
402  SSH_OPTIONS_PUBKEY_AUTH,
403  SSH_OPTIONS_KBDINT_AUTH,
404  SSH_OPTIONS_GSSAPI_AUTH,
405  SSH_OPTIONS_GLOBAL_KNOWNHOSTS,
406  SSH_OPTIONS_NODELAY,
407  SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES,
408 };
409 
410 enum {
412  SSH_SCP_WRITE,
414  SSH_SCP_READ,
415  SSH_SCP_RECURSIVE=0x10
416 };
417 
418 enum ssh_scp_request_types {
420  SSH_SCP_REQUEST_NEWDIR=1,
422  SSH_SCP_REQUEST_NEWFILE,
424  SSH_SCP_REQUEST_EOF,
426  SSH_SCP_REQUEST_ENDDIR,
428  SSH_SCP_REQUEST_WARNING
429 };
430 
431 enum ssh_connector_flags_e {
433  SSH_CONNECTOR_STDOUT = 1,
435  SSH_CONNECTOR_STDERR = 2,
437  SSH_CONNECTOR_BOTH = 3
438 };
439 
440 LIBSSH_API int ssh_blocking_flush(ssh_session session, int timeout);
441 LIBSSH_API ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms);
442 LIBSSH_API int ssh_channel_change_pty_size(ssh_channel channel,int cols,int rows);
443 LIBSSH_API int ssh_channel_close(ssh_channel channel);
444 LIBSSH_API void ssh_channel_free(ssh_channel channel);
445 LIBSSH_API int ssh_channel_get_exit_status(ssh_channel channel);
447 LIBSSH_API int ssh_channel_is_closed(ssh_channel channel);
448 LIBSSH_API int ssh_channel_is_eof(ssh_channel channel);
449 LIBSSH_API int ssh_channel_is_open(ssh_channel channel);
450 LIBSSH_API ssh_channel ssh_channel_new(ssh_session session);
451 LIBSSH_API int ssh_channel_open_auth_agent(ssh_channel channel);
452 LIBSSH_API int ssh_channel_open_forward(ssh_channel channel, const char *remotehost,
453  int remoteport, const char *sourcehost, int localport);
454 LIBSSH_API int ssh_channel_open_session(ssh_channel channel);
455 LIBSSH_API int ssh_channel_open_x11(ssh_channel channel, const char *orig_addr, int orig_port);
456 LIBSSH_API int ssh_channel_poll(ssh_channel channel, int is_stderr);
457 LIBSSH_API int ssh_channel_poll_timeout(ssh_channel channel, int timeout, int is_stderr);
458 LIBSSH_API int ssh_channel_read(ssh_channel channel, void *dest, uint32_t count, int is_stderr);
459 LIBSSH_API int ssh_channel_read_timeout(ssh_channel channel, void *dest, uint32_t count, int is_stderr, int timeout_ms);
460 LIBSSH_API int ssh_channel_read_nonblocking(ssh_channel channel, void *dest, uint32_t count,
461  int is_stderr);
462 LIBSSH_API int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value);
463 LIBSSH_API int ssh_channel_request_exec(ssh_channel channel, const char *cmd);
464 LIBSSH_API int ssh_channel_request_pty(ssh_channel channel);
465 LIBSSH_API int ssh_channel_request_pty_size(ssh_channel channel, const char *term,
466  int cols, int rows);
467 LIBSSH_API int ssh_channel_request_shell(ssh_channel channel);
468 LIBSSH_API int ssh_channel_request_send_signal(ssh_channel channel, const char *signum);
469 LIBSSH_API int ssh_channel_request_send_break(ssh_channel channel, uint32_t length);
470 LIBSSH_API int ssh_channel_request_sftp(ssh_channel channel);
471 LIBSSH_API int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem);
472 LIBSSH_API int ssh_channel_request_x11(ssh_channel channel, int single_connection, const char *protocol,
473  const char *cookie, int screen_number);
474 LIBSSH_API int ssh_channel_request_auth_agent(ssh_channel channel);
475 LIBSSH_API int ssh_channel_send_eof(ssh_channel channel);
476 LIBSSH_API int ssh_channel_select(ssh_channel *readchans, ssh_channel *writechans, ssh_channel *exceptchans, struct
477  timeval * timeout);
478 LIBSSH_API void ssh_channel_set_blocking(ssh_channel channel, int blocking);
479 LIBSSH_API void ssh_channel_set_counter(ssh_channel channel,
480  ssh_counter counter);
481 LIBSSH_API int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len);
482 LIBSSH_API int ssh_channel_write_stderr(ssh_channel channel,
483  const void *data,
484  uint32_t len);
485 LIBSSH_API uint32_t ssh_channel_window_size(ssh_channel channel);
486 
487 LIBSSH_API char *ssh_basename (const char *path);
488 LIBSSH_API void ssh_clean_pubkey_hash(unsigned char **hash);
489 LIBSSH_API int ssh_connect(ssh_session session);
490 
491 LIBSSH_API ssh_connector ssh_connector_new(ssh_session session);
492 LIBSSH_API void ssh_connector_free(ssh_connector connector);
493 LIBSSH_API int ssh_connector_set_in_channel(ssh_connector connector,
494  ssh_channel channel,
495  enum ssh_connector_flags_e flags);
496 LIBSSH_API int ssh_connector_set_out_channel(ssh_connector connector,
497  ssh_channel channel,
498  enum ssh_connector_flags_e flags);
499 LIBSSH_API void ssh_connector_set_in_fd(ssh_connector connector, socket_t fd);
500 LIBSSH_API void ssh_connector_set_out_fd(ssh_connector connector, socket_t fd);
501 
502 LIBSSH_API const char *ssh_copyright(void);
503 LIBSSH_API void ssh_disconnect(ssh_session session);
504 LIBSSH_API char *ssh_dirname (const char *path);
505 LIBSSH_API int ssh_finalize(void);
506 
507 /* REVERSE PORT FORWARDING */
509  int timeout_ms,
510  int *destination_port);
511 LIBSSH_API int ssh_channel_cancel_forward(ssh_session session,
512  const char *address,
513  int port);
514 LIBSSH_API int ssh_channel_listen_forward(ssh_session session,
515  const char *address,
516  int port,
517  int *bound_port);
518 
519 LIBSSH_API void ssh_free(ssh_session session);
520 LIBSSH_API const char *ssh_get_disconnect_message(ssh_session session);
521 LIBSSH_API const char *ssh_get_error(void *error);
522 LIBSSH_API int ssh_get_error_code(void *error);
523 LIBSSH_API socket_t ssh_get_fd(ssh_session session);
524 LIBSSH_API char *ssh_get_hexa(const unsigned char *what, size_t len);
525 LIBSSH_API char *ssh_get_issue_banner(ssh_session session);
526 LIBSSH_API int ssh_get_openssh_version(ssh_session session);
527 
528 LIBSSH_API int ssh_get_server_publickey(ssh_session session, ssh_key *key);
529 
530 enum ssh_publickey_hash_type {
531  SSH_PUBLICKEY_HASH_SHA1,
532  SSH_PUBLICKEY_HASH_MD5,
533  SSH_PUBLICKEY_HASH_SHA256
534 };
535 LIBSSH_API int ssh_get_publickey_hash(const ssh_key key,
536  enum ssh_publickey_hash_type type,
537  unsigned char **hash,
538  size_t *hlen);
539 
540 /* DEPRECATED FUNCTIONS */
541 SSH_DEPRECATED LIBSSH_API int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash);
542 SSH_DEPRECATED LIBSSH_API ssh_channel ssh_forward_accept(ssh_session session, int timeout_ms);
543 SSH_DEPRECATED LIBSSH_API int ssh_forward_cancel(ssh_session session, const char *address, int port);
544 SSH_DEPRECATED LIBSSH_API int ssh_forward_listen(ssh_session session, const char *address, int port, int *bound_port);
545 SSH_DEPRECATED LIBSSH_API int ssh_get_publickey(ssh_session session, ssh_key *key);
546 SSH_DEPRECATED LIBSSH_API int ssh_write_knownhost(ssh_session session);
547 SSH_DEPRECATED LIBSSH_API char *ssh_dump_knownhost(ssh_session session);
548 SSH_DEPRECATED LIBSSH_API int ssh_is_server_known(ssh_session session);
549 
550 
551 
552 LIBSSH_API int ssh_get_random(void *where,int len,int strong);
553 LIBSSH_API int ssh_get_version(ssh_session session);
554 LIBSSH_API int ssh_get_status(ssh_session session);
555 LIBSSH_API int ssh_get_poll_flags(ssh_session session);
556 LIBSSH_API int ssh_init(void);
557 LIBSSH_API int ssh_is_blocking(ssh_session session);
558 LIBSSH_API int ssh_is_connected(ssh_session session);
559 
560 /* KNOWN HOSTS */
561 LIBSSH_API void ssh_knownhosts_entry_free(struct ssh_knownhosts_entry *entry);
562 #define SSH_KNOWNHOSTS_ENTRY_FREE(e) do { \
563  if ((e) != NULL) { \
564  ssh_knownhosts_entry_free(e); \
565  e = NULL; \
566  } \
567 } while(0)
568 
569 LIBSSH_API int ssh_known_hosts_parse_line(const char *host,
570  const char *line,
571  struct ssh_knownhosts_entry **entry);
572 LIBSSH_API enum ssh_known_hosts_e ssh_session_has_known_hosts_entry(ssh_session session);
573 
575  char **pentry_string);
576 LIBSSH_API int ssh_session_update_known_hosts(ssh_session session);
577 
578 LIBSSH_API enum ssh_known_hosts_e
580  struct ssh_knownhosts_entry **pentry);
581 LIBSSH_API enum ssh_known_hosts_e ssh_session_is_known_server(ssh_session session);
582 
583 /* LOGGING */
584 LIBSSH_API int ssh_set_log_level(int level);
585 LIBSSH_API int ssh_get_log_level(void);
586 LIBSSH_API void *ssh_get_log_userdata(void);
587 LIBSSH_API int ssh_set_log_userdata(void *data);
588 LIBSSH_API void _ssh_log(int verbosity,
589  const char *function,
590  const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
591 
592 /* legacy */
593 SSH_DEPRECATED LIBSSH_API void ssh_log(ssh_session session,
594  int prioriry,
595  const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
596 
597 LIBSSH_API ssh_channel ssh_message_channel_request_open_reply_accept(ssh_message msg);
598 LIBSSH_API int ssh_message_channel_request_reply_success(ssh_message msg);
599 LIBSSH_API void ssh_message_free(ssh_message msg);
600 LIBSSH_API ssh_message ssh_message_get(ssh_session session);
601 LIBSSH_API int ssh_message_subtype(ssh_message msg);
602 LIBSSH_API int ssh_message_type(ssh_message msg);
603 LIBSSH_API int ssh_mkdir (const char *pathname, mode_t mode);
604 LIBSSH_API ssh_session ssh_new(void);
605 
606 LIBSSH_API int ssh_options_copy(ssh_session src, ssh_session *dest);
607 LIBSSH_API int ssh_options_getopt(ssh_session session, int *argcptr, char **argv);
608 LIBSSH_API int ssh_options_parse_config(ssh_session session, const char *filename);
609 LIBSSH_API int ssh_options_set(ssh_session session, enum ssh_options_e type,
610  const void *value);
611 LIBSSH_API int ssh_options_get(ssh_session session, enum ssh_options_e type,
612  char **value);
613 LIBSSH_API int ssh_options_get_port(ssh_session session, unsigned int * port_target);
614 LIBSSH_API int ssh_pcap_file_close(ssh_pcap_file pcap);
615 LIBSSH_API void ssh_pcap_file_free(ssh_pcap_file pcap);
616 LIBSSH_API ssh_pcap_file ssh_pcap_file_new(void);
617 LIBSSH_API int ssh_pcap_file_open(ssh_pcap_file pcap, const char *filename);
618 
632 typedef int (*ssh_auth_callback) (const char *prompt, char *buf, size_t len,
633  int echo, int verify, void *userdata);
634 
635 LIBSSH_API ssh_key ssh_key_new(void);
636 #define SSH_KEY_FREE(x) \
637  do { if ((x) != NULL) { ssh_key_free(x); x = NULL; } } while(0)
638 LIBSSH_API void ssh_key_free (ssh_key key);
639 LIBSSH_API enum ssh_keytypes_e ssh_key_type(const ssh_key key);
640 LIBSSH_API const char *ssh_key_type_to_char(enum ssh_keytypes_e type);
641 LIBSSH_API enum ssh_keytypes_e ssh_key_type_from_name(const char *name);
642 LIBSSH_API int ssh_key_is_public(const ssh_key k);
643 LIBSSH_API int ssh_key_is_private(const ssh_key k);
644 LIBSSH_API int ssh_key_cmp(const ssh_key k1,
645  const ssh_key k2,
646  enum ssh_keycmp_e what);
647 
648 LIBSSH_API int ssh_pki_generate(enum ssh_keytypes_e type, int parameter,
649  ssh_key *pkey);
650 LIBSSH_API int ssh_pki_import_privkey_base64(const char *b64_key,
651  const char *passphrase,
652  ssh_auth_callback auth_fn,
653  void *auth_data,
654  ssh_key *pkey);
655 LIBSSH_API int ssh_pki_export_privkey_base64(const ssh_key privkey,
656  const char *passphrase,
657  ssh_auth_callback auth_fn,
658  void *auth_data,
659  char **b64_key);
660 LIBSSH_API int ssh_pki_import_privkey_file(const char *filename,
661  const char *passphrase,
662  ssh_auth_callback auth_fn,
663  void *auth_data,
664  ssh_key *pkey);
665 LIBSSH_API int ssh_pki_export_privkey_file(const ssh_key privkey,
666  const char *passphrase,
667  ssh_auth_callback auth_fn,
668  void *auth_data,
669  const char *filename);
670 
671 LIBSSH_API int ssh_pki_copy_cert_to_privkey(const ssh_key cert_key,
672  ssh_key privkey);
673 
674 LIBSSH_API int ssh_pki_import_pubkey_base64(const char *b64_key,
675  enum ssh_keytypes_e type,
676  ssh_key *pkey);
677 LIBSSH_API int ssh_pki_import_pubkey_file(const char *filename,
678  ssh_key *pkey);
679 
680 LIBSSH_API int ssh_pki_import_cert_base64(const char *b64_cert,
681  enum ssh_keytypes_e type,
682  ssh_key *pkey);
683 LIBSSH_API int ssh_pki_import_cert_file(const char *filename,
684  ssh_key *pkey);
685 
686 LIBSSH_API int ssh_pki_export_privkey_to_pubkey(const ssh_key privkey,
687  ssh_key *pkey);
688 LIBSSH_API int ssh_pki_export_pubkey_base64(const ssh_key key,
689  char **b64_key);
690 LIBSSH_API int ssh_pki_export_pubkey_file(const ssh_key key,
691  const char *filename);
692 
693 LIBSSH_API const char *ssh_pki_key_ecdsa_name(const ssh_key key);
694 
695 LIBSSH_API char *ssh_get_fingerprint_hash(enum ssh_publickey_hash_type type,
696  unsigned char *hash,
697  size_t len);
698 LIBSSH_API void ssh_print_hash(enum ssh_publickey_hash_type type, unsigned char *hash, size_t len);
699 LIBSSH_API void ssh_print_hexa(const char *descr, const unsigned char *what, size_t len);
700 LIBSSH_API int ssh_send_ignore (ssh_session session, const char *data);
701 LIBSSH_API int ssh_send_debug (ssh_session session, const char *message, int always_display);
702 LIBSSH_API void ssh_gssapi_set_creds(ssh_session session, const ssh_gssapi_creds creds);
703 LIBSSH_API int ssh_scp_accept_request(ssh_scp scp);
704 LIBSSH_API int ssh_scp_close(ssh_scp scp);
705 LIBSSH_API int ssh_scp_deny_request(ssh_scp scp, const char *reason);
706 LIBSSH_API void ssh_scp_free(ssh_scp scp);
707 LIBSSH_API int ssh_scp_init(ssh_scp scp);
708 LIBSSH_API int ssh_scp_leave_directory(ssh_scp scp);
709 LIBSSH_API ssh_scp ssh_scp_new(ssh_session session, int mode, const char *location);
710 LIBSSH_API int ssh_scp_pull_request(ssh_scp scp);
711 LIBSSH_API int ssh_scp_push_directory(ssh_scp scp, const char *dirname, int mode);
712 LIBSSH_API int ssh_scp_push_file(ssh_scp scp, const char *filename, size_t size, int perms);
713 LIBSSH_API int ssh_scp_push_file64(ssh_scp scp, const char *filename, uint64_t size, int perms);
714 LIBSSH_API int ssh_scp_read(ssh_scp scp, void *buffer, size_t size);
715 LIBSSH_API const char *ssh_scp_request_get_filename(ssh_scp scp);
716 LIBSSH_API int ssh_scp_request_get_permissions(ssh_scp scp);
717 LIBSSH_API size_t ssh_scp_request_get_size(ssh_scp scp);
718 LIBSSH_API uint64_t ssh_scp_request_get_size64(ssh_scp scp);
719 LIBSSH_API const char *ssh_scp_request_get_warning(ssh_scp scp);
720 LIBSSH_API int ssh_scp_write(ssh_scp scp, const void *buffer, size_t len);
721 LIBSSH_API int ssh_select(ssh_channel *channels, ssh_channel *outchannels, socket_t maxfd,
722  fd_set *readfds, struct timeval *timeout);
723 LIBSSH_API int ssh_service_request(ssh_session session, const char *service);
724 LIBSSH_API int ssh_set_agent_channel(ssh_session session, ssh_channel channel);
725 LIBSSH_API int ssh_set_agent_socket(ssh_session session, socket_t fd);
726 LIBSSH_API void ssh_set_blocking(ssh_session session, int blocking);
727 LIBSSH_API void ssh_set_counters(ssh_session session, ssh_counter scounter,
728  ssh_counter rcounter);
729 LIBSSH_API void ssh_set_fd_except(ssh_session session);
730 LIBSSH_API void ssh_set_fd_toread(ssh_session session);
731 LIBSSH_API void ssh_set_fd_towrite(ssh_session session);
732 LIBSSH_API void ssh_silent_disconnect(ssh_session session);
733 LIBSSH_API int ssh_set_pcap_file(ssh_session session, ssh_pcap_file pcapfile);
734 
735 /* USERAUTH */
736 LIBSSH_API int ssh_userauth_none(ssh_session session, const char *username);
737 LIBSSH_API int ssh_userauth_list(ssh_session session, const char *username);
738 LIBSSH_API int ssh_userauth_try_publickey(ssh_session session,
739  const char *username,
740  const ssh_key pubkey);
741 LIBSSH_API int ssh_userauth_publickey(ssh_session session,
742  const char *username,
743  const ssh_key privkey);
744 #ifndef _WIN32
745 LIBSSH_API int ssh_userauth_agent(ssh_session session,
746  const char *username);
747 #endif
748 LIBSSH_API int ssh_userauth_publickey_auto(ssh_session session,
749  const char *username,
750  const char *passphrase);
751 LIBSSH_API int ssh_userauth_password(ssh_session session,
752  const char *username,
753  const char *password);
754 
755 LIBSSH_API int ssh_userauth_kbdint(ssh_session session, const char *user, const char *submethods);
756 LIBSSH_API const char *ssh_userauth_kbdint_getinstruction(ssh_session session);
757 LIBSSH_API const char *ssh_userauth_kbdint_getname(ssh_session session);
758 LIBSSH_API int ssh_userauth_kbdint_getnprompts(ssh_session session);
759 LIBSSH_API const char *ssh_userauth_kbdint_getprompt(ssh_session session, unsigned int i, char *echo);
760 LIBSSH_API int ssh_userauth_kbdint_getnanswers(ssh_session session);
761 LIBSSH_API const char *ssh_userauth_kbdint_getanswer(ssh_session session, unsigned int i);
762 LIBSSH_API int ssh_userauth_kbdint_setanswer(ssh_session session, unsigned int i,
763  const char *answer);
764 LIBSSH_API int ssh_userauth_gssapi(ssh_session session);
765 LIBSSH_API const char *ssh_version(int req_version);
766 
767 LIBSSH_API void ssh_string_burn(ssh_string str);
768 LIBSSH_API ssh_string ssh_string_copy(ssh_string str);
769 LIBSSH_API void *ssh_string_data(ssh_string str);
770 LIBSSH_API int ssh_string_fill(ssh_string str, const void *data, size_t len);
771 #define SSH_STRING_FREE(x) \
772  do { if ((x) != NULL) { ssh_string_free(x); x = NULL; } } while(0)
773 LIBSSH_API void ssh_string_free(ssh_string str);
774 LIBSSH_API ssh_string ssh_string_from_char(const char *what);
775 LIBSSH_API size_t ssh_string_len(ssh_string str);
776 LIBSSH_API ssh_string ssh_string_new(size_t size);
777 LIBSSH_API const char *ssh_string_get_char(ssh_string str);
778 LIBSSH_API char *ssh_string_to_char(ssh_string str);
779 #define SSH_STRING_FREE_CHAR(x) \
780  do { if ((x) != NULL) { ssh_string_free_char(x); x = NULL; } } while(0)
781 LIBSSH_API void ssh_string_free_char(char *s);
782 
783 LIBSSH_API int ssh_getpass(const char *prompt, char *buf, size_t len, int echo,
784  int verify);
785 
786 
787 typedef int (*ssh_event_callback)(socket_t fd, int revents, void *userdata);
788 
789 LIBSSH_API ssh_event ssh_event_new(void);
790 LIBSSH_API int ssh_event_add_fd(ssh_event event, socket_t fd, short events,
791  ssh_event_callback cb, void *userdata);
792 LIBSSH_API int ssh_event_add_session(ssh_event event, ssh_session session);
793 LIBSSH_API int ssh_event_add_connector(ssh_event event, ssh_connector connector);
794 LIBSSH_API int ssh_event_dopoll(ssh_event event, int timeout);
795 LIBSSH_API int ssh_event_remove_fd(ssh_event event, socket_t fd);
796 LIBSSH_API int ssh_event_remove_session(ssh_event event, ssh_session session);
797 LIBSSH_API int ssh_event_remove_connector(ssh_event event, ssh_connector connector);
798 LIBSSH_API void ssh_event_free(ssh_event event);
799 LIBSSH_API const char* ssh_get_clientbanner(ssh_session session);
800 LIBSSH_API const char* ssh_get_serverbanner(ssh_session session);
801 LIBSSH_API const char* ssh_get_kex_algo(ssh_session session);
802 LIBSSH_API const char* ssh_get_cipher_in(ssh_session session);
803 LIBSSH_API const char* ssh_get_cipher_out(ssh_session session);
804 LIBSSH_API const char* ssh_get_hmac_in(ssh_session session);
805 LIBSSH_API const char* ssh_get_hmac_out(ssh_session session);
806 
807 LIBSSH_API ssh_buffer ssh_buffer_new(void);
808 LIBSSH_API void ssh_buffer_free(ssh_buffer buffer);
809 #define SSH_BUFFER_FREE(x) \
810  do { if ((x) != NULL) { ssh_buffer_free(x); x = NULL; } } while(0)
811 LIBSSH_API int ssh_buffer_reinit(ssh_buffer buffer);
812 LIBSSH_API int ssh_buffer_add_data(ssh_buffer buffer, const void *data, uint32_t len);
813 LIBSSH_API uint32_t ssh_buffer_get_data(ssh_buffer buffer, void *data, uint32_t requestedlen);
814 LIBSSH_API void *ssh_buffer_get(ssh_buffer buffer);
815 LIBSSH_API uint32_t ssh_buffer_get_len(ssh_buffer buffer);
816 
817 #ifndef LIBSSH_LEGACY_0_4
818 #include "libssh/legacy.h"
819 #endif
820 
821 #ifdef __cplusplus
822 }
823 #endif
824 #endif /* _LIBSSH_H */
LIBSSH_API void ssh_knownhosts_entry_free(struct ssh_knownhosts_entry *entry)
Free an allocated ssh_knownhosts_entry.
Definition: knownhosts.c:144
LIBSSH_API int ssh_set_log_userdata(void *data)
Set the userdata for the logging function.
Definition: log.c:235
Definition: messages.h:46
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:1521
LIBSSH_API void * ssh_get_log_userdata(void)
Get the userdata of the logging function.
Definition: log.c:219
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:1613
Definition: pki.h:42
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:1637
LIBSSH_API int ssh_scp_init(ssh_scp scp)
Initialize the scp channel.
Definition: scp.c:95
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 current connected session.
Definition: knownhosts.c:824
Definition: agent.h:73
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:1032
SSH_DEPRECATED LIBSSH_API int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash)
Definition: dh.c:1177
char * ssh_string_to_char(struct ssh_string_struct *s)
Convert a SSH string to a C nul-terminated string.
Definition: string.c:181
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:3067
LIBSSH_API int ssh_options_parse_config(ssh_session session, const char *filename)
Parse the ssh config file.
Definition: options.c:1286
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:1850
LIBSSH_API const char * ssh_key_type_to_char(enum ssh_keytypes_e type)
Convert a key type to a string.
Definition: pki.c:233
LIBSSH_API int ssh_channel_request_shell(ssh_channel channel)
Request a shell.
Definition: channels.c:1739
LIBSSH_API int ssh_init(void)
Initialize global cryptographic data structures.
Definition: init.c:148
LIBSSH_API int ssh_message_type(ssh_message msg)
Get the type of the message.
Definition: messages.c:516
LIBSSH_API int ssh_send_debug(ssh_session session, const char *message, int always_display)
Send a debug message.
Definition: session.c:871
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:373
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:925
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:2489
Definition: messages.h:84
LIBSSH_API int ssh_channel_is_eof(ssh_channel channel)
Check if remote has sent an EOF.
Definition: channels.c:1416
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:386
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:2668
LIBSSH_API int ssh_set_log_level(int level)
Set the log level of the library.
Definition: log.c:181
LIBSSH_API int ssh_channel_send_eof(ssh_channel channel)
Send an end of file on the channel.
Definition: channels.c:1058
Definition: channels.h:57
void ssh_buffer_free(struct ssh_buffer_struct *buffer)
Deallocate a SSH buffer.
Definition: buffer.c:149
LIBSSH_API void ssh_scp_free(ssh_scp scp)
Free a scp context.
Definition: scp.c:199
LIBSSH_API void ssh_clean_pubkey_hash(unsigned char **hash)
Deallocate the hash obtained by ssh_get_pubkey_hash.
Definition: dh.c:1239
LIBSSH_API int ssh_channel_close(ssh_channel channel)
Close a channel.
Definition: channels.c:1110
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:770
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:548
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:597
LIBSSH_API int ssh_key_is_public(const ssh_key k)
Check if the key has/is a public key.
Definition: pki.c:418
LIBSSH_API uint32_t ssh_channel_window_size(ssh_channel channel)
Get the remote window size.
Definition: channels.c:1356
LIBSSH_API int ssh_scp_leave_directory(ssh_scp scp)
Leave a directory.
Definition: scp.c:271
LIBSSH_API int ssh_event_remove_connector(ssh_event event, ssh_connector connector)
Remove a connector from an event context.
Definition: poll.c:1003
LIBSSH_API ssh_string ssh_string_new(size_t size)
Create a new SSH String object.
Definition: string.c:56
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:644
LIBSSH_API int ssh_key_is_private(const ssh_key k)
Check if the key is a private key.
Definition: pki.c:433
Definition: poll.c:673
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:631
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:887
LIBSSH_API const char * ssh_version(int req_version)
Check if libssh is the required version or get the version string.
Definition: misc.c:355
LIBSSH_API ssh_message ssh_message_get(ssh_session session)
Retrieve a SSH message from a SSH session.
Definition: messages.c:489
LIBSSH_API int ssh_userauth_list(ssh_session session, const char *username)
Get available authentication methods from the server.
Definition: auth.c:355
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:1590
LIBSSH_API const char * ssh_get_error(void *error)
Retrieve the error text message from the last error.
Definition: error.c:128
Definition: libssh.h:341
LIBSSH_API int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel.
Definition: channels.c:1373
Definition: session.h:102
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:673
LIBSSH_API int ssh_event_add_session(ssh_event event, ssh_session session)
remove the poll handle from session and assign them to a event, when used in blocking mode...
Definition: poll.c:812
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:1681
LIBSSH_API int ssh_channel_request_pty_size(ssh_channel channel, const char *term, int cols, int rows)
Request a pty with a specific type and size.
Definition: channels.c:1618
LIBSSH_API int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem)
Request a subsystem (for example "sftp").
Definition: channels.c:1761
LIBSSH_API int ssh_pki_generate(enum ssh_keytypes_e type, int parameter, ssh_key *pkey)
Generates a keypair.
Definition: pki.c:1545
Definition: connector.c:52
LIBSSH_API ssh_string ssh_string_from_char(const char *what)
Create a ssh string using a C string.
Definition: string.c:108
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:212
LIBSSH_API int ssh_event_dopoll(ssh_event event, int timeout)
Poll all the sockets and sessions associated through an event object.i.
Definition: poll.c:884
LIBSSH_API int ssh_get_version(ssh_session session)
Get the protocol version of the session.
Definition: session.c:801
LIBSSH_API int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value)
Set environment variables.
Definition: channels.c:2303
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:574
uint32_t ssh_buffer_get_len(struct ssh_buffer_struct *buffer)
Get the length of the buffer from the current position.
Definition: buffer.c:602
LIBSSH_API char * ssh_get_issue_banner(ssh_session session)
Get the issue banner from the server.
Definition: client.c:605
int ssh_buffer_reinit(struct ssh_buffer_struct *buffer)
Reinitialize a SSH buffer.
Definition: buffer.c:259
LIBSSH_API enum ssh_known_hosts_e ssh_session_has_known_hosts_entry(ssh_session session)
Check if the set hostname and port matches an entry in known_hosts.
Definition: knownhosts.c:534
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:1774
int ssh_string_fill(struct ssh_string_struct *s, const void *data, size_t len)
Fill a string with given data. The string should be big enough.
Definition: string.c:87
LIBSSH_API int ssh_userauth_kbdint_getnprompts(ssh_session session)
Get the number of prompts (questions) the server has given.
Definition: auth.c:1680
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:743
LIBSSH_API void ssh_set_counters(ssh_session session, ssh_counter scounter, ssh_counter rcounter)
Set the session data counters.
Definition: session.c:927
LIBSSH_API int ssh_options_copy(ssh_session src, ssh_session *dest)
Duplicate the options of a session structure.
Definition: options.c:64
LIBSSH_API const char * ssh_userauth_kbdint_getinstruction(ssh_session session)
Get the "instruction" of the message block.
Definition: auth.c:1725
LIBSSH_API int ssh_channel_open_session(ssh_channel channel)
Open a session channel (suited for a shell, not TCP forwarding).
Definition: channels.c:860
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:789
struct ssh_string_struct * ssh_string_copy(struct ssh_string_struct *s)
Copy a string, return a newly allocated string. The caller has to free the string.
Definition: string.c:221
const char * ssh_string_get_char(struct ssh_string_struct *s)
Get the the string as a C nul-terminated string.
Definition: string.c:160
void * ssh_buffer_get(struct ssh_buffer_struct *buffer)
Get a pointer to the head of a buffer at the current position.
Definition: buffer.c:589
LIBSSH_API void ssh_set_blocking(ssh_session session, int blocking)
Set the session in blocking/nonblocking mode.
Definition: session.c:452
LIBSSH_API int ssh_channel_is_open(ssh_channel channel)
Check if the channel is open or not.
Definition: channels.c:1386
LIBSSH_API int ssh_event_add_connector(ssh_event event, ssh_connector connector)
Add a connector to the SSH event loop.
Definition: poll.c:864
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:381
SSH_DEPRECATED LIBSSH_API int ssh_write_knownhost(ssh_session session)
This function is deprecated.
Definition: known_hosts.c:515
LIBSSH_API int ssh_channel_is_closed(ssh_channel channel)
Check if the channel is closed or not.
Definition: channels.c:1402
LIBSSH_API void ssh_key_free(ssh_key key)
deallocate a SSH key
Definition: pki.c:174
Definition: libssh.h:335
Definition: libssh.h:344
LIBSSH_API ssh_session ssh_channel_get_session(ssh_channel channel)
Recover the session in which belongs a channel.
Definition: channels.c:2928
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:2887
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:92
LIBSSH_API ssh_scp ssh_scp_new(ssh_session session, int mode, const char *location)
Create a new scp session.
Definition: scp.c:60
LIBSSH_API ssh_buffer ssh_buffer_new(void)
Create a new SSH buffer.
Definition: buffer.c:119
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:754
LIBSSH_API int ssh_scp_write(ssh_scp scp, const void *buffer, size_t len)
Write into a remote scp file.
Definition: scp.c:437
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:688
LIBSSH_API int ssh_channel_poll(ssh_channel channel, int is_stderr)
Polls a channel for data to read.
Definition: channels.c:2835
LIBSSH_API int ssh_is_connected(ssh_session session)
Check if we are connected.
Definition: session.c:516
LIBSSH_API int ssh_get_log_level(void)
Get the log level of the library.
Definition: log.c:196
LIBSSH_API int ssh_get_poll_flags(ssh_session session)
Get poll flags for an external mainloop.
Definition: session.c:756
Definition: libssh.h:309
Definition: string.h:29
LIBSSH_API int ssh_userauth_gssapi(ssh_session session)
Try to authenticate through the "gssapi-with-mic" method.
Definition: auth.c:1882
Definition: libssh.h:332
LIBSSH_API ssh_channel ssh_channel_new(ssh_session session)
Allocate a new channel.
Definition: channels.c:79
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:430
LIBSSH_API int ssh_options_getopt(ssh_session session, int *argcptr, char **argv)
Parse command line arguments.
Definition: options.c:1104
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:1760
LIBSSH_API const char * ssh_userauth_kbdint_getname(ssh_session session)
Get the "name" of the message block.
Definition: auth.c:1702
LIBSSH_API const char * ssh_get_clientbanner(ssh_session session)
get the client banner
Definition: session.c:305
LIBSSH_API int ssh_event_remove_session(ssh_event event, ssh_session session)
Remove a session object from an event context.
Definition: poll.c:949
LIBSSH_API ssh_key ssh_key_new(void)
creates a new empty SSH key
Definition: pki.c:106
LIBSSH_API int ssh_get_server_publickey(ssh_session session, ssh_key *key)
Get the server public key from a session.
Definition: dh.c:1256
LIBSSH_API int ssh_userauth_password(ssh_session session, const char *username, const char *password)
Try to authenticate by password.
Definition: auth.c:1222
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:1002
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:1835
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:601
LIBSSH_API int ssh_pki_import_cert_base64(const char *b64_cert, enum ssh_keytypes_e type, ssh_key *pkey)
Import a base64 formated certificate from a memory c-string.
Definition: pki.c:1485
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:389
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:475
LIBSSH_API socket_t ssh_get_fd(ssh_session session)
Get the fd of a connection.
Definition: session.c:534
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:1700
LIBSSH_API int ssh_connect(ssh_session session)
Connect to the ssh server.
Definition: client.c:490
LIBSSH_API enum ssh_keytypes_e ssh_key_type(const ssh_key key)
returns the type of a ssh key
Definition: pki.c:189
LIBSSH_API void ssh_disconnect(ssh_session session)
Disconnect from a session (client or server). The session can then be reused to open a new session...
Definition: client.c:645
LIBSSH_API int ssh_userauth_none(ssh_session session, const char *username)
Try to authenticate through the "none" method.
Definition: auth.c:385
void ssh_string_free(struct ssh_string_struct *s)
Deallocate a SSH string object.
Definition: string.c:277
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:2170
LIBSSH_API ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms)
Accept an X11 forwarding channel.
Definition: channels.c:1966
LIBSSH_API int ssh_mkdir(const char *pathname, mode_t mode)
Attempts to create a directory with the given pathname.
Definition: misc.c:631
LIBSSH_API int ssh_blocking_flush(ssh_session session, int timeout)
Blocking flush of the outgoing buffer.
Definition: session.c:491
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:452
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:2443
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:561
LIBSSH_API void ssh_event_free(ssh_event event)
Free an event context.
Definition: poll.c:1016
Definition: libssh.h:338
SSH_DEPRECATED LIBSSH_API char * ssh_dump_knownhost(ssh_session session)
This function is deprecated.
Definition: known_hosts.c:446
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 information about incomming connection.
Definition: channels.c:2233
LIBSSH_API void ssh_print_hexa(const char *descr, const unsigned char *what, size_t len)
Print a buffer as colon separated hex string.
Definition: dh.c:1617
LIBSSH_API const char * ssh_scp_request_get_warning(ssh_scp scp)
Get the warning string from a scp handle.
Definition: scp.c:829
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. This function is useful when the session options have been automatically inferred from the environment or configuration files and one.
Definition: options.c:980
LIBSSH_API int ssh_pki_import_cert_file(const char *filename, ssh_key *pkey)
Import a certificate from the given filename.
Definition: pki.c:1524
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:766
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:779
void * ssh_string_data(struct ssh_string_struct *s)
Get the payload of the string.
Definition: string.c:264
uint32_t ssh_buffer_get_data(struct ssh_buffer_struct *buffer, void *data, uint32_t len)
Get the remaining data out of the buffer and adjust the read pointer.
Definition: buffer.c:671
LIBSSH_API int ssh_scp_read(ssh_scp scp, void *buffer, size_t size)
Read from a remote scp file.
Definition: scp.c:703
LIBSSH_API char * ssh_basename(const char *path)
basename - parse filename component.
Definition: misc.c:580
LIBSSH_API int ssh_finalize(void)
Finalize and cleanup all libssh and cryptographic data structures.
Definition: init.c:221
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:617
void ssh_string_burn(struct ssh_string_struct *s)
Destroy the data in a string so it couldn&#39;t appear in a core dump.
Definition: string.c:249
LIBSSH_API int ssh_channel_request_exec(ssh_channel channel, const char *cmd)
Run a shell command without an interactive shell.
Definition: channels.c:2373
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:420
LIBSSH_API int ssh_channel_request_pty(ssh_channel channel)
Request a PTY.
Definition: channels.c:1681
LIBSSH_API const char * ssh_get_serverbanner(ssh_session session)
get the server banner
Definition: session.c:320
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:889
LIBSSH_API int ssh_session_update_known_hosts(ssh_session session)
Add the current connected server to the known_hosts file.
Definition: knownhosts.c:669
LIBSSH_API void ssh_silent_disconnect(ssh_session session)
Disconnect impolitely from a remote host by closing the socket.
Definition: session.c:435
LIBSSH_API const char * ssh_get_disconnect_message(ssh_session session)
Get the disconnect message from the server.
Definition: session.c:776
Definition: scp.h:35
size_t ssh_string_len(struct ssh_string_struct *s)
Return the size of a SSH string.
Definition: string.c:136
LIBSSH_API void ssh_channel_set_blocking(ssh_channel channel, int blocking)
Put the channel into blocking or nonblocking mode.
Definition: channels.c:1441
LIBSSH_API const char * ssh_get_kex_algo(ssh_session session)
get the name of the current key exchange algorithm.
Definition: session.c:334
LIBSSH_API void ssh_message_free(ssh_message msg)
Free a SSH message.
Definition: messages.c:555
LIBSSH_API int ssh_message_subtype(ssh_message msg)
Get the subtype of the message.
Definition: messages.c:531
LIBSSH_API ssh_session ssh_new(void)
Create a new ssh session.
Definition: session.c:58
SSH_DEPRECATED LIBSSH_API int ssh_get_publickey(ssh_session session, ssh_key *key)
Definition: dh.c:1306
LIBSSH_API int ssh_get_status(ssh_session session)
Get session status.
Definition: session.c:718
LIBSSH_API void ssh_channel_set_counter(ssh_channel channel, ssh_counter counter)
Set the channel data counter.
Definition: channels.c:3201
LIBSSH_API void ssh_channel_free(ssh_channel channel)
Close and free a channel.
Definition: channels.c:981
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:468
LIBSSH_API int ssh_event_remove_fd(ssh_event event, socket_t fd)
Remove a socket fd from an event context.
Definition: poll.c:903
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:317
LIBSSH_API int ssh_scp_pull_request(ssh_scp scp)
Wait for a scp request (file, directory).
Definition: scp.c:547
LIBSSH_API void ssh_string_free_char(char *s)
Deallocate a char string object.
Definition: string.c:209
SSH_DEPRECATED LIBSSH_API int ssh_is_server_known(ssh_session session)
This function is depcrecated.
Definition: known_hosts.c:308
LIBSSH_API int ssh_send_ignore(ssh_session session, const char *data)
Send a message that should be ignored.
Definition: session.c:836
LIBSSH_API int ssh_is_blocking(ssh_session session)
Return the blocking mode of libssh.
Definition: session.c:466
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: dh.c:1479
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: dh.c:1339
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:2964
LIBSSH_API int ssh_pki_import_pubkey_file(const char *filename, ssh_key *pkey)
Import a public key from the given filename.
Definition: pki.c:1370
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:2252
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:1981
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:3221
LIBSSH_API int ssh_userauth_agent(ssh_session session, const char *username)
Try to do public key authentication with ssh agent.
Definition: auth.c:867
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:405
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:372
LIBSSH_API int ssh_pki_import_pubkey_base64(const char *b64_key, enum ssh_keytypes_e type, ssh_key *pkey)
Import a base64 formated public key from a memory c-string.
Definition: pki.c:1254
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:227
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:2636
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 formated key from a memory c-string
Definition: pki.c:556
LIBSSH_API void ssh_free(ssh_session session)
Deallocate a SSH session handle.
Definition: session.c:169
LIBSSH_API int ssh_scp_close(ssh_scp scp)
Close the scp channel.
Definition: scp.c:161
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:2783
int ssh_buffer_add_data(struct ssh_buffer_struct *buffer, const void *data, uint32_t len)
Add data at the tail of a buffer.
Definition: buffer.c:300
LIBSSH_API char * ssh_dirname(const char *path)
Parse directory component.
Definition: misc.c:525
LIBSSH_API int ssh_get_error_code(void *error)
Retrieve the error code from the last error.
Definition: error.c:148
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 key from a file.
Definition: pki.c:676
Definition: buffer.c:47
Definition: libssh.h:108