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