1 /* $OpenBSD: packet.h,v 1.90 2019/01/21 10:35:09 djm Exp $ */ 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 21 #include <openssl/bn.h> 22 #include <openssl/ec.h> 23 #include <sys/signal.h> 24 #include <sys/queue.h> 25 26 struct kex; 27 struct sshkey; 28 struct sshbuf; 29 struct session_state; /* private session data */ 30 31 #include "dispatch.h" /* typedef, DISPATCH_MAX */ 32 33 struct key_entry { 34 TAILQ_ENTRY(key_entry) next; 35 struct sshkey *key; 36 }; 37 38 struct ssh { 39 /* Session state */ 40 struct session_state *state; 41 42 /* Key exchange */ 43 struct kex *kex; 44 45 /* cached local and remote ip addresses and ports */ 46 char *remote_ipaddr; 47 int remote_port; 48 char *local_ipaddr; 49 int local_port; 50 char *rdomain_in; 51 52 /* Optional preamble for log messages (e.g. username) */ 53 char *log_preamble; 54 55 /* Dispatcher table */ 56 dispatch_fn *dispatch[DISPATCH_MAX]; 57 /* number of packets to ignore in the dispatcher */ 58 int dispatch_skip_packets; 59 60 /* datafellows */ 61 int compat; 62 63 /* Lists for private and public keys */ 64 TAILQ_HEAD(, key_entry) private_keys; 65 TAILQ_HEAD(, key_entry) public_keys; 66 67 /* Client/Server authentication context */ 68 void *authctxt; 69 70 /* Channels context */ 71 struct ssh_channels *chanctxt; 72 73 /* APP data */ 74 void *app_data; 75 }; 76 77 typedef int (ssh_packet_hook_fn)(struct ssh *, struct sshbuf *, 78 u_char *, void *); 79 80 struct ssh *ssh_alloc_session_state(void); 81 struct ssh *ssh_packet_set_connection(struct ssh *, int, int); 82 void ssh_packet_set_timeout(struct ssh *, int, int); 83 int ssh_packet_stop_discard(struct ssh *); 84 int ssh_packet_connection_af(struct ssh *); 85 void ssh_packet_set_nonblocking(struct ssh *); 86 int ssh_packet_get_connection_in(struct ssh *); 87 int ssh_packet_get_connection_out(struct ssh *); 88 void ssh_packet_close(struct ssh *); 89 void ssh_packet_set_input_hook(struct ssh *, ssh_packet_hook_fn *, void *); 90 void ssh_packet_clear_keys(struct ssh *); 91 void ssh_clear_newkeys(struct ssh *, int); 92 93 int ssh_packet_is_rekeying(struct ssh *); 94 void ssh_packet_set_protocol_flags(struct ssh *, u_int); 95 u_int ssh_packet_get_protocol_flags(struct ssh *); 96 void ssh_packet_set_tos(struct ssh *, int); 97 void ssh_packet_set_interactive(struct ssh *, int, int, int); 98 int ssh_packet_is_interactive(struct ssh *); 99 void ssh_packet_set_server(struct ssh *); 100 void ssh_packet_set_authenticated(struct ssh *); 101 void ssh_packet_set_mux(struct ssh *); 102 int ssh_packet_get_mux(struct ssh *); 103 int ssh_packet_set_log_preamble(struct ssh *, const char *, ...) 104 __attribute__((format(printf, 2, 3))); 105 106 int ssh_packet_log_type(u_char); 107 108 int ssh_packet_send2_wrapped(struct ssh *); 109 int ssh_packet_send2(struct ssh *); 110 111 int ssh_packet_read(struct ssh *); 112 int ssh_packet_read_expect(struct ssh *, u_int type); 113 int ssh_packet_read_poll(struct ssh *); 114 int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p); 115 int ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len); 116 int ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); 117 int ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); 118 119 const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr); 120 void ssh_packet_disconnect(struct ssh *, const char *fmt, ...) 121 __attribute__((format(printf, 2, 3))) 122 __attribute__((noreturn)); 123 void ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3))); 124 125 int ssh_set_newkeys(struct ssh *, int mode); 126 void ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *); 127 128 int ssh_packet_write_poll(struct ssh *); 129 int ssh_packet_write_wait(struct ssh *); 130 int ssh_packet_have_data_to_write(struct ssh *); 131 int ssh_packet_not_very_much_data_to_write(struct ssh *); 132 133 int ssh_packet_connection_is_on_socket(struct ssh *); 134 int ssh_packet_remaining(struct ssh *); 135 136 void ssh_tty_make_modes(struct ssh *, int, struct termios *); 137 void ssh_tty_parse_modes(struct ssh *, int); 138 139 void ssh_packet_set_alive_timeouts(struct ssh *, int); 140 int ssh_packet_inc_alive_timeouts(struct ssh *); 141 int ssh_packet_set_maxsize(struct ssh *, u_int); 142 u_int ssh_packet_get_maxsize(struct ssh *); 143 144 int ssh_packet_get_state(struct ssh *, struct sshbuf *); 145 int ssh_packet_set_state(struct ssh *, struct sshbuf *); 146 147 const char *ssh_remote_ipaddr(struct ssh *); 148 int ssh_remote_port(struct ssh *); 149 const char *ssh_local_ipaddr(struct ssh *); 150 int ssh_local_port(struct ssh *); 151 const char *ssh_packet_rdomain_in(struct ssh *); 152 153 void ssh_packet_set_rekey_limits(struct ssh *, u_int64_t, u_int32_t); 154 time_t ssh_packet_get_rekey_timeout(struct ssh *); 155 156 void *ssh_packet_get_input(struct ssh *); 157 void *ssh_packet_get_output(struct ssh *); 158 159 /* new API */ 160 int sshpkt_start(struct ssh *ssh, u_char type); 161 int sshpkt_send(struct ssh *ssh); 162 int sshpkt_disconnect(struct ssh *, const char *fmt, ...) 163 __attribute__((format(printf, 2, 3))); 164 int sshpkt_add_padding(struct ssh *, u_char); 165 void sshpkt_fatal(struct ssh *ssh, int r, const char *fmt, ...) 166 __attribute__((format(printf, 3, 4))); 167 int sshpkt_msg_ignore(struct ssh *, u_int); 168 169 int sshpkt_put(struct ssh *ssh, const void *v, size_t len); 170 int sshpkt_putb(struct ssh *ssh, const struct sshbuf *b); 171 int sshpkt_put_u8(struct ssh *ssh, u_char val); 172 int sshpkt_put_u32(struct ssh *ssh, u_int32_t val); 173 int sshpkt_put_u64(struct ssh *ssh, u_int64_t val); 174 int sshpkt_put_string(struct ssh *ssh, const void *v, size_t len); 175 int sshpkt_put_cstring(struct ssh *ssh, const void *v); 176 int sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v); 177 int sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g); 178 int sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v); 179 180 int sshpkt_get(struct ssh *ssh, void *valp, size_t len); 181 int sshpkt_get_u8(struct ssh *ssh, u_char *valp); 182 int sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp); 183 int sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp); 184 int sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp); 185 int sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp); 186 int sshpkt_peek_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp); 187 int sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp); 188 int sshpkt_getb_froms(struct ssh *ssh, struct sshbuf **valp); 189 int sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g); 190 int sshpkt_get_bignum2(struct ssh *ssh, BIGNUM **valp); 191 int sshpkt_get_end(struct ssh *ssh); 192 void sshpkt_fmt_connection_id(struct ssh *ssh, char *s, size_t l); 193 const u_char *sshpkt_ptr(struct ssh *, size_t *lenp); 194 195 #endif /* PACKET_H */ 196