xref: /freebsd/crypto/openssh/packet.h (revision ea906c4152774dff300bb26fbfc1e4188351c89a)
1 /* $OpenBSD: packet.h,v 1.49 2008/07/10 18:08:11 markus 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 
23 void     packet_set_connection(int, int);
24 void     packet_set_timeout(int, int);
25 void     packet_set_nonblocking(void);
26 int      packet_get_connection_in(void);
27 int      packet_get_connection_out(void);
28 void     packet_close(void);
29 void	 packet_set_encryption_key(const u_char *, u_int, int);
30 u_int	 packet_get_encryption_key(u_char *);
31 void     packet_set_protocol_flags(u_int);
32 u_int	 packet_get_protocol_flags(void);
33 void     packet_start_compression(int);
34 void     packet_set_interactive(int);
35 int      packet_is_interactive(void);
36 void     packet_set_server(void);
37 void     packet_set_authenticated(void);
38 
39 void     packet_start(u_char);
40 void     packet_put_char(int ch);
41 void     packet_put_int(u_int value);
42 void     packet_put_bignum(BIGNUM * value);
43 void     packet_put_bignum2(BIGNUM * value);
44 void     packet_put_string(const void *buf, u_int len);
45 void     packet_put_cstring(const char *str);
46 void     packet_put_raw(const void *buf, u_int len);
47 void     packet_send(void);
48 
49 int      packet_read(void);
50 void     packet_read_expect(int type);
51 int      packet_read_poll(void);
52 void     packet_process_incoming(const char *buf, u_int len);
53 int      packet_read_seqnr(u_int32_t *seqnr_p);
54 int      packet_read_poll_seqnr(u_int32_t *seqnr_p);
55 
56 u_int	 packet_get_char(void);
57 u_int	 packet_get_int(void);
58 void     packet_get_bignum(BIGNUM * value);
59 void     packet_get_bignum2(BIGNUM * value);
60 void	*packet_get_raw(u_int *length_ptr);
61 void	*packet_get_string(u_int *length_ptr);
62 void	*packet_get_string_ptr(u_int *length_ptr);
63 void     packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
64 void     packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
65 
66 void	 set_newkeys(int mode);
67 int	 packet_get_keyiv_len(int);
68 void	 packet_get_keyiv(int, u_char *, u_int);
69 int	 packet_get_keycontext(int, u_char *);
70 void	 packet_set_keycontext(int, u_char *);
71 void	 packet_get_state(int, u_int32_t *, u_int64_t *, u_int32_t *, u_int64_t *);
72 void	 packet_set_state(int, u_int32_t, u_int64_t, u_int32_t, u_int64_t);
73 int	 packet_get_ssh1_cipher(void);
74 void	 packet_set_iv(int, u_char *);
75 
76 void     packet_write_poll(void);
77 void     packet_write_wait(void);
78 int      packet_have_data_to_write(void);
79 int      packet_not_very_much_data_to_write(void);
80 
81 int	 packet_connection_is_on_socket(void);
82 int	 packet_connection_is_ipv4(void);
83 int	 packet_remaining(void);
84 void	 packet_send_ignore(int);
85 void	 packet_add_padding(u_char);
86 
87 void	 tty_make_modes(int, struct termios *);
88 void	 tty_parse_modes(int, int *);
89 
90 extern u_int max_packet_size;
91 extern int keep_alive_timeouts;
92 int	 packet_set_maxsize(u_int);
93 #define  packet_get_maxsize() max_packet_size
94 
95 /* don't allow remaining bytes after the end of the message */
96 #define packet_check_eom() \
97 do { \
98 	int _len = packet_remaining(); \
99 	if (_len > 0) { \
100 		logit("Packet integrity error (%d bytes remaining) at %s:%d", \
101 		    _len ,__FILE__, __LINE__); \
102 		packet_disconnect("Packet integrity error."); \
103 	} \
104 } while (0)
105 
106 int	 packet_need_rekeying(void);
107 void	 packet_set_rekey_limit(u_int32_t);
108 
109 #endif				/* PACKET_H */
110