Annotation of src/usr.bin/ssh/packet.h, Revision 1.63
1.63 ! markus 1: /* $OpenBSD: packet.h,v 1.62 2015/01/19 19:52:16 markus 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.13 markus 21: #include <openssl/bn.h>
1.54 djm 22: #include <openssl/ec.h>
1.62 markus 23: #include <sys/signal.h>
24: #include <sys/queue.h>
1.1 deraadt 25:
1.62 markus 26: struct kex;
27: struct sshkey;
28: struct sshbuf;
29: struct session_state; /* private session data */
30:
1.63 ! markus 31: #include "dispatch.h" /* typedef, DISPATCH_MAX */
! 32:
1.62 markus 33: struct ssh {
34: /* Session state */
35: struct session_state *state;
36:
37: /* Key exchange */
38: struct kex *kex;
39:
40: /* cached remote ip address and port*/
41: char *remote_ipaddr;
42: int remote_port;
1.63 ! markus 43:
! 44: /* Dispatcher table */
! 45: dispatch_fn *dispatch[DISPATCH_MAX];
! 46: /* number of packets to ignore in the dispatcher */
! 47: int dispatch_skip_packets;
1.62 markus 48:
49: /* datafellows */
50: int compat;
51: };
52:
53: struct ssh *ssh_alloc_session_state(void);
54: struct ssh *ssh_packet_set_connection(struct ssh *, int, int);
55: void ssh_packet_set_timeout(struct ssh *, int, int);
56: int ssh_packet_stop_discard(struct ssh *);
57: int ssh_packet_connection_af(struct ssh *);
58: void ssh_packet_set_nonblocking(struct ssh *);
59: int ssh_packet_get_connection_in(struct ssh *);
60: int ssh_packet_get_connection_out(struct ssh *);
61: void ssh_packet_close(struct ssh *);
62: void ssh_packet_set_encryption_key(struct ssh *, const u_char *, u_int, int);
63: void ssh_packet_set_protocol_flags(struct ssh *, u_int);
64: u_int ssh_packet_get_protocol_flags(struct ssh *);
65: int ssh_packet_start_compression(struct ssh *, int);
66: void ssh_packet_set_tos(struct ssh *, int);
67: void ssh_packet_set_interactive(struct ssh *, int, int, int);
68: int ssh_packet_is_interactive(struct ssh *);
69: void ssh_packet_set_server(struct ssh *);
70: void ssh_packet_set_authenticated(struct ssh *);
71:
72: int ssh_packet_send1(struct ssh *);
73: int ssh_packet_send2_wrapped(struct ssh *);
74: int ssh_packet_send2(struct ssh *);
75:
76: int ssh_packet_read(struct ssh *);
77: void ssh_packet_read_expect(struct ssh *, int type);
78: int ssh_packet_read_poll(struct ssh *);
79: int ssh_packet_read_poll1(struct ssh *, u_char *);
80: int ssh_packet_read_poll2(struct ssh *, u_char *, u_int32_t *seqnr_p);
81: void ssh_packet_process_incoming(struct ssh *, const char *buf, u_int len);
82: int ssh_packet_read_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
83: int ssh_packet_read_poll_seqnr(struct ssh *, u_char *, u_int32_t *seqnr_p);
84:
85: const void *ssh_packet_get_string_ptr(struct ssh *, u_int *length_ptr);
86: void ssh_packet_disconnect(struct ssh *, const char *fmt, ...)
87: __attribute__((format(printf, 2, 3)))
88: __attribute__((noreturn));
89: void ssh_packet_send_debug(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
90:
91: int ssh_set_newkeys(struct ssh *, int mode);
92: void ssh_packet_get_bytes(struct ssh *, u_int64_t *, u_int64_t *);
93:
94: typedef void *(ssh_packet_comp_alloc_func)(void *, u_int, u_int);
95: typedef void (ssh_packet_comp_free_func)(void *, void *);
96: void ssh_packet_set_compress_hooks(struct ssh *, void *,
97: ssh_packet_comp_alloc_func *, ssh_packet_comp_free_func *);
98:
99: void ssh_packet_write_poll(struct ssh *);
100: void ssh_packet_write_wait(struct ssh *);
101: int ssh_packet_have_data_to_write(struct ssh *);
102: int ssh_packet_not_very_much_data_to_write(struct ssh *);
103:
104: int ssh_packet_connection_is_on_socket(struct ssh *);
105: int ssh_packet_remaining(struct ssh *);
106: void ssh_packet_send_ignore(struct ssh *, int);
1.1 deraadt 107:
1.25 markus 108: void tty_make_modes(int, struct termios *);
109: void tty_parse_modes(int, int *);
1.1 deraadt 110:
1.62 markus 111: void ssh_packet_set_alive_timeouts(struct ssh *, int);
112: int ssh_packet_inc_alive_timeouts(struct ssh *);
113: int ssh_packet_set_maxsize(struct ssh *, u_int);
114: u_int ssh_packet_get_maxsize(struct ssh *);
115:
116: int ssh_packet_get_state(struct ssh *, struct sshbuf *);
117: int ssh_packet_set_state(struct ssh *, struct sshbuf *);
118:
119: const char *ssh_remote_ipaddr(struct ssh *);
120:
121: int ssh_packet_need_rekeying(struct ssh *);
122: void ssh_packet_set_rekey_limits(struct ssh *, u_int32_t, time_t);
123: time_t ssh_packet_get_rekey_timeout(struct ssh *);
124:
125: /* XXX FIXME */
126: void ssh_packet_backup_state(struct ssh *, struct ssh *);
127: void ssh_packet_restore_state(struct ssh *, struct ssh *);
128:
129: void *ssh_packet_get_input(struct ssh *);
130: void *ssh_packet_get_output(struct ssh *);
131:
132: /* new API */
133: int sshpkt_start(struct ssh *ssh, u_char type);
134: int sshpkt_send(struct ssh *ssh);
135: int sshpkt_disconnect(struct ssh *, const char *fmt, ...) __attribute__((format(printf, 2, 3)));
136: int sshpkt_add_padding(struct ssh *, u_char);
137:
138: int sshpkt_put(struct ssh *ssh, const void *v, size_t len);
139: int sshpkt_putb(struct ssh *ssh, const struct sshbuf *b);
140: int sshpkt_put_u8(struct ssh *ssh, u_char val);
141: int sshpkt_put_u32(struct ssh *ssh, u_int32_t val);
142: int sshpkt_put_u64(struct ssh *ssh, u_int64_t val);
143: int sshpkt_put_string(struct ssh *ssh, const void *v, size_t len);
144: int sshpkt_put_cstring(struct ssh *ssh, const void *v);
145: int sshpkt_put_stringb(struct ssh *ssh, const struct sshbuf *v);
146: int sshpkt_put_ec(struct ssh *ssh, const EC_POINT *v, const EC_GROUP *g);
147: int sshpkt_put_bignum1(struct ssh *ssh, const BIGNUM *v);
148: int sshpkt_put_bignum2(struct ssh *ssh, const BIGNUM *v);
149:
150: int sshpkt_get(struct ssh *ssh, void *valp, size_t len);
151: int sshpkt_get_u8(struct ssh *ssh, u_char *valp);
152: int sshpkt_get_u32(struct ssh *ssh, u_int32_t *valp);
153: int sshpkt_get_u64(struct ssh *ssh, u_int64_t *valp);
154: int sshpkt_get_string(struct ssh *ssh, u_char **valp, size_t *lenp);
155: int sshpkt_get_string_direct(struct ssh *ssh, const u_char **valp, size_t *lenp);
156: int sshpkt_get_cstring(struct ssh *ssh, char **valp, size_t *lenp);
157: int sshpkt_get_ec(struct ssh *ssh, EC_POINT *v, const EC_GROUP *g);
158: int sshpkt_get_bignum1(struct ssh *ssh, BIGNUM *v);
159: int sshpkt_get_bignum2(struct ssh *ssh, BIGNUM *v);
160: int sshpkt_get_end(struct ssh *ssh);
161: const u_char *sshpkt_ptr(struct ssh *, size_t *lenp);
162:
163: /* OLD API */
164: extern struct ssh *active_state;
165: #include "opacket.h"
1.1 deraadt 166:
1.5 deraadt 167: #endif /* PACKET_H */