Annotation of src/usr.bin/ssh/packet.h, Revision 1.94.8.1
1.94.8.1! bluhm 1: /* $OpenBSD: packet.h,v 1.94 2022/01/22 00:49:34 djm Exp $ */
1.33 stevesk 2:
1.1 deraadt 3: /*
1.5 deraadt 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.
1.15 markus 8: *
1.17 deraadt 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".
1.5 deraadt 14: */
1.1 deraadt 15:
16: #ifndef PACKET_H
17: #define PACKET_H
1.44 stevesk 18:
19: #include <termios.h>
1.1 deraadt 20:
1.91 djm 21: #include <sys/signal.h>
22: #include <sys/queue.h>
23:
24: #ifdef WITH_OPENSSL
1.13 markus 25: #include <openssl/bn.h>
1.54 djm 26: #include <openssl/ec.h>
1.91 djm 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 */
1.1 deraadt 33:
1.62 markus 34: struct kex;
35: struct sshkey;
36: struct sshbuf;
37: struct session_state; /* private session data */
38:
1.63 markus 39: #include "dispatch.h" /* typedef, DISPATCH_MAX */
40:
1.64 markus 41: struct key_entry {
42: TAILQ_ENTRY(key_entry) next;
43: struct sshkey *key;
44: };
45:
1.62 markus 46: struct ssh {
47: /* Session state */
48: struct session_state *state;
49:
50: /* Key exchange */
51: struct kex *kex;
52:
1.71 djm 53: /* cached local and remote ip addresses and ports */
1.62 markus 54: char *remote_ipaddr;
55: int remote_port;
1.71 djm 56: char *local_ipaddr;
57: int local_port;
1.83 djm 58: char *rdomain_in;
1.63 markus 59:
1.76 djm 60: /* Optional preamble for log messages (e.g. username) */
61: char *log_preamble;
62:
1.63 markus 63: /* Dispatcher table */
64: dispatch_fn *dispatch[DISPATCH_MAX];
65: /* number of packets to ignore in the dispatcher */
66: int dispatch_skip_packets;
1.62 markus 67:
68: /* datafellows */
69: int compat;
1.64 markus 70:
71: /* Lists for private and public keys */
72: TAILQ_HEAD(, key_entry) private_keys;
73: TAILQ_HEAD(, key_entry) public_keys;
1.80 markus 74:
75: /* Client/Server authentication context */
76: void *authctxt;
1.64 markus 77:
1.82 djm 78: /* Channels context */
79: struct ssh_channels *chanctxt;
80:
1.64 markus 81: /* APP data */
82: void *app_data;
1.62 markus 83: };
84:
1.74 djm 85: typedef int (ssh_packet_hook_fn)(struct ssh *, struct sshbuf *,
86: u_char *, void *);
87:
1.62 markus 88: struct ssh *ssh_alloc_session_state(void);
89: struct ssh *ssh_packet_set_connection(struct ssh *, int, int);
90: void ssh_packet_set_timeout(struct ssh *, int, int);
91: int ssh_packet_stop_discard(struct ssh *);
92: int ssh_packet_connection_af(struct ssh *);
93: void ssh_packet_set_nonblocking(struct ssh *);
94: int ssh_packet_get_connection_in(struct ssh *);
95: int ssh_packet_get_connection_out(struct ssh *);
96: void ssh_packet_close(struct ssh *);
1.74 djm 97: void ssh_packet_set_input_hook(struct ssh *, ssh_packet_hook_fn *, void *);
1.81 markus 98: void ssh_packet_clear_keys(struct ssh *);
99: void ssh_clear_newkeys(struct ssh *, int);
1.74 djm 100:
1.70 djm 101: int ssh_packet_is_rekeying(struct ssh *);
1.93 djm 102: int ssh_packet_check_rekey(struct ssh *);
1.62 markus 103: void ssh_packet_set_protocol_flags(struct ssh *, u_int);
104: u_int ssh_packet_get_protocol_flags(struct ssh *);
105: void ssh_packet_set_tos(struct ssh *, int);
106: void ssh_packet_set_interactive(struct ssh *, int, int, int);
107: int ssh_packet_is_interactive(struct ssh *);
108: void ssh_packet_set_server(struct ssh *);
109: void ssh_packet_set_authenticated(struct ssh *);
1.73 markus 110: void ssh_packet_set_mux(struct ssh *);
111: int ssh_packet_get_mux(struct ssh *);
1.76 djm 112: int ssh_packet_set_log_preamble(struct ssh *, const char *, ...)
113: __attribute__((format(printf, 2, 3)));
1.73 markus 114:
115: int ssh_packet_log_type(u_char);
1.62 markus 116:
117: int ssh_packet_send2_wrapped(struct ssh *);
118: int ssh_packet_send2(struct ssh *);
119:
120: int ssh_packet_read(struct ssh *);
121: int ssh_packet_read_poll(struct ssh *);
122: int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p);
1.65 djm 123: int ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len);
1.94 djm 124: int ssh_packet_process_read(struct ssh *, int);
1.62 markus 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:
1.66 djm 137: int ssh_packet_write_poll(struct ssh *);
138: int ssh_packet_write_wait(struct ssh *);
1.62 markus 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 *);
1.1 deraadt 144:
1.86 markus 145: void ssh_tty_make_modes(struct ssh *, int, struct termios *);
146: void ssh_tty_parse_modes(struct ssh *, int);
1.1 deraadt 147:
1.62 markus 148: void ssh_packet_set_alive_timeouts(struct ssh *, int);
149: int ssh_packet_inc_alive_timeouts(struct ssh *);
150: int ssh_packet_set_maxsize(struct ssh *, u_int);
151: u_int ssh_packet_get_maxsize(struct ssh *);
152:
153: int ssh_packet_get_state(struct ssh *, struct sshbuf *);
154: int ssh_packet_set_state(struct ssh *, struct sshbuf *);
155:
156: const char *ssh_remote_ipaddr(struct ssh *);
1.67 djm 157: int ssh_remote_port(struct ssh *);
1.71 djm 158: const char *ssh_local_ipaddr(struct ssh *);
159: int ssh_local_port(struct ssh *);
1.83 djm 160: const char *ssh_packet_rdomain_in(struct ssh *);
1.62 markus 161:
1.75 dtucker 162: void ssh_packet_set_rekey_limits(struct ssh *, u_int64_t, u_int32_t);
1.62 markus 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);
1.66 djm 171: int sshpkt_disconnect(struct ssh *, const char *fmt, ...)
172: __attribute__((format(printf, 2, 3)));
1.62 markus 173: int sshpkt_add_padding(struct ssh *, u_char);
1.88 djm 174: void sshpkt_fatal(struct ssh *ssh, int r, const char *fmt, ...)
1.92 markus 175: __attribute__((format(printf, 3, 4)))
176: __attribute__((noreturn));
1.82 djm 177: int sshpkt_msg_ignore(struct ssh *, u_int);
1.62 markus 178:
179: int sshpkt_put(struct ssh *ssh, const void *v, size_t len);
180: int sshpkt_putb(struct ssh *ssh, const struct sshbuf *b);
181: int sshpkt_put_u8(struct ssh *ssh, u_char val);
182: int sshpkt_put_u32(struct ssh *ssh, u_int32_t val);
183: int sshpkt_put_u64(struct ssh *ssh, u_int64_t val);
184: int sshpkt_put_string(struct ssh *ssh, const void *v, size_t len);
185: int sshpkt_put_cstring(struct ssh *ssh, const void *v);
186: int sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v);
187: int sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g);
188: int sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v);
189:
190: int sshpkt_get(struct ssh *ssh, void *valp, size_t len);
191: int sshpkt_get_u8(struct ssh *ssh, u_char *valp);
192: int sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp);
193: int sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp);
194: int sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp);
195: int sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
1.82 djm 196: int sshpkt_peek_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
1.62 markus 197: int sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp);
1.90 djm 198: int sshpkt_getb_froms(struct ssh *ssh, struct sshbuf **valp);
1.62 markus 199: int sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g);
1.89 djm 200: int sshpkt_get_bignum2(struct ssh *ssh, BIGNUM **valp);
1.62 markus 201: int sshpkt_get_end(struct ssh *ssh);
1.84 dtucker 202: void sshpkt_fmt_connection_id(struct ssh *ssh, char *s, size_t l);
1.62 markus 203: const u_char *sshpkt_ptr(struct ssh *, size_t *lenp);
1.1 deraadt 204:
1.5 deraadt 205: #endif /* PACKET_H */
![[BACK]](/icons/back.gif){kind=icon}
Return to packet.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh