blob: 6ce6dd56078b10e8dae76594ca91e9461ee49a82 [file] [log] [blame]
markus@openbsd.org1e0cdf82017-05-31 08:09:45 +00001/* $OpenBSD: packet.h,v 1.81 2017/05/31 08:09:45 markus Exp $ */
Ben Lindstrom05764b92002-03-05 01:53:02 +00002
Damien Millerd4a8b7e1999-10-27 13:42:43 +10003/*
Damien Miller95def091999-11-25 00:26:21 +11004 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11005 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11007 * Interface for the packet protocol functions.
Damien Miller4af51302000-04-16 11:18:38 +10008 *
Damien Millere4340be2000-09-16 13:29:08 +11009 * 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".
Damien Miller95def091999-11-25 00:26:21 +110014 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
Damien Millerd4a8b7e1999-10-27 13:42:43 +100016#ifndef PACKET_H
17#define PACKET_H
18
Damien Miller99bd21e2006-03-15 11:11:28 +110019#include <termios.h>
20
markus@openbsd.org091c3022015-01-19 19:52:16 +000021#ifdef WITH_OPENSSL
22# include <openssl/bn.h>
23# ifdef OPENSSL_HAS_ECC
24# include <openssl/ec.h>
Damien Miller773dda22015-01-30 23:10:17 +110025# 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
Tim Rice91020922015-02-23 22:06:56 -080037#include <signal.h>
Damien Miller62f678d2015-02-24 09:02:54 +110038#include "openbsd-compat/sys-queue.h"
Damien Millerd4a8b7e1999-10-27 13:42:43 +100039
markus@openbsd.org091c3022015-01-19 19:52:16 +000040struct kex;
41struct sshkey;
42struct sshbuf;
43struct session_state; /* private session data */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100044
markus@openbsd.org3fdc88a2015-01-19 20:07:45 +000045#include "dispatch.h" /* typedef, DISPATCH_MAX */
46
markus@openbsd.orgf582f0e2015-01-19 20:30:23 +000047struct key_entry {
48 TAILQ_ENTRY(key_entry) next;
49 struct sshkey *key;
50};
51
markus@openbsd.org091c3022015-01-19 19:52:16 +000052struct ssh {
53 /* Session state */
54 struct session_state *state;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100055
markus@openbsd.org091c3022015-01-19 19:52:16 +000056 /* Key exchange */
57 struct kex *kex;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100058
djm@openbsd.org95767262016-03-07 19:02:43 +000059 /* cached local and remote ip addresses and ports */
markus@openbsd.org091c3022015-01-19 19:52:16 +000060 char *remote_ipaddr;
61 int remote_port;
djm@openbsd.org95767262016-03-07 19:02:43 +000062 char *local_ipaddr;
63 int local_port;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100064
djm@openbsd.org07edd7e2017-02-03 23:03:33 +000065 /* Optional preamble for log messages (e.g. username) */
66 char *log_preamble;
67
markus@openbsd.org3fdc88a2015-01-19 20:07:45 +000068 /* Dispatcher table */
69 dispatch_fn *dispatch[DISPATCH_MAX];
70 /* number of packets to ignore in the dispatcher */
71 int dispatch_skip_packets;
72
markus@openbsd.org091c3022015-01-19 19:52:16 +000073 /* datafellows */
74 int compat;
markus@openbsd.orgf582f0e2015-01-19 20:30:23 +000075
76 /* Lists for private and public keys */
77 TAILQ_HEAD(, key_entry) private_keys;
78 TAILQ_HEAD(, key_entry) public_keys;
79
markus@openbsd.org5f4082d2017-05-30 14:18:15 +000080 /* Client/Server authentication context */
81 void *authctxt;
82
markus@openbsd.orgf582f0e2015-01-19 20:30:23 +000083 /* APP data */
84 void *app_data;
markus@openbsd.org091c3022015-01-19 19:52:16 +000085};
Ben Lindstromf6027d32002-03-22 01:42:04 +000086
djm@openbsd.org39af7b42016-10-11 21:47:45 +000087typedef int (ssh_packet_hook_fn)(struct ssh *, struct sshbuf *,
88 u_char *, void *);
89
markus@openbsd.org091c3022015-01-19 19:52:16 +000090struct ssh *ssh_alloc_session_state(void);
91struct ssh *ssh_packet_set_connection(struct ssh *, int, int);
92void ssh_packet_set_timeout(struct ssh *, int, int);
93int ssh_packet_stop_discard(struct ssh *);
94int ssh_packet_connection_af(struct ssh *);
95void ssh_packet_set_nonblocking(struct ssh *);
96int ssh_packet_get_connection_in(struct ssh *);
97int ssh_packet_get_connection_out(struct ssh *);
98void ssh_packet_close(struct ssh *);
djm@openbsd.org39af7b42016-10-11 21:47:45 +000099void ssh_packet_set_input_hook(struct ssh *, ssh_packet_hook_fn *, void *);
markus@openbsd.org1e0cdf82017-05-31 08:09:45 +0000100void ssh_packet_clear_keys(struct ssh *);
101void ssh_clear_newkeys(struct ssh *, int);
djm@openbsd.org39af7b42016-10-11 21:47:45 +0000102
djm@openbsd.org19bcf2e2016-02-08 10:57:07 +0000103int ssh_packet_is_rekeying(struct ssh *);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000104void ssh_packet_set_protocol_flags(struct ssh *, u_int);
105u_int ssh_packet_get_protocol_flags(struct ssh *);
106int ssh_packet_start_compression(struct ssh *, int);
107void ssh_packet_set_tos(struct ssh *, int);
108void ssh_packet_set_interactive(struct ssh *, int, int, int);
109int ssh_packet_is_interactive(struct ssh *);
110void ssh_packet_set_server(struct ssh *);
111void ssh_packet_set_authenticated(struct ssh *);
markus@openbsd.org8d057842016-09-30 09:19:13 +0000112void ssh_packet_set_mux(struct ssh *);
113int ssh_packet_get_mux(struct ssh *);
djm@openbsd.org07edd7e2017-02-03 23:03:33 +0000114int ssh_packet_set_log_preamble(struct ssh *, const char *, ...)
115 __attribute__((format(printf, 2, 3)));
markus@openbsd.org8d057842016-09-30 09:19:13 +0000116
117int ssh_packet_log_type(u_char);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000118
markus@openbsd.org091c3022015-01-19 19:52:16 +0000119int ssh_packet_send2_wrapped(struct ssh *);
120int ssh_packet_send2(struct ssh *);
121
122int ssh_packet_read(struct ssh *);
djm@openbsd.org4509b5d2015-01-30 01:13:33 +0000123int ssh_packet_read_expect(struct ssh *, u_int type);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000124int ssh_packet_read_poll(struct ssh *);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000125int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p);
djm@openbsd.orgfae7bbe2015-01-28 21:15:47 +0000126int ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000127int ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
128int ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
129
130const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr);
131void ssh_packet_disconnect(struct ssh *, const char *fmt, ...)
132 __attribute__((format(printf, 2, 3)))
133 __attribute__((noreturn));
134void ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
135
136int ssh_set_newkeys(struct ssh *, int mode);
137void ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *);
138
djm@openbsd.org4509b5d2015-01-30 01:13:33 +0000139int ssh_packet_write_poll(struct ssh *);
140int ssh_packet_write_wait(struct ssh *);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000141int ssh_packet_have_data_to_write(struct ssh *);
142int ssh_packet_not_very_much_data_to_write(struct ssh *);
143
144int ssh_packet_connection_is_on_socket(struct ssh *);
145int ssh_packet_remaining(struct ssh *);
146void ssh_packet_send_ignore(struct ssh *, int);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000147
Ben Lindstrom4cc240d2001-07-04 04:46:56 +0000148void tty_make_modes(int, struct termios *);
149void tty_parse_modes(int, int *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000150
markus@openbsd.org091c3022015-01-19 19:52:16 +0000151void ssh_packet_set_alive_timeouts(struct ssh *, int);
152int ssh_packet_inc_alive_timeouts(struct ssh *);
153int ssh_packet_set_maxsize(struct ssh *, u_int);
154u_int ssh_packet_get_maxsize(struct ssh *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000155
markus@openbsd.org091c3022015-01-19 19:52:16 +0000156int ssh_packet_get_state(struct ssh *, struct sshbuf *);
157int ssh_packet_set_state(struct ssh *, struct sshbuf *);
Damien Miller4af51302000-04-16 11:18:38 +1000158
markus@openbsd.org091c3022015-01-19 19:52:16 +0000159const char *ssh_remote_ipaddr(struct ssh *);
djm@openbsd.orga4b9e0f2015-12-11 03:24:25 +0000160int ssh_remote_port(struct ssh *);
djm@openbsd.org95767262016-03-07 19:02:43 +0000161const char *ssh_local_ipaddr(struct ssh *);
162int ssh_local_port(struct ssh *);
Damien Millera5539d22003-04-09 20:50:06 +1000163
dtucker@openbsd.orgc998bf02017-02-03 02:56:00 +0000164void ssh_packet_set_rekey_limits(struct ssh *, u_int64_t, u_int32_t);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000165time_t ssh_packet_get_rekey_timeout(struct ssh *);
Darren Tuckere841eb02009-07-06 07:11:13 +1000166
markus@openbsd.org091c3022015-01-19 19:52:16 +0000167void *ssh_packet_get_input(struct ssh *);
168void *ssh_packet_get_output(struct ssh *);
169
170/* new API */
171int sshpkt_start(struct ssh *ssh, u_char type);
172int sshpkt_send(struct ssh *ssh);
djm@openbsd.org4509b5d2015-01-30 01:13:33 +0000173int sshpkt_disconnect(struct ssh *, const char *fmt, ...)
174 __attribute__((format(printf, 2, 3)));
markus@openbsd.org091c3022015-01-19 19:52:16 +0000175int sshpkt_add_padding(struct ssh *, u_char);
djm@openbsd.org4509b5d2015-01-30 01:13:33 +0000176void sshpkt_fatal(struct ssh *ssh, const char *tag, int r);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000177
178int sshpkt_put(struct ssh *ssh, const void *v, size_t len);
179int sshpkt_putb(struct ssh *ssh, const struct sshbuf *b);
180int sshpkt_put_u8(struct ssh *ssh, u_char val);
181int sshpkt_put_u32(struct ssh *ssh, u_int32_t val);
182int sshpkt_put_u64(struct ssh *ssh, u_int64_t val);
183int sshpkt_put_string(struct ssh *ssh, const void *v, size_t len);
184int sshpkt_put_cstring(struct ssh *ssh, const void *v);
185int sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v);
186int sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000187int sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v);
188
189int sshpkt_get(struct ssh *ssh, void *valp, size_t len);
190int sshpkt_get_u8(struct ssh *ssh, u_char *valp);
191int sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp);
192int sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp);
193int sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp);
194int sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
195int sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp);
196int sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000197int sshpkt_get_bignum2(struct ssh *ssh, BIGNUM *v);
198int sshpkt_get_end(struct ssh *ssh);
199const u_char *sshpkt_ptr(struct ssh *, size_t *lenp);
200
201/* OLD API */
202extern struct ssh *active_state;
203#include "opacket.h"
Darren Tuckerf7288d72009-06-21 18:12:20 +1000204
Damien Miller773dda22015-01-30 23:10:17 +1100205#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
Damien Miller95def091999-11-25 00:26:21 +1100216#endif /* PACKET_H */