Annotation of src/usr.bin/ssh/packet.h, Revision 1.24
1.1 deraadt 1: /*
1.5 deraadt 2: * Author: Tatu Ylonen <ylo@cs.hut.fi>
3: * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4: * All rights reserved
5: * Interface for the packet protocol functions.
1.15 markus 6: *
1.17 deraadt 7: * As far as I am concerned, the code I have written for this software
8: * can be used freely for any purpose. Any derived versions of this
9: * software must be clearly marked as such, and if the derived work is
10: * incompatible with the protocol description in the RFC file, it must be
11: * called by a name other than "ssh" or "Secure Shell".
1.5 deraadt 12: */
1.1 deraadt 13:
1.24 ! itojun 14: /* RCSID("$OpenBSD: packet.h,v 1.23 2001/05/28 23:58:35 markus Exp $"); */
1.1 deraadt 15:
16: #ifndef PACKET_H
17: #define PACKET_H
18:
1.13 markus 19: #include <openssl/bn.h>
1.1 deraadt 20:
1.6 markus 21: /*
22: * Sets the socket used for communication. Disables encryption until
23: * packet_set_encryption_key is called. It is permissible that fd_in and
24: * fd_out are the same descriptor; in that case it is assumed to be a socket.
25: */
1.24 ! itojun 26: void packet_set_connection(int, int);
1.1 deraadt 27:
28: /* Puts the connection file descriptors into non-blocking mode. */
1.5 deraadt 29: void packet_set_nonblocking(void);
1.1 deraadt 30:
31: /* Returns the file descriptor used for input. */
1.5 deraadt 32: int packet_get_connection_in(void);
1.1 deraadt 33:
34: /* Returns the file descriptor used for output. */
1.5 deraadt 35: int packet_get_connection_out(void);
1.1 deraadt 36:
1.6 markus 37: /*
38: * Closes the connection (both descriptors) and clears and frees internal
39: * data structures.
40: */
1.5 deraadt 41: void packet_close(void);
1.1 deraadt 42:
1.6 markus 43: /*
44: * Causes any further packets to be encrypted using the given key. The same
45: * key is used for both sending and reception. However, both directions are
46: * encrypted independently of each other. Cipher types are defined in ssh.h.
47: */
1.15 markus 48: void
1.24 ! itojun 49: packet_set_encryption_key(const u_char *, u_int, int);
1.1 deraadt 50:
1.6 markus 51: /*
52: * Sets remote side protocol flags for the current connection. This can be
53: * called at any time.
54: */
1.24 ! itojun 55: void packet_set_protocol_flags(u_int);
1.1 deraadt 56:
57: /* Returns the remote protocol flags set earlier by the above function. */
1.18 markus 58: u_int packet_get_protocol_flags(void);
1.1 deraadt 59:
60: /* Enables compression in both directions starting from the next packet. */
1.24 ! itojun 61: void packet_start_compression(int);
1.1 deraadt 62:
1.6 markus 63: /*
64: * Informs that the current session is interactive. Sets IP flags for
65: * optimal performance in interactive use.
66: */
1.24 ! itojun 67: void packet_set_interactive(int);
1.1 deraadt 68:
69: /* Returns true if the current connection is interactive. */
1.5 deraadt 70: int packet_is_interactive(void);
1.1 deraadt 71:
72: /* Starts constructing a packet to send. */
1.24 ! itojun 73: void packet_start(u_char);
1.1 deraadt 74:
75: /* Appends a character to the packet data. */
1.5 deraadt 76: void packet_put_char(int ch);
1.1 deraadt 77:
78: /* Appends an integer to the packet data. */
1.18 markus 79: void packet_put_int(u_int value);
1.1 deraadt 80:
81: /* Appends an arbitrary precision integer to packet data. */
1.5 deraadt 82: void packet_put_bignum(BIGNUM * value);
1.11 markus 83: void packet_put_bignum2(BIGNUM * value);
1.1 deraadt 84:
85: /* Appends a string to packet data. */
1.18 markus 86: void packet_put_string(const char *buf, u_int len);
1.11 markus 87: void packet_put_cstring(const char *str);
1.18 markus 88: void packet_put_raw(const char *buf, u_int len);
1.1 deraadt 89:
1.6 markus 90: /*
91: * Finalizes and sends the packet. If the encryption key has been set,
92: * encrypts the packet before sending.
93: */
1.5 deraadt 94: void packet_send(void);
1.1 deraadt 95:
96: /* Waits until a packet has been received, and returns its type. */
1.5 deraadt 97: int packet_read(int *payload_len_ptr);
1.1 deraadt 98:
1.6 markus 99: /*
100: * Waits until a packet has been received, verifies that its type matches
101: * that given, and gives a fatal error and exits if there is a mismatch.
102: */
1.5 deraadt 103: void packet_read_expect(int *payload_len_ptr, int type);
1.1 deraadt 104:
1.6 markus 105: /*
106: * Checks if a full packet is available in the data received so far via
107: * packet_process_incoming. If so, reads the packet; otherwise returns
108: * SSH_MSG_NONE. This does not wait for data from the connection.
109: * SSH_MSG_DISCONNECT is handled specially here. Also, SSH_MSG_IGNORE
110: * messages are skipped by this function and are never returned to higher
111: * levels.
112: */
1.5 deraadt 113: int packet_read_poll(int *packet_len_ptr);
1.1 deraadt 114:
1.6 markus 115: /*
116: * Buffers the given amount of input characters. This is intended to be used
117: * together with packet_read_poll.
118: */
1.18 markus 119: void packet_process_incoming(const char *buf, u_int len);
1.1 deraadt 120:
121: /* Returns a character (0-255) from the packet data. */
1.18 markus 122: u_int packet_get_char(void);
1.1 deraadt 123:
124: /* Returns an integer from the packet data. */
1.18 markus 125: u_int packet_get_int(void);
1.1 deraadt 126:
1.6 markus 127: /*
128: * Returns an arbitrary precision integer from the packet data. The integer
129: * must have been initialized before this call.
130: */
1.5 deraadt 131: void packet_get_bignum(BIGNUM * value, int *length_ptr);
1.12 markus 132: void packet_get_bignum2(BIGNUM * value, int *length_ptr);
1.11 markus 133: char *packet_get_raw(int *length_ptr);
1.1 deraadt 134:
1.6 markus 135: /*
136: * Returns a string from the packet data. The string is allocated using
137: * xmalloc; it is the responsibility of the calling program to free it when
138: * no longer needed. The length_ptr argument may be NULL, or point to an
139: * integer into which the length of the string is stored.
140: */
1.18 markus 141: char *packet_get_string(u_int *length_ptr);
1.1 deraadt 142:
1.6 markus 143: /*
144: * Logs the error in syslog using LOG_INFO, constructs and sends a disconnect
145: * packet, closes the connection, and exits. This function never returns.
146: * The error message should not contain a newline. The total length of the
147: * message must not exceed 1024 bytes.
148: */
1.10 markus 149: void packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
1.1 deraadt 150:
1.6 markus 151: /*
152: * Sends a diagnostic message to the other side. This message can be sent at
153: * any time (but not while constructing another message). The message is
154: * printed immediately, but only if the client is being executed in verbose
155: * mode. These messages are primarily intended to ease debugging
156: * authentication problems. The total length of the message must not exceed
157: * 1024 bytes. This will automatically call packet_write_wait. If the
158: * remote side protocol flags do not indicate that it supports SSH_MSG_DEBUG,
159: * this will do nothing.
160: */
1.10 markus 161: void packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
1.1 deraadt 162:
1.6 markus 163: /* Checks if there is any buffered output, and tries to write some of the output. */
1.5 deraadt 164: void packet_write_poll(void);
1.1 deraadt 165:
166: /* Waits until all pending output data has been written. */
1.5 deraadt 167: void packet_write_wait(void);
1.1 deraadt 168:
169: /* Returns true if there is buffered data to write to the connection. */
1.5 deraadt 170: int packet_have_data_to_write(void);
1.1 deraadt 171:
172: /* Returns true if there is not too much data to write to the connection. */
1.5 deraadt 173: int packet_not_very_much_data_to_write(void);
1.4 markus 174:
175: /* maximum packet size, requested by client with SSH_CMSG_MAX_PACKET_SIZE */
176: extern int max_packet_size;
1.24 ! itojun 177: int packet_set_maxsize(int);
1.4 markus 178: #define packet_get_maxsize() max_packet_size
1.1 deraadt 179:
1.22 stevesk 180: /* Stores tty modes from the fd or tiop into current packet. */
1.24 ! itojun 181: void tty_make_modes(int, struct termios *);
1.1 deraadt 182:
183: /* Parses tty modes for the fd from the current packet. */
1.24 ! itojun 184: void tty_parse_modes(int, int *);
1.1 deraadt 185:
186: #define packet_integrity_check(payload_len, expected_len, type) \
187: do { \
188: int _p = (payload_len), _e = (expected_len); \
189: if (_p != _e) { \
190: log("Packet integrity error (%d != %d) at %s:%d", \
191: _p, _e, __FILE__, __LINE__); \
192: packet_disconnect("Packet integrity error. (%d)", (type)); \
193: } \
194: } while (0)
1.8 markus 195:
1.14 markus 196: #define packet_done() \
197: do { \
198: int _len = packet_remaining(); \
199: if (_len > 0) { \
200: log("Packet integrity error (%d bytes remaining) at %s:%d", \
201: _len ,__FILE__, __LINE__); \
202: packet_disconnect("Packet integrity error."); \
203: } \
204: } while (0)
205:
1.9 markus 206: /* remote host is connected via a socket/ipv4 */
1.8 markus 207: int packet_connection_is_on_socket(void);
1.9 markus 208: int packet_connection_is_ipv4(void);
1.14 markus 209:
210: /* returns remaining payload bytes */
211: int packet_remaining(void);
1.20 markus 212:
213: /* append an ignore message */
1.24 ! itojun 214: void packet_send_ignore(int);
1.21 markus 215:
216: /* add an ignore message and make sure size (current+ignore) = n*sumlen */
1.24 ! itojun 217: void packet_inject_ignore(int);
1.1 deraadt 218:
1.5 deraadt 219: #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