1/*
2 * This file is part of the SSH Library
3 *
4 * Copyright (c) 2009 by Aris Adamantiadis
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#ifndef BUFFER_H_
22#define BUFFER_H_
23
24#include <stdarg.h>
25
26#include "libssh/libssh.h"
27/*
28 * Describes a buffer state
29 * [XXXXXXXXXXXXDATA PAYLOAD XXXXXXXXXXXXXXXXXXXXXXXX]
30 * ^ ^ ^ ^]
31 * \_data points\_pos points here \_used points here | /
32 * here Allocated
33 */
34struct ssh_buffer_struct {
35 char *data;
36 uint32_t used;
37 uint32_t allocated;
38 uint32_t pos;
39 int secure;
40};
41
42#define SSH_BUFFER_PACK_END ((uint32_t) 0x4f65feb3)
43
44LIBSSH_API void ssh_buffer_free(ssh_buffer buffer);
45LIBSSH_API void *ssh_buffer_get_begin(ssh_buffer buffer);
46LIBSSH_API uint32_t ssh_buffer_get_len(ssh_buffer buffer);
47LIBSSH_API ssh_buffer ssh_buffer_new(void);
48void ssh_buffer_set_secure(ssh_buffer buffer);
49int buffer_add_ssh_string(ssh_buffer buffer, ssh_string string);
50int buffer_add_u8(ssh_buffer buffer, uint8_t data);
51int buffer_add_u16(ssh_buffer buffer, uint16_t data);
52int buffer_add_u32(ssh_buffer buffer, uint32_t data);
53int buffer_add_u64(ssh_buffer buffer, uint64_t data);
54int ssh_buffer_add_data(ssh_buffer buffer, const void *data, uint32_t len);
55
56int ssh_buffer_validate_length(struct ssh_buffer_struct *buffer, size_t len);
57
58int ssh_buffer_pack_va(struct ssh_buffer_struct *buffer,
59 const char *format,
60 int argc,
61 va_list ap);
62int _ssh_buffer_pack(struct ssh_buffer_struct *buffer,
63 const char *format,
64 int argc,
65 ...);
66#define ssh_buffer_pack(buffer, format, ...) \
67 _ssh_buffer_pack((buffer), (format), __VA_NARG__(__VA_ARGS__), __VA_ARGS__, SSH_BUFFER_PACK_END)
68
69int ssh_buffer_unpack_va(struct ssh_buffer_struct *buffer,
70 const char *format, int argc,
71 va_list ap);
72int _ssh_buffer_unpack(struct ssh_buffer_struct *buffer,
73 const char *format,
74 int argc,
75 ...);
76#define ssh_buffer_unpack(buffer, format, ...) \
77 _ssh_buffer_unpack((buffer), (format), __VA_NARG__(__VA_ARGS__), __VA_ARGS__, SSH_BUFFER_PACK_END)
78
79int buffer_prepend_data(ssh_buffer buffer, const void *data, uint32_t len);
80int buffer_add_buffer(ssh_buffer buffer, ssh_buffer source);
81int ssh_buffer_reinit(ssh_buffer buffer);
82
83/* buffer_get_rest returns a pointer to the current position into the buffer */
84void *buffer_get_rest(ssh_buffer buffer);
85/* buffer_get_rest_len returns the number of bytes which can be read */
86uint32_t buffer_get_rest_len(ssh_buffer buffer);
87
88/* buffer_read_*() returns the number of bytes read, except for ssh strings */
89int buffer_get_u8(ssh_buffer buffer, uint8_t *data);
90int buffer_get_u32(ssh_buffer buffer, uint32_t *data);
91int buffer_get_u64(ssh_buffer buffer, uint64_t *data);
92
93uint32_t buffer_get_data(ssh_buffer buffer, void *data, uint32_t requestedlen);
94/* buffer_get_ssh_string() is an exception. if the String read is too large or invalid, it will answer NULL. */
95ssh_string buffer_get_ssh_string(ssh_buffer buffer);
96/* gets a string out of a SSH-1 mpint */
97ssh_string buffer_get_mpint(ssh_buffer buffer);
98/* buffer_pass_bytes acts as if len bytes have been read (used for padding) */
99uint32_t buffer_pass_bytes_end(ssh_buffer buffer, uint32_t len);
100uint32_t buffer_pass_bytes(ssh_buffer buffer, uint32_t len);
101
102#endif /* BUFFER_H_ */
103