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