• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* $OpenBSD: packet.h,v 1.76 2017/02/03 23:03:33 djm 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 
65 	/* Optional preamble for log messages (e.g. username) */
66 	char *log_preamble;
67 
68 	/* Dispatcher table */
69 	dispatch_fn *dispatch[DISPATCH_MAX];
70 	/* number of packets to ignore in the dispatcher */
71 	int dispatch_skip_packets;
72 
73 	/* datafellows */
74 	int compat;
75 
76 	/* Lists for private and public keys */
77 	TAILQ_HEAD(, key_entry) private_keys;
78 	TAILQ_HEAD(, key_entry) public_keys;
79 
80 	/* APP data */
81 	void *app_data;
82 };
83 
84 typedef int (ssh_packet_hook_fn)(struct ssh *, struct sshbuf *,
85     u_char *, void *);
86 
87 struct ssh *ssh_alloc_session_state(void);
88 struct ssh *ssh_packet_set_connection(struct ssh *, int, int);
89 void     ssh_packet_set_timeout(struct ssh *, int, int);
90 int	 ssh_packet_stop_discard(struct ssh *);
91 int	 ssh_packet_connection_af(struct ssh *);
92 void     ssh_packet_set_nonblocking(struct ssh *);
93 int      ssh_packet_get_connection_in(struct ssh *);
94 int      ssh_packet_get_connection_out(struct ssh *);
95 void     ssh_packet_close(struct ssh *);
96 void	 ssh_packet_set_encryption_key(struct ssh *, const u_char *, u_int, int);
97 void	 ssh_packet_set_input_hook(struct ssh *, ssh_packet_hook_fn *, void *);
98 
99 int	 ssh_packet_is_rekeying(struct ssh *);
100 void     ssh_packet_set_protocol_flags(struct ssh *, u_int);
101 u_int	 ssh_packet_get_protocol_flags(struct ssh *);
102 int      ssh_packet_start_compression(struct ssh *, int);
103 void	 ssh_packet_set_tos(struct ssh *, int);
104 void     ssh_packet_set_interactive(struct ssh *, int, int, int);
105 int      ssh_packet_is_interactive(struct ssh *);
106 void     ssh_packet_set_server(struct ssh *);
107 void     ssh_packet_set_authenticated(struct ssh *);
108 void     ssh_packet_set_mux(struct ssh *);
109 int	 ssh_packet_get_mux(struct ssh *);
110 int	 ssh_packet_set_log_preamble(struct ssh *, const char *, ...)
111     __attribute__((format(printf, 2, 3)));
112 
113 int	 ssh_packet_log_type(u_char);
114 
115 int	 ssh_packet_send1(struct ssh *);
116 int	 ssh_packet_send2_wrapped(struct ssh *);
117 int	 ssh_packet_send2(struct ssh *);
118 
119 int      ssh_packet_read(struct ssh *);
120 int	 ssh_packet_read_expect(struct ssh *, u_int type);
121 int      ssh_packet_read_poll(struct ssh *);
122 int ssh_packet_read_poll1(struct ssh *, u_char *);
123 int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p);
124 int	 ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len);
125 int      ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
126 int      ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
127 
128 const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr);
129 void     ssh_packet_disconnect(struct ssh *, const char *fmt, ...)
130 	__attribute__((format(printf, 2, 3)))
131 	__attribute__((noreturn));
132 void     ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
133 
134 int	 ssh_set_newkeys(struct ssh *, int mode);
135 void	 ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *);
136 
137 int	 ssh_packet_write_poll(struct ssh *);
138 int	 ssh_packet_write_wait(struct ssh *);
139 int      ssh_packet_have_data_to_write(struct ssh *);
140 int      ssh_packet_not_very_much_data_to_write(struct ssh *);
141 
142 int	 ssh_packet_connection_is_on_socket(struct ssh *);
143 int	 ssh_packet_remaining(struct ssh *);
144 void	 ssh_packet_send_ignore(struct ssh *, int);
145 
146 void	 tty_make_modes(int, struct termios *);
147 void	 tty_parse_modes(int, int *);
148 
149 void	 ssh_packet_set_alive_timeouts(struct ssh *, int);
150 int	 ssh_packet_inc_alive_timeouts(struct ssh *);
151 int	 ssh_packet_set_maxsize(struct ssh *, u_int);
152 u_int	 ssh_packet_get_maxsize(struct ssh *);
153 
154 int	 ssh_packet_get_state(struct ssh *, struct sshbuf *);
155 int	 ssh_packet_set_state(struct ssh *, struct sshbuf *);
156 
157 const char *ssh_remote_ipaddr(struct ssh *);
158 int	 ssh_remote_port(struct ssh *);
159 const char *ssh_local_ipaddr(struct ssh *);
160 int	 ssh_local_port(struct ssh *);
161 
162 void	 ssh_packet_set_rekey_limits(struct ssh *, u_int64_t, u_int32_t);
163 time_t	 ssh_packet_get_rekey_timeout(struct ssh *);
164 
165 void	*ssh_packet_get_input(struct ssh *);
166 void	*ssh_packet_get_output(struct ssh *);
167 
168 /* new API */
169 int	sshpkt_start(struct ssh *ssh, u_char type);
170 int	sshpkt_send(struct ssh *ssh);
171 int     sshpkt_disconnect(struct ssh *, const char *fmt, ...)
172 	    __attribute__((format(printf, 2, 3)));
173 int	sshpkt_add_padding(struct ssh *, u_char);
174 void	sshpkt_fatal(struct ssh *ssh, const char *tag, int r);
175 
176 int	sshpkt_put(struct ssh *ssh, const void *v, size_t len);
177 int	sshpkt_putb(struct ssh *ssh, const struct sshbuf *b);
178 int	sshpkt_put_u8(struct ssh *ssh, u_char val);
179 int	sshpkt_put_u32(struct ssh *ssh, u_int32_t val);
180 int	sshpkt_put_u64(struct ssh *ssh, u_int64_t val);
181 int	sshpkt_put_string(struct ssh *ssh, const void *v, size_t len);
182 int	sshpkt_put_cstring(struct ssh *ssh, const void *v);
183 int	sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v);
184 int	sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g);
185 int	sshpkt_put_bignum1(struct ssh *ssh, const BIGNUM *v);
186 int	sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v);
187 
188 int	sshpkt_get(struct ssh *ssh, void *valp, size_t len);
189 int	sshpkt_get_u8(struct ssh *ssh, u_char *valp);
190 int	sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp);
191 int	sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp);
192 int	sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp);
193 int	sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
194 int	sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp);
195 int	sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g);
196 int	sshpkt_get_bignum1(struct ssh *ssh, BIGNUM *v);
197 int	sshpkt_get_bignum2(struct ssh *ssh, BIGNUM *v);
198 int	sshpkt_get_end(struct ssh *ssh);
199 const u_char	*sshpkt_ptr(struct ssh *, size_t *lenp);
200 
201 /* OLD API */
202 extern struct ssh *active_state;
203 #include "opacket.h"
204 
205 #if !defined(WITH_OPENSSL)
206 # undef BIGNUM
207 # undef EC_KEY
208 # undef EC_GROUP
209 # undef EC_POINT
210 #elif !defined(OPENSSL_HAS_ECC)
211 # undef EC_KEY
212 # undef EC_GROUP
213 # undef EC_POINT
214 #endif
215 
216 #endif				/* PACKET_H */
217