1 /* $NetBSD: packet.h,v 1.14 2016/12/25 00:07:47 christos Exp $ */ 2 /* $OpenBSD: packet.h,v 1.74 2016/10/11 21:47:45 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 52 /* Dispatcher table */ 53 dispatch_fn *dispatch[DISPATCH_MAX]; 54 /* number of packets to ignore in the dispatcher */ 55 int dispatch_skip_packets; 56 57 /* datafellows */ 58 int compat; 59 60 /* Lists for private and public keys */ 61 TAILQ_HEAD(, key_entry) private_keys; 62 TAILQ_HEAD(, key_entry) public_keys; 63 64 /* APP data */ 65 void *app_data; 66 }; 67 68 typedef int (ssh_packet_hook_fn)(struct ssh *, struct sshbuf *, 69 u_char *, void *); 70 71 struct ssh *ssh_alloc_session_state(void); 72 struct ssh *ssh_packet_set_connection(struct ssh *, int, int); 73 void ssh_packet_set_timeout(struct ssh *, int, int); 74 int ssh_packet_stop_discard(struct ssh *); 75 int ssh_packet_connection_af(struct ssh *); 76 void ssh_packet_set_nonblocking(struct ssh *); 77 int ssh_packet_get_connection_in(struct ssh *); 78 int ssh_packet_get_connection_out(struct ssh *); 79 void ssh_packet_close(struct ssh *); 80 void ssh_packet_set_encryption_key(struct ssh *, const u_char *, u_int, int); 81 void ssh_packet_set_input_hook(struct ssh *, ssh_packet_hook_fn *, void *); 82 83 int ssh_packet_is_rekeying(struct ssh *); 84 void ssh_packet_set_protocol_flags(struct ssh *, u_int); 85 u_int ssh_packet_get_protocol_flags(struct ssh *); 86 int ssh_packet_start_compression(struct ssh *, int); 87 void ssh_packet_set_tos(struct ssh *, int); 88 void ssh_packet_set_interactive(struct ssh *, int, int, int); 89 int ssh_packet_is_interactive(struct ssh *); 90 void ssh_packet_set_server(struct ssh *); 91 void ssh_packet_set_authenticated(struct ssh *); 92 void ssh_packet_set_mux(struct ssh *); 93 int ssh_packet_get_mux(struct ssh *); 94 95 int ssh_packet_log_type(u_char); 96 97 int ssh_packet_send1(struct ssh *); 98 int ssh_packet_send2_wrapped(struct ssh *); 99 int ssh_packet_send2(struct ssh *); 100 int ssh_packet_authentication_state(void); 101 void ssh_packet_request_rekeying(void); 102 103 int ssh_packet_read(struct ssh *); 104 int ssh_packet_read_expect(struct ssh *, u_int type); 105 int ssh_packet_read_poll(struct ssh *); 106 int ssh_packet_read_poll1(struct ssh *, u_char *); 107 int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p); 108 int ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len); 109 int ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); 110 int ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); 111 112 const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr); 113 void ssh_packet_disconnect(struct ssh *, const char *fmt, ...) 114 __attribute__((format(printf, 2, 3))) 115 __attribute__((noreturn)); 116 void ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3))); 117 118 int ssh_set_newkeys(struct ssh *, int mode); 119 void ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *); 120 121 int ssh_packet_write_poll(struct ssh *); 122 int ssh_packet_write_wait(struct ssh *); 123 int ssh_packet_have_data_to_write(struct ssh *); 124 int ssh_packet_not_very_much_data_to_write(struct ssh *); 125 126 int ssh_packet_connection_is_on_socket(struct ssh *); 127 int ssh_packet_remaining(struct ssh *); 128 void ssh_packet_send_ignore(struct ssh *, int); 129 130 void tty_make_modes(int, struct termios *); 131 void tty_parse_modes(int, int *); 132 133 void ssh_packet_set_alive_timeouts(struct ssh *, int); 134 int ssh_packet_inc_alive_timeouts(struct ssh *); 135 int ssh_packet_set_maxsize(struct ssh *, u_int); 136 u_int ssh_packet_get_maxsize(struct ssh *); 137 138 int ssh_packet_get_state(struct ssh *, struct sshbuf *); 139 int ssh_packet_set_state(struct ssh *, struct sshbuf *); 140 141 const char *ssh_remote_ipaddr(struct ssh *); 142 int ssh_remote_port(struct ssh *); 143 const char *ssh_local_ipaddr(struct ssh *); 144 int ssh_local_port(struct ssh *); 145 146 void ssh_packet_set_rekey_limits(struct ssh *, u_int64_t, time_t); 147 time_t ssh_packet_get_rekey_timeout(struct ssh *); 148 149 void *ssh_packet_get_input(struct ssh *); 150 void *ssh_packet_get_output(struct ssh *); 151 152 /* new API */ 153 int sshpkt_start(struct ssh *ssh, u_char type); 154 int sshpkt_send(struct ssh *ssh); 155 int sshpkt_sendx(struct ssh *ssh); 156 int sshpkt_disconnect(struct ssh *, const char *fmt, ...) 157 __attribute__((format(printf, 2, 3))); 158 int sshpkt_add_padding(struct ssh *, u_char); 159 void sshpkt_fatal(struct ssh *ssh, const char *tag, int r) __dead; 160 161 int sshpkt_put(struct ssh *ssh, const void *v, size_t len); 162 int sshpkt_putb(struct ssh *ssh, const struct sshbuf *b); 163 int sshpkt_put_u8(struct ssh *ssh, u_char val); 164 int sshpkt_put_u32(struct ssh *ssh, u_int32_t val); 165 int sshpkt_put_u64(struct ssh *ssh, u_int64_t val); 166 int sshpkt_put_string(struct ssh *ssh, const void *v, size_t len); 167 int sshpkt_put_cstring(struct ssh *ssh, const void *v); 168 int sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v); 169 int sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g); 170 int sshpkt_put_bignum1(struct ssh *ssh, const BIGNUM *v); 171 int sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v); 172 173 int sshpkt_get(struct ssh *ssh, void *valp, size_t len); 174 int sshpkt_get_u8(struct ssh *ssh, u_char *valp); 175 int sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp); 176 int sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp); 177 int sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp); 178 int sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp); 179 int sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp); 180 int sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g); 181 int sshpkt_get_bignum1(struct ssh *ssh, BIGNUM *v); 182 int sshpkt_get_bignum2(struct ssh *ssh, BIGNUM *v); 183 int sshpkt_get_end(struct ssh *ssh); 184 const u_char *sshpkt_ptr(struct ssh *, size_t *lenp); 185 186 /* OLD API */ 187 extern struct ssh *active_state; 188 #include "opacket.h" 189 190 #endif /* PACKET_H */ 191