| /* Copyright (c) 2004, Sara Golemon <sarag@libssh2.org> |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, |
| * with or without modification, are permitted provided |
| * that the following conditions are met: |
| * |
| * Redistributions of source code must retain the above |
| * copyright notice, this list of conditions and the |
| * following disclaimer. |
| * |
| * Redistributions in binary form must reproduce the above |
| * copyright notice, this list of conditions and the following |
| * disclaimer in the documentation and/or other materials |
| * provided with the distribution. |
| * |
| * Neither the name of the copyright holder nor the names |
| * of any other contributors may be used to endorse or |
| * promote products derived from this software without |
| * specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
| * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
| * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
| * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
| * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
| * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE |
| * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
| * OF SUCH DAMAGE. |
| */ |
| |
| #ifndef LIBSSH2_H |
| #define LIBSSH2_H 1 |
| |
| #include <stddef.h> |
| #include <string.h> |
| #include <sys/stat.h> |
| |
| /* Allow alternate API prefix from CFLAGS or calling app */ |
| #ifndef LIBSSH2_API |
| #ifdef LIBSSH2_WIN32 |
| # ifdef LIBSSH2_LIBRARY |
| # define LIBSSH2_API __declspec(dllexport) |
| # else |
| # define LIBSSH2_API __declspec(dllimport) |
| # endif |
| # ifndef _MSC_VER |
| # include <sys/uio.h> |
| # endif |
| #else |
| # define LIBSSH2_API |
| #endif |
| #endif |
| |
| #if defined(LIBSSH2_WIN32) && _MSC_VER < 1300 |
| typedef unsigned __int64 libssh2_uint64_t; |
| typedef __int64 libssh2_int64_t; |
| #else |
| typedef unsigned long long libssh2_uint64_t; |
| typedef long long libssh2_int64_t; |
| #endif |
| |
| #define LIBSSH2_VERSION "0.6" |
| #define LIBSSH2_APINO 200502091118 |
| |
| /* Part of every banner, user specified or not */ |
| #define LIBSSH2_SSH_BANNER "SSH-2.0-libssh2_" LIBSSH2_VERSION |
| |
| /* We *could* add a comment here if we so chose */ |
| #define LIBSSH2_SSH_DEFAULT_BANNER LIBSSH2_SSH_BANNER |
| #define LIBSSH2_SSH_DEFAULT_BANNER_WITH_CRLF LIBSSH2_SSH_DEFAULT_BANNER "\r\n" |
| |
| /* Default generate and safe prime sizes for diffie-hellman-group-exchange-sha1 */ |
| #define LIBSSH2_DH_GEX_MINGROUP 1024 |
| #define LIBSSH2_DH_GEX_OPTGROUP 1536 |
| #define LIBSSH2_DH_GEX_MAXGROUP 2048 |
| |
| /* Defaults for pty requests */ |
| #define LIBSSH2_TERM_WIDTH 80 |
| #define LIBSSH2_TERM_HEIGHT 24 |
| #define LIBSSH2_TERM_WIDTH_PX 0 |
| #define LIBSSH2_TERM_HEIGHT_PX 0 |
| |
| /* 1/4 second */ |
| #define LIBSSH2_SOCKET_POLL_UDELAY 250000 |
| /* 0.25 * 120 == 30 seconds */ |
| #define LIBSSH2_SOCKET_POLL_MAXLOOPS 120 |
| |
| /* Maximum size to allow a payload to compress to, plays it safe by falling short of spec limits */ |
| #define LIBSSH2_PACKET_MAXCOMP 32000 |
| |
| /* Maximum size to allow a payload to deccompress to, plays it safe by allowing more than spec requires */ |
| #define LIBSSH2_PACKET_MAXDECOMP 40000 |
| |
| /* Maximum size for an inbound compressed payload, plays it safe by overshooting spec limits */ |
| #define LIBSSH2_PACKET_MAXPAYLOAD 40000 |
| |
| /* Malloc callbacks */ |
| #define LIBSSH2_ALLOC_FUNC(name) void *name(size_t count, void **abstract) |
| #define LIBSSH2_REALLOC_FUNC(name) void *name(void *ptr, size_t count, void **abstract) |
| #define LIBSSH2_FREE_FUNC(name) void name(void *ptr, void **abstract) |
| |
| /* Callbacks for special SSH packets */ |
| #define LIBSSH2_IGNORE_FUNC(name) void name(LIBSSH2_SESSION *session, const char *message, int message_len, void **abstract) |
| #define LIBSSH2_DEBUG_FUNC(name) void name(LIBSSH2_SESSION *session, int always_display, const char *message, int message_len, const char *language, int language_len,void **abstract) |
| #define LIBSSH2_DISCONNECT_FUNC(name) void name(LIBSSH2_SESSION *session, int reason, const char *message, int message_len, const char *language, int language_len, void **abstract) |
| #define LIBSSH2_PASSWD_CHANGEREQ_FUNC(name) void name(LIBSSH2_SESSION *session, char **newpw, int *newpw_len, void **abstract) |
| #define LIBSSH2_MACERROR_FUNC(name) int name(LIBSSH2_SESSION *session, const char *packet, int packet_len, void **abstract) |
| #define LIBSSH2_X11_OPEN_FUNC(name) void name(LIBSSH2_SESSION *session, LIBSSH2_CHANNEL *channel, char *shost, int sport, void **abstract) |
| |
| #define LIBSSH2_CHANNEL_CLOSE_FUNC(name) void name(LIBSSH2_SESSION *session, void **session_abstract, LIBSSH2_CHANNEL *channel, void **channel_abstract) |
| |
| /* libssh2_session_callback_set() constants */ |
| #define LIBSSH2_CALLBACK_IGNORE 0 |
| #define LIBSSH2_CALLBACK_DEBUG 1 |
| #define LIBSSH2_CALLBACK_DISCONNECT 2 |
| #define LIBSSH2_CALLBACK_MACERROR 3 |
| #define LIBSSH2_CALLBACK_X11 4 |
| |
| /* libssh2_session_method_pref() constants */ |
| #define LIBSSH2_METHOD_KEX 0 |
| #define LIBSSH2_METHOD_HOSTKEY 1 |
| #define LIBSSH2_METHOD_CRYPT_CS 2 |
| #define LIBSSH2_METHOD_CRYPT_SC 3 |
| #define LIBSSH2_METHOD_MAC_CS 4 |
| #define LIBSSH2_METHOD_MAC_SC 5 |
| #define LIBSSH2_METHOD_COMP_CS 6 |
| #define LIBSSH2_METHOD_COMP_SC 7 |
| #define LIBSSH2_METHOD_LANG_CS 8 |
| #define LIBSSH2_METHOD_LANG_SC 9 |
| |
| /* session.flags bits */ |
| #define LIBSSH2_FLAG_SIGPIPE 0x00000001 |
| |
| typedef struct _LIBSSH2_SESSION LIBSSH2_SESSION; |
| typedef struct _LIBSSH2_CHANNEL LIBSSH2_CHANNEL; |
| typedef struct _LIBSSH2_LISTENER LIBSSH2_LISTENER; |
| |
| #define LIBSSH2_HOSTKEY_HASH_MD5 1 |
| #define LIBSSH2_HOSTKEY_HASH_SHA1 2 |
| |
| /* Disconnect Codes (defined by SSH protocol) */ |
| #define SSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT 1 |
| #define SSH_DISCONNECT_PROTOCOL_ERROR 2 |
| #define SSH_DISCONNECT_KEY_EXCHANGE_FAILED 3 |
| #define SSH_DISCONNECT_RESERVED 4 |
| #define SSH_DISCONNECT_MAC_ERROR 5 |
| #define SSH_DISCONNECT_COMPRESSION_ERROR 6 |
| #define SSH_DISCONNECT_SERVICE_NOT_AVAILABLE 7 |
| #define SSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED 8 |
| #define SSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE 9 |
| #define SSH_DISCONNECT_CONNECTION_LOST 10 |
| #define SSH_DISCONNECT_BY_APPLICATION 11 |
| #define SSH_DISCONNECT_TOO_MANY_CONNECTIONS 12 |
| #define SSH_DISCONNECT_AUTH_CANCELLED_BY_USER 13 |
| #define SSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE 14 |
| #define SSH_DISCONNECT_ILLEGAL_USER_NAME 15 |
| |
| /* Error Codes (defined by libssh2) */ |
| #define LIBSSH2_ERROR_SOCKET_NONE -1 |
| #define LIBSSH2_ERROR_BANNER_NONE -2 |
| #define LIBSSH2_ERROR_BANNER_SEND -3 |
| #define LIBSSH2_ERROR_INVALID_MAC -4 |
| #define LIBSSH2_ERROR_KEX_FAILURE -5 |
| #define LIBSSH2_ERROR_ALLOC -6 |
| #define LIBSSH2_ERROR_SOCKET_SEND -7 |
| #define LIBSSH2_ERROR_KEY_EXCHANGE_FAILURE -8 |
| #define LIBSSH2_ERROR_TIMEOUT -9 |
| #define LIBSSH2_ERROR_HOSTKEY_INIT -10 |
| #define LIBSSH2_ERROR_HOSTKEY_SIGN -11 |
| #define LIBSSH2_ERROR_DECRYPT -12 |
| #define LIBSSH2_ERROR_SOCKET_DISCONNECT -13 |
| #define LIBSSH2_ERROR_PROTO -14 |
| #define LIBSSH2_ERROR_PASSWORD_EXPIRED -15 |
| #define LIBSSH2_ERROR_FILE -16 |
| #define LIBSSH2_ERROR_METHOD_NONE -17 |
| #define LIBSSH2_ERROR_PUBLICKEY_UNRECOGNIZED -18 |
| #define LIBSSH2_ERROR_PUBLICKEY_UNVERIFIED -19 |
| #define LIBSSH2_ERROR_CHANNEL_OUTOFORDER -20 |
| #define LIBSSH2_ERROR_CHANNEL_FAILURE -21 |
| #define LIBSSH2_ERROR_CHANNEL_REQUEST_DENIED -22 |
| #define LIBSSH2_ERROR_CHANNEL_UNKNOWN -23 |
| #define LIBSSH2_ERROR_CHANNEL_WINDOW_EXCEEDED -24 |
| #define LIBSSH2_ERROR_CHANNEL_PACKET_EXCEEDED -25 |
| #define LIBSSH2_ERROR_CHANNEL_CLOSED -26 |
| #define LIBSSH2_ERROR_CHANNEL_EOF_SENT -27 |
| #define LIBSSH2_ERROR_SCP_PROTOCOL -28 |
| #define LIBSSH2_ERROR_ZLIB -29 |
| #define LIBSSH2_ERROR_SOCKET_TIMEOUT -30 |
| #define LIBSSH2_ERROR_SFTP_PROTOCOL -31 |
| #define LIBSSH2_ERROR_REQUEST_DENIED -32 |
| #define LIBSSH2_ERROR_METHOD_NOT_SUPPORTED -33 |
| #define LIBSSH2_ERROR_INVAL -34 |
| |
| /* Session API */ |
| LIBSSH2_API LIBSSH2_SESSION *libssh2_session_init_ex(LIBSSH2_ALLOC_FUNC((*my_alloc)), LIBSSH2_FREE_FUNC((*my_free)), LIBSSH2_REALLOC_FUNC((*my_realloc)), void *abstract); |
| #define libssh2_session_init() libssh2_session_init_ex(NULL, NULL, NULL, NULL) |
| LIBSSH2_API void **libssh2_session_abstract(LIBSSH2_SESSION *session); |
| |
| LIBSSH2_API void *libssh2_session_callback_set(LIBSSH2_SESSION *session, int cbtype, void *callback); |
| LIBSSH2_API int libssh2_banner_set(LIBSSH2_SESSION *session, char *banner); |
| |
| LIBSSH2_API int libssh2_session_startup(LIBSSH2_SESSION *session, int socket); |
| LIBSSH2_API int libssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason, char *description, char *lang); |
| #define libssh2_session_disconnect(session, description) libssh2_session_disconnect_ex((session), SSH_DISCONNECT_BY_APPLICATION, (description), "") |
| LIBSSH2_API void libssh2_session_free(LIBSSH2_SESSION *session); |
| |
| LIBSSH2_API char *libssh2_hostkey_hash(LIBSSH2_SESSION *session, int hash_type); |
| |
| LIBSSH2_API int libssh2_session_method_pref(LIBSSH2_SESSION *session, int method_type, char *prefs); |
| LIBSSH2_API char *libssh2_session_methods(LIBSSH2_SESSION *session, int method_type); |
| LIBSSH2_API int libssh2_session_last_error(LIBSSH2_SESSION *session, char **errmsg, int *errmsg_len, int want_buf); |
| |
| LIBSSH2_API int libssh2_session_flag(LIBSSH2_SESSION *session, int flag, int value); |
| |
| /* Userauth API */ |
| LIBSSH2_API char *libssh2_userauth_list(LIBSSH2_SESSION *session, char *username, int username_len); |
| LIBSSH2_API int libssh2_userauth_authenticated(LIBSSH2_SESSION *session); |
| LIBSSH2_API int libssh2_userauth_password_ex(LIBSSH2_SESSION *session, char *username, int username_len, char *password, int password_len, LIBSSH2_PASSWD_CHANGEREQ_FUNC((*passwd_change_cb))); |
| #define libssh2_userauth_password(session, username, password) libssh2_userauth_password_ex((session), (username), strlen(username), (password), strlen(password), NULL) |
| |
| LIBSSH2_API int libssh2_userauth_publickey_fromfile_ex(LIBSSH2_SESSION *session, char *username, int username_len, |
| char *publickey, char *privatekey, |
| char *passphrase); |
| #define libssh2_userauth_publickey_fromfile(session, username, publickey, privatekey, passphrase) \ |
| libssh2_userauth_publickey_fromfile_ex((session), (username), strlen(username), (publickey), (privatekey), (passphrase)) |
| |
| /* Channel API */ |
| #define LIBSSH2_CHANNEL_WINDOW_DEFAULT 65536 |
| #define LIBSSH2_CHANNEL_PACKET_DEFAULT 16384 |
| |
| /* Extended Data Handling */ |
| #define LIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL 0 |
| #define LIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE 1 |
| #define LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE 2 |
| |
| #define SSH_EXTENDED_DATA_STDERR 1 |
| |
| LIBSSH2_API LIBSSH2_CHANNEL *libssh2_channel_open_ex(LIBSSH2_SESSION *session, char *channel_type, int channel_type_len, int window_size, int packet_size, char *message, int message_len); |
| #define libssh2_channel_open_session(session) libssh2_channel_open_ex((session), "session", sizeof("session") - 1, LIBSSH2_CHANNEL_WINDOW_DEFAULT, LIBSSH2_CHANNEL_PACKET_DEFAULT, NULL, 0) |
| |
| LIBSSH2_API LIBSSH2_CHANNEL *libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session, char *host, int port, char *shost, int sport); |
| #define libssh2_channel_direct_tcpip(session, host, port) libssh2_channel_direct_tcpip_ex((session), (host), (port), "127.0.0.1", 22) |
| |
| LIBSSH2_API LIBSSH2_LISTENER *libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session, char *host, int port, int *bound_port, int queue_maxsize); |
| #define libssh2_channel_forward_listen(session, port) libssh2_channel_forward_listen_ex((session), NULL, (port), NULL, 16) |
| |
| LIBSSH2_API int libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener); |
| |
| LIBSSH2_API LIBSSH2_CHANNEL *libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener); |
| |
| LIBSSH2_API int libssh2_channel_setenv_ex(LIBSSH2_CHANNEL *channel, char *varname, int varname_len, char *value, int value_len); |
| #define libssh2_channel_setenv(channel, varname, value) libssh2_channel_setenv_ex((channel), (varname), strlen(varname), (value), strlen(value)) |
| |
| LIBSSH2_API int libssh2_channel_request_pty_ex(LIBSSH2_CHANNEL *channel, char *term, int term_len, char *modes, int modes_len, int width, int height, int width_px, int height_px); |
| #define libssh2_channel_request_pty(channel, term) libssh2_channel_request_pty_ex((channel), (term), strlen(term), NULL, 0, LIBSSH2_TERM_WIDTH, LIBSSH2_TERM_HEIGHT, LIBSSH2_TERM_WIDTH_PX, LIBSSH2_TERM_HEIGHT_PX) |
| |
| LIBSSH2_API int libssh2_channel_x11_req_ex(LIBSSH2_CHANNEL *channel, int single_connection, char *auth_proto, char *auth_cookie, int screen_number); |
| #define libssh2_channel_x11_req(channel, screen_number) libssh2_channel_x11_req_ex((channel), 0, NULL, NULL, (screen_number)) |
| |
| LIBSSH2_API int libssh2_channel_process_startup(LIBSSH2_CHANNEL *channel, char *request, int request_len, char *message, int message_len); |
| #define libssh2_channel_shell(channel) libssh2_channel_process_startup((channel), "shell", sizeof("shell") - 1, NULL, 0) |
| #define libssh2_channel_exec(channel, command) libssh2_channel_process_startup((channel), "exec", sizeof("exec") - 1, (command), strlen(command)) |
| #define libssh2_channel_subsystem(channel, subsystem) libssh2_channel_process_startup((channel), "subsystem", sizeof("subsystem") - 1, (subsystem), strlen(subsystem)) |
| |
| LIBSSH2_API int libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel, int stream_id, char *buf, size_t buflen); |
| #define libssh2_channel_read(channel, buf, buflen) libssh2_channel_read_ex((channel), 0, (buf), (buflen)) |
| #define libssh2_channel_read_stderr(channel, buf, buflen) libssh2_channel_read_ex((channel), SSH_EXTENDED_DATA_STDERR, (buf), (buflen)) |
| |
| LIBSSH2_API int libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel, int stream_id, const char *buf, size_t buflen); |
| #define libssh2_channel_write(channel, buf, buflen) libssh2_channel_write_ex((channel), 0, (buf), (buflen)) |
| #define libssh2_channel_write_stderr(channel, buf, buflen) libssh2_channel_write_ex((channel), SSH_EXTENDED_DATA_STDERR, (buf), (buflen)) |
| |
| LIBSSH2_API void libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking); |
| LIBSSH2_API void libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel, int ignore_mode); |
| /* libssh2_channel_ignore_extended_data() is defined below for BC with version 0.1 |
| * Future uses should use libssh2_channel_handle_extended_data() directly |
| * if LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE is passed, extended data will be read (FIFO) from the standard data channel |
| */ |
| /* DEPRECATED */ |
| #define libssh2_channel_ignore_extended_data(channel, ignore) libssh2_channel_handle_extended_data((channel), (ignore) ? LIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE : LIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL ) |
| |
| #define LIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA -1 |
| #define LIBSSH2_CHANNEL_FLUSH_ALL -2 |
| LIBSSH2_API int libssh2_channel_flush_ex(LIBSSH2_CHANNEL *channel, int streamid); |
| #define libssh2_channel_flush(channel) libssh2_channel_flush_ex((channel), 0) |
| #define libssh2_channel_flush_stderr(channel) libssh2_channel_flush_ex((channel), SSH_EXTENDED_DATA_STDERR) |
| |
| LIBSSH2_API int libssh2_channel_send_eof(LIBSSH2_CHANNEL *channel); |
| LIBSSH2_API int libssh2_channel_eof(LIBSSH2_CHANNEL *channel); |
| LIBSSH2_API int libssh2_channel_close(LIBSSH2_CHANNEL *channel); |
| LIBSSH2_API int libssh2_channel_free(LIBSSH2_CHANNEL *channel); |
| |
| LIBSSH2_API LIBSSH2_CHANNEL *libssh2_scp_recv(LIBSSH2_SESSION *session, char *path, struct stat *sb); |
| LIBSSH2_API LIBSSH2_CHANNEL *libssh2_scp_send_ex(LIBSSH2_SESSION *session, char *path, int mode, size_t size, long mtime, long atime); |
| #define libssh2_scp_send(session, path, mode, size) libssh2_scp_send_ex((session), (path), (mode), (size), 0, 0) |
| |
| LIBSSH2_API int libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest, int *dest_len, char *src, int src_len); |
| |
| #endif /* LIBSSH2_H */ |