crypto/openssh/sshbuf.h

1 /*	$OpenBSD: sshbuf.h,v 1.7 2016/05/02 08:49:03 djm Exp $	*/
40 struct sshbuf {
50 	struct sshbuf *parent;	/* If child, pointer to parent */
59 void sshbuf_init(struct sshbuf *buf);
63  * Create a new sshbuf buffer.
66 struct sshbuf *sshbuf_new(void);
69  * Create a new, read-only sshbuf buffer from existing data.
72 struct sshbuf *sshbuf_from(const void *blob, size_t len);
75  * Create a new, read-only sshbuf buffer from the contents of an existing
80 struct sshbuf *sshbuf_fromb(struct sshbuf *buf);
83  * Create a new, read-only sshbuf buffer from the contents of a string in
89 int	sshbuf_froms(struct sshbuf *buf, struct sshbuf **bufp);
94 void	sshbuf_free(struct sshbuf *buf);
99 void	sshbuf_reset(struct sshbuf *buf);
104 size_t	sshbuf_max_size(const struct sshbuf *buf);
110 int	sshbuf_set_max_size(struct sshbuf *buf, size_t max_size);
115 size_t	sshbuf_len(const struct sshbuf *buf);
120 size_t	sshbuf_avail(const struct sshbuf *buf);
125 const u_char *sshbuf_ptr(const struct sshbuf *buf);
131 u_char *sshbuf_mutable_ptr(const struct sshbuf *buf);
139 int	sshbuf_check_reserve(const struct sshbuf *buf, size_t len);
146 int	sshbuf_reserve(struct sshbuf *buf, size_t len, u_char **dpp);
152 int	sshbuf_consume(struct sshbuf *buf, size_t len);
158 int	sshbuf_consume_end(struct sshbuf *buf, size_t len);
161 int	sshbuf_get(struct sshbuf *buf, void *v, size_t len);
162 int	sshbuf_put(struct sshbuf *buf, const void *v, size_t len);
163 int	sshbuf_putb(struct sshbuf *buf, const struct sshbuf *v);
166 int	sshbuf_putf(struct sshbuf *buf, const char *fmt, ...)
168 int	sshbuf_putfv(struct sshbuf *buf, const char *fmt, va_list ap);
171 int	sshbuf_get_u64(struct sshbuf *buf, u_int64_t *valp);
172 int	sshbuf_get_u32(struct sshbuf *buf, u_int32_t *valp);
173 int	sshbuf_get_u16(struct sshbuf *buf, u_int16_t *valp);
174 int	sshbuf_get_u8(struct sshbuf *buf, u_char *valp);
175 int	sshbuf_put_u64(struct sshbuf *buf, u_int64_t val);
176 int	sshbuf_put_u32(struct sshbuf *buf, u_int32_t val);
177 int	sshbuf_put_u16(struct sshbuf *buf, u_int16_t val);
178 int	sshbuf_put_u8(struct sshbuf *buf, u_char val);
185 int	sshbuf_get_string(struct sshbuf *buf, u_char **valp, size_t *lenp);
186 int	sshbuf_get_cstring(struct sshbuf *buf, char **valp, size_t *lenp);
187 int	sshbuf_get_stringb(struct sshbuf *buf, struct sshbuf *v);
188 int	sshbuf_put_string(struct sshbuf *buf, const void *v, size_t len);
189 int	sshbuf_put_cstring(struct sshbuf *buf, const char *v);
190 int	sshbuf_put_stringb(struct sshbuf *buf, const struct sshbuf *v);
193  * "Direct" variant of sshbuf_get_string, returns pointer into the sshbuf to
195  * next sshbuf-modifying function call. Caller does not free.
197 int	sshbuf_get_string_direct(struct sshbuf *buf, const u_char **valp,
204 int	sshbuf_peek_string_direct(const struct sshbuf *buf, const u_char **valp,
211 int	sshbuf_put_bignum2_bytes(struct sshbuf *buf, const void *v, size_t len);
212 int	sshbuf_get_bignum2_bytes_direct(struct sshbuf *buf,
215 int	sshbuf_get_bignum2(struct sshbuf *buf, BIGNUM *v);
216 int	sshbuf_get_bignum1(struct sshbuf *buf, BIGNUM *v);
217 int	sshbuf_put_bignum2(struct sshbuf *buf, const BIGNUM *v);
218 int	sshbuf_put_bignum1(struct sshbuf *buf, const BIGNUM *v);
220 int	sshbuf_get_ec(struct sshbuf *buf, EC_POINT *v, const EC_GROUP *g);
221 int	sshbuf_get_eckey(struct sshbuf *buf, EC_KEY *v);
222 int	sshbuf_put_ec(struct sshbuf *buf, const EC_POINT *v, const EC_GROUP *g);
223 int	sshbuf_put_eckey(struct sshbuf *buf, const EC_KEY *v);
228 void	sshbuf_dump(struct sshbuf *buf, FILE *f);
234 char	*sshbuf_dtob16(struct sshbuf *buf);
237 char	*sshbuf_dtob64(struct sshbuf *buf);
240 int	sshbuf_b64tod(struct sshbuf *buf, const char *b64);
247 char *sshbuf_dup_string(struct sshbuf *buf);
301 size_t	sshbuf_alloc(const struct sshbuf *buf);
306 int	sshbuf_set_parent(struct sshbuf *child, struct sshbuf *parent);
311 const struct sshbuf *sshbuf_parent(const struct sshbuf *buf);
316 u_int	sshbuf_refcount(const struct sshbuf *buf);