Annotation of src/usr.bin/ssh/buffer.h, Revision 1.25
1.25 ! djm 1: /* $OpenBSD: buffer.h,v 1.24 2014/04/28 03:09:18 djm Exp $ */
1.11 stevesk 2:
1.1 deraadt 3: /*
1.25 ! djm 4: * Copyright (c) 2012 Damien Miller <djm@mindrot.org>
1.4 markus 5: *
1.25 ! djm 6: * Permission to use, copy, modify, and distribute this software for any
! 7: * purpose with or without fee is hereby granted, provided that the above
! 8: * copyright notice and this permission notice appear in all copies.
! 9: *
! 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
! 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
! 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
! 13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
! 14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
! 15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
! 16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.2 deraadt 17: */
1.1 deraadt 18:
1.25 ! djm 19: /* Emulation wrappers for legacy OpenSSH buffer API atop sshbuf */
! 20:
1.1 deraadt 21: #ifndef BUFFER_H
22: #define BUFFER_H
23:
1.25 ! djm 24: #include "sshbuf.h"
! 25:
! 26: typedef struct sshbuf Buffer;
1.1 deraadt 27:
1.25 ! djm 28: #define buffer_init(b) sshbuf_init(b)
! 29: #define buffer_clear(b) sshbuf_reset(b)
! 30: #define buffer_free(b) sshbuf_free(b)
! 31: #define buffer_dump(b) sshbuf_dump(b, stderr)
! 32:
! 33: /* XXX cast is safe: sshbuf never stores more than len 2^31 */
! 34: #define buffer_len(b) ((u_int) sshbuf_len(b))
! 35: #define buffer_ptr(b) sshbuf_mutable_ptr(b)
1.9 markus 36:
1.10 stevesk 37: void buffer_append(Buffer *, const void *, u_int);
38: void *buffer_append_space(Buffer *, u_int);
1.15 djm 39: int buffer_check_alloc(Buffer *, u_int);
1.10 stevesk 40: void buffer_get(Buffer *, void *, u_int);
1.9 markus 41:
42: void buffer_consume(Buffer *, u_int);
43: void buffer_consume_end(Buffer *, u_int);
44:
1.12 djm 45:
46: int buffer_get_ret(Buffer *, void *, u_int);
47: int buffer_consume_ret(Buffer *, u_int);
48: int buffer_consume_end_ret(Buffer *, u_int);
1.16 deraadt 49:
50: void buffer_put_bignum(Buffer *, const BIGNUM *);
51: void buffer_put_bignum2(Buffer *, const BIGNUM *);
52: void buffer_get_bignum(Buffer *, BIGNUM *);
53: void buffer_get_bignum2(Buffer *, BIGNUM *);
1.25 ! djm 54: void buffer_put_bignum2_from_string(Buffer *, const u_char *, u_int);
1.16 deraadt 55:
56: u_short buffer_get_short(Buffer *);
57: void buffer_put_short(Buffer *, u_short);
58:
59: u_int buffer_get_int(Buffer *);
60: void buffer_put_int(Buffer *, u_int);
61:
62: u_int64_t buffer_get_int64(Buffer *);
63: void buffer_put_int64(Buffer *, u_int64_t);
64:
65: int buffer_get_char(Buffer *);
66: void buffer_put_char(Buffer *, int);
67:
68: void *buffer_get_string(Buffer *, u_int *);
1.24 djm 69: const void *buffer_get_string_ptr(Buffer *, u_int *);
1.16 deraadt 70: void buffer_put_string(Buffer *, const void *, u_int);
1.20 djm 71: char *buffer_get_cstring(Buffer *, u_int *);
1.16 deraadt 72: void buffer_put_cstring(Buffer *, const char *);
73:
1.25 ! djm 74: #define buffer_skip_string(b) (void)buffer_get_string_ptr(b, NULL);
1.16 deraadt 75:
76: int buffer_put_bignum_ret(Buffer *, const BIGNUM *);
77: int buffer_get_bignum_ret(Buffer *, BIGNUM *);
78: int buffer_put_bignum2_ret(Buffer *, const BIGNUM *);
79: int buffer_get_bignum2_ret(Buffer *, BIGNUM *);
80: int buffer_get_short_ret(u_short *, Buffer *);
81: int buffer_get_int_ret(u_int *, Buffer *);
82: int buffer_get_int64_ret(u_int64_t *, Buffer *);
83: void *buffer_get_string_ret(Buffer *, u_int *);
1.20 djm 84: char *buffer_get_cstring_ret(Buffer *, u_int *);
1.24 djm 85: const void *buffer_get_string_ptr_ret(Buffer *, u_int *);
1.25 ! djm 86: int buffer_get_char_ret(char *, Buffer *);
1.21 djm 87:
88: int buffer_put_ecpoint_ret(Buffer *, const EC_GROUP *, const EC_POINT *);
89: void buffer_put_ecpoint(Buffer *, const EC_GROUP *, const EC_POINT *);
90: int buffer_get_ecpoint_ret(Buffer *, const EC_GROUP *, EC_POINT *);
91: void buffer_get_ecpoint(Buffer *, const EC_GROUP *, EC_POINT *);
1.1 deraadt 92:
1.25 ! djm 93: #endif /* BUFFER_H */
! 94: