1 /* $OpenBSD: packet.h,v 1.71 2016/03/07 19:02:43 djm Exp $ */
4 * Author: Tatu Ylonen <ylo@cs.hut.fi>
5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7 * Interface for the packet protocol functions.
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".
22 # include <openssl/bn.h>
23 # ifdef OPENSSL_HAS_ECC
24 # include <openssl/ec.h>
25 # else /* OPENSSL_HAS_ECC */
27 # define EC_GROUP void
28 # define EC_POINT void
29 # endif /* OPENSSL_HAS_ECC */
30 #else /* WITH_OPENSSL */
33 # define EC_GROUP void
34 # define EC_POINT void
35 #endif /* WITH_OPENSSL */
38 #include "openbsd-compat/sys-queue.h"
43 struct session_state
; /* private session data */
45 #include "dispatch.h" /* typedef, DISPATCH_MAX */
48 TAILQ_ENTRY(key_entry
) next
;
54 struct session_state
*state
;
59 /* cached local and remote ip addresses and ports */
65 /* Dispatcher table */
66 dispatch_fn
*dispatch
[DISPATCH_MAX
];
67 /* number of packets to ignore in the dispatcher */
68 int dispatch_skip_packets
;
73 /* Lists for private and public keys */
74 TAILQ_HEAD(, key_entry
) private_keys
;
75 TAILQ_HEAD(, key_entry
) public_keys
;
81 struct ssh
*ssh_alloc_session_state(void);
82 struct ssh
*ssh_packet_set_connection(struct ssh
*, int, int);
83 void ssh_packet_set_timeout(struct ssh
*, int, int);
84 int ssh_packet_stop_discard(struct ssh
*);
85 int ssh_packet_connection_af(struct ssh
*);
86 void ssh_packet_set_nonblocking(struct ssh
*);
87 int ssh_packet_get_connection_in(struct ssh
*);
88 int ssh_packet_get_connection_out(struct ssh
*);
89 void ssh_packet_close(struct ssh
*);
90 void ssh_packet_set_encryption_key(struct ssh
*, const u_char
*, u_int
, int);
91 int ssh_packet_is_rekeying(struct ssh
*);
92 void ssh_packet_set_protocol_flags(struct ssh
*, u_int
);
93 u_int
ssh_packet_get_protocol_flags(struct ssh
*);
94 int ssh_packet_start_compression(struct ssh
*, int);
95 void ssh_packet_set_tos(struct ssh
*, int);
96 void ssh_packet_set_interactive(struct ssh
*, int, int, int);
97 int ssh_packet_is_interactive(struct ssh
*);
98 void ssh_packet_set_server(struct ssh
*);
99 void ssh_packet_set_authenticated(struct ssh
*);
101 int ssh_packet_send1(struct ssh
*);
102 int ssh_packet_send2_wrapped(struct ssh
*);
103 int ssh_packet_send2(struct ssh
*);
105 int ssh_packet_read(struct ssh
*);
106 int ssh_packet_read_expect(struct ssh
*, u_int type
);
107 int ssh_packet_read_poll(struct ssh
*);
108 int ssh_packet_read_poll1(struct ssh
*, u_char
*);
109 int ssh_packet_read_poll2(struct ssh
*, u_char
*, u_int32_t
*seqnr_p
);
110 int ssh_packet_process_incoming(struct ssh
*, const char *buf
, u_int len
);
111 int ssh_packet_read_seqnr(struct ssh
*, u_char
*, u_int32_t
*seqnr_p
);
112 int ssh_packet_read_poll_seqnr(struct ssh
*, u_char
*, u_int32_t
*seqnr_p
);
114 const void *ssh_packet_get_string_ptr(struct ssh
*, u_int
*length_ptr
);
115 void ssh_packet_disconnect(struct ssh
*, const char *fmt
, ...)
116 __attribute__((format(printf
, 2, 3)))
117 __attribute__((noreturn
));
118 void ssh_packet_send_debug(struct ssh
*, const char *fmt
, ...) __attribute__((format(printf
, 2, 3)));
120 int ssh_set_newkeys(struct ssh
*, int mode
);
121 void ssh_packet_get_bytes(struct ssh
*, u_int64_t
*, u_int64_t
*);
123 typedef void *(ssh_packet_comp_alloc_func
)(void *, u_int
, u_int
);
124 typedef void (ssh_packet_comp_free_func
)(void *, void *);
125 void ssh_packet_set_compress_hooks(struct ssh
*, void *,
126 ssh_packet_comp_alloc_func
*, ssh_packet_comp_free_func
*);
128 int ssh_packet_write_poll(struct ssh
*);
129 int ssh_packet_write_wait(struct ssh
*);
130 int ssh_packet_have_data_to_write(struct ssh
*);
131 int ssh_packet_not_very_much_data_to_write(struct ssh
*);
133 int ssh_packet_connection_is_on_socket(struct ssh
*);
134 int ssh_packet_remaining(struct ssh
*);
135 void ssh_packet_send_ignore(struct ssh
*, int);
137 void tty_make_modes(int, struct termios
*);
138 void tty_parse_modes(int, int *);
140 void ssh_packet_set_alive_timeouts(struct ssh
*, int);
141 int ssh_packet_inc_alive_timeouts(struct ssh
*);
142 int ssh_packet_set_maxsize(struct ssh
*, u_int
);
143 u_int
ssh_packet_get_maxsize(struct ssh
*);
145 int ssh_packet_get_state(struct ssh
*, struct sshbuf
*);
146 int ssh_packet_set_state(struct ssh
*, struct sshbuf
*);
148 const char *ssh_remote_ipaddr(struct ssh
*);
149 int ssh_remote_port(struct ssh
*);
150 const char *ssh_local_ipaddr(struct ssh
*);
151 int ssh_local_port(struct ssh
*);
153 void ssh_packet_set_rekey_limits(struct ssh
*, u_int64_t
, time_t);
154 time_t ssh_packet_get_rekey_timeout(struct ssh
*);
156 void *ssh_packet_get_input(struct ssh
*);
157 void *ssh_packet_get_output(struct ssh
*);
160 int sshpkt_start(struct ssh
*ssh
, u_char type
);
161 int sshpkt_send(struct ssh
*ssh
);
162 int sshpkt_disconnect(struct ssh
*, const char *fmt
, ...)
163 __attribute__((format(printf
, 2, 3)));
164 int sshpkt_add_padding(struct ssh
*, u_char
);
165 void sshpkt_fatal(struct ssh
*ssh
, const char *tag
, int r
);
167 int sshpkt_put(struct ssh
*ssh
, const void *v
, size_t len
);
168 int sshpkt_putb(struct ssh
*ssh
, const struct sshbuf
*b
);
169 int sshpkt_put_u8(struct ssh
*ssh
, u_char val
);
170 int sshpkt_put_u32(struct ssh
*ssh
, u_int32_t val
);
171 int sshpkt_put_u64(struct ssh
*ssh
, u_int64_t val
);
172 int sshpkt_put_string(struct ssh
*ssh
, const void *v
, size_t len
);
173 int sshpkt_put_cstring(struct ssh
*ssh
, const void *v
);
174 int sshpkt_put_stringb(struct ssh
*ssh
, const struct sshbuf
*v
);
175 int sshpkt_put_ec(struct ssh
*ssh
, const EC_POINT
*v
, const EC_GROUP
*g
);
176 int sshpkt_put_bignum1(struct ssh
*ssh
, const BIGNUM
*v
);
177 int sshpkt_put_bignum2(struct ssh
*ssh
, const BIGNUM
*v
);
179 int sshpkt_get(struct ssh
*ssh
, void *valp
, size_t len
);
180 int sshpkt_get_u8(struct ssh
*ssh
, u_char
*valp
);
181 int sshpkt_get_u32(struct ssh
*ssh
, u_int32_t
*valp
);
182 int sshpkt_get_u64(struct ssh
*ssh
, u_int64_t
*valp
);
183 int sshpkt_get_string(struct ssh
*ssh
, u_char
**valp
, size_t *lenp
);
184 int sshpkt_get_string_direct(struct ssh
*ssh
, const u_char
**valp
, size_t *lenp
);
185 int sshpkt_get_cstring(struct ssh
*ssh
, char **valp
, size_t *lenp
);
186 int sshpkt_get_ec(struct ssh
*ssh
, EC_POINT
*v
, const EC_GROUP
*g
);
187 int sshpkt_get_bignum1(struct ssh
*ssh
, BIGNUM
*v
);
188 int sshpkt_get_bignum2(struct ssh
*ssh
, BIGNUM
*v
);
189 int sshpkt_get_end(struct ssh
*ssh
);
190 const u_char
*sshpkt_ptr(struct ssh
*, size_t *lenp
);
193 extern struct ssh
*active_state
;
196 #if !defined(WITH_OPENSSL)
201 #elif !defined(OPENSSL_HAS_ECC)
207 #endif /* PACKET_H */