xref: /openssh-portable/packet.h (revision 714e1cbc)
1 /* $OpenBSD: packet.h,v 1.92 2020/03/06 18:11:10 markus Exp $ */
2 
3 /*
4  * Author: Tatu Ylonen <ylo@cs.hut.fi>
5  * Copyright (c) 1995 Tatu Ylonen <ylo@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 #ifdef WITH_OPENSSL
22 # include <openssl/bn.h>
23 # ifdef OPENSSL_HAS_ECC
24 #  include <openssl/ec.h>
25 # else /* OPENSSL_HAS_ECC */
26 #  define EC_KEY	void
27 #  define EC_GROUP	void
28 #  define EC_POINT	void
29 # endif /* OPENSSL_HAS_ECC */
30 #else /* WITH_OPENSSL */
31 # define BIGNUM		void
32 # define EC_KEY		void
33 # define EC_GROUP	void
34 # define EC_POINT	void
35 #endif /* WITH_OPENSSL */
36 
37 #include <signal.h>
38 #include "openbsd-compat/sys-queue.h"
39 
40 struct kex;
41 struct sshkey;
42 struct sshbuf;
43 struct session_state;	/* private session data */
44 
45 #include "dispatch.h"	/* typedef, DISPATCH_MAX */
46 
47 struct key_entry {
48 	TAILQ_ENTRY(key_entry) next;
49 	struct sshkey *key;
50 };
51 
52 struct ssh {
53 	/* Session state */
54 	struct session_state *state;
55 
56 	/* Key exchange */
57 	struct kex *kex;
58 
59 	/* cached local and remote ip addresses and ports */
60 	char *remote_ipaddr;
61 	int remote_port;
62 	char *local_ipaddr;
63 	int local_port;
64 	char *rdomain_in;
65 
66 	/* Optional preamble for log messages (e.g. username) */
67 	char *log_preamble;
68 
69 	/* Dispatcher table */
70 	dispatch_fn *dispatch[DISPATCH_MAX];
71 	/* number of packets to ignore in the dispatcher */
72 	int dispatch_skip_packets;
73 
74 	/* datafellows */
75 	int compat;
76 
77 	/* Lists for private and public keys */
78 	TAILQ_HEAD(, key_entry) private_keys;
79 	TAILQ_HEAD(, key_entry) public_keys;
80 
81 	/* Client/Server authentication context */
82 	void *authctxt;
83 
84 	/* Channels context */
85 	struct ssh_channels *chanctxt;
86 
87 	/* APP data */
88 	void *app_data;
89 };
90 
91 typedef int (ssh_packet_hook_fn)(struct ssh *, struct sshbuf *,
92     u_char *, void *);
93 
94 struct ssh *ssh_alloc_session_state(void);
95 struct ssh *ssh_packet_set_connection(struct ssh *, int, int);
96 void     ssh_packet_set_timeout(struct ssh *, int, int);
97 int	 ssh_packet_stop_discard(struct ssh *);
98 int	 ssh_packet_connection_af(struct ssh *);
99 void     ssh_packet_set_nonblocking(struct ssh *);
100 int      ssh_packet_get_connection_in(struct ssh *);
101 int      ssh_packet_get_connection_out(struct ssh *);
102 void     ssh_packet_close(struct ssh *);
103 void	 ssh_packet_set_input_hook(struct ssh *, ssh_packet_hook_fn *, void *);
104 void	 ssh_packet_clear_keys(struct ssh *);
105 void	 ssh_clear_newkeys(struct ssh *, int);
106 
107 int	 ssh_packet_is_rekeying(struct ssh *);
108 void     ssh_packet_set_protocol_flags(struct ssh *, u_int);
109 u_int	 ssh_packet_get_protocol_flags(struct ssh *);
110 void	 ssh_packet_set_tos(struct ssh *, int);
111 void     ssh_packet_set_interactive(struct ssh *, int, int, int);
112 int      ssh_packet_is_interactive(struct ssh *);
113 void     ssh_packet_set_server(struct ssh *);
114 void     ssh_packet_set_authenticated(struct ssh *);
115 void     ssh_packet_set_mux(struct ssh *);
116 int	 ssh_packet_get_mux(struct ssh *);
117 int	 ssh_packet_set_log_preamble(struct ssh *, const char *, ...)
118     __attribute__((format(printf, 2, 3)));
119 
120 int	 ssh_packet_log_type(u_char);
121 
122 int	 ssh_packet_send2_wrapped(struct ssh *);
123 int	 ssh_packet_send2(struct ssh *);
124 
125 int      ssh_packet_read(struct ssh *);
126 int	 ssh_packet_read_expect(struct ssh *, u_int type);
127 int      ssh_packet_read_poll(struct ssh *);
128 int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p);
129 int	 ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len);
130 int      ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
131 int      ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
132 
133 const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr);
134 void     ssh_packet_disconnect(struct ssh *, const char *fmt, ...)
135 	__attribute__((format(printf, 2, 3)))
136 	__attribute__((noreturn));
137 void     ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
138 
139 int	 ssh_set_newkeys(struct ssh *, int mode);
140 void	 ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *);
141 
142 int	 ssh_packet_write_poll(struct ssh *);
143 int	 ssh_packet_write_wait(struct ssh *);
144 int      ssh_packet_have_data_to_write(struct ssh *);
145 int      ssh_packet_not_very_much_data_to_write(struct ssh *);
146 
147 int	 ssh_packet_connection_is_on_socket(struct ssh *);
148 int	 ssh_packet_remaining(struct ssh *);
149 
150 void	 ssh_tty_make_modes(struct ssh *, int, struct termios *);
151 void	 ssh_tty_parse_modes(struct ssh *, int);
152 
153 void	 ssh_packet_set_alive_timeouts(struct ssh *, int);
154 int	 ssh_packet_inc_alive_timeouts(struct ssh *);
155 int	 ssh_packet_set_maxsize(struct ssh *, u_int);
156 u_int	 ssh_packet_get_maxsize(struct ssh *);
157 
158 int	 ssh_packet_get_state(struct ssh *, struct sshbuf *);
159 int	 ssh_packet_set_state(struct ssh *, struct sshbuf *);
160 
161 const char *ssh_remote_ipaddr(struct ssh *);
162 int	 ssh_remote_port(struct ssh *);
163 const char *ssh_local_ipaddr(struct ssh *);
164 int	 ssh_local_port(struct ssh *);
165 const char *ssh_packet_rdomain_in(struct ssh *);
166 
167 void	 ssh_packet_set_rekey_limits(struct ssh *, u_int64_t, u_int32_t);
168 time_t	 ssh_packet_get_rekey_timeout(struct ssh *);
169 
170 void	*ssh_packet_get_input(struct ssh *);
171 void	*ssh_packet_get_output(struct ssh *);
172 
173 /* new API */
174 int	sshpkt_start(struct ssh *ssh, u_char type);
175 int	sshpkt_send(struct ssh *ssh);
176 int     sshpkt_disconnect(struct ssh *, const char *fmt, ...)
177 	    __attribute__((format(printf, 2, 3)));
178 int	sshpkt_add_padding(struct ssh *, u_char);
179 void	sshpkt_fatal(struct ssh *ssh, int r, const char *fmt, ...)
180 	    __attribute__((format(printf, 3, 4)))
181 	    __attribute__((noreturn));
182 int	sshpkt_msg_ignore(struct ssh *, u_int);
183 
184 int	sshpkt_put(struct ssh *ssh, const void *v, size_t len);
185 int	sshpkt_putb(struct ssh *ssh, const struct sshbuf *b);
186 int	sshpkt_put_u8(struct ssh *ssh, u_char val);
187 int	sshpkt_put_u32(struct ssh *ssh, u_int32_t val);
188 int	sshpkt_put_u64(struct ssh *ssh, u_int64_t val);
189 int	sshpkt_put_string(struct ssh *ssh, const void *v, size_t len);
190 int	sshpkt_put_cstring(struct ssh *ssh, const void *v);
191 int	sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v);
192 int	sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g);
193 int	sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v);
194 
195 int	sshpkt_get(struct ssh *ssh, void *valp, size_t len);
196 int	sshpkt_get_u8(struct ssh *ssh, u_char *valp);
197 int	sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp);
198 int	sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp);
199 int	sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp);
200 int	sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
201 int	sshpkt_peek_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
202 int	sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp);
203 int	sshpkt_getb_froms(struct ssh *ssh, struct sshbuf **valp);
204 int	sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g);
205 int	sshpkt_get_bignum2(struct ssh *ssh, BIGNUM **valp);
206 int	sshpkt_get_end(struct ssh *ssh);
207 void	sshpkt_fmt_connection_id(struct ssh *ssh, char *s, size_t l);
208 const u_char	*sshpkt_ptr(struct ssh *, size_t *lenp);
209 
210 #if !defined(WITH_OPENSSL)
211 # undef BIGNUM
212 # undef EC_KEY
213 # undef EC_GROUP
214 # undef EC_POINT
215 #elif !defined(OPENSSL_HAS_ECC)
216 # undef EC_KEY
217 # undef EC_GROUP
218 # undef EC_POINT
219 #endif
220 
221 #endif				/* PACKET_H */
222