1 /* $NetBSD: packet.h,v 1.8 2013/11/08 19:18:25 christos Exp $ */ 2 /* $OpenBSD: packet.h,v 1.59 2013/07/12 00:19:59 djm Exp $ */ 3 4 /* 5 * Author: Tatu Ylonen <ylo@cs.hut.fi> 6 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 7 * All rights reserved 8 * Interface for the packet protocol functions. 9 * 10 * As far as I am concerned, the code I have written for this software 11 * can be used freely for any purpose. Any derived versions of this 12 * software must be clearly marked as such, and if the derived work is 13 * incompatible with the protocol description in the RFC file, it must be 14 * called by a name other than "ssh" or "Secure Shell". 15 */ 16 17 #ifndef PACKET_H 18 #define PACKET_H 19 20 #include <termios.h> 21 22 #include <openssl/bn.h> 23 #include <openssl/ec.h> 24 25 void packet_request_rekeying(void); 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 int packet_authentication_state(void); 42 43 void packet_start(u_char); 44 void packet_put_char(int ch); 45 void packet_put_int(u_int value); 46 void packet_put_int64(u_int64_t value); 47 void packet_put_bignum(BIGNUM * value); 48 void packet_put_bignum2(BIGNUM * value); 49 void packet_put_ecpoint(const EC_GROUP *, const EC_POINT *); 50 void packet_put_string(const void *buf, u_int len); 51 void packet_put_cstring(const char *str); 52 void packet_put_raw(const void *buf, u_int len); 53 int packet_send(void); 54 55 int packet_read(void); 56 void packet_read_expect(int type); 57 void packet_process_incoming(const char *buf, u_int len); 58 int packet_read_seqnr(u_int32_t *seqnr_p); 59 int packet_read_poll_seqnr(u_int32_t *seqnr_p); 60 61 u_int packet_get_char(void); 62 u_int packet_get_int(void); 63 u_int64_t packet_get_int64(void); 64 void packet_get_bignum(BIGNUM * value); 65 void packet_get_bignum2(BIGNUM * value); 66 void packet_get_ecpoint(const EC_GROUP *, EC_POINT *); 67 void *packet_get_raw(u_int *length_ptr); 68 void *packet_get_string(u_int *length_ptr); 69 char *packet_get_cstring(u_int *length_ptr); 70 void *packet_get_string_ptr(u_int *length_ptr); 71 void packet_disconnect(const char *fmt,...) __attribute__((noreturn)) __attribute__((format(printf, 1, 2))); 72 void packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2))); 73 74 void set_newkeys(int mode); 75 int packet_get_keyiv_len(int); 76 void packet_get_keyiv(int, u_char *, u_int); 77 int packet_get_keycontext(int, u_char *); 78 void packet_set_keycontext(int, u_char *); 79 void packet_get_state(int, u_int32_t *, u_int64_t *, u_int32_t *, u_int64_t *); 80 void packet_set_state(int, u_int32_t, u_int64_t, u_int32_t, u_int64_t); 81 int packet_get_ssh1_cipher(void); 82 void packet_set_iv(int, u_char *); 83 void *packet_get_newkeys(int); 84 85 int packet_write_poll(void); 86 int packet_write_wait(void); 87 int packet_have_data_to_write(void); 88 int packet_not_very_much_data_to_write(void); 89 90 int packet_connection_is_on_socket(void); 91 int packet_remaining(void); 92 void packet_send_ignore(int); 93 void packet_add_padding(u_char); 94 95 void tty_make_modes(int, struct termios *); 96 void tty_parse_modes(int, int *); 97 98 void packet_set_alive_timeouts(int); 99 int packet_inc_alive_timeouts(void); 100 int packet_set_maxsize(u_int); 101 u_int packet_get_maxsize(void); 102 103 /* don't allow remaining bytes after the end of the message */ 104 #define packet_check_eom() \ 105 do { \ 106 int _len = packet_remaining(); \ 107 if (_len > 0) { \ 108 logit("Packet integrity error (%d bytes remaining) at %s:%d", \ 109 _len ,__FILE__, __LINE__); \ 110 packet_disconnect("Packet integrity error."); \ 111 } \ 112 } while (0) 113 114 int packet_need_rekeying(void); 115 void packet_set_rekey_limits(u_int32_t, time_t); 116 time_t packet_get_rekey_timeout(void); 117 118 void packet_backup_state(void); 119 void packet_restore_state(void); 120 121 void *packet_get_input(void); 122 void *packet_get_output(void); 123 124 #endif /* PACKET_H */ 125