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