djm@openbsd.org | 7be8572 | 2019-01-21 09:54:11 +0000 | [diff] [blame^] | 1 | /* $OpenBSD: packet.h,v 1.89 2019/01/21 09:54:11 djm 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> |
Damien Miller | 773dda2 | 2015-01-30 23:10:17 +1100 | [diff] [blame] | 25 | # else /* OPENSSL_HAS_ECC */ |
| 26 | # define EC_KEY void |
| 27 | # define EC_GROUP void |
| 28 | # define EC_POINT void |
| 29 | # endif /* OPENSSL_HAS_ECC */ |
| 30 | #else /* WITH_OPENSSL */ |
| 31 | # define BIGNUM void |
| 32 | # define EC_KEY void |
| 33 | # define EC_GROUP void |
| 34 | # define EC_POINT void |
| 35 | #endif /* WITH_OPENSSL */ |
| 36 | |
Tim Rice | 9102092 | 2015-02-23 22:06:56 -0800 | [diff] [blame] | 37 | #include <signal.h> |
Damien Miller | 62f678d | 2015-02-24 09:02:54 +1100 | [diff] [blame] | 38 | #include "openbsd-compat/sys-queue.h" |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 39 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 40 | struct kex; |
| 41 | struct sshkey; |
| 42 | struct sshbuf; |
| 43 | struct session_state; /* private session data */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 44 | |
markus@openbsd.org | 3fdc88a | 2015-01-19 20:07:45 +0000 | [diff] [blame] | 45 | #include "dispatch.h" /* typedef, DISPATCH_MAX */ |
| 46 | |
markus@openbsd.org | f582f0e | 2015-01-19 20:30:23 +0000 | [diff] [blame] | 47 | struct key_entry { |
| 48 | TAILQ_ENTRY(key_entry) next; |
| 49 | struct sshkey *key; |
| 50 | }; |
| 51 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 52 | struct ssh { |
| 53 | /* Session state */ |
| 54 | struct session_state *state; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 55 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 56 | /* Key exchange */ |
| 57 | struct kex *kex; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 58 | |
djm@openbsd.org | 9576726 | 2016-03-07 19:02:43 +0000 | [diff] [blame] | 59 | /* cached local and remote ip addresses and ports */ |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 60 | char *remote_ipaddr; |
| 61 | int remote_port; |
djm@openbsd.org | 9576726 | 2016-03-07 19:02:43 +0000 | [diff] [blame] | 62 | char *local_ipaddr; |
| 63 | int local_port; |
djm@openbsd.org | 35eb33f | 2017-10-25 00:17:08 +0000 | [diff] [blame] | 64 | char *rdomain_in; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 65 | |
djm@openbsd.org | 07edd7e | 2017-02-03 23:03:33 +0000 | [diff] [blame] | 66 | /* Optional preamble for log messages (e.g. username) */ |
| 67 | char *log_preamble; |
| 68 | |
markus@openbsd.org | 3fdc88a | 2015-01-19 20:07:45 +0000 | [diff] [blame] | 69 | /* Dispatcher table */ |
| 70 | dispatch_fn *dispatch[DISPATCH_MAX]; |
| 71 | /* number of packets to ignore in the dispatcher */ |
| 72 | int dispatch_skip_packets; |
| 73 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 74 | /* datafellows */ |
| 75 | int compat; |
markus@openbsd.org | f582f0e | 2015-01-19 20:30:23 +0000 | [diff] [blame] | 76 | |
| 77 | /* Lists for private and public keys */ |
| 78 | TAILQ_HEAD(, key_entry) private_keys; |
| 79 | TAILQ_HEAD(, key_entry) public_keys; |
| 80 | |
markus@openbsd.org | 5f4082d | 2017-05-30 14:18:15 +0000 | [diff] [blame] | 81 | /* Client/Server authentication context */ |
| 82 | void *authctxt; |
| 83 | |
djm@openbsd.org | dbee411 | 2017-09-12 06:32:07 +0000 | [diff] [blame] | 84 | /* Channels context */ |
| 85 | struct ssh_channels *chanctxt; |
| 86 | |
markus@openbsd.org | f582f0e | 2015-01-19 20:30:23 +0000 | [diff] [blame] | 87 | /* APP data */ |
| 88 | void *app_data; |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 89 | }; |
Ben Lindstrom | f6027d3 | 2002-03-22 01:42:04 +0000 | [diff] [blame] | 90 | |
djm@openbsd.org | 39af7b4 | 2016-10-11 21:47:45 +0000 | [diff] [blame] | 91 | typedef int (ssh_packet_hook_fn)(struct ssh *, struct sshbuf *, |
| 92 | u_char *, void *); |
| 93 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 94 | struct ssh *ssh_alloc_session_state(void); |
| 95 | struct ssh *ssh_packet_set_connection(struct ssh *, int, int); |
| 96 | void ssh_packet_set_timeout(struct ssh *, int, int); |
| 97 | int ssh_packet_stop_discard(struct ssh *); |
| 98 | int ssh_packet_connection_af(struct ssh *); |
| 99 | void ssh_packet_set_nonblocking(struct ssh *); |
| 100 | int ssh_packet_get_connection_in(struct ssh *); |
| 101 | int ssh_packet_get_connection_out(struct ssh *); |
| 102 | void ssh_packet_close(struct ssh *); |
djm@openbsd.org | 39af7b4 | 2016-10-11 21:47:45 +0000 | [diff] [blame] | 103 | void ssh_packet_set_input_hook(struct ssh *, ssh_packet_hook_fn *, void *); |
markus@openbsd.org | 1e0cdf8 | 2017-05-31 08:09:45 +0000 | [diff] [blame] | 104 | void ssh_packet_clear_keys(struct ssh *); |
| 105 | void ssh_clear_newkeys(struct ssh *, int); |
djm@openbsd.org | 39af7b4 | 2016-10-11 21:47:45 +0000 | [diff] [blame] | 106 | |
djm@openbsd.org | 19bcf2e | 2016-02-08 10:57:07 +0000 | [diff] [blame] | 107 | int ssh_packet_is_rekeying(struct ssh *); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 108 | void ssh_packet_set_protocol_flags(struct ssh *, u_int); |
| 109 | u_int ssh_packet_get_protocol_flags(struct ssh *); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 110 | void ssh_packet_set_tos(struct ssh *, int); |
| 111 | void ssh_packet_set_interactive(struct ssh *, int, int, int); |
| 112 | int ssh_packet_is_interactive(struct ssh *); |
| 113 | void ssh_packet_set_server(struct ssh *); |
| 114 | void ssh_packet_set_authenticated(struct ssh *); |
markus@openbsd.org | 8d05784 | 2016-09-30 09:19:13 +0000 | [diff] [blame] | 115 | void ssh_packet_set_mux(struct ssh *); |
| 116 | int ssh_packet_get_mux(struct ssh *); |
djm@openbsd.org | 07edd7e | 2017-02-03 23:03:33 +0000 | [diff] [blame] | 117 | int ssh_packet_set_log_preamble(struct ssh *, const char *, ...) |
| 118 | __attribute__((format(printf, 2, 3))); |
markus@openbsd.org | 8d05784 | 2016-09-30 09:19:13 +0000 | [diff] [blame] | 119 | |
| 120 | int ssh_packet_log_type(u_char); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 121 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 122 | int ssh_packet_send2_wrapped(struct ssh *); |
| 123 | int ssh_packet_send2(struct ssh *); |
| 124 | |
| 125 | int ssh_packet_read(struct ssh *); |
djm@openbsd.org | 4509b5d | 2015-01-30 01:13:33 +0000 | [diff] [blame] | 126 | int ssh_packet_read_expect(struct ssh *, u_int type); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 127 | int ssh_packet_read_poll(struct ssh *); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 128 | int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p); |
djm@openbsd.org | fae7bbe | 2015-01-28 21:15:47 +0000 | [diff] [blame] | 129 | int ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 130 | int ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); |
| 131 | int ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); |
| 132 | |
| 133 | const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr); |
| 134 | void ssh_packet_disconnect(struct ssh *, const char *fmt, ...) |
| 135 | __attribute__((format(printf, 2, 3))) |
| 136 | __attribute__((noreturn)); |
| 137 | void ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3))); |
| 138 | |
| 139 | int ssh_set_newkeys(struct ssh *, int mode); |
| 140 | void ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *); |
| 141 | |
djm@openbsd.org | 4509b5d | 2015-01-30 01:13:33 +0000 | [diff] [blame] | 142 | int ssh_packet_write_poll(struct ssh *); |
| 143 | int ssh_packet_write_wait(struct ssh *); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 144 | int ssh_packet_have_data_to_write(struct ssh *); |
| 145 | int ssh_packet_not_very_much_data_to_write(struct ssh *); |
| 146 | |
| 147 | int ssh_packet_connection_is_on_socket(struct ssh *); |
| 148 | int ssh_packet_remaining(struct ssh *); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 149 | |
markus@openbsd.org | 89dd615 | 2018-07-09 21:20:26 +0000 | [diff] [blame] | 150 | void ssh_tty_make_modes(struct ssh *, int, struct termios *); |
| 151 | void ssh_tty_parse_modes(struct ssh *, int); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 152 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 153 | void ssh_packet_set_alive_timeouts(struct ssh *, int); |
| 154 | int ssh_packet_inc_alive_timeouts(struct ssh *); |
| 155 | int ssh_packet_set_maxsize(struct ssh *, u_int); |
| 156 | u_int ssh_packet_get_maxsize(struct ssh *); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 157 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 158 | int ssh_packet_get_state(struct ssh *, struct sshbuf *); |
| 159 | int ssh_packet_set_state(struct ssh *, struct sshbuf *); |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 160 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 161 | const char *ssh_remote_ipaddr(struct ssh *); |
djm@openbsd.org | a4b9e0f | 2015-12-11 03:24:25 +0000 | [diff] [blame] | 162 | int ssh_remote_port(struct ssh *); |
djm@openbsd.org | 9576726 | 2016-03-07 19:02:43 +0000 | [diff] [blame] | 163 | const char *ssh_local_ipaddr(struct ssh *); |
| 164 | int ssh_local_port(struct ssh *); |
djm@openbsd.org | 35eb33f | 2017-10-25 00:17:08 +0000 | [diff] [blame] | 165 | const char *ssh_packet_rdomain_in(struct ssh *); |
Damien Miller | a5539d2 | 2003-04-09 20:50:06 +1000 | [diff] [blame] | 166 | |
dtucker@openbsd.org | c998bf0 | 2017-02-03 02:56:00 +0000 | [diff] [blame] | 167 | void ssh_packet_set_rekey_limits(struct ssh *, u_int64_t, u_int32_t); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 168 | time_t ssh_packet_get_rekey_timeout(struct ssh *); |
Darren Tucker | e841eb0 | 2009-07-06 07:11:13 +1000 | [diff] [blame] | 169 | |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 170 | void *ssh_packet_get_input(struct ssh *); |
| 171 | void *ssh_packet_get_output(struct ssh *); |
| 172 | |
| 173 | /* new API */ |
| 174 | int sshpkt_start(struct ssh *ssh, u_char type); |
| 175 | int sshpkt_send(struct ssh *ssh); |
djm@openbsd.org | 4509b5d | 2015-01-30 01:13:33 +0000 | [diff] [blame] | 176 | int sshpkt_disconnect(struct ssh *, const char *fmt, ...) |
| 177 | __attribute__((format(printf, 2, 3))); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 178 | int sshpkt_add_padding(struct ssh *, u_char); |
djm@openbsd.org | ad60b11 | 2019-01-19 21:33:13 +0000 | [diff] [blame] | 179 | void sshpkt_fatal(struct ssh *ssh, int r, const char *fmt, ...) |
| 180 | __attribute__((format(printf, 3, 4))); |
djm@openbsd.org | dbee411 | 2017-09-12 06:32:07 +0000 | [diff] [blame] | 181 | int sshpkt_msg_ignore(struct ssh *, u_int); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 182 | |
| 183 | int sshpkt_put(struct ssh *ssh, const void *v, size_t len); |
| 184 | int sshpkt_putb(struct ssh *ssh, const struct sshbuf *b); |
| 185 | int sshpkt_put_u8(struct ssh *ssh, u_char val); |
| 186 | int sshpkt_put_u32(struct ssh *ssh, u_int32_t val); |
| 187 | int sshpkt_put_u64(struct ssh *ssh, u_int64_t val); |
| 188 | int sshpkt_put_string(struct ssh *ssh, const void *v, size_t len); |
| 189 | int sshpkt_put_cstring(struct ssh *ssh, const void *v); |
| 190 | int sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v); |
| 191 | int sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 192 | int sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v); |
| 193 | |
| 194 | int sshpkt_get(struct ssh *ssh, void *valp, size_t len); |
| 195 | int sshpkt_get_u8(struct ssh *ssh, u_char *valp); |
| 196 | int sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp); |
| 197 | int sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp); |
| 198 | int sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp); |
| 199 | int sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp); |
djm@openbsd.org | dbee411 | 2017-09-12 06:32:07 +0000 | [diff] [blame] | 200 | int sshpkt_peek_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 201 | int sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp); |
| 202 | int sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g); |
djm@openbsd.org | 7be8572 | 2019-01-21 09:54:11 +0000 | [diff] [blame^] | 203 | int sshpkt_get_bignum2(struct ssh *ssh, BIGNUM **valp); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 204 | int sshpkt_get_end(struct ssh *ssh); |
dtucker@openbsd.org | 48c23a3 | 2017-12-10 05:55:29 +0000 | [diff] [blame] | 205 | void sshpkt_fmt_connection_id(struct ssh *ssh, char *s, size_t l); |
markus@openbsd.org | 091c302 | 2015-01-19 19:52:16 +0000 | [diff] [blame] | 206 | const u_char *sshpkt_ptr(struct ssh *, size_t *lenp); |
| 207 | |
Damien Miller | 773dda2 | 2015-01-30 23:10:17 +1100 | [diff] [blame] | 208 | #if !defined(WITH_OPENSSL) |
| 209 | # undef BIGNUM |
| 210 | # undef EC_KEY |
| 211 | # undef EC_GROUP |
| 212 | # undef EC_POINT |
| 213 | #elif !defined(OPENSSL_HAS_ECC) |
| 214 | # undef EC_KEY |
| 215 | # undef EC_GROUP |
| 216 | # undef EC_POINT |
| 217 | #endif |
| 218 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 219 | #endif /* PACKET_H */ |