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