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