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