1d059297112922cabb0c674840589be8db821fd9aAdam Langley/* $OpenBSD: packet.h,v 1.66 2015/01/30 01:13:33 djm Exp $ */ 2bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman 3bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman/* 4bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman * Author: Tatu Ylonen <ylo@cs.hut.fi> 5bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 6bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman * All rights reserved 7bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman * Interface for the packet protocol functions. 8bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman * 9bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman * As far as I am concerned, the code I have written for this software 10bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman * can be used freely for any purpose. Any derived versions of this 11bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman * software must be clearly marked as such, and if the derived work is 12bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman * incompatible with the protocol description in the RFC file, it must be 13bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman * called by a name other than "ssh" or "Secure Shell". 14bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman */ 15bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman 16bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman#ifndef PACKET_H 17bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman#define PACKET_H 18bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman 19bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman#include <termios.h> 20bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman 21d059297112922cabb0c674840589be8db821fd9aAdam Langley#ifdef WITH_OPENSSL 22d059297112922cabb0c674840589be8db821fd9aAdam Langley# include <openssl/bn.h> 23d059297112922cabb0c674840589be8db821fd9aAdam Langley# ifdef OPENSSL_HAS_ECC 24d059297112922cabb0c674840589be8db821fd9aAdam Langley# include <openssl/ec.h> 25d059297112922cabb0c674840589be8db821fd9aAdam Langley# else /* OPENSSL_HAS_ECC */ 26d059297112922cabb0c674840589be8db821fd9aAdam Langley# define EC_KEY void 27d059297112922cabb0c674840589be8db821fd9aAdam Langley# define EC_GROUP void 28d059297112922cabb0c674840589be8db821fd9aAdam Langley# define EC_POINT void 29d059297112922cabb0c674840589be8db821fd9aAdam Langley# endif /* OPENSSL_HAS_ECC */ 30d059297112922cabb0c674840589be8db821fd9aAdam Langley#else /* WITH_OPENSSL */ 31d059297112922cabb0c674840589be8db821fd9aAdam Langley# define BIGNUM void 32d059297112922cabb0c674840589be8db821fd9aAdam Langley# define EC_KEY void 33d059297112922cabb0c674840589be8db821fd9aAdam Langley# define EC_GROUP void 34d059297112922cabb0c674840589be8db821fd9aAdam Langley# define EC_POINT void 35d059297112922cabb0c674840589be8db821fd9aAdam Langley#endif /* WITH_OPENSSL */ 36d059297112922cabb0c674840589be8db821fd9aAdam Langley 37d059297112922cabb0c674840589be8db821fd9aAdam Langley#include <signal.h> 38d059297112922cabb0c674840589be8db821fd9aAdam Langley#include "openbsd-compat/sys-queue.h" 39d059297112922cabb0c674840589be8db821fd9aAdam Langley 40d059297112922cabb0c674840589be8db821fd9aAdam Langleystruct kex; 41d059297112922cabb0c674840589be8db821fd9aAdam Langleystruct sshkey; 42d059297112922cabb0c674840589be8db821fd9aAdam Langleystruct sshbuf; 43d059297112922cabb0c674840589be8db821fd9aAdam Langleystruct session_state; /* private session data */ 44d059297112922cabb0c674840589be8db821fd9aAdam Langley 45d059297112922cabb0c674840589be8db821fd9aAdam Langley#include "dispatch.h" /* typedef, DISPATCH_MAX */ 46d059297112922cabb0c674840589be8db821fd9aAdam Langley 47d059297112922cabb0c674840589be8db821fd9aAdam Langleystruct key_entry { 48d059297112922cabb0c674840589be8db821fd9aAdam Langley TAILQ_ENTRY(key_entry) next; 49d059297112922cabb0c674840589be8db821fd9aAdam Langley struct sshkey *key; 50d059297112922cabb0c674840589be8db821fd9aAdam Langley}; 51d059297112922cabb0c674840589be8db821fd9aAdam Langley 52d059297112922cabb0c674840589be8db821fd9aAdam Langleystruct ssh { 53d059297112922cabb0c674840589be8db821fd9aAdam Langley /* Session state */ 54d059297112922cabb0c674840589be8db821fd9aAdam Langley struct session_state *state; 55d059297112922cabb0c674840589be8db821fd9aAdam Langley 56d059297112922cabb0c674840589be8db821fd9aAdam Langley /* Key exchange */ 57d059297112922cabb0c674840589be8db821fd9aAdam Langley struct kex *kex; 58d059297112922cabb0c674840589be8db821fd9aAdam Langley 59d059297112922cabb0c674840589be8db821fd9aAdam Langley /* cached remote ip address and port*/ 60d059297112922cabb0c674840589be8db821fd9aAdam Langley char *remote_ipaddr; 61d059297112922cabb0c674840589be8db821fd9aAdam Langley int remote_port; 62d059297112922cabb0c674840589be8db821fd9aAdam Langley 63d059297112922cabb0c674840589be8db821fd9aAdam Langley /* Dispatcher table */ 64d059297112922cabb0c674840589be8db821fd9aAdam Langley dispatch_fn *dispatch[DISPATCH_MAX]; 65d059297112922cabb0c674840589be8db821fd9aAdam Langley /* number of packets to ignore in the dispatcher */ 66d059297112922cabb0c674840589be8db821fd9aAdam Langley int dispatch_skip_packets; 67d059297112922cabb0c674840589be8db821fd9aAdam Langley 68d059297112922cabb0c674840589be8db821fd9aAdam Langley /* datafellows */ 69d059297112922cabb0c674840589be8db821fd9aAdam Langley int compat; 70d059297112922cabb0c674840589be8db821fd9aAdam Langley 71d059297112922cabb0c674840589be8db821fd9aAdam Langley /* Lists for private and public keys */ 72d059297112922cabb0c674840589be8db821fd9aAdam Langley TAILQ_HEAD(, key_entry) private_keys; 73d059297112922cabb0c674840589be8db821fd9aAdam Langley TAILQ_HEAD(, key_entry) public_keys; 74d059297112922cabb0c674840589be8db821fd9aAdam Langley 75d059297112922cabb0c674840589be8db821fd9aAdam Langley /* APP data */ 76d059297112922cabb0c674840589be8db821fd9aAdam Langley void *app_data; 77d059297112922cabb0c674840589be8db821fd9aAdam Langley}; 78d059297112922cabb0c674840589be8db821fd9aAdam Langley 79d059297112922cabb0c674840589be8db821fd9aAdam Langleystruct ssh *ssh_alloc_session_state(void); 80d059297112922cabb0c674840589be8db821fd9aAdam Langleystruct ssh *ssh_packet_set_connection(struct ssh *, int, int); 81d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_timeout(struct ssh *, int, int); 82d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_stop_discard(struct ssh *); 83d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_connection_af(struct ssh *); 84d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_nonblocking(struct ssh *); 85d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_get_connection_in(struct ssh *); 86d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_get_connection_out(struct ssh *); 87d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_close(struct ssh *); 88d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_encryption_key(struct ssh *, const u_char *, u_int, int); 89d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_protocol_flags(struct ssh *, u_int); 90d059297112922cabb0c674840589be8db821fd9aAdam Langleyu_int ssh_packet_get_protocol_flags(struct ssh *); 91d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_start_compression(struct ssh *, int); 92d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_tos(struct ssh *, int); 93d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_interactive(struct ssh *, int, int, int); 94d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_is_interactive(struct ssh *); 95d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_server(struct ssh *); 96d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_authenticated(struct ssh *); 97d059297112922cabb0c674840589be8db821fd9aAdam Langley 98d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_send1(struct ssh *); 99d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_send2_wrapped(struct ssh *); 100d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_send2(struct ssh *); 101d059297112922cabb0c674840589be8db821fd9aAdam Langley 102d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_read(struct ssh *); 103d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_read_expect(struct ssh *, u_int type); 104d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_read_poll(struct ssh *); 105d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_read_poll1(struct ssh *, u_char *); 106d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p); 107d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len); 108d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); 109d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); 110d059297112922cabb0c674840589be8db821fd9aAdam Langley 111d059297112922cabb0c674840589be8db821fd9aAdam Langleyconst void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr); 112d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_disconnect(struct ssh *, const char *fmt, ...) 113d059297112922cabb0c674840589be8db821fd9aAdam Langley __attribute__((format(printf, 2, 3))) 114d059297112922cabb0c674840589be8db821fd9aAdam Langley __attribute__((noreturn)); 115d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3))); 116d059297112922cabb0c674840589be8db821fd9aAdam Langley 117d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_set_newkeys(struct ssh *, int mode); 118d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *); 119d059297112922cabb0c674840589be8db821fd9aAdam Langley 120d059297112922cabb0c674840589be8db821fd9aAdam Langleytypedef void *(ssh_packet_comp_alloc_func)(void *, u_int, u_int); 121d059297112922cabb0c674840589be8db821fd9aAdam Langleytypedef void (ssh_packet_comp_free_func)(void *, void *); 122d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_compress_hooks(struct ssh *, void *, 123d059297112922cabb0c674840589be8db821fd9aAdam Langley ssh_packet_comp_alloc_func *, ssh_packet_comp_free_func *); 124d059297112922cabb0c674840589be8db821fd9aAdam Langley 125d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_write_poll(struct ssh *); 126d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_write_wait(struct ssh *); 127d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_have_data_to_write(struct ssh *); 128d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_not_very_much_data_to_write(struct ssh *); 129d059297112922cabb0c674840589be8db821fd9aAdam Langley 130d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_connection_is_on_socket(struct ssh *); 131d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_remaining(struct ssh *); 132d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_send_ignore(struct ssh *, int); 133bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman 134bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartmanvoid tty_make_modes(int, struct termios *); 135bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartmanvoid tty_parse_modes(int, int *); 136bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman 137d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_alive_timeouts(struct ssh *, int); 138d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_inc_alive_timeouts(struct ssh *); 139d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_set_maxsize(struct ssh *, u_int); 140d059297112922cabb0c674840589be8db821fd9aAdam Langleyu_int ssh_packet_get_maxsize(struct ssh *); 141d059297112922cabb0c674840589be8db821fd9aAdam Langley 142d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_get_state(struct ssh *, struct sshbuf *); 143d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_set_state(struct ssh *, struct sshbuf *); 144d059297112922cabb0c674840589be8db821fd9aAdam Langley 145d059297112922cabb0c674840589be8db821fd9aAdam Langleyconst char *ssh_remote_ipaddr(struct ssh *); 146d059297112922cabb0c674840589be8db821fd9aAdam Langley 147d059297112922cabb0c674840589be8db821fd9aAdam Langleyint ssh_packet_need_rekeying(struct ssh *); 148d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_set_rekey_limits(struct ssh *, u_int32_t, time_t); 149d059297112922cabb0c674840589be8db821fd9aAdam Langleytime_t ssh_packet_get_rekey_timeout(struct ssh *); 150d059297112922cabb0c674840589be8db821fd9aAdam Langley 151d059297112922cabb0c674840589be8db821fd9aAdam Langley/* XXX FIXME */ 152d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_backup_state(struct ssh *, struct ssh *); 153d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid ssh_packet_restore_state(struct ssh *, struct ssh *); 154d059297112922cabb0c674840589be8db821fd9aAdam Langley 155d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid *ssh_packet_get_input(struct ssh *); 156d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid *ssh_packet_get_output(struct ssh *); 157d059297112922cabb0c674840589be8db821fd9aAdam Langley 158d059297112922cabb0c674840589be8db821fd9aAdam Langley/* new API */ 159d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_start(struct ssh *ssh, u_char type); 160d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_send(struct ssh *ssh); 161d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_disconnect(struct ssh *, const char *fmt, ...) 162d059297112922cabb0c674840589be8db821fd9aAdam Langley __attribute__((format(printf, 2, 3))); 163d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_add_padding(struct ssh *, u_char); 164d059297112922cabb0c674840589be8db821fd9aAdam Langleyvoid sshpkt_fatal(struct ssh *ssh, const char *tag, int r); 165d059297112922cabb0c674840589be8db821fd9aAdam Langley 166d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_put(struct ssh *ssh, const void *v, size_t len); 167d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_putb(struct ssh *ssh, const struct sshbuf *b); 168d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_put_u8(struct ssh *ssh, u_char val); 169d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_put_u32(struct ssh *ssh, u_int32_t val); 170d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_put_u64(struct ssh *ssh, u_int64_t val); 171d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_put_string(struct ssh *ssh, const void *v, size_t len); 172d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_put_cstring(struct ssh *ssh, const void *v); 173d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v); 174d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g); 175d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_put_bignum1(struct ssh *ssh, const BIGNUM *v); 176d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v); 177d059297112922cabb0c674840589be8db821fd9aAdam Langley 178d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get(struct ssh *ssh, void *valp, size_t len); 179d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get_u8(struct ssh *ssh, u_char *valp); 180d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp); 181d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp); 182d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp); 183d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp); 184d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp); 185d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g); 186d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get_bignum1(struct ssh *ssh, BIGNUM *v); 187d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get_bignum2(struct ssh *ssh, BIGNUM *v); 188d059297112922cabb0c674840589be8db821fd9aAdam Langleyint sshpkt_get_end(struct ssh *ssh); 189d059297112922cabb0c674840589be8db821fd9aAdam Langleyconst u_char *sshpkt_ptr(struct ssh *, size_t *lenp); 190d059297112922cabb0c674840589be8db821fd9aAdam Langley 191d059297112922cabb0c674840589be8db821fd9aAdam Langley/* OLD API */ 192d059297112922cabb0c674840589be8db821fd9aAdam Langleyextern struct ssh *active_state; 193d059297112922cabb0c674840589be8db821fd9aAdam Langley#include "opacket.h" 194d059297112922cabb0c674840589be8db821fd9aAdam Langley 195d059297112922cabb0c674840589be8db821fd9aAdam Langley#if !defined(WITH_OPENSSL) 196d059297112922cabb0c674840589be8db821fd9aAdam Langley# undef BIGNUM 197d059297112922cabb0c674840589be8db821fd9aAdam Langley# undef EC_KEY 198d059297112922cabb0c674840589be8db821fd9aAdam Langley# undef EC_GROUP 199d059297112922cabb0c674840589be8db821fd9aAdam Langley# undef EC_POINT 200d059297112922cabb0c674840589be8db821fd9aAdam Langley#elif !defined(OPENSSL_HAS_ECC) 201d059297112922cabb0c674840589be8db821fd9aAdam Langley# undef EC_KEY 202d059297112922cabb0c674840589be8db821fd9aAdam Langley# undef EC_GROUP 203d059297112922cabb0c674840589be8db821fd9aAdam Langley# undef EC_POINT 204d059297112922cabb0c674840589be8db821fd9aAdam Langley#endif 205bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman 206bd77cf78387b72b7b3ea870459077672bf75c3b5Greg Hartman#endif /* PACKET_H */ 207