Grid Community Toolkit  6.2.1705709074 (tag: v6.2.20240202)
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
packet.h
1 /* $OpenBSD: packet.h,v 1.94 2022/01/22 00:49:34 djm Exp $ */
2 
3 /*
4  * Author: Tatu Ylonen <[email protected]>
5  * Copyright (c) 1995 Tatu Ylonen <[email protected]>, 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  /* logging data for ServerLogging patch*/
91  double start_time;
92  u_long fdout_bytes;
93  u_long stdin_bytes;
94 
95  /* track that we are in a none cipher/mac state */
96  int none;
97 };
98 
99 typedef int (ssh_packet_hook_fn)(struct ssh *, struct sshbuf *,
100  u_char *, void *);
101 
102 struct ssh *ssh_alloc_session_state(void);
103 struct ssh *ssh_packet_set_connection(struct ssh *, int, int);
104 void ssh_packet_set_timeout(struct ssh *, int, int);
105 int ssh_packet_stop_discard(struct ssh *);
106 int ssh_packet_connection_af(struct ssh *);
107 void ssh_packet_set_nonblocking(struct ssh *);
108 int ssh_packet_get_connection_in(struct ssh *);
109 int ssh_packet_get_connection_out(struct ssh *);
110 void ssh_packet_close(struct ssh *);
111 void ssh_packet_set_input_hook(struct ssh *, ssh_packet_hook_fn *, void *);
112 void ssh_packet_clear_keys(struct ssh *);
113 void ssh_clear_newkeys(struct ssh *, int);
114 
115 int ssh_packet_is_rekeying(struct ssh *);
116 int ssh_packet_check_rekey(struct ssh *);
117 void ssh_packet_set_protocol_flags(struct ssh *, u_int);
118 u_int ssh_packet_get_protocol_flags(struct ssh *);
119 void ssh_packet_set_tos(struct ssh *, int);
120 void ssh_packet_set_interactive(struct ssh *, int, int, int);
121 int ssh_packet_is_interactive(struct ssh *);
122 void ssh_packet_set_server(struct ssh *);
123 void ssh_packet_set_authenticated(struct ssh *);
124 void ssh_packet_set_mux(struct ssh *);
125 int ssh_packet_get_mux(struct ssh *);
126 int ssh_packet_set_log_preamble(struct ssh *, const char *, ...)
127  __attribute__((format(printf, 2, 3)));
128 
129 int ssh_packet_log_type(u_char);
130 
131 int ssh_packet_send2_wrapped(struct ssh *);
132 int ssh_packet_send2(struct ssh *);
133 
134 int ssh_packet_read(struct ssh *);
135 int ssh_packet_read_expect(struct ssh *, u_int type);
136 int ssh_packet_read_poll(struct ssh *);
137 int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p);
138 int ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len);
139 int ssh_packet_process_read(struct ssh *, int);
140 int ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
141 int ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
142 
143 const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr);
144 void ssh_packet_disconnect(struct ssh *, const char *fmt, ...)
145  __attribute__((format(printf, 2, 3)))
146  __attribute__((noreturn));
147 void ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
148 
149 int ssh_set_newkeys(struct ssh *, int mode);
150 void ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *);
151 
152 int ssh_packet_write_poll(struct ssh *);
153 int ssh_packet_write_wait(struct ssh *);
154 int ssh_packet_have_data_to_write(struct ssh *);
155 int ssh_packet_not_very_much_data_to_write(struct ssh *);
156 
157 int ssh_packet_connection_is_on_socket(struct ssh *);
158 int ssh_packet_remaining(struct ssh *);
159 
160 void ssh_tty_make_modes(struct ssh *, int, struct termios *);
161 void ssh_tty_parse_modes(struct ssh *, int);
162 
163 void ssh_packet_set_alive_timeouts(struct ssh *, int);
164 int ssh_packet_inc_alive_timeouts(struct ssh *);
165 int ssh_packet_set_maxsize(struct ssh *, u_int);
166 u_int ssh_packet_get_maxsize(struct ssh *);
167 
168 int packet_authentication_state(const struct ssh *);
169 
170 int ssh_packet_get_state(struct ssh *, struct sshbuf *);
171 int ssh_packet_set_state(struct ssh *, struct sshbuf *);
172 
173 const char *ssh_remote_ipaddr(struct ssh *);
174 int ssh_remote_port(struct ssh *);
175 const char *ssh_local_ipaddr(struct ssh *);
176 int ssh_local_port(struct ssh *);
177 const char *ssh_packet_rdomain_in(struct ssh *);
178 
179 void ssh_packet_set_rekey_limits(struct ssh *, u_int64_t, u_int32_t);
180 time_t ssh_packet_get_rekey_timeout(struct ssh *);
181 
182 void *ssh_packet_get_input(struct ssh *);
183 void *ssh_packet_get_output(struct ssh *);
184 void *ssh_packet_get_receive_context(struct ssh *);
185 void *ssh_packet_get_send_context(struct ssh *);
186 
187 /* for forced packet rekeying post auth */
188 void packet_request_rekeying(void);
189 /* final log entry support */
190 void sshpkt_final_log_entry (struct ssh *);
191 
192 /* new API */
193 int sshpkt_start(struct ssh *ssh, u_char type);
194 int sshpkt_send(struct ssh *ssh);
195 int sshpkt_disconnect(struct ssh *, const char *fmt, ...)
196  __attribute__((format(printf, 2, 3)));
197 int sshpkt_add_padding(struct ssh *, u_char);
198 void sshpkt_fatal(struct ssh *ssh, int r, const char *fmt, ...)
199  __attribute__((format(printf, 3, 4)))
200  __attribute__((noreturn));
201 int sshpkt_msg_ignore(struct ssh *, u_int);
202 
203 int sshpkt_put(struct ssh *ssh, const void *v, size_t len);
204 int sshpkt_putb(struct ssh *ssh, const struct sshbuf *b);
205 int sshpkt_put_u8(struct ssh *ssh, u_char val);
206 int sshpkt_put_u32(struct ssh *ssh, u_int32_t val);
207 int sshpkt_put_u64(struct ssh *ssh, u_int64_t val);
208 int sshpkt_put_string(struct ssh *ssh, const void *v, size_t len);
209 int sshpkt_put_cstring(struct ssh *ssh, const void *v);
210 int sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v);
211 int sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g);
212 int sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v);
213 
214 int sshpkt_get(struct ssh *ssh, void *valp, size_t len);
215 int sshpkt_get_u8(struct ssh *ssh, u_char *valp);
216 int sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp);
217 int sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp);
218 int sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp);
219 int sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
220 int sshpkt_peek_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
221 int sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp);
222 int sshpkt_getb_froms(struct ssh *ssh, struct sshbuf **valp);
223 int sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g);
224 int sshpkt_get_bignum2(struct ssh *ssh, BIGNUM **valp);
225 int sshpkt_get_end(struct ssh *ssh);
226 void sshpkt_fmt_connection_id(struct ssh *ssh, char *s, size_t l);
227 const u_char *sshpkt_ptr(struct ssh *, size_t *lenp);
228 
229 #if !defined(WITH_OPENSSL)
230 # undef BIGNUM
231 # undef EC_KEY
232 # undef EC_GROUP
233 # undef EC_POINT
234 #elif !defined(OPENSSL_HAS_ECC)
235 # undef EC_KEY
236 # undef EC_GROUP
237 # undef EC_POINT
238 #endif
239 
240 void packet_destroy_all(struct ssh *, int, int);
241 #endif /* PACKET_H */
Generated by   doxygen 1.8.5