libssh  0.9.3
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 9
82#define LIBSSH_VERSION_MICRO 3
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
105extern "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};
114typedef struct ssh_counter_struct *ssh_counter;
115
116typedef struct ssh_agent_struct* ssh_agent;
117typedef struct ssh_buffer_struct* ssh_buffer;
118typedef struct ssh_channel_struct* ssh_channel;
119typedef struct ssh_message_struct* ssh_message;
120typedef struct ssh_pcap_file_struct* ssh_pcap_file;
121typedef struct ssh_key_struct* ssh_key;
122typedef struct ssh_scp_struct* ssh_scp;
123typedef struct ssh_session_struct* ssh_session;
124typedef struct ssh_string_struct* ssh_string;
125typedef struct ssh_event_struct* ssh_event;
126typedef struct ssh_connector_struct * ssh_connector;
127typedef void* ssh_gssapi_creds;
128
129/* Socket type */
130#ifdef _WIN32
131#ifndef socket_t
132typedef SOCKET socket_t;
133#endif /* socket_t */
134#else /* _WIN32 */
135#ifndef socket_t
136typedef int socket_t;
137#endif
138#endif /* _WIN32 */
139
140#define SSH_INVALID_SOCKET ((socket_t) -1)
141
142/* the offsets of methods */
143enum 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
161enum 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 0x0000u
172#define SSH_AUTH_METHOD_NONE 0x0001u
173#define SSH_AUTH_METHOD_PASSWORD 0x0002u
174#define SSH_AUTH_METHOD_PUBLICKEY 0x0004u
175#define SSH_AUTH_METHOD_HOSTBASED 0x0008u
176#define SSH_AUTH_METHOD_INTERACTIVE 0x0010u
177#define SSH_AUTH_METHOD_GSSAPI_MIC 0x0020u
178
179/* messages */
180enum 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
188enum 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
197enum 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
208enum 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
215enum 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
226#define SSH_READ_PENDING 0x02
228#define SSH_CLOSED_ERROR 0x04
230#define SSH_WRITE_PENDING 0x08
231
232enum 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
241enum 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
283enum 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 */
291enum 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, /* deprecated */
297 SSH_KEYTYPE_ED25519,
298 SSH_KEYTYPE_DSS_CERT01,
299 SSH_KEYTYPE_RSA_CERT01,
300 SSH_KEYTYPE_ECDSA_P256,
301 SSH_KEYTYPE_ECDSA_P384,
302 SSH_KEYTYPE_ECDSA_P521,
303 SSH_KEYTYPE_ECDSA_P256_CERT01,
304 SSH_KEYTYPE_ECDSA_P384_CERT01,
305 SSH_KEYTYPE_ECDSA_P521_CERT01,
306 SSH_KEYTYPE_ED25519_CERT01,
307};
308
309enum ssh_keycmp_e {
310 SSH_KEY_CMP_PUBLIC = 0,
311 SSH_KEY_CMP_PRIVATE
312};
313
314#define SSH_ADDRSTRLEN 46
315
317 char *hostname;
318 char *unparsed;
319 ssh_key publickey;
320 char *comment;
321};
322
323
324/* Error return codes */
325#define SSH_OK 0 /* No error */
326#define SSH_ERROR -1 /* Error of some kind */
327#define SSH_AGAIN -2 /* The nonblocking call must be repeated */
328#define SSH_EOF -127 /* We have already a eof */
329
336enum {
354#define SSH_LOG_RARE SSH_LOG_WARNING
355
364#define SSH_LOG_NONE 0
366#define SSH_LOG_WARN 1
368#define SSH_LOG_INFO 2
370#define SSH_LOG_DEBUG 3
372#define SSH_LOG_TRACE 4
373
376enum ssh_options_e {
377 SSH_OPTIONS_HOST,
378 SSH_OPTIONS_PORT,
379 SSH_OPTIONS_PORT_STR,
380 SSH_OPTIONS_FD,
381 SSH_OPTIONS_USER,
382 SSH_OPTIONS_SSH_DIR,
383 SSH_OPTIONS_IDENTITY,
384 SSH_OPTIONS_ADD_IDENTITY,
385 SSH_OPTIONS_KNOWNHOSTS,
386 SSH_OPTIONS_TIMEOUT,
387 SSH_OPTIONS_TIMEOUT_USEC,
388 SSH_OPTIONS_SSH1,
389 SSH_OPTIONS_SSH2,
390 SSH_OPTIONS_LOG_VERBOSITY,
391 SSH_OPTIONS_LOG_VERBOSITY_STR,
392 SSH_OPTIONS_CIPHERS_C_S,
393 SSH_OPTIONS_CIPHERS_S_C,
394 SSH_OPTIONS_COMPRESSION_C_S,
395 SSH_OPTIONS_COMPRESSION_S_C,
396 SSH_OPTIONS_PROXYCOMMAND,
397 SSH_OPTIONS_BINDADDR,
398 SSH_OPTIONS_STRICTHOSTKEYCHECK,
399 SSH_OPTIONS_COMPRESSION,
400 SSH_OPTIONS_COMPRESSION_LEVEL,
401 SSH_OPTIONS_KEY_EXCHANGE,
402 SSH_OPTIONS_HOSTKEYS,
403 SSH_OPTIONS_GSSAPI_SERVER_IDENTITY,
404 SSH_OPTIONS_GSSAPI_CLIENT_IDENTITY,
405 SSH_OPTIONS_GSSAPI_DELEGATE_CREDENTIALS,
406 SSH_OPTIONS_HMAC_C_S,
407 SSH_OPTIONS_HMAC_S_C,
408 SSH_OPTIONS_PASSWORD_AUTH,
409 SSH_OPTIONS_PUBKEY_AUTH,
410 SSH_OPTIONS_KBDINT_AUTH,
411 SSH_OPTIONS_GSSAPI_AUTH,
412 SSH_OPTIONS_GLOBAL_KNOWNHOSTS,
413 SSH_OPTIONS_NODELAY,
414 SSH_OPTIONS_PUBLICKEY_ACCEPTED_TYPES,
415 SSH_OPTIONS_PROCESS_CONFIG,
416 SSH_OPTIONS_REKEY_DATA,
417 SSH_OPTIONS_REKEY_TIME,
418};
419
420enum {
422 SSH_SCP_WRITE,
424 SSH_SCP_READ,
425 SSH_SCP_RECURSIVE=0x10
426};
427
428enum ssh_scp_request_types {
430 SSH_SCP_REQUEST_NEWDIR=1,
432 SSH_SCP_REQUEST_NEWFILE,
434 SSH_SCP_REQUEST_EOF,
436 SSH_SCP_REQUEST_ENDDIR,
438 SSH_SCP_REQUEST_WARNING
439};
440
441enum ssh_connector_flags_e {
443 SSH_CONNECTOR_STDOUT = 1,
444 SSH_CONNECTOR_STDINOUT = 1,
446 SSH_CONNECTOR_STDERR = 2,
448 SSH_CONNECTOR_BOTH = 3
449};
450
451LIBSSH_API int ssh_blocking_flush(ssh_session session, int timeout);
452LIBSSH_API ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms);
453LIBSSH_API int ssh_channel_change_pty_size(ssh_channel channel,int cols,int rows);
454LIBSSH_API int ssh_channel_close(ssh_channel channel);
455LIBSSH_API void ssh_channel_free(ssh_channel channel);
456LIBSSH_API int ssh_channel_get_exit_status(ssh_channel channel);
458LIBSSH_API int ssh_channel_is_closed(ssh_channel channel);
459LIBSSH_API int ssh_channel_is_eof(ssh_channel channel);
460LIBSSH_API int ssh_channel_is_open(ssh_channel channel);
461LIBSSH_API ssh_channel ssh_channel_new(ssh_session session);
462LIBSSH_API int ssh_channel_open_auth_agent(ssh_channel channel);
463LIBSSH_API int ssh_channel_open_forward(ssh_channel channel, const char *remotehost,
464 int remoteport, const char *sourcehost, int localport);
465LIBSSH_API int ssh_channel_open_forward_unix(ssh_channel channel, const char *remotepath,
466 const char *sourcehost, int localport);
467LIBSSH_API int ssh_channel_open_session(ssh_channel channel);
468LIBSSH_API int ssh_channel_open_x11(ssh_channel channel, const char *orig_addr, int orig_port);
469LIBSSH_API int ssh_channel_poll(ssh_channel channel, int is_stderr);
470LIBSSH_API int ssh_channel_poll_timeout(ssh_channel channel, int timeout, int is_stderr);
471LIBSSH_API int ssh_channel_read(ssh_channel channel, void *dest, uint32_t count, int is_stderr);
472LIBSSH_API int ssh_channel_read_timeout(ssh_channel channel, void *dest, uint32_t count, int is_stderr, int timeout_ms);
473LIBSSH_API int ssh_channel_read_nonblocking(ssh_channel channel, void *dest, uint32_t count,
474 int is_stderr);
475LIBSSH_API int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value);
476LIBSSH_API int ssh_channel_request_exec(ssh_channel channel, const char *cmd);
477LIBSSH_API int ssh_channel_request_pty(ssh_channel channel);
478LIBSSH_API int ssh_channel_request_pty_size(ssh_channel channel, const char *term,
479 int cols, int rows);
480LIBSSH_API int ssh_channel_request_shell(ssh_channel channel);
481LIBSSH_API int ssh_channel_request_send_signal(ssh_channel channel, const char *signum);
482LIBSSH_API int ssh_channel_request_send_break(ssh_channel channel, uint32_t length);
483LIBSSH_API int ssh_channel_request_sftp(ssh_channel channel);
484LIBSSH_API int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem);
485LIBSSH_API int ssh_channel_request_x11(ssh_channel channel, int single_connection, const char *protocol,
486 const char *cookie, int screen_number);
487LIBSSH_API int ssh_channel_request_auth_agent(ssh_channel channel);
488LIBSSH_API int ssh_channel_send_eof(ssh_channel channel);
489LIBSSH_API int ssh_channel_select(ssh_channel *readchans, ssh_channel *writechans, ssh_channel *exceptchans, struct
490 timeval * timeout);
491LIBSSH_API void ssh_channel_set_blocking(ssh_channel channel, int blocking);
492LIBSSH_API void ssh_channel_set_counter(ssh_channel channel,
493 ssh_counter counter);
494LIBSSH_API int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len);
495LIBSSH_API int ssh_channel_write_stderr(ssh_channel channel,
496 const void *data,
497 uint32_t len);
498LIBSSH_API uint32_t ssh_channel_window_size(ssh_channel channel);
499
500LIBSSH_API char *ssh_basename (const char *path);
501LIBSSH_API void ssh_clean_pubkey_hash(unsigned char **hash);
502LIBSSH_API int ssh_connect(ssh_session session);
503
504LIBSSH_API ssh_connector ssh_connector_new(ssh_session session);
505LIBSSH_API void ssh_connector_free(ssh_connector connector);
506LIBSSH_API int ssh_connector_set_in_channel(ssh_connector connector,
507 ssh_channel channel,
508 enum ssh_connector_flags_e flags);
509LIBSSH_API int ssh_connector_set_out_channel(ssh_connector connector,
510 ssh_channel channel,
511 enum ssh_connector_flags_e flags);
512LIBSSH_API void ssh_connector_set_in_fd(ssh_connector connector, socket_t fd);
513LIBSSH_API void ssh_connector_set_out_fd(ssh_connector connector, socket_t fd);
514
515LIBSSH_API const char *ssh_copyright(void);
516LIBSSH_API void ssh_disconnect(ssh_session session);
517LIBSSH_API char *ssh_dirname (const char *path);
518LIBSSH_API int ssh_finalize(void);
519
520/* REVERSE PORT FORWARDING */
522 int timeout_ms,
523 int *destination_port);
524LIBSSH_API int ssh_channel_cancel_forward(ssh_session session,
525 const char *address,
526 int port);
527LIBSSH_API int ssh_channel_listen_forward(ssh_session session,
528 const char *address,
529 int port,
530 int *bound_port);
531
532LIBSSH_API void ssh_free(ssh_session session);
533LIBSSH_API const char *ssh_get_disconnect_message(ssh_session session);
534LIBSSH_API const char *ssh_get_error(void *error);
535LIBSSH_API int ssh_get_error_code(void *error);
536LIBSSH_API socket_t ssh_get_fd(ssh_session session);
537LIBSSH_API char *ssh_get_hexa(const unsigned char *what, size_t len);
538LIBSSH_API char *ssh_get_issue_banner(ssh_session session);
539LIBSSH_API int ssh_get_openssh_version(ssh_session session);
540
541LIBSSH_API int ssh_get_server_publickey(ssh_session session, ssh_key *key);
542
543enum ssh_publickey_hash_type {
544 SSH_PUBLICKEY_HASH_SHA1,
545 SSH_PUBLICKEY_HASH_MD5,
546 SSH_PUBLICKEY_HASH_SHA256
547};
548LIBSSH_API int ssh_get_publickey_hash(const ssh_key key,
549 enum ssh_publickey_hash_type type,
550 unsigned char **hash,
551 size_t *hlen);
552
553/* DEPRECATED FUNCTIONS */
554SSH_DEPRECATED LIBSSH_API int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash);
555SSH_DEPRECATED LIBSSH_API ssh_channel ssh_forward_accept(ssh_session session, int timeout_ms);
556SSH_DEPRECATED LIBSSH_API int ssh_forward_cancel(ssh_session session, const char *address, int port);
557SSH_DEPRECATED LIBSSH_API int ssh_forward_listen(ssh_session session, const char *address, int port, int *bound_port);
558SSH_DEPRECATED LIBSSH_API int ssh_get_publickey(ssh_session session, ssh_key *key);
559SSH_DEPRECATED LIBSSH_API int ssh_write_knownhost(ssh_session session);
560SSH_DEPRECATED LIBSSH_API char *ssh_dump_knownhost(ssh_session session);
561SSH_DEPRECATED LIBSSH_API int ssh_is_server_known(ssh_session session);
562SSH_DEPRECATED LIBSSH_API void ssh_print_hexa(const char *descr, const unsigned char *what, size_t len);
563
564
565
566LIBSSH_API int ssh_get_random(void *where,int len,int strong);
567LIBSSH_API int ssh_get_version(ssh_session session);
568LIBSSH_API int ssh_get_status(ssh_session session);
569LIBSSH_API int ssh_get_poll_flags(ssh_session session);
570LIBSSH_API int ssh_init(void);
571LIBSSH_API int ssh_is_blocking(ssh_session session);
572LIBSSH_API int ssh_is_connected(ssh_session session);
573
574/* KNOWN HOSTS */
575LIBSSH_API void ssh_knownhosts_entry_free(struct ssh_knownhosts_entry *entry);
576#define SSH_KNOWNHOSTS_ENTRY_FREE(e) do { \
577 if ((e) != NULL) { \
578 ssh_knownhosts_entry_free(e); \
579 e = NULL; \
580 } \
581} while(0)
582
583LIBSSH_API int ssh_known_hosts_parse_line(const char *host,
584 const char *line,
585 struct ssh_knownhosts_entry **entry);
586LIBSSH_API enum ssh_known_hosts_e ssh_session_has_known_hosts_entry(ssh_session session);
587
589 char **pentry_string);
590LIBSSH_API int ssh_session_update_known_hosts(ssh_session session);
591
592LIBSSH_API enum ssh_known_hosts_e ssh_session_get_known_hosts_entry(ssh_session session,
593 struct ssh_knownhosts_entry **pentry);
594LIBSSH_API enum ssh_known_hosts_e ssh_session_is_known_server(ssh_session session);
595
596/* LOGGING */
597LIBSSH_API int ssh_set_log_level(int level);
598LIBSSH_API int ssh_get_log_level(void);
599LIBSSH_API void *ssh_get_log_userdata(void);
600LIBSSH_API int ssh_set_log_userdata(void *data);
601LIBSSH_API void _ssh_log(int verbosity,
602 const char *function,
603 const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
604
605/* legacy */
606SSH_DEPRECATED LIBSSH_API void ssh_log(ssh_session session,
607 int prioriry,
608 const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
609
610LIBSSH_API ssh_channel ssh_message_channel_request_open_reply_accept(ssh_message msg);
611LIBSSH_API int ssh_message_channel_request_open_reply_accept_channel(ssh_message msg, ssh_channel chan);
612LIBSSH_API int ssh_message_channel_request_reply_success(ssh_message msg);
613#define SSH_MESSAGE_FREE(x) \
614 do { if ((x) != NULL) { ssh_message_free(x); (x) = NULL; } } while(0)
615LIBSSH_API void ssh_message_free(ssh_message msg);
616LIBSSH_API ssh_message ssh_message_get(ssh_session session);
617LIBSSH_API int ssh_message_subtype(ssh_message msg);
618LIBSSH_API int ssh_message_type(ssh_message msg);
619LIBSSH_API int ssh_mkdir (const char *pathname, mode_t mode);
620LIBSSH_API ssh_session ssh_new(void);
621
622LIBSSH_API int ssh_options_copy(ssh_session src, ssh_session *dest);
623LIBSSH_API int ssh_options_getopt(ssh_session session, int *argcptr, char **argv);
624LIBSSH_API int ssh_options_parse_config(ssh_session session, const char *filename);
625LIBSSH_API int ssh_options_set(ssh_session session, enum ssh_options_e type,
626 const void *value);
627LIBSSH_API int ssh_options_get(ssh_session session, enum ssh_options_e type,
628 char **value);
629LIBSSH_API int ssh_options_get_port(ssh_session session, unsigned int * port_target);
630LIBSSH_API int ssh_pcap_file_close(ssh_pcap_file pcap);
631LIBSSH_API void ssh_pcap_file_free(ssh_pcap_file pcap);
632LIBSSH_API ssh_pcap_file ssh_pcap_file_new(void);
633LIBSSH_API int ssh_pcap_file_open(ssh_pcap_file pcap, const char *filename);
634
648typedef int (*ssh_auth_callback) (const char *prompt, char *buf, size_t len,
649 int echo, int verify, void *userdata);
650
651LIBSSH_API ssh_key ssh_key_new(void);
652#define SSH_KEY_FREE(x) \
653 do { if ((x) != NULL) { ssh_key_free(x); x = NULL; } } while(0)
654LIBSSH_API void ssh_key_free (ssh_key key);
655LIBSSH_API enum ssh_keytypes_e ssh_key_type(const ssh_key key);
656LIBSSH_API const char *ssh_key_type_to_char(enum ssh_keytypes_e type);
657LIBSSH_API enum ssh_keytypes_e ssh_key_type_from_name(const char *name);
658LIBSSH_API int ssh_key_is_public(const ssh_key k);
659LIBSSH_API int ssh_key_is_private(const ssh_key k);
660LIBSSH_API int ssh_key_cmp(const ssh_key k1,
661 const ssh_key k2,
662 enum ssh_keycmp_e what);
663
664LIBSSH_API int ssh_pki_generate(enum ssh_keytypes_e type, int parameter,
665 ssh_key *pkey);
666LIBSSH_API int ssh_pki_import_privkey_base64(const char *b64_key,
667 const char *passphrase,
668 ssh_auth_callback auth_fn,
669 void *auth_data,
670 ssh_key *pkey);
671LIBSSH_API int ssh_pki_export_privkey_base64(const ssh_key privkey,
672 const char *passphrase,
673 ssh_auth_callback auth_fn,
674 void *auth_data,
675 char **b64_key);
676LIBSSH_API int ssh_pki_import_privkey_file(const char *filename,
677 const char *passphrase,
678 ssh_auth_callback auth_fn,
679 void *auth_data,
680 ssh_key *pkey);
681LIBSSH_API int ssh_pki_export_privkey_file(const ssh_key privkey,
682 const char *passphrase,
683 ssh_auth_callback auth_fn,
684 void *auth_data,
685 const char *filename);
686
687LIBSSH_API int ssh_pki_copy_cert_to_privkey(const ssh_key cert_key,
688 ssh_key privkey);
689
690LIBSSH_API int ssh_pki_import_pubkey_base64(const char *b64_key,
691 enum ssh_keytypes_e type,
692 ssh_key *pkey);
693LIBSSH_API int ssh_pki_import_pubkey_file(const char *filename,
694 ssh_key *pkey);
695
696LIBSSH_API int ssh_pki_import_cert_base64(const char *b64_cert,
697 enum ssh_keytypes_e type,
698 ssh_key *pkey);
699LIBSSH_API int ssh_pki_import_cert_file(const char *filename,
700 ssh_key *pkey);
701
702LIBSSH_API int ssh_pki_export_privkey_to_pubkey(const ssh_key privkey,
703 ssh_key *pkey);
704LIBSSH_API int ssh_pki_export_pubkey_base64(const ssh_key key,
705 char **b64_key);
706LIBSSH_API int ssh_pki_export_pubkey_file(const ssh_key key,
707 const char *filename);
708
709LIBSSH_API const char *ssh_pki_key_ecdsa_name(const ssh_key key);
710
711LIBSSH_API char *ssh_get_fingerprint_hash(enum ssh_publickey_hash_type type,
712 unsigned char *hash,
713 size_t len);
714LIBSSH_API void ssh_print_hash(enum ssh_publickey_hash_type type, unsigned char *hash, size_t len);
715LIBSSH_API int ssh_send_ignore (ssh_session session, const char *data);
716LIBSSH_API int ssh_send_debug (ssh_session session, const char *message, int always_display);
717LIBSSH_API void ssh_gssapi_set_creds(ssh_session session, const ssh_gssapi_creds creds);
718LIBSSH_API int ssh_scp_accept_request(ssh_scp scp);
719LIBSSH_API int ssh_scp_close(ssh_scp scp);
720LIBSSH_API int ssh_scp_deny_request(ssh_scp scp, const char *reason);
721LIBSSH_API void ssh_scp_free(ssh_scp scp);
722LIBSSH_API int ssh_scp_init(ssh_scp scp);
723LIBSSH_API int ssh_scp_leave_directory(ssh_scp scp);
724LIBSSH_API ssh_scp ssh_scp_new(ssh_session session, int mode, const char *location);
725LIBSSH_API int ssh_scp_pull_request(ssh_scp scp);
726LIBSSH_API int ssh_scp_push_directory(ssh_scp scp, const char *dirname, int mode);
727LIBSSH_API int ssh_scp_push_file(ssh_scp scp, const char *filename, size_t size, int perms);
728LIBSSH_API int ssh_scp_push_file64(ssh_scp scp, const char *filename, uint64_t size, int perms);
729LIBSSH_API int ssh_scp_read(ssh_scp scp, void *buffer, size_t size);
730LIBSSH_API const char *ssh_scp_request_get_filename(ssh_scp scp);
731LIBSSH_API int ssh_scp_request_get_permissions(ssh_scp scp);
732LIBSSH_API size_t ssh_scp_request_get_size(ssh_scp scp);
733LIBSSH_API uint64_t ssh_scp_request_get_size64(ssh_scp scp);
734LIBSSH_API const char *ssh_scp_request_get_warning(ssh_scp scp);
735LIBSSH_API int ssh_scp_write(ssh_scp scp, const void *buffer, size_t len);
736LIBSSH_API int ssh_select(ssh_channel *channels, ssh_channel *outchannels, socket_t maxfd,
737 fd_set *readfds, struct timeval *timeout);
738LIBSSH_API int ssh_service_request(ssh_session session, const char *service);
739LIBSSH_API int ssh_set_agent_channel(ssh_session session, ssh_channel channel);
740LIBSSH_API int ssh_set_agent_socket(ssh_session session, socket_t fd);
741LIBSSH_API void ssh_set_blocking(ssh_session session, int blocking);
742LIBSSH_API void ssh_set_counters(ssh_session session, ssh_counter scounter,
743 ssh_counter rcounter);
744LIBSSH_API void ssh_set_fd_except(ssh_session session);
745LIBSSH_API void ssh_set_fd_toread(ssh_session session);
746LIBSSH_API void ssh_set_fd_towrite(ssh_session session);
747LIBSSH_API void ssh_silent_disconnect(ssh_session session);
748LIBSSH_API int ssh_set_pcap_file(ssh_session session, ssh_pcap_file pcapfile);
749
750/* USERAUTH */
751LIBSSH_API int ssh_userauth_none(ssh_session session, const char *username);
752LIBSSH_API int ssh_userauth_list(ssh_session session, const char *username);
753LIBSSH_API int ssh_userauth_try_publickey(ssh_session session,
754 const char *username,
755 const ssh_key pubkey);
756LIBSSH_API int ssh_userauth_publickey(ssh_session session,
757 const char *username,
758 const ssh_key privkey);
759#ifndef _WIN32
760LIBSSH_API int ssh_userauth_agent(ssh_session session,
761 const char *username);
762#endif
763LIBSSH_API int ssh_userauth_publickey_auto(ssh_session session,
764 const char *username,
765 const char *passphrase);
766LIBSSH_API int ssh_userauth_password(ssh_session session,
767 const char *username,
768 const char *password);
769
770LIBSSH_API int ssh_userauth_kbdint(ssh_session session, const char *user, const char *submethods);
771LIBSSH_API const char *ssh_userauth_kbdint_getinstruction(ssh_session session);
772LIBSSH_API const char *ssh_userauth_kbdint_getname(ssh_session session);
773LIBSSH_API int ssh_userauth_kbdint_getnprompts(ssh_session session);
774LIBSSH_API const char *ssh_userauth_kbdint_getprompt(ssh_session session, unsigned int i, char *echo);
775LIBSSH_API int ssh_userauth_kbdint_getnanswers(ssh_session session);
776LIBSSH_API const char *ssh_userauth_kbdint_getanswer(ssh_session session, unsigned int i);
777LIBSSH_API int ssh_userauth_kbdint_setanswer(ssh_session session, unsigned int i,
778 const char *answer);
779LIBSSH_API int ssh_userauth_gssapi(ssh_session session);
780LIBSSH_API const char *ssh_version(int req_version);
781
782LIBSSH_API void ssh_string_burn(ssh_string str);
784LIBSSH_API void *ssh_string_data(ssh_string str);
785LIBSSH_API int ssh_string_fill(ssh_string str, const void *data, size_t len);
786#define SSH_STRING_FREE(x) \
787 do { if ((x) != NULL) { ssh_string_free(x); x = NULL; } } while(0)
788LIBSSH_API void ssh_string_free(ssh_string str);
789LIBSSH_API ssh_string ssh_string_from_char(const char *what);
790LIBSSH_API size_t ssh_string_len(ssh_string str);
791LIBSSH_API ssh_string ssh_string_new(size_t size);
792LIBSSH_API const char *ssh_string_get_char(ssh_string str);
793LIBSSH_API char *ssh_string_to_char(ssh_string str);
794#define SSH_STRING_FREE_CHAR(x) \
795 do { if ((x) != NULL) { ssh_string_free_char(x); x = NULL; } } while(0)
796LIBSSH_API void ssh_string_free_char(char *s);
797
798LIBSSH_API int ssh_getpass(const char *prompt, char *buf, size_t len, int echo,
799 int verify);
800
801
802typedef int (*ssh_event_callback)(socket_t fd, int revents, void *userdata);
803
804LIBSSH_API ssh_event ssh_event_new(void);
805LIBSSH_API int ssh_event_add_fd(ssh_event event, socket_t fd, short events,
806 ssh_event_callback cb, void *userdata);
807LIBSSH_API int ssh_event_add_session(ssh_event event, ssh_session session);
808LIBSSH_API int ssh_event_add_connector(ssh_event event, ssh_connector connector);
809LIBSSH_API int ssh_event_dopoll(ssh_event event, int timeout);
810LIBSSH_API int ssh_event_remove_fd(ssh_event event, socket_t fd);
811LIBSSH_API int ssh_event_remove_session(ssh_event event, ssh_session session);
812LIBSSH_API int ssh_event_remove_connector(ssh_event event, ssh_connector connector);
813LIBSSH_API void ssh_event_free(ssh_event event);
814LIBSSH_API const char* ssh_get_clientbanner(ssh_session session);
815LIBSSH_API const char* ssh_get_serverbanner(ssh_session session);
816LIBSSH_API const char* ssh_get_kex_algo(ssh_session session);
817LIBSSH_API const char* ssh_get_cipher_in(ssh_session session);
818LIBSSH_API const char* ssh_get_cipher_out(ssh_session session);
819LIBSSH_API const char* ssh_get_hmac_in(ssh_session session);
820LIBSSH_API const char* ssh_get_hmac_out(ssh_session session);
821
822LIBSSH_API ssh_buffer ssh_buffer_new(void);
823LIBSSH_API void ssh_buffer_free(ssh_buffer buffer);
824#define SSH_BUFFER_FREE(x) \
825 do { if ((x) != NULL) { ssh_buffer_free(x); x = NULL; } } while(0)
826LIBSSH_API int ssh_buffer_reinit(ssh_buffer buffer);
827LIBSSH_API int ssh_buffer_add_data(ssh_buffer buffer, const void *data, uint32_t len);
828LIBSSH_API uint32_t ssh_buffer_get_data(ssh_buffer buffer, void *data, uint32_t requestedlen);
829LIBSSH_API void *ssh_buffer_get(ssh_buffer buffer);
830LIBSSH_API uint32_t ssh_buffer_get_len(ssh_buffer buffer);
831
832#ifndef LIBSSH_LEGACY_0_4
833#include "libssh/legacy.h"
834#endif
835
836#ifdef __cplusplus
837}
838#endif
839#endif /* _LIBSSH_H */
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:1771
LIBSSH_API int ssh_userauth_gssapi(ssh_session session)
Try to authenticate through the "gssapi-with-mic" method.
Definition: auth.c:1893
LIBSSH_API int ssh_userauth_list(ssh_session session, const char *username)
Get available authentication methods from the server.
Definition: auth.c:376
LIBSSH_API int ssh_userauth_password(ssh_session session, const char *username, const char *password)
Try to authenticate by password.
Definition: auth.c:1230
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:1007
LIBSSH_API int ssh_userauth_none(ssh_session session, const char *username)
Try to authenticate through the "none" method.
Definition: auth.c:406
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:489
LIBSSH_API const char * ssh_userauth_kbdint_getname(ssh_session session)
Get the "name" of the message block.
Definition: auth.c:1713
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:1648
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:1846
LIBSSH_API int ssh_userauth_agent(ssh_session session, const char *username)
Try to do public key authentication with ssh agent.
Definition: auth.c:872
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:609
LIBSSH_API int ssh_userauth_kbdint_getnprompts(ssh_session session)
Get the number of prompts (questions) the server has given.
Definition: auth.c:1691
LIBSSH_API const char * ssh_userauth_kbdint_getinstruction(ssh_session session)
Get the "instruction" of the message block.
Definition: auth.c:1736
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:676
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
void ssh_buffer_free(struct ssh_buffer_struct *buffer)
Deallocate a SSH buffer.
Definition: buffer.c:149
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:594
LIBSSH_API ssh_buffer ssh_buffer_new(void)
Create a new SSH buffer.
Definition: buffer.c:119
uint32_t ssh_buffer_get_len(struct ssh_buffer_struct *buffer)
Get the length of the buffer from the current position.
Definition: buffer.c:607
int ssh_buffer_reinit(struct ssh_buffer_struct *buffer)
Reinitialize a SSH buffer.
Definition: buffer.c:259
LIBSSH_API int ssh_channel_request_subsystem(ssh_channel channel, const char *subsystem)
Request a subsystem (for example "sftp").
Definition: channels.c:1941
LIBSSH_API int ssh_channel_send_eof(ssh_channel channel)
Send an end of file on the channel.
Definition: channels.c:1224
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:3279
LIBSSH_API int ssh_channel_poll(ssh_channel channel, int is_stderr)
Polls a channel for data to read.
Definition: channels.c:3038
LIBSSH_API void ssh_channel_set_blocking(ssh_channel channel, int blocking)
Put the channel into blocking or nonblocking mode.
Definition: channels.c:1621
LIBSSH_API int ssh_channel_close(ssh_channel channel)
Close a channel.
Definition: channels.c:1285
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:2863
LIBSSH_API int ssh_channel_request_pty(ssh_channel channel)
Request a PTY.
Definition: channels.c:1861
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:2447
LIBSSH_API int ssh_channel_request_sftp(ssh_channel channel)
Request sftp subsystem on the channel.
Definition: channels.c:1990
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:2428
LIBSSH_API ssh_channel ssh_channel_accept_x11(ssh_channel channel, int timeout_ms)
Accept an X11 forwarding channel.
Definition: channels.c:2158
LIBSSH_API int ssh_channel_request_exec(ssh_channel channel, const char *cmd)
Run a shell command without an interactive shell.
Definition: channels.c:2568
LIBSSH_API int ssh_channel_write(ssh_channel channel, const void *data, uint32_t len)
Blocking write on a channel.
Definition: channels.c:1553
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:947
LIBSSH_API ssh_session ssh_channel_get_session(ssh_channel channel)
Recover the session in which belongs a channel.
Definition: channels.c:3139
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:2365
LIBSSH_API int ssh_channel_request_env(ssh_channel channel, const char *name, const char *value)
Set environment variables.
Definition: channels.c:2498
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:3433
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:1057
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:3175
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:2638
LIBSSH_API int ssh_channel_is_open(ssh_channel channel)
Check if the channel is open or not.
Definition: channels.c:1566
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:2983
LIBSSH_API void ssh_channel_set_counter(ssh_channel channel, ssh_counter counter)
Set the channel data counter.
Definition: channels.c:3413
LIBSSH_API int ssh_channel_is_closed(ssh_channel channel)
Check if the channel is closed or not.
Definition: channels.c:1582
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:2173
LIBSSH_API int ssh_channel_is_eof(ssh_channel channel)
Check if remote has sent an EOF.
Definition: channels.c:1596
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:3090
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:1798
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:2831
LIBSSH_API void ssh_channel_free(ssh_channel channel)
Close and free a channel.
Definition: channels.c:1123
LIBSSH_API ssh_channel ssh_channel_new(ssh_session session)
Allocate a new channel.
Definition: channels.c:80
LIBSSH_API uint32_t ssh_channel_window_size(ssh_channel channel)
Get the remote window size.
Definition: channels.c:1536
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:2042
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:985
LIBSSH_API int ssh_channel_request_shell(ssh_channel channel)
Request a shell.
Definition: channels.c:1919
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:2684
LIBSSH_API int ssh_channel_open_session(ssh_channel channel)
Open a session channel (suited for a shell, not TCP forwarding).
Definition: channels.c:920
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:1880
LIBSSH_API int ssh_get_error_code(void *error)
Retrieve the error code from the last error.
Definition: error.c:148
LIBSSH_API const char * ssh_get_error(void *error)
Retrieve the error text message from the last error.
Definition: error.c:128
LIBSSH_API int ssh_set_log_userdata(void *data)
Set the userdata for the logging function.
Definition: log.c:235
LIBSSH_API void * ssh_get_log_userdata(void)
Get the userdata of the logging function.
Definition: log.c:219
LIBSSH_API int ssh_set_log_level(int level)
Set the log level of the library.
Definition: log.c:181
LIBSSH_API int ssh_get_log_level(void)
Get the log level of the library.
Definition: log.c:196
@ SSH_LOG_WARNING
Definition: libssh.h:342
@ SSH_LOG_PACKET
Definition: libssh.h:348
@ SSH_LOG_PROTOCOL
Definition: libssh.h:345
@ SSH_LOG_FUNCTIONS
Definition: libssh.h:351
@ SSH_LOG_NOLOG
Definition: libssh.h:339
LIBSSH_API int ssh_message_type(ssh_message msg)
Get the type of the message.
Definition: messages.c:543
LIBSSH_API int ssh_message_subtype(ssh_message msg)
Get the subtype of the message.
Definition: messages.c:558
LIBSSH_API ssh_message ssh_message_get(ssh_session session)
Retrieve a SSH message from a SSH session.
Definition: messages.c:516
LIBSSH_API void ssh_message_free(ssh_message msg)
Free a SSH message.
Definition: messages.c:582
LIBSSH_API char * ssh_dirname(const char *path)
Parse directory component.
Definition: misc.c:847
SSH_DEPRECATED LIBSSH_API void ssh_print_hexa(const char *descr, const unsigned char *what, size_t len)
Definition: misc.c:431
LIBSSH_API int ssh_mkdir(const char *pathname, mode_t mode)
Attempts to create a directory with the given pathname.
Definition: misc.c:953
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:403
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 const char * ssh_version(int req_version)
Check if libssh is the required version or get the version string.
Definition: misc.c:652
LIBSSH_API char * ssh_basename(const char *path)
basename - parse filename component.
Definition: misc.c:902
LIBSSH_API void ssh_key_free(ssh_key key)
deallocate a SSH key
Definition: pki.c:193
LIBSSH_API int ssh_key_is_private(const ssh_key k)
Check if the key is a private key.
Definition: pki.c:600
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:101
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:850
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:1916
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:791
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:944
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:512
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:619
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:1848
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:730
LIBSSH_API const char * ssh_key_type_to_char(enum ssh_keytypes_e type)
Convert a key type to a string.
Definition: pki.c:271
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:2009
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:1699
LIBSSH_API int ssh_pki_import_cert_file(const char *filename, ssh_key *pkey)
Import a certificate from the given filename.
Definition: pki.c:1738
LIBSSH_API int ssh_key_is_public(const ssh_key k)
Check if the key has/is a public key.
Definition: pki.c:585
LIBSSH_API enum ssh_keytypes_e ssh_key_type(const ssh_key key)
returns the type of a ssh key
Definition: pki.c:211
LIBSSH_API ssh_key ssh_key_new(void)
creates a new empty SSH key
Definition: pki.c:118
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:1470
LIBSSH_API int ssh_pki_generate(enum ssh_keytypes_e type, int parameter, ssh_key *pkey)
Generates a keypair.
Definition: pki.c:1758
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:1584
LIBSSH_API void ssh_event_free(ssh_event event)
Free an event context.
Definition: poll.c:1089
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:760
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:815
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:884
LIBSSH_API int ssh_event_remove_session(ssh_event event, ssh_session session)
Remove a session object from an event context.
Definition: poll.c:1022
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:957
LIBSSH_API int ssh_event_remove_connector(ssh_event event, ssh_connector connector)
Remove a connector from an event context.
Definition: poll.c:1076
LIBSSH_API int ssh_event_add_connector(ssh_event event, ssh_connector connector)
Add a connector to the SSH event loop.
Definition: poll.c:936
LIBSSH_API int ssh_event_remove_fd(ssh_event event, socket_t fd)
Remove a socket fd from an event context.
Definition: poll.c:976
LIBSSH_API int ssh_scp_read(ssh_scp scp, void *buffer, size_t size)
Read from a remote scp file.
Definition: scp.c:956
LIBSSH_API int ssh_scp_write(ssh_scp scp, const void *buffer, size_t len)
Write into a remote scp file.
Definition: scp.c:642
LIBSSH_API int ssh_scp_close(ssh_scp scp)
Close the scp channel.
Definition: scp.c:241
LIBSSH_API int ssh_scp_init(ssh_scp scp)
Initialize the scp channel.
Definition: scp.c:119
LIBSSH_API int ssh_scp_leave_directory(ssh_scp scp)
Leave a directory.
Definition: scp.c:409
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:1038
LIBSSH_API const char * ssh_scp_request_get_warning(ssh_scp scp)
Get the warning string from a scp handle.
Definition: scp.c:1110
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:456
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:557
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:1023
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:1054
LIBSSH_API ssh_scp ssh_scp_new(ssh_session session, int mode, const char *location)
Create a new scp session.
Definition: scp.c:61
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:320
LIBSSH_API int ssh_scp_pull_request(ssh_scp scp)
Wait for a scp request (file, directory).
Definition: scp.c:770
LIBSSH_API void ssh_scp_free(ssh_scp scp)
Free a scp context.
Definition: scp.c:286
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:882
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:918
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:1066
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:419
LIBSSH_API int ssh_connect(ssh_session session)
Connect to the ssh server.
Definition: client.c:507
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:606
LIBSSH_API void ssh_clean_pubkey_hash(unsigned char **hash)
Deallocate the hash obtained by ssh_get_pubkey_hash.
Definition: session.c:1046
LIBSSH_API const char * ssh_get_disconnect_message(ssh_session session)
Get the disconnect message from the server.
Definition: session.c:810
LIBSSH_API int ssh_is_blocking(ssh_session session)
Return the blocking mode of libssh.
Definition: session.c:497
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:580
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:672
LIBSSH_API const char * ssh_get_serverbanner(ssh_session session)
get the server banner
Definition: session.c:350
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:435
LIBSSH_API char * ssh_get_issue_banner(ssh_session session)
Get the issue banner from the server.
Definition: client.c:632
LIBSSH_API void ssh_set_blocking(ssh_session session, int blocking)
Set the session in blocking/nonblocking mode.
Definition: session.c:482
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:716
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:593
LIBSSH_API int ssh_is_connected(ssh_session session)
Check if we are connected.
Definition: session.c:548
LIBSSH_API const char * ssh_get_kex_algo(ssh_session session)
get the name of the current key exchange algorithm.
Definition: session.c:364
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:892
LIBSSH_API int ssh_get_server_publickey(ssh_session session, ssh_key *key)
Get the server public key from a session.
Definition: session.c:1062
SSH_DEPRECATED LIBSSH_API char * ssh_dump_knownhost(ssh_session session)
This function is deprecated.
Definition: known_hosts.c:430
LIBSSH_API int ssh_send_debug(ssh_session session, const char *message, int always_display)
Send a debug message.
Definition: session.c:905
LIBSSH_API int ssh_blocking_flush(ssh_session session, int timeout)
Blocking flush of the outgoing buffer.
Definition: session.c:523
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:403
LIBSSH_API const char * ssh_get_clientbanner(ssh_session session)
get the client banner
Definition: session.c:335
SSH_DEPRECATED LIBSSH_API int ssh_is_server_known(ssh_session session)
This function is deprecated.
Definition: known_hosts.c:288
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:1117
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:474
LIBSSH_API int ssh_options_parse_config(ssh_session session, const char *filename)
Parse the ssh config file.
Definition: options.c:1376
SSH_DEPRECATED LIBSSH_API int ssh_get_publickey(ssh_session session, ssh_key *key)
Definition: session.c:1084
LIBSSH_API int ssh_get_version(ssh_session session)
Get the protocol version of the session.
Definition: session.c:835
LIBSSH_API void ssh_set_counters(ssh_session session, ssh_counter scounter, ssh_counter rcounter)
Set the session data counters.
Definition: session.c:961
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:316
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:1130
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:788
LIBSSH_API int ssh_options_getopt(ssh_session session, int *argcptr, char **argv)
Parse command line arguments.
Definition: options.c:1194
LIBSSH_API int ssh_session_update_known_hosts(ssh_session session)
Add the current connected server to the user known_hosts file.
Definition: knownhosts.c:965
LIBSSH_API void ssh_knownhosts_entry_free(struct ssh_knownhosts_entry *entry)
Free an allocated ssh_knownhosts_entry.
Definition: knownhosts.c:145
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:1056
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:612
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:1114
LIBSSH_API ssh_session ssh_new(void)
Create a new ssh session.
Definition: session.c:59
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:450
LIBSSH_API int ssh_send_ignore(ssh_session session, const char *data)
Send a message that should be ignored.
Definition: session.c:870
LIBSSH_API int ssh_get_status(ssh_session session)
Get session status.
Definition: session.c:752
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:658
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:1255
LIBSSH_API void ssh_silent_disconnect(ssh_session session)
Disconnect impolitely from a remote host by closing the socket.
Definition: session.c:465
LIBSSH_API void ssh_free(ssh_session session)
Deallocate a SSH session handle.
Definition: session.c:191
LIBSSH_API int ssh_get_poll_flags(ssh_session session)
Get poll flags for an external mainloop.
Definition: session.c:790
LIBSSH_API int ssh_options_copy(ssh_session src, ssh_session *dest)
Duplicate the options of a session structure.
Definition: options.c:65
SSH_DEPRECATED LIBSSH_API int ssh_write_knownhost(ssh_session session)
This function is deprecated.
Definition: known_hosts.c:499
SSH_DEPRECATED LIBSSH_API int ssh_get_pubkey_hash(ssh_session session, unsigned char **hash)
Definition: session.c:972
LIBSSH_API socket_t ssh_get_fd(ssh_session session)
Get the fd of a connection.
Definition: session.c:566
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:777
char * ssh_string_to_char(struct ssh_string_struct *s)
Convert a SSH string to a C nul-terminated string.
Definition: string.c:181
size_t ssh_string_len(struct ssh_string_struct *s)
Return the size of a SSH string.
Definition: string.c:136
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 ssh_string ssh_string_new(size_t size)
Create a new SSH String object.
Definition: string.c:56
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
void * ssh_string_data(struct ssh_string_struct *s)
Get the payload of the string.
Definition: string.c:264
void ssh_string_burn(struct ssh_string_struct *s)
Destroy the data in a string so it couldn't appear in a core dump.
Definition: string.c:249
void ssh_string_free(struct ssh_string_struct *s)
Deallocate a SSH string object.
Definition: string.c:277
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
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
LIBSSH_API void ssh_string_free_char(char *s)
Deallocate a char string object.
Definition: string.c:209
LIBSSH_API int ssh_init(void)
Initialize global cryptographic data structures.
Definition: init.c:148
LIBSSH_API int ssh_finalize(void)
Finalize and cleanup all libssh and cryptographic data structures.
Definition: init.c:221
Definition: agent.h:73
Definition: buffer.c:47
Definition: channels.h:62
Definition: connector.c:52
Definition: libssh.h:108
Definition: poll.c:745
Definition: pki.h:50
Definition: libssh.h:316
Definition: messages.h:84
Definition: scp.h:35
Definition: messages.h:46
Definition: session.h:109
Definition: string.h:29