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