markus@openbsd.org | 3fdc88a | 2015-01-19 20:07:45 +0000 | [diff] [blame^] | 1 | /* $OpenBSD: packet.h,v 1.63 2015/01/19 20:07:45 markus Exp $ */ |
Ben Lindstrom | 05764b9 | 2002-03-05 01:53:02 +0000 | [diff] [blame] | 2 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 3 | /* |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 4 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 5 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 6 | * All rights reserved |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 7 | * Interface for the packet protocol functions. |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 8 | * |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 9 | * As far as I am concerned, the code I have written for this software |
| 10 | * can be used freely for any purpose. Any derived versions of this |
| 11 | * software must be clearly marked as such, and if the derived work is |
| 12 | * incompatible with the protocol description in the RFC file, it must be |
| 13 | * called by a name other than "ssh" or "Secure Shell". |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 14 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 15 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 16 | #ifndef PACKET_H |
| 17 | #define PACKET_H |
| 18 | |
Damien Miller | 99bd21e | 2006-03-15 11:11:28 +1100 | [diff] [blame] | 19 | #include <termios.h> |
| 20 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 21 | #ifdef WITH_OPENSSL |
| 22 | # include <openssl/bn.h> |
| 23 | # ifdef OPENSSL_HAS_ECC |
| 24 | # include <openssl/ec.h> |
| 25 | # endif |
Darren Tucker | 8ccb739 | 2010-09-10 12:28:24 +1000 | [diff] [blame] | 26 | #endif |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 27 | #include <sys/signal.h> |
| 28 | #include <sys/queue.h> |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 29 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 30 | struct kex; |
| 31 | struct sshkey; |
| 32 | struct sshbuf; |
| 33 | struct session_state; /* private session data */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 34 | |
markus@openbsd.org | 3fdc88a | 2015-01-19 20:07:45 +0000 | [diff] [blame^] | 35 | #include "dispatch.h" /* typedef, DISPATCH_MAX */ |
| 36 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 37 | struct ssh { |
| 38 | /* Session state */ |
| 39 | struct session_state *state; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 40 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 41 | /* Key exchange */ |
| 42 | struct kex *kex; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 43 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 44 | /* cached remote ip address and port*/ |
| 45 | char *remote_ipaddr; |
| 46 | int remote_port; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 47 | |
markus@openbsd.org | 3fdc88a | 2015-01-19 20:07:45 +0000 | [diff] [blame^] | 48 | /* Dispatcher table */ |
| 49 | dispatch_fn *dispatch[DISPATCH_MAX]; |
| 50 | /* number of packets to ignore in the dispatcher */ |
| 51 | int dispatch_skip_packets; |
| 52 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 53 | /* datafellows */ |
| 54 | int compat; |
| 55 | }; |
Ben Lindstrom | f6027d3 | 2002-03-22 01:42:04 +0000 | [diff] [blame] | 56 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 57 | struct ssh *ssh_alloc_session_state(void); |
| 58 | struct ssh *ssh_packet_set_connection(struct ssh *, int, int); |
| 59 | void ssh_packet_set_timeout(struct ssh *, int, int); |
| 60 | int ssh_packet_stop_discard(struct ssh *); |
| 61 | int ssh_packet_connection_af(struct ssh *); |
| 62 | void ssh_packet_set_nonblocking(struct ssh *); |
| 63 | int ssh_packet_get_connection_in(struct ssh *); |
| 64 | int ssh_packet_get_connection_out(struct ssh *); |
| 65 | void ssh_packet_close(struct ssh *); |
| 66 | void ssh_packet_set_encryption_key(struct ssh *, const u_char *, u_int, int); |
| 67 | void ssh_packet_set_protocol_flags(struct ssh *, u_int); |
| 68 | u_int ssh_packet_get_protocol_flags(struct ssh *); |
| 69 | int ssh_packet_start_compression(struct ssh *, int); |
| 70 | void ssh_packet_set_tos(struct ssh *, int); |
| 71 | void ssh_packet_set_interactive(struct ssh *, int, int, int); |
| 72 | int ssh_packet_is_interactive(struct ssh *); |
| 73 | void ssh_packet_set_server(struct ssh *); |
| 74 | void ssh_packet_set_authenticated(struct ssh *); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 75 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 76 | int ssh_packet_send1(struct ssh *); |
| 77 | int ssh_packet_send2_wrapped(struct ssh *); |
| 78 | int ssh_packet_send2(struct ssh *); |
| 79 | |
| 80 | int ssh_packet_read(struct ssh *); |
| 81 | void ssh_packet_read_expect(struct ssh *, int type); |
| 82 | int ssh_packet_read_poll(struct ssh *); |
| 83 | int ssh_packet_read_poll1(struct ssh *, u_char *); |
| 84 | int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p); |
| 85 | void ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len); |
| 86 | int ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); |
| 87 | int ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); |
| 88 | |
| 89 | const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr); |
| 90 | void ssh_packet_disconnect(struct ssh *, const char *fmt, ...) |
| 91 | __attribute__((format(printf, 2, 3))) |
| 92 | __attribute__((noreturn)); |
| 93 | void ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3))); |
| 94 | |
| 95 | int ssh_set_newkeys(struct ssh *, int mode); |
| 96 | void ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *); |
| 97 | |
| 98 | typedef void *(ssh_packet_comp_alloc_func)(void *, u_int, u_int); |
| 99 | typedef void (ssh_packet_comp_free_func)(void *, void *); |
| 100 | void ssh_packet_set_compress_hooks(struct ssh *, void *, |
| 101 | ssh_packet_comp_alloc_func *, ssh_packet_comp_free_func *); |
| 102 | |
| 103 | void ssh_packet_write_poll(struct ssh *); |
| 104 | void ssh_packet_write_wait(struct ssh *); |
| 105 | int ssh_packet_have_data_to_write(struct ssh *); |
| 106 | int ssh_packet_not_very_much_data_to_write(struct ssh *); |
| 107 | |
| 108 | int ssh_packet_connection_is_on_socket(struct ssh *); |
| 109 | int ssh_packet_remaining(struct ssh *); |
| 110 | void ssh_packet_send_ignore(struct ssh *, int); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 111 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 112 | void tty_make_modes(int, struct termios *); |
| 113 | void tty_parse_modes(int, int *); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 114 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 115 | void ssh_packet_set_alive_timeouts(struct ssh *, int); |
| 116 | int ssh_packet_inc_alive_timeouts(struct ssh *); |
| 117 | int ssh_packet_set_maxsize(struct ssh *, u_int); |
| 118 | u_int ssh_packet_get_maxsize(struct ssh *); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 119 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 120 | int ssh_packet_get_state(struct ssh *, struct sshbuf *); |
| 121 | int ssh_packet_set_state(struct ssh *, struct sshbuf *); |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 122 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 123 | const char *ssh_remote_ipaddr(struct ssh *); |
Damien Miller | a5539d2 | 2003-04-09 20:50:06 +1000 | [diff] [blame] | 124 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 125 | int ssh_packet_need_rekeying(struct ssh *); |
| 126 | void ssh_packet_set_rekey_limits(struct ssh *, u_int32_t, time_t); |
| 127 | time_t ssh_packet_get_rekey_timeout(struct ssh *); |
Darren Tucker | e841eb0 | 2009-07-06 07:11:13 +1000 | [diff] [blame] | 128 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 129 | /* XXX FIXME */ |
| 130 | void ssh_packet_backup_state(struct ssh *, struct ssh *); |
| 131 | void ssh_packet_restore_state(struct ssh *, struct ssh *); |
| 132 | |
| 133 | void *ssh_packet_get_input(struct ssh *); |
| 134 | void *ssh_packet_get_output(struct ssh *); |
| 135 | |
| 136 | /* new API */ |
| 137 | int sshpkt_start(struct ssh *ssh, u_char type); |
| 138 | int sshpkt_send(struct ssh *ssh); |
| 139 | int sshpkt_disconnect(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3))); |
| 140 | int sshpkt_add_padding(struct ssh *, u_char); |
| 141 | |
| 142 | int sshpkt_put(struct ssh *ssh, const void *v, size_t len); |
| 143 | int sshpkt_putb(struct ssh *ssh, const struct sshbuf *b); |
| 144 | int sshpkt_put_u8(struct ssh *ssh, u_char val); |
| 145 | int sshpkt_put_u32(struct ssh *ssh, u_int32_t val); |
| 146 | int sshpkt_put_u64(struct ssh *ssh, u_int64_t val); |
| 147 | int sshpkt_put_string(struct ssh *ssh, const void *v, size_t len); |
| 148 | int sshpkt_put_cstring(struct ssh *ssh, const void *v); |
| 149 | int sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v); |
| 150 | int sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g); |
| 151 | int sshpkt_put_bignum1(struct ssh *ssh, const BIGNUM *v); |
| 152 | int sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v); |
| 153 | |
| 154 | int sshpkt_get(struct ssh *ssh, void *valp, size_t len); |
| 155 | int sshpkt_get_u8(struct ssh *ssh, u_char *valp); |
| 156 | int sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp); |
| 157 | int sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp); |
| 158 | int sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp); |
| 159 | int sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp); |
| 160 | int sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp); |
| 161 | int sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g); |
| 162 | int sshpkt_get_bignum1(struct ssh *ssh, BIGNUM *v); |
| 163 | int sshpkt_get_bignum2(struct ssh *ssh, BIGNUM *v); |
| 164 | int sshpkt_get_end(struct ssh *ssh); |
| 165 | const u_char *sshpkt_ptr(struct ssh *, size_t *lenp); |
| 166 | |
| 167 | /* OLD API */ |
| 168 | extern struct ssh *active_state; |
| 169 | #include "opacket.h" |
Darren Tucker | f7288d7 | 2009-06-21 18:12:20 +1000 | [diff] [blame] | 170 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 171 | #endif /* PACKET_H */ |