2007-01-22 21:40:44 +00:00
|
|
|
/* Copyright (c) 2004-2007, Sara Golemon <sarag@libssh2.org>
|
2004-12-07 21:17:20 +00:00
|
|
|
* 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_PRIV_H
|
|
|
|
#define LIBSSH2_PRIV_H 1
|
|
|
|
|
2005-01-01 23:38:34 +00:00
|
|
|
#define LIBSSH2_LIBRARY
|
2004-12-07 21:17:20 +00:00
|
|
|
#include "libssh2_config.h"
|
2007-04-05 09:31:38 +00:00
|
|
|
|
|
|
|
/* The following CPP block should really only be in session.c and
|
|
|
|
packet.c. However, AIX have #define's for 'events' and 'revents'
|
|
|
|
and we are using those names in libssh2.h, so we need to include
|
|
|
|
the AIX headers first, to make sure all code is compiled with
|
|
|
|
consistent names of these fields. While arguable the best would to
|
|
|
|
change libssh2.h to use other names, that would break backwards
|
|
|
|
compatibility. For more information, see:
|
|
|
|
http://www.mail-archive.com/libssh2-devel%40lists.sourceforge.net/msg00003.html
|
|
|
|
http://www.mail-archive.com/libssh2-devel%40lists.sourceforge.net/msg00224.html
|
|
|
|
*/
|
|
|
|
#ifdef HAVE_POLL
|
|
|
|
# include <sys/poll.h>
|
|
|
|
#else
|
|
|
|
# ifdef HAVE_SELECT
|
|
|
|
# ifdef HAVE_SYS_SELECT_H
|
|
|
|
# include <sys/select.h>
|
|
|
|
# else
|
|
|
|
# include <sys/time.h>
|
|
|
|
# include <sys/types.h>
|
|
|
|
# endif
|
|
|
|
# endif
|
|
|
|
#endif
|
|
|
|
|
2004-12-07 21:17:20 +00:00
|
|
|
#include "libssh2.h"
|
|
|
|
|
2007-01-23 08:14:14 +00:00
|
|
|
#include <stdio.h>
|
|
|
|
|
2007-04-11 07:22:33 +00:00
|
|
|
#ifdef HAVE_SYS_SOCKET_H
|
|
|
|
# include <sys/socket.h>
|
|
|
|
#endif
|
|
|
|
#ifdef HAVE_SYS_IOCTL_H
|
|
|
|
# include <sys/ioctl.h>
|
2005-01-03 22:46:15 +00:00
|
|
|
#endif
|
2007-01-15 21:12:00 +00:00
|
|
|
|
2007-01-22 21:40:44 +00:00
|
|
|
#ifdef LIBSSH2_LIBGCRYPT
|
2007-01-15 21:12:00 +00:00
|
|
|
#include "libgcrypt.h"
|
|
|
|
#else
|
|
|
|
#include "openssl.h"
|
2005-08-25 20:50:37 +00:00
|
|
|
#endif
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-02-02 16:21:20 +00:00
|
|
|
/* RFC4253 section 6.1 Maximum Packet Length says:
|
|
|
|
*
|
|
|
|
* "All implementations MUST be able to process packets with
|
|
|
|
* uncompressed payload length of 32768 bytes or less and
|
|
|
|
* total packet size of 35000 bytes or less (including length,
|
|
|
|
* padding length, payload, padding, and MAC.)."
|
|
|
|
*/
|
|
|
|
#define MAX_SSH_PACKET_LEN 35000
|
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_ALLOC(session, count) session->alloc((count), &(session)->abstract)
|
|
|
|
#define LIBSSH2_REALLOC(session, ptr, count) ((ptr) ? session->realloc((ptr), (count), &(session)->abstract) : session->alloc((count), &(session)->abstract))
|
|
|
|
#define LIBSSH2_FREE(session, ptr) session->free((ptr), &(session)->abstract)
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_IGNORE(session, data, datalen) session->ssh_msg_ignore((session), (data), (datalen), &(session)->abstract)
|
|
|
|
#define LIBSSH2_DEBUG(session, always_display, message, message_len, language, language_len) \
|
|
|
|
session->ssh_msg_disconnect((session), (always_display), (message), (message_len), (language), (language_len), &(session)->abstract)
|
|
|
|
#define LIBSSH2_DISCONNECT(session, reason, message, message_len, language, language_len) \
|
|
|
|
session->ssh_msg_disconnect((session), (reason), (message), (message_len), (language), (language_len), &(session)->abstract)
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_MACERROR(session, data, datalen) session->macerror((session), (data), (datalen), &(session)->abstract)
|
|
|
|
#define LIBSSH2_X11_OPEN(channel, shost, sport) channel->session->x11(((channel)->session), (channel), (shost), (sport), (&(channel)->session->abstract))
|
2004-12-20 21:52:35 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_CHANNEL_CLOSE(session, channel) channel->close_cb((session), &(session)->abstract, (channel), &(channel)->abstract)
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
typedef struct _LIBSSH2_KEX_METHOD LIBSSH2_KEX_METHOD;
|
|
|
|
typedef struct _LIBSSH2_HOSTKEY_METHOD LIBSSH2_HOSTKEY_METHOD;
|
|
|
|
typedef struct _LIBSSH2_MAC_METHOD LIBSSH2_MAC_METHOD;
|
|
|
|
typedef struct _LIBSSH2_CRYPT_METHOD LIBSSH2_CRYPT_METHOD;
|
|
|
|
typedef struct _LIBSSH2_COMP_METHOD LIBSSH2_COMP_METHOD;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
typedef struct _LIBSSH2_PACKET LIBSSH2_PACKET;
|
|
|
|
typedef struct _LIBSSH2_PACKET_BRIGADE LIBSSH2_PACKET_BRIGADE;
|
|
|
|
typedef struct _LIBSSH2_CHANNEL_BRIGADE LIBSSH2_CHANNEL_BRIGADE;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
struct _LIBSSH2_PACKET {
|
2007-05-28 17:56:08 +00:00
|
|
|
unsigned char type;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Unencrypted Payload (no type byte, no padding, just the facts ma'am) */
|
|
|
|
unsigned char *data;
|
|
|
|
unsigned long data_len;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Where to start reading data from,
|
|
|
|
* used for channel data that's been partially consumed */
|
|
|
|
unsigned long data_head;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Can the message be confirmed? */
|
|
|
|
int mac;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
LIBSSH2_PACKET_BRIGADE *brigade;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
LIBSSH2_PACKET *next, *prev;
|
2004-12-07 21:17:20 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct _LIBSSH2_PACKET_BRIGADE {
|
2007-05-28 17:56:08 +00:00
|
|
|
LIBSSH2_PACKET *head, *tail;
|
2004-12-07 21:17:20 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef struct _libssh2_channel_data {
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Identifier */
|
|
|
|
unsigned long id;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Limits and restrictions */
|
|
|
|
unsigned long window_size_initial, window_size, packet_size;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Set to 1 when CHANNEL_CLOSE / CHANNEL_EOF sent/received */
|
|
|
|
char close, eof, extended_data_ignore_mode;
|
2004-12-07 21:17:20 +00:00
|
|
|
} libssh2_channel_data;
|
|
|
|
|
|
|
|
struct _LIBSSH2_CHANNEL {
|
2007-05-28 17:56:08 +00:00
|
|
|
unsigned char *channel_type;
|
|
|
|
unsigned channel_type_len;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
int blocking;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* channel's program exit status */
|
|
|
|
int exit_status;
|
2005-06-23 05:55:01 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
libssh2_channel_data local, remote;
|
|
|
|
unsigned long adjust_queue; /* Amount of bytes to be refunded to receive window (but not yet sent) */
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
LIBSSH2_SESSION *session;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
LIBSSH2_CHANNEL *next, *prev;
|
2004-12-20 21:52:35 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
void *abstract;
|
|
|
|
LIBSSH2_CHANNEL_CLOSE_FUNC((*close_cb));
|
2004-12-07 21:17:20 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct _LIBSSH2_CHANNEL_BRIGADE {
|
2007-05-28 17:56:08 +00:00
|
|
|
LIBSSH2_CHANNEL *head, *tail;
|
2004-12-07 21:17:20 +00:00
|
|
|
};
|
|
|
|
|
2004-12-29 19:26:28 +00:00
|
|
|
struct _LIBSSH2_LISTENER {
|
2007-05-28 17:56:08 +00:00
|
|
|
LIBSSH2_SESSION *session;
|
2004-12-29 19:26:28 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
char *host;
|
|
|
|
int port;
|
2004-12-29 19:26:28 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
LIBSSH2_CHANNEL *queue;
|
|
|
|
int queue_size;
|
|
|
|
int queue_maxsize;
|
2004-12-29 19:26:28 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
LIBSSH2_LISTENER *prev, *next;
|
2004-12-29 19:26:28 +00:00
|
|
|
};
|
|
|
|
|
2004-12-07 21:17:20 +00:00
|
|
|
typedef struct _libssh2_endpoint_data {
|
2007-05-28 17:56:08 +00:00
|
|
|
unsigned char *banner;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
unsigned char *kexinit;
|
|
|
|
unsigned long kexinit_len;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
const LIBSSH2_CRYPT_METHOD *crypt;
|
|
|
|
void *crypt_abstract;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
const LIBSSH2_MAC_METHOD *mac;
|
|
|
|
unsigned long seqno;
|
|
|
|
void *mac_abstract;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
const LIBSSH2_COMP_METHOD *comp;
|
|
|
|
void *comp_abstract;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Method Preferences -- NULL yields "load order" */
|
|
|
|
char *crypt_prefs;
|
|
|
|
char *mac_prefs;
|
|
|
|
char *comp_prefs;
|
|
|
|
char *lang_prefs;
|
2004-12-07 21:17:20 +00:00
|
|
|
} libssh2_endpoint_data;
|
|
|
|
|
2007-02-02 16:21:20 +00:00
|
|
|
#define PACKETBUFSIZE 4096
|
|
|
|
|
|
|
|
struct transportpacket {
|
2007-05-28 17:56:08 +00:00
|
|
|
/* ------------- for incoming data --------------- */
|
|
|
|
unsigned char buf[PACKETBUFSIZE];
|
|
|
|
unsigned char init[5]; /* first 5 bytes of the incoming data stream,
|
|
|
|
still encrypted */
|
|
|
|
int writeidx; /* at what array index we do the next write into
|
|
|
|
the buffer */
|
|
|
|
int readidx; /* at what array index we do the next read from
|
|
|
|
the buffer */
|
|
|
|
int packet_length; /* the most recent packet_length as read from the
|
|
|
|
network data */
|
|
|
|
int padding_length; /* the most recent padding_length as read from the
|
|
|
|
network data */
|
|
|
|
int data_num; /* How much of the total package that has been read
|
|
|
|
so far. */
|
|
|
|
int total_num; /* How much a total package is supposed to be, in
|
|
|
|
number of bytes. A full package is
|
|
|
|
packet_length + padding_length + 4 +
|
|
|
|
mac_length. */
|
|
|
|
unsigned char *payload; /* this is a pointer to a LIBSSH2_ALLOC()
|
|
|
|
area to which we write decrypted data */
|
|
|
|
unsigned char *wptr; /* write pointer into the payload to where we
|
|
|
|
are currently writing decrypted data */
|
|
|
|
|
|
|
|
/* ------------- for outgoing data --------------- */
|
|
|
|
unsigned char *outbuf; /* pointer to a LIBSSH2_ALLOC() area for the
|
|
|
|
outgoing data */
|
|
|
|
int ototal_num; /* size of outbuf in number of bytes */
|
|
|
|
unsigned char *odata; /* original pointer to the data we stored in
|
|
|
|
outbuf */
|
|
|
|
unsigned long olen; /* original size of the data we stored in
|
|
|
|
outbuf */
|
|
|
|
unsigned long osent; /* number of bytes already sent */
|
2007-02-02 16:21:20 +00:00
|
|
|
};
|
|
|
|
|
2004-12-07 21:17:20 +00:00
|
|
|
struct _LIBSSH2_SESSION {
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Memory management callbacks */
|
|
|
|
void *abstract;
|
|
|
|
LIBSSH2_ALLOC_FUNC((*alloc));
|
|
|
|
LIBSSH2_REALLOC_FUNC((*realloc));
|
|
|
|
LIBSSH2_FREE_FUNC((*free));
|
|
|
|
|
|
|
|
/* Other callbacks */
|
|
|
|
LIBSSH2_IGNORE_FUNC((*ssh_msg_ignore));
|
|
|
|
LIBSSH2_DEBUG_FUNC((*ssh_msg_debug));
|
|
|
|
LIBSSH2_DISCONNECT_FUNC((*ssh_msg_disconnect));
|
|
|
|
LIBSSH2_MACERROR_FUNC((*macerror));
|
|
|
|
LIBSSH2_X11_OPEN_FUNC((*x11));
|
|
|
|
|
|
|
|
/* Method preferences -- NULL yields "load order" */
|
|
|
|
char *kex_prefs;
|
|
|
|
char *hostkey_prefs;
|
|
|
|
|
|
|
|
int state;
|
|
|
|
int flags;
|
|
|
|
|
|
|
|
/* Agreed Key Exchange Method */
|
|
|
|
const LIBSSH2_KEX_METHOD *kex;
|
|
|
|
int burn_optimistic_kexinit:1;
|
|
|
|
|
|
|
|
unsigned char *session_id;
|
|
|
|
unsigned long session_id_len;
|
|
|
|
|
|
|
|
/* Server's public key */
|
|
|
|
const LIBSSH2_HOSTKEY_METHOD *hostkey;
|
|
|
|
void *server_hostkey_abstract;
|
|
|
|
|
|
|
|
/* Either set with libssh2_session_hostkey() (for server mode)
|
|
|
|
* Or read from server in (eg) KEXDH_INIT (for client mode)
|
|
|
|
*/
|
|
|
|
unsigned char *server_hostkey;
|
|
|
|
unsigned long server_hostkey_len;
|
2007-01-17 14:41:06 +00:00
|
|
|
#if LIBSSH2_MD5
|
2007-05-28 17:56:08 +00:00
|
|
|
unsigned char server_hostkey_md5[MD5_DIGEST_LENGTH];
|
2007-01-17 14:41:06 +00:00
|
|
|
#endif /* ! LIBSSH2_MD5 */
|
2007-05-28 17:56:08 +00:00
|
|
|
unsigned char server_hostkey_sha1[SHA_DIGEST_LENGTH];
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* (remote as source of data -- packet_read ) */
|
|
|
|
libssh2_endpoint_data remote;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* (local as source of data -- packet_write ) */
|
|
|
|
libssh2_endpoint_data local;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Inbound Data buffer -- Sometimes the packet that comes in isn't the packet we're ready for */
|
|
|
|
LIBSSH2_PACKET_BRIGADE packets;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Active connection channels */
|
|
|
|
LIBSSH2_CHANNEL_BRIGADE channels;
|
|
|
|
unsigned long next_channel;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
LIBSSH2_LISTENER *listeners;
|
2004-12-29 19:26:28 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Actual I/O socket */
|
|
|
|
int socket_fd;
|
|
|
|
int socket_block;
|
|
|
|
int socket_state;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Error tracking */
|
|
|
|
char *err_msg;
|
|
|
|
unsigned long err_msglen;
|
|
|
|
int err_should_free;
|
|
|
|
int err_code;
|
2007-02-02 16:21:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* struct members for packet-level reading */
|
|
|
|
struct transportpacket packet;
|
2007-02-02 23:23:36 +00:00
|
|
|
#ifdef LIBSSH2DEBUG
|
2007-05-28 17:56:08 +00:00
|
|
|
int showmask; /* what debug/trace messages to display */
|
2007-02-02 23:23:36 +00:00
|
|
|
#endif
|
2004-12-07 21:17:20 +00:00
|
|
|
};
|
|
|
|
|
2005-02-03 05:41:35 +00:00
|
|
|
/* session.state bits */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_STATE_EXCHANGING_KEYS 0x00000001
|
|
|
|
#define LIBSSH2_STATE_NEWKEYS 0x00000002
|
|
|
|
#define LIBSSH2_STATE_AUTHENTICATED 0x00000004
|
2005-02-03 05:41:35 +00:00
|
|
|
|
2005-02-03 05:57:43 +00:00
|
|
|
/* session.flag helpers */
|
|
|
|
#ifdef MSG_NOSIGNAL
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_SOCKET_SEND_FLAGS(session) (((session)->flags & LIBSSH2_FLAG_SIGPIPE) ? 0 : MSG_NOSIGNAL)
|
|
|
|
#define LIBSSH2_SOCKET_RECV_FLAGS(session) (((session)->flags & LIBSSH2_FLAG_SIGPIPE) ? 0 : MSG_NOSIGNAL)
|
2005-02-03 05:57:43 +00:00
|
|
|
#else
|
|
|
|
/* If MSG_NOSIGNAL isn't defined we're SOL on blocking SIGPIPE */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_SOCKET_SEND_FLAGS(session) 0
|
|
|
|
#define LIBSSH2_SOCKET_RECV_FLAGS(session) 0
|
2005-02-03 05:57:43 +00:00
|
|
|
#endif
|
|
|
|
|
2004-12-07 21:17:20 +00:00
|
|
|
/* libssh2 extensible ssh api, ultimately I'd like to allow loading additional methods via .so/.dll */
|
|
|
|
|
|
|
|
struct _LIBSSH2_KEX_METHOD {
|
2007-05-28 17:56:08 +00:00
|
|
|
const char *name;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Key exchange, populates session->* and returns 0 on success, non-0 on error */
|
|
|
|
int (*exchange_keys)(LIBSSH2_SESSION *session);
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
long flags;
|
2004-12-07 21:17:20 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct _LIBSSH2_HOSTKEY_METHOD {
|
2007-05-28 17:56:08 +00:00
|
|
|
const char *name;
|
|
|
|
unsigned long hash_len;
|
|
|
|
|
|
|
|
int (*init)(LIBSSH2_SESSION *session, const unsigned char *hostkey_data, unsigned long hostkey_data_len, void **abstract);
|
|
|
|
int (*initPEM)(LIBSSH2_SESSION *session, const char *privkeyfile, unsigned const char *passphrase, void **abstract);
|
|
|
|
int (*sig_verify)(LIBSSH2_SESSION *session, const unsigned char *sig, unsigned long sig_len, const unsigned char *m, unsigned long m_len, void **abstract);
|
|
|
|
int (*signv)(LIBSSH2_SESSION *session, unsigned char **signature, unsigned long *signature_len, unsigned long veccount, const struct iovec datavec[], void **abstract);
|
|
|
|
int (*encrypt)(LIBSSH2_SESSION *session, unsigned char **dst, unsigned long *dst_len, const unsigned char *src, unsigned long src_len, void **abstract);
|
|
|
|
int (*dtor)(LIBSSH2_SESSION *session, void **abstract);
|
2004-12-07 21:17:20 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct _LIBSSH2_CRYPT_METHOD {
|
2007-05-28 17:56:08 +00:00
|
|
|
const char *name;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
int blocksize;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* iv and key sizes (-1 for variable length) */
|
|
|
|
int iv_len;
|
|
|
|
int secret_len;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
long flags;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
int (*init)(LIBSSH2_SESSION *session, const LIBSSH2_CRYPT_METHOD *method, unsigned char *iv, int *free_iv, unsigned char *secret, int *free_secret, int encrypt, void **abstract);
|
|
|
|
int (*crypt)(LIBSSH2_SESSION *session, unsigned char *block, void **abstract);
|
|
|
|
int (*dtor)(LIBSSH2_SESSION *session, void **abstract);
|
2007-01-18 11:21:12 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
_libssh2_cipher_type(algo);
|
2004-12-07 21:17:20 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct _LIBSSH2_COMP_METHOD {
|
2007-05-28 17:56:08 +00:00
|
|
|
const char *name;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
int (*init)(LIBSSH2_SESSION *session, int compress, void **abstract);
|
|
|
|
int (*comp)(LIBSSH2_SESSION *session, int compress, unsigned char **dest, unsigned long *dest_len, unsigned long payload_limit, int *free_dest,
|
|
|
|
const unsigned char *src, unsigned long src_len, void **abstract);
|
|
|
|
int (*dtor)(LIBSSH2_SESSION *session, int compress, void **abstract);
|
2004-12-07 21:17:20 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct _LIBSSH2_MAC_METHOD {
|
2007-05-28 17:56:08 +00:00
|
|
|
const char *name;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* The length of a given MAC packet */
|
|
|
|
int mac_len;
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* integrity key length */
|
|
|
|
int key_len;
|
2004-12-31 00:55:52 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
/* Message Authentication Code Hashing algo */
|
|
|
|
int (*init)(LIBSSH2_SESSION *session, unsigned char *key, int *free_key, void **abstract);
|
|
|
|
int (*hash)(LIBSSH2_SESSION *session, unsigned char *buf, unsigned long seqno, const unsigned char *packet, unsigned long packet_len, const unsigned char *addtl, unsigned long addtl_len, void **abstract);
|
|
|
|
int (*dtor)(LIBSSH2_SESSION *session, void **abstract);
|
2004-12-07 21:17:20 +00:00
|
|
|
};
|
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_DBG_TRANS 1
|
|
|
|
#define LIBSSH2_DBG_KEX 2
|
|
|
|
#define LIBSSH2_DBG_AUTH 3
|
|
|
|
#define LIBSSH2_DBG_CONN 4
|
|
|
|
#define LIBSSH2_DBG_SCP 5
|
|
|
|
#define LIBSSH2_DBG_SFTP 6
|
|
|
|
#define LIBSSH2_DBG_ERROR 7
|
|
|
|
#define LIBSSH2_DBG_PUBLICKEY 8
|
2007-02-07 21:21:06 +00:00
|
|
|
#ifdef LIBSSH2DEBUG
|
|
|
|
void _libssh2_debug(LIBSSH2_SESSION *session, int context, const char *format, ...);
|
2007-02-02 23:23:36 +00:00
|
|
|
#else
|
|
|
|
#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
|
|
|
|
/* C99 style */
|
|
|
|
#define _libssh2_debug(x,y,z, __VA_ARGS__) do {} while (0)
|
|
|
|
#elif defined(__GNUC__)
|
|
|
|
/* GNU style */
|
|
|
|
#define _libssh2_debug(x,y,z,...) do {} while (0)
|
|
|
|
#else
|
|
|
|
/* no gcc and not C99, do static and hopefully inline */
|
|
|
|
static inline void _libssh2_debug(LIBSSH2_SESSION *session, int context,
|
2007-05-28 17:56:08 +00:00
|
|
|
const char *format, ...) {}
|
2007-02-02 23:23:36 +00:00
|
|
|
#endif
|
|
|
|
#endif
|
2005-05-11 05:11:31 +00:00
|
|
|
|
2007-02-02 23:23:36 +00:00
|
|
|
#ifdef LIBSSH2DEBUG
|
2007-05-28 17:56:08 +00:00
|
|
|
#define libssh2_error(session, errcode, errmsg, should_free) \
|
2005-05-11 05:11:31 +00:00
|
|
|
{ \
|
2007-05-28 17:56:08 +00:00
|
|
|
if (session->err_msg && session->err_should_free) { \
|
|
|
|
LIBSSH2_FREE(session, session->err_msg); \
|
|
|
|
} \
|
|
|
|
session->err_msg = (char *)errmsg; \
|
|
|
|
session->err_msglen = strlen(errmsg); \
|
|
|
|
session->err_should_free = should_free; \
|
|
|
|
session->err_code = errcode; \
|
|
|
|
_libssh2_debug(session, LIBSSH2_DBG_ERROR, "%d - %s", session->err_code, session->err_msg); \
|
2005-05-11 05:11:31 +00:00
|
|
|
}
|
|
|
|
|
2007-02-02 23:23:36 +00:00
|
|
|
#else /* ! LIBSSH2DEBUG */
|
2005-05-11 05:11:31 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
#define libssh2_error(session, errcode, errmsg, should_free) \
|
2004-12-07 21:17:20 +00:00
|
|
|
{ \
|
2007-05-28 17:56:08 +00:00
|
|
|
if (session->err_msg && session->err_should_free) { \
|
|
|
|
LIBSSH2_FREE(session, session->err_msg); \
|
|
|
|
} \
|
|
|
|
session->err_msg = (char *)errmsg; \
|
|
|
|
session->err_msglen = strlen(errmsg); \
|
|
|
|
session->err_should_free = should_free; \
|
|
|
|
session->err_code = errcode; \
|
2004-12-07 21:17:20 +00:00
|
|
|
}
|
|
|
|
|
2005-05-11 05:11:31 +00:00
|
|
|
#endif /* LIBSSH2_DEBUG_ENABLED */
|
|
|
|
|
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_SOCKET_UNKNOWN 1
|
|
|
|
#define LIBSSH2_SOCKET_CONNECTED 0
|
|
|
|
#define LIBSSH2_SOCKET_DISCONNECTED -1
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
/* Initial packet state, prior to MAC check */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_MAC_UNCONFIRMED 1
|
2004-12-07 21:17:20 +00:00
|
|
|
/* When MAC type is "none" (proto initiation phase) all packets are deemed "confirmed" */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_MAC_CONFIRMED 0
|
2004-12-07 21:17:20 +00:00
|
|
|
/* Something very bad is going on */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define LIBSSH2_MAC_INVALID -1
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
/* SSH Packet Types -- Defined by internet draft */
|
|
|
|
/* Transport Layer */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define SSH_MSG_DISCONNECT 1
|
|
|
|
#define SSH_MSG_IGNORE 2
|
|
|
|
#define SSH_MSG_UNIMPLEMENTED 3
|
|
|
|
#define SSH_MSG_DEBUG 4
|
|
|
|
#define SSH_MSG_SERVICE_REQUEST 5
|
|
|
|
#define SSH_MSG_SERVICE_ACCEPT 6
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-05-28 17:56:08 +00:00
|
|
|
#define SSH_MSG_KEXINIT 20
|
|
|
|
#define SSH_MSG_NEWKEYS 21
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
/* diffie-hellman-group1-sha1 */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define SSH_MSG_KEXDH_INIT 30
|
|
|
|
#define SSH_MSG_KEXDH_REPLY 31
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
/* diffie-hellman-group-exchange-sha1 */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define SSH_MSG_KEX_DH_GEX_REQUEST_OLD 30
|
|
|
|
#define SSH_MSG_KEX_DH_GEX_REQUEST 34
|
|
|
|
#define SSH_MSG_KEX_DH_GEX_GROUP 31
|
|
|
|
#define SSH_MSG_KEX_DH_GEX_INIT 32
|
|
|
|
#define SSH_MSG_KEX_DH_GEX_REPLY 33
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
/* User Authentication */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define SSH_MSG_USERAUTH_REQUEST 50
|
|
|
|
#define SSH_MSG_USERAUTH_FAILURE 51
|
|
|
|
#define SSH_MSG_USERAUTH_SUCCESS 52
|
|
|
|
#define SSH_MSG_USERAUTH_BANNER 53
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
/* "public key" method */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define SSH_MSG_USERAUTH_PK_OK 60
|
2004-12-07 21:17:20 +00:00
|
|
|
/* "password" method */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define SSH_MSG_USERAUTH_PASSWD_CHANGEREQ 60
|
2005-06-11 19:18:06 +00:00
|
|
|
/* "keyboard-interactive" method */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define SSH_MSG_USERAUTH_INFO_REQUEST 60
|
|
|
|
#define SSH_MSG_USERAUTH_INFO_RESPONSE 61
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
/* Channels */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define SSH_MSG_GLOBAL_REQUEST 80
|
|
|
|
#define SSH_MSG_REQUEST_SUCCESS 81
|
|
|
|
#define SSH_MSG_REQUEST_FAILURE 82
|
|
|
|
|
|
|
|
#define SSH_MSG_CHANNEL_OPEN 90
|
|
|
|
#define SSH_MSG_CHANNEL_OPEN_CONFIRMATION 91
|
|
|
|
#define SSH_MSG_CHANNEL_OPEN_FAILURE 92
|
|
|
|
#define SSH_MSG_CHANNEL_WINDOW_ADJUST 93
|
|
|
|
#define SSH_MSG_CHANNEL_DATA 94
|
|
|
|
#define SSH_MSG_CHANNEL_EXTENDED_DATA 95
|
|
|
|
#define SSH_MSG_CHANNEL_EOF 96
|
|
|
|
#define SSH_MSG_CHANNEL_CLOSE 97
|
|
|
|
#define SSH_MSG_CHANNEL_REQUEST 98
|
|
|
|
#define SSH_MSG_CHANNEL_SUCCESS 99
|
|
|
|
#define SSH_MSG_CHANNEL_FAILURE 100
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
void libssh2_session_shutdown(LIBSSH2_SESSION *session);
|
|
|
|
|
|
|
|
unsigned long libssh2_ntohu32(const unsigned char *buf);
|
2005-01-11 14:58:04 +00:00
|
|
|
libssh2_uint64_t libssh2_ntohu64(const unsigned char *buf);
|
2004-12-07 21:17:20 +00:00
|
|
|
void libssh2_htonu32(unsigned char *buf, unsigned long val);
|
2005-01-11 14:58:04 +00:00
|
|
|
void libssh2_htonu64(unsigned char *buf, libssh2_uint64_t val);
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-02-02 16:21:20 +00:00
|
|
|
#define LIBSSH2_READ_TIMEOUT 60 /* generic timeout in seconds used when
|
2007-05-28 17:56:08 +00:00
|
|
|
waiting for more data to arrive */
|
2007-02-02 16:21:20 +00:00
|
|
|
int libssh2_waitsocket(LIBSSH2_SESSION *session, long seconds);
|
|
|
|
|
|
|
|
|
|
|
|
/* CAUTION: some of these error codes are returned in the public API and is
|
|
|
|
there known with other #defined names from the public header file. They
|
|
|
|
should not be changed. */
|
|
|
|
typedef int libssh2pack_t;
|
|
|
|
|
|
|
|
#define PACKET_TIMEOUT -7
|
|
|
|
#define PACKET_BADUSE -6
|
|
|
|
#define PACKET_COMPRESS -5
|
|
|
|
#define PACKET_TOOBIG -4
|
|
|
|
#define PACKET_ENOMEM -3
|
|
|
|
#define PACKET_EAGAIN -2
|
|
|
|
#define PACKET_FAIL -1
|
|
|
|
#define PACKET_NONE 0
|
|
|
|
|
|
|
|
libssh2pack_t libssh2_packet_read(LIBSSH2_SESSION *session);
|
|
|
|
|
2004-12-07 21:17:20 +00:00
|
|
|
int libssh2_packet_ask_ex(LIBSSH2_SESSION *session, unsigned char packet_type, unsigned char **data, unsigned long *data_len, unsigned long match_ofs, const unsigned char *match_buf, unsigned long match_len, int poll_socket);
|
2007-05-28 17:56:08 +00:00
|
|
|
#define libssh2_packet_ask(session, packet_type, data, data_len, poll_socket) \
|
|
|
|
libssh2_packet_ask_ex((session), (packet_type), (data), (data_len), 0, NULL, 0, (poll_socket))
|
2007-04-17 18:12:41 +00:00
|
|
|
int libssh2_packet_askv_ex(LIBSSH2_SESSION *session, const unsigned char *packet_types, unsigned char **data, unsigned long *data_len, unsigned long match_ofs, const unsigned char *match_buf, unsigned long match_len, int poll_socket);
|
2007-05-28 17:56:08 +00:00
|
|
|
#define libssh2_packet_askv(session, packet_types, data, data_len, poll_socket) \
|
|
|
|
libssh2_packet_askv_ex((session), (packet_types), (data), (data_len), 0, NULL, 0, (poll_socket))
|
2004-12-07 21:17:20 +00:00
|
|
|
int libssh2_packet_require_ex(LIBSSH2_SESSION *session, unsigned char packet_type, unsigned char **data, unsigned long *data_len, unsigned long match_ofs, const unsigned char *match_buf, unsigned long match_len);
|
2007-02-02 16:21:20 +00:00
|
|
|
#define libssh2_packet_require(session, packet_type, data, data_len) \
|
|
|
|
libssh2_packet_require_ex((session), (packet_type), (data), (data_len), 0, NULL, 0)
|
2007-04-17 18:12:41 +00:00
|
|
|
int libssh2_packet_requirev_ex(LIBSSH2_SESSION *session, const unsigned char *packet_types, unsigned char **data, unsigned long *data_len, unsigned long match_ofs, const unsigned char *match_buf, unsigned long match_len);
|
2007-05-28 17:56:08 +00:00
|
|
|
#define libssh2_packet_requirev(session, packet_types, data, data_len) \
|
|
|
|
libssh2_packet_requirev_ex((session), (packet_types), (data), (data_len), 0, NULL, 0)
|
2006-06-22 18:45:29 +00:00
|
|
|
int libssh2_packet_burn(LIBSSH2_SESSION *session);
|
2004-12-07 21:17:20 +00:00
|
|
|
int libssh2_packet_write(LIBSSH2_SESSION *session, unsigned char *data, unsigned long data_len);
|
2007-02-02 16:21:20 +00:00
|
|
|
int libssh2_packet_add(LIBSSH2_SESSION *session, unsigned char *data, size_t datalen, int macstate);
|
2004-12-07 21:17:20 +00:00
|
|
|
int libssh2_kex_exchange(LIBSSH2_SESSION *session, int reexchange);
|
2004-12-29 19:26:28 +00:00
|
|
|
unsigned long libssh2_channel_nextid(LIBSSH2_SESSION *session);
|
2004-12-07 21:17:20 +00:00
|
|
|
LIBSSH2_CHANNEL *libssh2_channel_locate(LIBSSH2_SESSION *session, unsigned long channel_id);
|
2007-02-02 16:21:20 +00:00
|
|
|
ssize_t _libssh2_channel_read_ex(LIBSSH2_CHANNEL *channel,
|
2007-05-28 17:56:08 +00:00
|
|
|
int stream_id, char *buf, size_t buflen);
|
2007-02-02 16:21:20 +00:00
|
|
|
#define _libssh2_channel_read(channel, buf, buflen) \
|
|
|
|
_libssh2_channel_read_ex((channel), 0, (buf), (buflen))
|
|
|
|
#undef libssh2_channel_read /* never use this internally */
|
|
|
|
#define libssh2_channel_read fix this code
|
|
|
|
|
|
|
|
int _libssh2_channel_write_ex(LIBSSH2_CHANNEL *channel,
|
2007-05-28 17:56:08 +00:00
|
|
|
int stream_id,
|
|
|
|
const char *buf, size_t buflen);
|
2007-02-02 16:21:20 +00:00
|
|
|
#define _libssh2_channel_write(channel, buf, buflen) \
|
|
|
|
_libssh2_channel_write_ex((channel), 0, (buf), (buflen))
|
|
|
|
|
|
|
|
/* this is the lib-internal set blocking function */
|
|
|
|
int _libssh2_channel_set_blocking(LIBSSH2_CHANNEL *channel, int blocking);
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
/* Let crypt.c/hostkey.c/comp.c/mac.c expose their method structs */
|
2007-04-17 18:12:41 +00:00
|
|
|
const LIBSSH2_CRYPT_METHOD **libssh2_crypt_methods(void);
|
|
|
|
const LIBSSH2_HOSTKEY_METHOD **libssh2_hostkey_methods(void);
|
|
|
|
const LIBSSH2_COMP_METHOD **libssh2_comp_methods(void);
|
|
|
|
const LIBSSH2_MAC_METHOD **libssh2_mac_methods(void);
|
2004-12-07 21:17:20 +00:00
|
|
|
|
|
|
|
/* Language API doesn't exist yet. Just act like we've agreed on a language */
|
2007-05-28 17:56:08 +00:00
|
|
|
#define libssh2_kex_agree_lang(session, endpoint, str, str_len) 0
|
2004-12-07 21:17:20 +00:00
|
|
|
|
2007-01-23 08:14:14 +00:00
|
|
|
/* pem.c */
|
|
|
|
int _libssh2_pem_parse (LIBSSH2_SESSION *session,
|
2007-05-28 17:56:08 +00:00
|
|
|
const char *headerbegin,
|
|
|
|
const char *headerend,
|
|
|
|
FILE *fp,
|
|
|
|
char **data, unsigned int *datalen);
|
2007-01-23 21:36:40 +00:00
|
|
|
int _libssh2_pem_decode_sequence (unsigned char **data, unsigned int *datalen);
|
|
|
|
int _libssh2_pem_decode_integer (unsigned char **data, unsigned int *datalen,
|
2007-05-28 17:56:08 +00:00
|
|
|
unsigned char **i, unsigned int *ilen);
|
2007-01-23 08:14:14 +00:00
|
|
|
|
2004-12-07 21:17:20 +00:00
|
|
|
#endif /* LIBSSH2_H */
|