blob: d5473001c5041ec78a0312c6779fb1af0b0a085d [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller95def091999-11-25 00:26:21 +11002 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11003 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11005 * Interface for the packet protocol functions.
Damien Miller4af51302000-04-16 11:18:38 +10006 *
Damien Millere4340be2000-09-16 13:29:08 +11007 * As far as I am concerned, the code I have written for this software
8 * can be used freely for any purpose. Any derived versions of this
9 * software must be clearly marked as such, and if the derived work is
10 * incompatible with the protocol description in the RFC file, it must be
11 * called by a name other than "ssh" or "Secure Shell".
Damien Miller95def091999-11-25 00:26:21 +110012 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100013
Damien Miller9f643902001-11-12 11:02:52 +110014/* RCSID("$OpenBSD: packet.h,v 1.26 2001/11/07 16:03:17 markus Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
16#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);
27void packet_set_protocol_flags(u_int);
28u_int packet_get_protocol_flags(void);
29void packet_start_compression(int);
30void packet_set_interactive(int);
31int packet_is_interactive(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100032
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000033void packet_start(u_char);
34void packet_put_char(int ch);
35void packet_put_int(u_int value);
36void packet_put_bignum(BIGNUM * value);
37void packet_put_bignum2(BIGNUM * value);
38void packet_put_string(const char *buf, u_int len);
39void packet_put_cstring(const char *str);
40void packet_put_raw(const char *buf, u_int len);
41void packet_send(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100042
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000043int packet_read(int *payload_len_ptr);
44void packet_read_expect(int *payload_len_ptr, int type);
45int packet_read_poll(int *packet_len_ptr);
46void packet_process_incoming(const char *buf, u_int len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100047
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000048u_int packet_get_char(void);
49u_int packet_get_int(void);
50void packet_get_bignum(BIGNUM * value, int *length_ptr);
51void packet_get_bignum2(BIGNUM * value, int *length_ptr);
Damien Miller33b13562000-04-04 14:38:59 +100052char *packet_get_raw(int *length_ptr);
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000053char *packet_get_string(u_int *length_ptr);
54void packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
55void packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
Damien Millerd4a8b7e1999-10-27 13:42:43 +100056
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000057void packet_write_poll(void);
58void packet_write_wait(void);
59int packet_have_data_to_write(void);
60int packet_not_very_much_data_to_write(void);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100061
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000062int packet_connection_is_on_socket(void);
63int packet_connection_is_ipv4(void);
64int packet_remaining(void);
65void packet_send_ignore(int);
Damien Miller9f643902001-11-12 11:02:52 +110066void packet_add_padding(u_char);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100067
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000068void tty_make_modes(int, struct termios *);
69void tty_parse_modes(int, int *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100070
Damien Miller6162d121999-11-21 13:23:52 +110071extern int max_packet_size;
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000072int packet_set_maxsize(int);
73#define packet_get_maxsize() max_packet_size
Damien Millerd4a8b7e1999-10-27 13:42:43 +100074
75#define packet_integrity_check(payload_len, expected_len, type) \
76do { \
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000077 int _p = (payload_len), _e = (expected_len); \
78 if (_p != _e) { \
79 log("Packet integrity error (%d != %d) at %s:%d", \
80 _p, _e, __FILE__, __LINE__); \
81 packet_disconnect("Packet integrity error. (%d)", (type)); \
82 } \
Damien Millerd4a8b7e1999-10-27 13:42:43 +100083} while (0)
84
Damien Miller4af51302000-04-16 11:18:38 +100085#define packet_done() \
86do { \
87 int _len = packet_remaining(); \
88 if (_len > 0) { \
89 log("Packet integrity error (%d bytes remaining) at %s:%d", \
90 _len ,__FILE__, __LINE__); \
91 packet_disconnect("Packet integrity error."); \
92 } \
93} while (0)
94
Damien Miller95def091999-11-25 00:26:21 +110095#endif /* PACKET_H */