1 /* $MirOS: src/usr.bin/ssh/packet.h,v 1.7 2013/10/31 20:07:12 tg Exp $ */
2 /* $OpenBSD: packet.h,v 1.52 2009/06/27 09:29:06 andreas Exp $ */
3 
4 /*
5  * Author: Tatu Ylonen <ylo@cs.hut.fi>
6  * Copyright © 2013
7  *	Thorsten “mirabilos” Glaser <tg@mirbsd.org>
8  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
9  *                    All rights reserved
10  * Interface for the packet protocol functions.
11  *
12  * As far as I am concerned, the code I have written for this software
13  * can be used freely for any purpose.  Any derived versions of this
14  * software must be clearly marked as such, and if the derived work is
15  * incompatible with the protocol description in the RFC file, it must be
16  * called by a name other than "ssh" or "Secure Shell".
17  */
18 
19 #ifndef PACKET_H
20 #define PACKET_H
21 
22 #include <termios.h>
23 
24 #include <openssl/bn.h>
25 
26 void     packet_set_connection(int, int);
27 void     packet_set_timeout(int, int);
28 void     packet_set_nonblocking(void);
29 int      packet_get_connection_in(void);
30 int      packet_get_connection_out(void);
31 void     packet_close(void);
32 void	 packet_set_encryption_key(const u_char *, u_int, int);
33 u_int	 packet_get_encryption_key(u_char *);
34 void     packet_set_protocol_flags(u_int);
35 u_int	 packet_get_protocol_flags(void);
36 void     packet_start_compression(int);
37 void     packet_set_interactive(int);
38 int      packet_is_interactive(void);
39 void     packet_set_server(void);
40 void     packet_set_authenticated(void);
41 
42 void     packet_start(u_char);
43 void     packet_put_char(int ch);
44 void     packet_put_int(u_int value);
45 void     packet_put_int64(u_int64_t value);
46 void     packet_put_bignum(BIGNUM * value);
47 void     packet_put_bignum2(BIGNUM * value);
48 void     packet_put_string(const void *buf, u_int len);
49 void     packet_put_cstring(const char *str);
50 void     packet_put_raw(const void *buf, u_int len);
51 void     packet_send(void);
52 
53 int      packet_read(void);
54 void     packet_read_expect(int type);
55 int      packet_read_poll(void);
56 void     packet_process_incoming(const char *buf, u_int len);
57 int      packet_read_seqnr(u_int32_t *seqnr_p);
58 int      packet_read_poll_seqnr(u_int32_t *seqnr_p);
59 
60 u_int	 packet_get_char(void);
61 u_int	 packet_get_int(void);
62 u_int64_t packet_get_int64(void);
63 void     packet_get_bignum(BIGNUM * value);
64 void     packet_get_bignum2(BIGNUM * value);
65 void	*packet_get_raw(u_int *length_ptr);
66 void	*packet_get_string(u_int *length_ptr);
67 void	*packet_get_string_ptr(u_int *length_ptr);
68 void     packet_disconnect(const char *fmt,...) __dead __attribute__((__format__(__printf__, 1, 2)));
69 void     packet_send_debug(const char *fmt,...) __attribute__((__format__(__printf__, 1, 2)));
70 
71 void	 set_newkeys(int mode);
72 int	 packet_get_keyiv_len(int);
73 void	 packet_get_keyiv(int, u_char *, u_int);
74 int	 packet_get_keycontext(int, u_char *);
75 void	 packet_set_keycontext(int, u_char *);
76 void	 packet_get_state(int, u_int32_t *, u_int64_t *, u_int32_t *, u_int64_t *);
77 void	 packet_set_state(int, u_int32_t, u_int64_t, u_int32_t, u_int64_t);
78 int	 packet_get_ssh1_cipher(void);
79 void	 packet_set_iv(int, u_char *);
80 void	*packet_get_newkeys(int);
81 
82 void     packet_write_poll(void);
83 void     packet_write_wait(void);
84 int      packet_have_data_to_write(void);
85 int      packet_not_very_much_data_to_write(void);
86 
87 int	 packet_connection_is_on_socket(void);
88 int	 packet_connection_is_ipv4(void);
89 int	 packet_remaining(void);
90 void	 packet_send_ignore(int);
91 void	 packet_add_padding(u_char);
92 
93 void	 tty_make_modes(int, struct termios *);
94 void	 tty_parse_modes(int, int *);
95 
96 void	 packet_set_alive_timeouts(int);
97 int	 packet_inc_alive_timeouts(void);
98 int	 packet_set_maxsize(u_int);
99 u_int	 packet_get_maxsize(void);
100 
101 /* don't allow remaining bytes after the end of the message */
102 #define packet_check_eom() \
103 do { \
104 	int _len = packet_remaining(); \
105 	if (_len > 0) { \
106 		logit("Packet integrity error (%d bytes remaining) at %s:%d", \
107 		    _len ,__FILE__, __LINE__); \
108 		packet_disconnect("Packet integrity error."); \
109 	} \
110 } while (0)
111 
112 int	 packet_need_rekeying(void);
113 void	 packet_set_rekey_limit(u_int32_t);
114 
115 void	 packet_backup_state(void);
116 void	 packet_restore_state(void);
117 
118 void	*packet_get_input(void);
119 void	*packet_get_output(void);
120 
121 #endif				/* PACKET_H */
122