packet.h revision cd7d5faf5bbb52336a6f85578a90b31a648ac3fa
/*
* Author: Tatu Ylonen <ylo@cs.hut.fi>
* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
* All rights reserved
* Interface for the packet protocol functions.
*
* As far as I am concerned, the code I have written for this software
* can be used freely for any purpose. Any derived versions of this
* software must be clearly marked as such, and if the derived work is
* incompatible with the protocol description in the RFC file, it must be
* called by a name other than "ssh" or "Secure Shell".
*/
/*
* Copyright 2008 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _PACKET_H
#define _PACKET_H
/* $OpenBSD: packet.h,v 1.35 2002/06/19 18:01:00 markus Exp $ */
#ifdef __cplusplus
extern "C" {
#endif
#include <openssl/bn.h>
#include "kex.h"
#ifdef ALTPRIVSEP
/* Monitor-side functions */
void packet_set_server(void);
void packet_set_no_monitor(void);
void packet_set_monitor(int pip_fd);
int packet_is_server(void);
int packet_is_monitor(void);
void packet_set_packet(const void *buf, u_int len);
void packet_set_fds(int fd, int restore);
#endif /* ALTPRIVSEP */
void packet_set_connection(int, int);
void packet_set_nonblocking(void);
int packet_get_connection_in(void);
int packet_get_connection_out(void);
void packet_close(void);
void packet_set_encryption_key(const u_char *, u_int, int);
u_int packet_get_encryption_key(u_char *);
void packet_set_protocol_flags(u_int);
u_int packet_get_protocol_flags(void);
void packet_start_compression(int);
void packet_set_interactive(int);
int packet_is_interactive(void);
void packet_start(u_char);
void packet_put_char(int ch);
void packet_put_int(u_int value);
void packet_put_bignum(BIGNUM * value);
void packet_put_bignum2(BIGNUM * value);
void packet_put_string(const void *buf, u_int len);
void packet_put_cstring(const char *str);
void packet_put_ascii_cstring(const char *str);
void packet_put_utf8_cstring(const u_char *str);
void packet_put_raw(const void *buf, u_int len);
void packet_send(void);
#if 0
/* If these are needed, then get rid of the #if 0 and this comment */
void packet_put_utf8_string(const u_char *buf, u_int len);
void packet_put_ascii_string(const char *str, u_int len);
#endif
int packet_read(void);
void packet_read_expect(int type);
int packet_read_poll(void);
void packet_process_incoming(const char *buf, u_int len);
int packet_read_seqnr(u_int32_t *seqnr_p);
int packet_read_poll_seqnr(u_int32_t *seqnr_p);
u_int packet_get_char(void);
u_int packet_get_int(void);
void packet_get_bignum(BIGNUM * value);
void packet_get_bignum2(BIGNUM * value);
void *packet_get_raw(u_int *length_ptr);
void *packet_get_string(u_int *length_ptr);
char *packet_get_ascii_cstring();
u_char *packet_get_utf8_cstring();
void packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
void packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
void set_newkeys(int mode);
void free_keys(Newkeys *keys);
void packet_write_poll(void);
void packet_write_wait(void);
int packet_have_data_to_write(void);
int packet_not_very_much_data_to_write(void);
int packet_connection_is_on_socket(void);
int packet_connection_is_ipv4(void);
int packet_remaining(void);
void packet_send_ignore(int);
void packet_add_padding(u_char);
void tty_make_modes(int, struct termios *);
void tty_parse_modes(int, int *);
extern int max_packet_size;
int packet_set_maxsize(int);
#define packet_get_maxsize() max_packet_size
/* don't allow remaining bytes after the end of the message */
#define packet_check_eom() \
do { \
int _len = packet_remaining(); \
if (_len > 0) { \
log("Packet integrity error (%d bytes remaining) at %s:%d", \
_len ,__FILE__, __LINE__); \
packet_disconnect("Packet integrity error."); \
} \
} while (0)
int packet_need_rekeying(void);
void packet_set_rekey_limit(u_int32_t);
/* see a comment attached to will_daemonize in packet.c for more information */
#define NOT_DAEMONIZING 0
#define DAEMONIZING_REQUESTED 1
#define FIRST_NEWKEYS_PROCESSED 2
#define SECOND_NEWKEYS_PROCESSED 3
#ifdef __cplusplus
}
#endif
#endif /* _PACKET_H */