blob: 3ff75593adba7162f67b5d54b8d359bee9f6e478 [file] [log] [blame]
Ben Lindstrom402c6cc2002-06-21 00:43:42 +00001/* $OpenBSD: packet.h,v 1.35 2002/06/19 18:01:00 markus Exp $ */
Ben Lindstrom05764b92002-03-05 01:53:02 +00002
Damien Millerd4a8b7e1999-10-27 13:42:43 +10003/*
Damien Miller95def091999-11-25 00:26:21 +11004 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11005 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11007 * Interface for the packet protocol functions.
Damien Miller4af51302000-04-16 11:18:38 +10008 *
Damien Millere4340be2000-09-16 13:29:08 +11009 * 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".
Damien Miller95def091999-11-25 00:26:21 +110014 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
Damien Millerd4a8b7e1999-10-27 13:42:43 +100016#ifndef PACKET_H
17#define PACKET_H
18
19#include <openssl/bn.h>
Damien Millerd4a8b7e1999-10-27 13:42:43 +100020
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000021void packet_set_connection(int, int);
22void packet_set_nonblocking(void);
23int packet_get_connection_in(void);
24int packet_get_connection_out(void);
25void packet_close(void);
26void packet_set_encryption_key(const u_char *, u_int, int);
Ben Lindstrom402c6cc2002-06-21 00:43:42 +000027u_int packet_get_encryption_key(u_char *);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000028void packet_set_protocol_flags(u_int);
29u_int packet_get_protocol_flags(void);
30void packet_start_compression(int);
31void packet_set_interactive(int);
32int packet_is_interactive(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100033
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000034void packet_start(u_char);
35void packet_put_char(int ch);
36void packet_put_int(u_int value);
37void packet_put_bignum(BIGNUM * value);
38void packet_put_bignum2(BIGNUM * value);
Damien Miller5a6b4fe2001-12-21 14:56:54 +110039void packet_put_string(const void *buf, u_int len);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000040void packet_put_cstring(const char *str);
Damien Miller5a6b4fe2001-12-21 14:56:54 +110041void packet_put_raw(const void *buf, u_int len);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000042void packet_send(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100043
Damien Millerdff50992002-01-22 23:16:32 +110044int packet_read(void);
45void packet_read_expect(int type);
46int packet_read_poll(void);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000047void packet_process_incoming(const char *buf, u_int len);
Damien Millerdff50992002-01-22 23:16:32 +110048int packet_read_seqnr(u_int32_t *seqnr_p);
49int packet_read_poll_seqnr(u_int32_t *seqnr_p);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100050
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000051u_int packet_get_char(void);
52u_int packet_get_int(void);
Damien Millerd432ccf2002-01-22 23:14:44 +110053void packet_get_bignum(BIGNUM * value);
54void packet_get_bignum2(BIGNUM * value);
Damien Miller5a6b4fe2001-12-21 14:56:54 +110055void *packet_get_raw(int *length_ptr);
56void *packet_get_string(u_int *length_ptr);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000057void packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
58void packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
Damien Millerd4a8b7e1999-10-27 13:42:43 +100059
Ben Lindstromf6027d32002-03-22 01:42:04 +000060void set_newkeys(int mode);
61int packet_get_keyiv_len(int);
62void packet_get_keyiv(int, u_char *, u_int);
63int packet_get_keycontext(int, u_char *);
64void packet_set_keycontext(int, u_char *);
65u_int32_t packet_get_seqnr(int);
66void packet_set_seqnr(int, u_int32_t);
67int packet_get_ssh1_cipher(void);
68void packet_set_iv(int, u_char *);
69
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000070void packet_write_poll(void);
71void packet_write_wait(void);
72int packet_have_data_to_write(void);
73int packet_not_very_much_data_to_write(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100074
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000075int packet_connection_is_on_socket(void);
76int packet_connection_is_ipv4(void);
77int packet_remaining(void);
78void packet_send_ignore(int);
Damien Miller9f643902001-11-12 11:02:52 +110079void packet_add_padding(u_char);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100080
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000081void tty_make_modes(int, struct termios *);
82void tty_parse_modes(int, int *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100083
Damien Miller6162d121999-11-21 13:23:52 +110084extern int max_packet_size;
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000085int packet_set_maxsize(int);
86#define packet_get_maxsize() max_packet_size
Damien Millerd4a8b7e1999-10-27 13:42:43 +100087
Damien Miller48b03fc2002-01-22 23:11:40 +110088/* don't allow remaining bytes after the end of the message */
89#define packet_check_eom() \
Damien Miller4af51302000-04-16 11:18:38 +100090do { \
91 int _len = packet_remaining(); \
92 if (_len > 0) { \
93 log("Packet integrity error (%d bytes remaining) at %s:%d", \
94 _len ,__FILE__, __LINE__); \
95 packet_disconnect("Packet integrity error."); \
96 } \
97} while (0)
98
Damien Miller95def091999-11-25 00:26:21 +110099#endif /* PACKET_H */