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