xref: /openbsd-src/usr.bin/ssh/packet.h (revision 3a3fbb3f2e2521ab7c4a56b7ff7462ebd9095ec5)
1 /*
2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4  *                    All rights reserved
5  * Interface for the packet protocol functions.
6  *
7  * As far as I am concerned, the code I have written for this software
8  * can be used freely for any purpose.  Any derived versions of this
9  * software must be clearly marked as such, and if the derived work is
10  * incompatible with the protocol description in the RFC file, it must be
11  * called by a name other than "ssh" or "Secure Shell".
12  */
13 
14 /* RCSID("$OpenBSD: packet.h,v 1.32 2001/12/28 14:50:54 markus Exp $"); */
15 
16 #ifndef PACKET_H
17 #define PACKET_H
18 
19 #include <openssl/bn.h>
20 
21 void     packet_set_connection(int, int);
22 void     packet_set_nonblocking(void);
23 int      packet_get_connection_in(void);
24 int      packet_get_connection_out(void);
25 void     packet_close(void);
26 void	 packet_set_encryption_key(const u_char *, u_int, int);
27 void     packet_set_protocol_flags(u_int);
28 u_int	 packet_get_protocol_flags(void);
29 void     packet_start_compression(int);
30 void     packet_set_interactive(int);
31 int      packet_is_interactive(void);
32 
33 void     packet_start(u_char);
34 void     packet_put_char(int ch);
35 void     packet_put_int(u_int value);
36 void     packet_put_bignum(BIGNUM * value);
37 void     packet_put_bignum2(BIGNUM * value);
38 void     packet_put_string(const void *buf, u_int len);
39 void     packet_put_cstring(const char *str);
40 void     packet_put_raw(const void *buf, u_int len);
41 void     packet_send(void);
42 
43 int      packet_read(void);
44 void     packet_read_expect(int type);
45 int      packet_read_poll(void);
46 void     packet_process_incoming(const char *buf, u_int len);
47 int      packet_read_seqnr(u_int32_t *seqnr_p);
48 int      packet_read_poll_seqnr(u_int32_t *seqnr_p);
49 
50 u_int	 packet_get_char(void);
51 u_int	 packet_get_int(void);
52 void     packet_get_bignum(BIGNUM * value);
53 void     packet_get_bignum2(BIGNUM * value);
54 void	*packet_get_raw(int *length_ptr);
55 void	*packet_get_string(u_int *length_ptr);
56 void     packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
57 void     packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
58 
59 void     packet_write_poll(void);
60 void     packet_write_wait(void);
61 int      packet_have_data_to_write(void);
62 int      packet_not_very_much_data_to_write(void);
63 
64 int	 packet_connection_is_on_socket(void);
65 int	 packet_connection_is_ipv4(void);
66 int	 packet_remaining(void);
67 void	 packet_send_ignore(int);
68 void	 packet_add_padding(u_char);
69 
70 void	 tty_make_modes(int, struct termios *);
71 void	 tty_parse_modes(int, int *);
72 
73 extern int max_packet_size;
74 int      packet_set_maxsize(int);
75 #define  packet_get_maxsize() max_packet_size
76 
77 /* don't allow remaining bytes after the end of the message */
78 #define packet_check_eom() \
79 do { \
80 	int _len = packet_remaining(); \
81 	if (_len > 0) { \
82 		log("Packet integrity error (%d bytes remaining) at %s:%d", \
83 		    _len ,__FILE__, __LINE__); \
84 		packet_disconnect("Packet integrity error."); \
85 	} \
86 } while (0)
87 
88 #endif				/* PACKET_H */
89