blob: 170203cabeb28a6f61724e43b176d804296e722d [file] [log] [blame]
markus@openbsd.org89dd6152018-07-09 21:20:26 +00001/* $OpenBSD: packet.h,v 1.86 2018/07/09 21:20:26 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;
djm@openbsd.org35eb33f2017-10-25 00:17:08 +000064 char *rdomain_in;
Damien Millerd4a8b7e1999-10-27 13:42:43 +100065
djm@openbsd.org07edd7e2017-02-03 23:03:33 +000066 /* Optional preamble for log messages (e.g. username) */
67 char *log_preamble;
68
markus@openbsd.org3fdc88a2015-01-19 20:07:45 +000069 /* Dispatcher table */
70 dispatch_fn *dispatch[DISPATCH_MAX];
71 /* number of packets to ignore in the dispatcher */
72 int dispatch_skip_packets;
73
markus@openbsd.org091c3022015-01-19 19:52:16 +000074 /* datafellows */
75 int compat;
markus@openbsd.orgf582f0e2015-01-19 20:30:23 +000076
77 /* Lists for private and public keys */
78 TAILQ_HEAD(, key_entry) private_keys;
79 TAILQ_HEAD(, key_entry) public_keys;
80
markus@openbsd.org5f4082d2017-05-30 14:18:15 +000081 /* Client/Server authentication context */
82 void *authctxt;
83
djm@openbsd.orgdbee4112017-09-12 06:32:07 +000084 /* Channels context */
85 struct ssh_channels *chanctxt;
86
markus@openbsd.orgf582f0e2015-01-19 20:30:23 +000087 /* APP data */
88 void *app_data;
markus@openbsd.org091c3022015-01-19 19:52:16 +000089};
Ben Lindstromf6027d32002-03-22 01:42:04 +000090
djm@openbsd.org39af7b42016-10-11 21:47:45 +000091typedef int (ssh_packet_hook_fn)(struct ssh *, struct sshbuf *,
92 u_char *, void *);
93
markus@openbsd.org091c3022015-01-19 19:52:16 +000094struct ssh *ssh_alloc_session_state(void);
95struct ssh *ssh_packet_set_connection(struct ssh *, int, int);
96void ssh_packet_set_timeout(struct ssh *, int, int);
97int ssh_packet_stop_discard(struct ssh *);
98int ssh_packet_connection_af(struct ssh *);
99void ssh_packet_set_nonblocking(struct ssh *);
100int ssh_packet_get_connection_in(struct ssh *);
101int ssh_packet_get_connection_out(struct ssh *);
102void ssh_packet_close(struct ssh *);
djm@openbsd.org39af7b42016-10-11 21:47:45 +0000103void ssh_packet_set_input_hook(struct ssh *, ssh_packet_hook_fn *, void *);
markus@openbsd.org1e0cdf82017-05-31 08:09:45 +0000104void ssh_packet_clear_keys(struct ssh *);
105void ssh_clear_newkeys(struct ssh *, int);
djm@openbsd.org39af7b42016-10-11 21:47:45 +0000106
djm@openbsd.org19bcf2e2016-02-08 10:57:07 +0000107int ssh_packet_is_rekeying(struct ssh *);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000108void ssh_packet_set_protocol_flags(struct ssh *, u_int);
109u_int ssh_packet_get_protocol_flags(struct ssh *);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000110void ssh_packet_set_tos(struct ssh *, int);
111void ssh_packet_set_interactive(struct ssh *, int, int, int);
112int ssh_packet_is_interactive(struct ssh *);
113void ssh_packet_set_server(struct ssh *);
114void ssh_packet_set_authenticated(struct ssh *);
markus@openbsd.org8d057842016-09-30 09:19:13 +0000115void ssh_packet_set_mux(struct ssh *);
116int ssh_packet_get_mux(struct ssh *);
djm@openbsd.org07edd7e2017-02-03 23:03:33 +0000117int ssh_packet_set_log_preamble(struct ssh *, const char *, ...)
118 __attribute__((format(printf, 2, 3)));
markus@openbsd.org8d057842016-09-30 09:19:13 +0000119
120int ssh_packet_log_type(u_char);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000121
markus@openbsd.org091c3022015-01-19 19:52:16 +0000122int ssh_packet_send2_wrapped(struct ssh *);
123int ssh_packet_send2(struct ssh *);
124
125int ssh_packet_read(struct ssh *);
djm@openbsd.org4509b5d2015-01-30 01:13:33 +0000126int ssh_packet_read_expect(struct ssh *, u_int type);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000127int ssh_packet_read_poll(struct ssh *);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000128int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p);
djm@openbsd.orgfae7bbe2015-01-28 21:15:47 +0000129int ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000130int ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
131int ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
132
133const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr);
134void ssh_packet_disconnect(struct ssh *, const char *fmt, ...)
135 __attribute__((format(printf, 2, 3)))
136 __attribute__((noreturn));
137void ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
138
139int ssh_set_newkeys(struct ssh *, int mode);
140void ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *);
141
djm@openbsd.org4509b5d2015-01-30 01:13:33 +0000142int ssh_packet_write_poll(struct ssh *);
143int ssh_packet_write_wait(struct ssh *);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000144int ssh_packet_have_data_to_write(struct ssh *);
145int ssh_packet_not_very_much_data_to_write(struct ssh *);
146
147int ssh_packet_connection_is_on_socket(struct ssh *);
148int ssh_packet_remaining(struct ssh *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000149
markus@openbsd.org89dd6152018-07-09 21:20:26 +0000150void ssh_tty_make_modes(struct ssh *, int, struct termios *);
151void ssh_tty_parse_modes(struct ssh *, int);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000152
markus@openbsd.org091c3022015-01-19 19:52:16 +0000153void ssh_packet_set_alive_timeouts(struct ssh *, int);
154int ssh_packet_inc_alive_timeouts(struct ssh *);
155int ssh_packet_set_maxsize(struct ssh *, u_int);
156u_int ssh_packet_get_maxsize(struct ssh *);
Damien Millerd4a8b7e1999-10-27 13:42:43 +1000157
markus@openbsd.org091c3022015-01-19 19:52:16 +0000158int ssh_packet_get_state(struct ssh *, struct sshbuf *);
159int ssh_packet_set_state(struct ssh *, struct sshbuf *);
Damien Miller4af51302000-04-16 11:18:38 +1000160
markus@openbsd.org091c3022015-01-19 19:52:16 +0000161const char *ssh_remote_ipaddr(struct ssh *);
djm@openbsd.orga4b9e0f2015-12-11 03:24:25 +0000162int ssh_remote_port(struct ssh *);
djm@openbsd.org95767262016-03-07 19:02:43 +0000163const char *ssh_local_ipaddr(struct ssh *);
164int ssh_local_port(struct ssh *);
djm@openbsd.org35eb33f2017-10-25 00:17:08 +0000165const char *ssh_packet_rdomain_in(struct ssh *);
Damien Millera5539d22003-04-09 20:50:06 +1000166
dtucker@openbsd.orgc998bf02017-02-03 02:56:00 +0000167void ssh_packet_set_rekey_limits(struct ssh *, u_int64_t, u_int32_t);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000168time_t ssh_packet_get_rekey_timeout(struct ssh *);
Darren Tuckere841eb02009-07-06 07:11:13 +1000169
markus@openbsd.org091c3022015-01-19 19:52:16 +0000170void *ssh_packet_get_input(struct ssh *);
171void *ssh_packet_get_output(struct ssh *);
172
173/* new API */
174int sshpkt_start(struct ssh *ssh, u_char type);
175int sshpkt_send(struct ssh *ssh);
djm@openbsd.org4509b5d2015-01-30 01:13:33 +0000176int sshpkt_disconnect(struct ssh *, const char *fmt, ...)
177 __attribute__((format(printf, 2, 3)));
markus@openbsd.org091c3022015-01-19 19:52:16 +0000178int sshpkt_add_padding(struct ssh *, u_char);
djm@openbsd.org4509b5d2015-01-30 01:13:33 +0000179void sshpkt_fatal(struct ssh *ssh, const char *tag, int r);
djm@openbsd.orgdbee4112017-09-12 06:32:07 +0000180int sshpkt_msg_ignore(struct ssh *, u_int);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000181
182int sshpkt_put(struct ssh *ssh, const void *v, size_t len);
183int sshpkt_putb(struct ssh *ssh, const struct sshbuf *b);
184int sshpkt_put_u8(struct ssh *ssh, u_char val);
185int sshpkt_put_u32(struct ssh *ssh, u_int32_t val);
186int sshpkt_put_u64(struct ssh *ssh, u_int64_t val);
187int sshpkt_put_string(struct ssh *ssh, const void *v, size_t len);
188int sshpkt_put_cstring(struct ssh *ssh, const void *v);
189int sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v);
190int sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000191int sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v);
192
193int sshpkt_get(struct ssh *ssh, void *valp, size_t len);
194int sshpkt_get_u8(struct ssh *ssh, u_char *valp);
195int sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp);
196int sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp);
197int sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp);
198int sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
djm@openbsd.orgdbee4112017-09-12 06:32:07 +0000199int sshpkt_peek_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000200int sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp);
201int sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000202int sshpkt_get_bignum2(struct ssh *ssh, BIGNUM *v);
203int sshpkt_get_end(struct ssh *ssh);
dtucker@openbsd.org48c23a32017-12-10 05:55:29 +0000204void sshpkt_fmt_connection_id(struct ssh *ssh, char *s, size_t l);
markus@openbsd.org091c3022015-01-19 19:52:16 +0000205const u_char *sshpkt_ptr(struct ssh *, size_t *lenp);
206
207/* OLD API */
208extern struct ssh *active_state;
209#include "opacket.h"
Darren Tuckerf7288d72009-06-21 18:12:20 +1000210
Damien Miller773dda22015-01-30 23:10:17 +1100211#if !defined(WITH_OPENSSL)
212# undef BIGNUM
213# undef EC_KEY
214# undef EC_GROUP
215# undef EC_POINT
216#elif !defined(OPENSSL_HAS_ECC)
217# undef EC_KEY
218# undef EC_GROUP
219# undef EC_POINT
220#endif
221
Damien Miller95def091999-11-25 00:26:21 +1100222#endif /* PACKET_H */