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