xref: /freebsd/crypto/openssh/packet.h (revision ee2ea5ceafed78a5bd9810beb9e3ca927180c226)
1 /*	$OpenBSD: packet.h,v 1.33 2002/03/04 17:27:39 stevesk Exp $	*/
2 /*	$FreeBSD$	*/
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 <openssl/bn.h>
21 
22 void     packet_set_connection(int, int);
23 void     packet_set_nonblocking(void);
24 int      packet_get_connection_in(void);
25 int      packet_get_connection_out(void);
26 void     packet_close(void);
27 void	 packet_set_encryption_key(const u_char *, u_int, int);
28 void     packet_set_protocol_flags(u_int);
29 u_int	 packet_get_protocol_flags(void);
30 void     packet_start_compression(int);
31 void     packet_set_interactive(int);
32 int      packet_is_interactive(void);
33 
34 void     packet_start(u_char);
35 void     packet_put_char(int ch);
36 void     packet_put_int(u_int value);
37 void     packet_put_bignum(BIGNUM * value);
38 void     packet_put_bignum2(BIGNUM * value);
39 void     packet_put_string(const void *buf, u_int len);
40 void     packet_put_cstring(const char *str);
41 void     packet_put_raw(const void *buf, u_int len);
42 void     packet_send(void);
43 
44 int      packet_read(void);
45 void     packet_read_expect(int type);
46 int      packet_read_poll(void);
47 void     packet_process_incoming(const char *buf, u_int len);
48 int      packet_read_seqnr(u_int32_t *seqnr_p);
49 int      packet_read_poll_seqnr(u_int32_t *seqnr_p);
50 
51 u_int	 packet_get_char(void);
52 u_int	 packet_get_int(void);
53 void     packet_get_bignum(BIGNUM * value);
54 void     packet_get_bignum2(BIGNUM * value);
55 void	*packet_get_raw(int *length_ptr);
56 void	*packet_get_string(u_int *length_ptr);
57 void     packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
58 void     packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
59 
60 void     packet_write_poll(void);
61 void     packet_write_wait(void);
62 int      packet_have_data_to_write(void);
63 int      packet_not_very_much_data_to_write(void);
64 
65 int	 packet_connection_is_on_socket(void);
66 int	 packet_connection_is_ipv4(void);
67 int	 packet_remaining(void);
68 void	 packet_send_ignore(int);
69 void	 packet_add_padding(u_char);
70 
71 void	 tty_make_modes(int, struct termios *);
72 void	 tty_parse_modes(int, int *);
73 
74 extern int max_packet_size;
75 int      packet_set_maxsize(int);
76 #define  packet_get_maxsize() max_packet_size
77 
78 /* don't allow remaining bytes after the end of the message */
79 #define packet_check_eom() \
80 do { \
81 	int _len = packet_remaining(); \
82 	if (_len > 0) { \
83 		log("Packet integrity error (%d bytes remaining) at %s:%d", \
84 		    _len ,__FILE__, __LINE__); \
85 		packet_disconnect("Packet integrity error."); \
86 	} \
87 } while (0)
88 
89 #endif				/* PACKET_H */
90