1 /* $OpenBSD: packet.h,v 1.66 2015/01/30 01:13:33 djm Exp $ */ 2 3 /* 4 * Author: Tatu Ylonen <ylo@cs.hut.fi> 5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 6 * All rights reserved 7 * Interface for the packet protocol functions. 8 * 9 * As far as I am concerned, the code I have written for this software 10 * can be used freely for any purpose. Any derived versions of this 11 * software must be clearly marked as such, and if the derived work is 12 * incompatible with the protocol description in the RFC file, it must be 13 * called by a name other than "ssh" or "Secure Shell". 14 */ 15 16 #ifndef PACKET_H 17 #define PACKET_H 18 19 #include <termios.h> 20 21 #include <openssl/bn.h> 22 #include <openssl/ec.h> 23 #include <sys/signal.h> 24 #include <sys/queue.h> 25 26 struct kex; 27 struct sshkey; 28 struct sshbuf; 29 struct session_state; /* private session data */ 30 31 #include "dispatch.h" /* typedef, DISPATCH_MAX */ 32 33 struct key_entry { 34 TAILQ_ENTRY(key_entry) next; 35 struct sshkey *key; 36 }; 37 38 struct ssh { 39 /* Session state */ 40 struct session_state *state; 41 42 /* Key exchange */ 43 struct kex *kex; 44 45 /* cached remote ip address and port*/ 46 char *remote_ipaddr; 47 int remote_port; 48 49 /* Dispatcher table */ 50 dispatch_fn *dispatch[DISPATCH_MAX]; 51 /* number of packets to ignore in the dispatcher */ 52 int dispatch_skip_packets; 53 54 /* datafellows */ 55 int compat; 56 57 /* Lists for private and public keys */ 58 TAILQ_HEAD(, key_entry) private_keys; 59 TAILQ_HEAD(, key_entry) public_keys; 60 61 /* APP data */ 62 void *app_data; 63 }; 64 65 struct ssh *ssh_alloc_session_state(void); 66 struct ssh *ssh_packet_set_connection(struct ssh *, int, int); 67 void ssh_packet_set_timeout(struct ssh *, int, int); 68 int ssh_packet_stop_discard(struct ssh *); 69 int ssh_packet_connection_af(struct ssh *); 70 void ssh_packet_set_nonblocking(struct ssh *); 71 int ssh_packet_get_connection_in(struct ssh *); 72 int ssh_packet_get_connection_out(struct ssh *); 73 void ssh_packet_close(struct ssh *); 74 void ssh_packet_set_encryption_key(struct ssh *, const u_char *, u_int, int); 75 void ssh_packet_set_protocol_flags(struct ssh *, u_int); 76 u_int ssh_packet_get_protocol_flags(struct ssh *); 77 int ssh_packet_start_compression(struct ssh *, int); 78 void ssh_packet_set_tos(struct ssh *, int); 79 void ssh_packet_set_interactive(struct ssh *, int, int, int); 80 int ssh_packet_is_interactive(struct ssh *); 81 void ssh_packet_set_server(struct ssh *); 82 void ssh_packet_set_authenticated(struct ssh *); 83 84 int ssh_packet_send1(struct ssh *); 85 int ssh_packet_send2_wrapped(struct ssh *); 86 int ssh_packet_send2(struct ssh *); 87 88 int ssh_packet_read(struct ssh *); 89 int ssh_packet_read_expect(struct ssh *, u_int type); 90 int ssh_packet_read_poll(struct ssh *); 91 int ssh_packet_read_poll1(struct ssh *, u_char *); 92 int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p); 93 int ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len); 94 int ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); 95 int ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p); 96 97 const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr); 98 void ssh_packet_disconnect(struct ssh *, const char *fmt, ...) 99 __attribute__((format(printf, 2, 3))) 100 __attribute__((noreturn)); 101 void ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3))); 102 103 int ssh_set_newkeys(struct ssh *, int mode); 104 void ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *); 105 106 typedef void *(ssh_packet_comp_alloc_func)(void *, u_int, u_int); 107 typedef void (ssh_packet_comp_free_func)(void *, void *); 108 void ssh_packet_set_compress_hooks(struct ssh *, void *, 109 ssh_packet_comp_alloc_func *, ssh_packet_comp_free_func *); 110 111 int ssh_packet_write_poll(struct ssh *); 112 int ssh_packet_write_wait(struct ssh *); 113 int ssh_packet_have_data_to_write(struct ssh *); 114 int ssh_packet_not_very_much_data_to_write(struct ssh *); 115 116 int ssh_packet_connection_is_on_socket(struct ssh *); 117 int ssh_packet_remaining(struct ssh *); 118 void ssh_packet_send_ignore(struct ssh *, int); 119 120 void tty_make_modes(int, struct termios *); 121 void tty_parse_modes(int, int *); 122 123 void ssh_packet_set_alive_timeouts(struct ssh *, int); 124 int ssh_packet_inc_alive_timeouts(struct ssh *); 125 int ssh_packet_set_maxsize(struct ssh *, u_int); 126 u_int ssh_packet_get_maxsize(struct ssh *); 127 128 int ssh_packet_get_state(struct ssh *, struct sshbuf *); 129 int ssh_packet_set_state(struct ssh *, struct sshbuf *); 130 131 const char *ssh_remote_ipaddr(struct ssh *); 132 133 int ssh_packet_need_rekeying(struct ssh *); 134 void ssh_packet_set_rekey_limits(struct ssh *, u_int32_t, time_t); 135 time_t ssh_packet_get_rekey_timeout(struct ssh *); 136 137 /* XXX FIXME */ 138 void ssh_packet_backup_state(struct ssh *, struct ssh *); 139 void ssh_packet_restore_state(struct ssh *, 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_disconnect(struct ssh *, const char *fmt, ...) 148 __attribute__((format(printf, 2, 3))); 149 int sshpkt_add_padding(struct ssh *, u_char); 150 void sshpkt_fatal(struct ssh *ssh, const char *tag, int r); 151 152 int sshpkt_put(struct ssh *ssh, const void *v, size_t len); 153 int sshpkt_putb(struct ssh *ssh, const struct sshbuf *b); 154 int sshpkt_put_u8(struct ssh *ssh, u_char val); 155 int sshpkt_put_u32(struct ssh *ssh, u_int32_t val); 156 int sshpkt_put_u64(struct ssh *ssh, u_int64_t val); 157 int sshpkt_put_string(struct ssh *ssh, const void *v, size_t len); 158 int sshpkt_put_cstring(struct ssh *ssh, const void *v); 159 int sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v); 160 int sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g); 161 int sshpkt_put_bignum1(struct ssh *ssh, const BIGNUM *v); 162 int sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v); 163 164 int sshpkt_get(struct ssh *ssh, void *valp, size_t len); 165 int sshpkt_get_u8(struct ssh *ssh, u_char *valp); 166 int sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp); 167 int sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp); 168 int sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp); 169 int sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp); 170 int sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp); 171 int sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g); 172 int sshpkt_get_bignum1(struct ssh *ssh, BIGNUM *v); 173 int sshpkt_get_bignum2(struct ssh *ssh, BIGNUM *v); 174 int sshpkt_get_end(struct ssh *ssh); 175 const u_char *sshpkt_ptr(struct ssh *, size_t *lenp); 176 177 /* OLD API */ 178 extern struct ssh *active_state; 179 #include "opacket.h" 180 181 #endif /* PACKET_H */ 182