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