libssh
buffer.h
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  */
34 struct 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 
44 void ssh_buffer_set_secure(ssh_buffer buffer);
45 int ssh_buffer_add_ssh_string(ssh_buffer buffer, ssh_string string);
46 int ssh_buffer_add_u8(ssh_buffer buffer, uint8_t data);
47 int ssh_buffer_add_u16(ssh_buffer buffer, uint16_t data);
48 int ssh_buffer_add_u32(ssh_buffer buffer, uint32_t data);
49 int ssh_buffer_add_u64(ssh_buffer buffer, uint64_t data);
50 
51 int ssh_buffer_validate_length(struct ssh_buffer_struct *buffer, size_t len);
52 
53 void *ssh_buffer_allocate(struct ssh_buffer_struct *buffer, uint32_t len);
54 int ssh_buffer_allocate_size(struct ssh_buffer_struct *buffer, uint32_t len);
55 int ssh_buffer_pack_va(struct ssh_buffer_struct *buffer,
56  const char *format,
57  int argc,
58  va_list ap);
59 int _ssh_buffer_pack(struct ssh_buffer_struct *buffer,
60  const char *format,
61  int argc,
62  ...);
63 #define ssh_buffer_pack(buffer, format, ...) \
64  _ssh_buffer_pack((buffer), (format), __VA_NARG__(__VA_ARGS__), __VA_ARGS__, SSH_BUFFER_PACK_END)
65 
66 int ssh_buffer_unpack_va(struct ssh_buffer_struct *buffer,
67  const char *format, int argc,
68  va_list ap);
69 int _ssh_buffer_unpack(struct ssh_buffer_struct *buffer,
70  const char *format,
71  int argc,
72  ...);
73 #define ssh_buffer_unpack(buffer, format, ...) \
74  _ssh_buffer_unpack((buffer), (format), __VA_NARG__(__VA_ARGS__), __VA_ARGS__, SSH_BUFFER_PACK_END)
75 
76 int ssh_buffer_prepend_data(ssh_buffer buffer, const void *data, uint32_t len);
77 int ssh_buffer_add_buffer(ssh_buffer buffer, ssh_buffer source);
78 
79 /* buffer_read_*() returns the number of bytes read, except for ssh strings */
80 int ssh_buffer_get_u8(ssh_buffer buffer, uint8_t *data);
81 int ssh_buffer_get_u32(ssh_buffer buffer, uint32_t *data);
82 int ssh_buffer_get_u64(ssh_buffer buffer, uint64_t *data);
83 
84 /* ssh_buffer_get_ssh_string() is an exception. if the String read is too large or invalid, it will answer NULL. */
85 ssh_string ssh_buffer_get_ssh_string(ssh_buffer buffer);
86 
87 /* ssh_buffer_pass_bytes acts as if len bytes have been read (used for padding) */
88 uint32_t ssh_buffer_pass_bytes_end(ssh_buffer buffer, uint32_t len);
89 uint32_t ssh_buffer_pass_bytes(ssh_buffer buffer, uint32_t len);
90 
91 #endif /* BUFFER_H_ */
int ssh_buffer_allocate_size(struct ssh_buffer_struct *buffer, uint32_t len)
Ensure the buffer has at least a certain preallocated size.
Definition: buffer.c:260
int ssh_buffer_validate_length(struct ssh_buffer_struct *buffer, size_t len)
Valdiates that the given length can be obtained from the buffer.
Definition: buffer.c:668
void ssh_buffer_set_secure(ssh_buffer buffer)
Sets the buffer as secure.
Definition: buffer.c:125