Add trunnel spec and impl for NETINFO cells

This commit is contained in:
rl1987 2018-09-21 12:39:11 +03:00
parent 52a82bc53c
commit b59eedc259
4 changed files with 972 additions and 2 deletions

View File

@ -23,7 +23,8 @@ TRUNNELSOURCES = \
src/trunnel/hs/cell_introduce1.c \ src/trunnel/hs/cell_introduce1.c \
src/trunnel/hs/cell_rendezvous.c \ src/trunnel/hs/cell_rendezvous.c \
src/trunnel/channelpadding_negotiation.c \ src/trunnel/channelpadding_negotiation.c \
src/trunnel/socks5.c src/trunnel/socks5.c \
src/trunnel/netinfo.c
TRUNNELHEADERS = \ TRUNNELHEADERS = \
src/ext/trunnel/trunnel.h \ src/ext/trunnel/trunnel.h \
@ -37,7 +38,8 @@ TRUNNELHEADERS = \
src/trunnel/hs/cell_introduce1.h \ src/trunnel/hs/cell_introduce1.h \
src/trunnel/hs/cell_rendezvous.h \ src/trunnel/hs/cell_rendezvous.h \
src/trunnel/channelpadding_negotiation.h \ src/trunnel/channelpadding_negotiation.h \
src/trunnel/socks5.h src/trunnel/socks5.h \
src/trunnel/netinfo.h
src_trunnel_libor_trunnel_a_SOURCES = $(TRUNNELSOURCES) src_trunnel_libor_trunnel_a_SOURCES = $(TRUNNELSOURCES)
src_trunnel_libor_trunnel_a_CPPFLAGS = \ src_trunnel_libor_trunnel_a_CPPFLAGS = \

721
src/trunnel/netinfo.c Normal file
View File

@ -0,0 +1,721 @@
/* netinfo.c -- generated by Trunnel v1.5.2.
* https://gitweb.torproject.org/trunnel.git
* You probably shouldn't edit this file.
*/
#include <stdlib.h>
#include "trunnel-impl.h"
#include "netinfo.h"
#define TRUNNEL_SET_ERROR_CODE(obj) \
do { \
(obj)->trunnel_error_code_ = 1; \
} while (0)
#if defined(__COVERITY__) || defined(__clang_analyzer__)
/* If we're running a static analysis tool, we don't want it to complain
* that some of our remaining-bytes checks are dead-code. */
int netinfo_deadcode_dummy__ = 0;
#define OR_DEADCODE_DUMMY || netinfo_deadcode_dummy__
#else
#define OR_DEADCODE_DUMMY
#endif
#define CHECK_REMAINING(nbytes, label) \
do { \
if (remaining < (nbytes) OR_DEADCODE_DUMMY) { \
goto label; \
} \
} while (0)
netinfo_addr_t *
netinfo_addr_new(void)
{
netinfo_addr_t *val = trunnel_calloc(1, sizeof(netinfo_addr_t));
if (NULL == val)
return NULL;
val->addr_type = NETINFO_ADDR_TYPE_IPV4;
val->len = 4;
return val;
}
/** Release all storage held inside 'obj', but do not free 'obj'.
*/
static void
netinfo_addr_clear(netinfo_addr_t *obj)
{
(void) obj;
}
void
netinfo_addr_free(netinfo_addr_t *obj)
{
if (obj == NULL)
return;
netinfo_addr_clear(obj);
trunnel_memwipe(obj, sizeof(netinfo_addr_t));
trunnel_free_(obj);
}
uint8_t
netinfo_addr_get_addr_type(const netinfo_addr_t *inp)
{
return inp->addr_type;
}
int
netinfo_addr_set_addr_type(netinfo_addr_t *inp, uint8_t val)
{
if (! ((val == NETINFO_ADDR_TYPE_IPV4 || val == NETINFO_ADDR_TYPE_IPV6))) {
TRUNNEL_SET_ERROR_CODE(inp);
return -1;
}
inp->addr_type = val;
return 0;
}
uint8_t
netinfo_addr_get_len(const netinfo_addr_t *inp)
{
return inp->len;
}
int
netinfo_addr_set_len(netinfo_addr_t *inp, uint8_t val)
{
if (! ((val == 4 || val == 16))) {
TRUNNEL_SET_ERROR_CODE(inp);
return -1;
}
inp->len = val;
return 0;
}
uint32_t
netinfo_addr_get_addr_ipv4(const netinfo_addr_t *inp)
{
return inp->addr_ipv4;
}
int
netinfo_addr_set_addr_ipv4(netinfo_addr_t *inp, uint32_t val)
{
inp->addr_ipv4 = val;
return 0;
}
size_t
netinfo_addr_getlen_addr_ipv6(const netinfo_addr_t *inp)
{
(void)inp; return 16;
}
uint8_t
netinfo_addr_get_addr_ipv6(netinfo_addr_t *inp, size_t idx)
{
trunnel_assert(idx < 16);
return inp->addr_ipv6[idx];
}
uint8_t
netinfo_addr_getconst_addr_ipv6(const netinfo_addr_t *inp, size_t idx)
{
return netinfo_addr_get_addr_ipv6((netinfo_addr_t*)inp, idx);
}
int
netinfo_addr_set_addr_ipv6(netinfo_addr_t *inp, size_t idx, uint8_t elt)
{
trunnel_assert(idx < 16);
inp->addr_ipv6[idx] = elt;
return 0;
}
uint8_t *
netinfo_addr_getarray_addr_ipv6(netinfo_addr_t *inp)
{
return inp->addr_ipv6;
}
const uint8_t *
netinfo_addr_getconstarray_addr_ipv6(const netinfo_addr_t *inp)
{
return (const uint8_t *)netinfo_addr_getarray_addr_ipv6((netinfo_addr_t*)inp);
}
const char *
netinfo_addr_check(const netinfo_addr_t *obj)
{
if (obj == NULL)
return "Object was NULL";
if (obj->trunnel_error_code_)
return "A set function failed on this object";
if (! (obj->addr_type == NETINFO_ADDR_TYPE_IPV4 || obj->addr_type == NETINFO_ADDR_TYPE_IPV6))
return "Integer out of bounds";
if (! (obj->len == 4 || obj->len == 16))
return "Integer out of bounds";
switch (obj->addr_type) {
case NETINFO_ADDR_TYPE_IPV4:
break;
case NETINFO_ADDR_TYPE_IPV6:
break;
default:
return "Bad tag for union";
break;
}
return NULL;
}
ssize_t
netinfo_addr_encoded_len(const netinfo_addr_t *obj)
{
ssize_t result = 0;
if (NULL != netinfo_addr_check(obj))
return -1;
/* Length of u8 addr_type IN [NETINFO_ADDR_TYPE_IPV4, NETINFO_ADDR_TYPE_IPV6] */
result += 1;
/* Length of u8 len IN [4, 16] */
result += 1;
switch (obj->addr_type) {
case NETINFO_ADDR_TYPE_IPV4:
/* Length of u32 addr_ipv4 */
result += 4;
break;
case NETINFO_ADDR_TYPE_IPV6:
/* Length of u8 addr_ipv6[16] */
result += 16;
break;
default:
trunnel_assert(0);
break;
}
return result;
}
int
netinfo_addr_clear_errors(netinfo_addr_t *obj)
{
int r = obj->trunnel_error_code_;
obj->trunnel_error_code_ = 0;
return r;
}
ssize_t
netinfo_addr_encode(uint8_t *output, const size_t avail, const netinfo_addr_t *obj)
{
ssize_t result = 0;
size_t written = 0;
uint8_t *ptr = output;
const char *msg;
#ifdef TRUNNEL_CHECK_ENCODED_LEN
const ssize_t encoded_len = netinfo_addr_encoded_len(obj);
#endif
if (NULL != (msg = netinfo_addr_check(obj)))
goto check_failed;
#ifdef TRUNNEL_CHECK_ENCODED_LEN
trunnel_assert(encoded_len >= 0);
#endif
/* Encode u8 addr_type IN [NETINFO_ADDR_TYPE_IPV4, NETINFO_ADDR_TYPE_IPV6] */
trunnel_assert(written <= avail);
if (avail - written < 1)
goto truncated;
trunnel_set_uint8(ptr, (obj->addr_type));
written += 1; ptr += 1;
/* Encode u8 len IN [4, 16] */
trunnel_assert(written <= avail);
if (avail - written < 1)
goto truncated;
trunnel_set_uint8(ptr, (obj->len));
written += 1; ptr += 1;
/* Encode union addr[addr_type] */
trunnel_assert(written <= avail);
switch (obj->addr_type) {
case NETINFO_ADDR_TYPE_IPV4:
/* Encode u32 addr_ipv4 */
trunnel_assert(written <= avail);
if (avail - written < 4)
goto truncated;
trunnel_set_uint32(ptr, trunnel_htonl(obj->addr_ipv4));
written += 4; ptr += 4;
break;
case NETINFO_ADDR_TYPE_IPV6:
/* Encode u8 addr_ipv6[16] */
trunnel_assert(written <= avail);
if (avail - written < 16)
goto truncated;
memcpy(ptr, obj->addr_ipv6, 16);
written += 16; ptr += 16;
break;
default:
trunnel_assert(0);
break;
}
trunnel_assert(ptr == output + written);
#ifdef TRUNNEL_CHECK_ENCODED_LEN
{
trunnel_assert(encoded_len >= 0);
trunnel_assert((size_t)encoded_len == written);
}
#endif
return written;
truncated:
result = -2;
goto fail;
check_failed:
(void)msg;
result = -1;
goto fail;
fail:
trunnel_assert(result < 0);
return result;
}
/** As netinfo_addr_parse(), but do not allocate the output object.
*/
static ssize_t
netinfo_addr_parse_into(netinfo_addr_t *obj, const uint8_t *input, const size_t len_in)
{
const uint8_t *ptr = input;
size_t remaining = len_in;
ssize_t result = 0;
(void)result;
/* Parse u8 addr_type IN [NETINFO_ADDR_TYPE_IPV4, NETINFO_ADDR_TYPE_IPV6] */
CHECK_REMAINING(1, truncated);
obj->addr_type = (trunnel_get_uint8(ptr));
remaining -= 1; ptr += 1;
if (! (obj->addr_type == NETINFO_ADDR_TYPE_IPV4 || obj->addr_type == NETINFO_ADDR_TYPE_IPV6))
goto fail;
/* Parse u8 len IN [4, 16] */
CHECK_REMAINING(1, truncated);
obj->len = (trunnel_get_uint8(ptr));
remaining -= 1; ptr += 1;
if (! (obj->len == 4 || obj->len == 16))
goto fail;
/* Parse union addr[addr_type] */
switch (obj->addr_type) {
case NETINFO_ADDR_TYPE_IPV4:
/* Parse u32 addr_ipv4 */
CHECK_REMAINING(4, truncated);
obj->addr_ipv4 = trunnel_ntohl(trunnel_get_uint32(ptr));
remaining -= 4; ptr += 4;
break;
case NETINFO_ADDR_TYPE_IPV6:
/* Parse u8 addr_ipv6[16] */
CHECK_REMAINING(16, truncated);
memcpy(obj->addr_ipv6, ptr, 16);
remaining -= 16; ptr += 16;
break;
default:
goto fail;
break;
}
trunnel_assert(ptr + remaining == input + len_in);
return len_in - remaining;
truncated:
return -2;
fail:
result = -1;
return result;
}
ssize_t
netinfo_addr_parse(netinfo_addr_t **output, const uint8_t *input, const size_t len_in)
{
ssize_t result;
*output = netinfo_addr_new();
if (NULL == *output)
return -1;
result = netinfo_addr_parse_into(*output, input, len_in);
if (result < 0) {
netinfo_addr_free(*output);
*output = NULL;
}
return result;
}
netinfo_cell_t *
netinfo_cell_new(void)
{
netinfo_cell_t *val = trunnel_calloc(1, sizeof(netinfo_cell_t));
if (NULL == val)
return NULL;
return val;
}
/** Release all storage held inside 'obj', but do not free 'obj'.
*/
static void
netinfo_cell_clear(netinfo_cell_t *obj)
{
(void) obj;
netinfo_addr_free(obj->other_addr);
obj->other_addr = NULL;
{
unsigned idx;
for (idx = 0; idx < TRUNNEL_DYNARRAY_LEN(&obj->my_addrs); ++idx) {
netinfo_addr_free(TRUNNEL_DYNARRAY_GET(&obj->my_addrs, idx));
}
}
TRUNNEL_DYNARRAY_WIPE(&obj->my_addrs);
TRUNNEL_DYNARRAY_CLEAR(&obj->my_addrs);
}
void
netinfo_cell_free(netinfo_cell_t *obj)
{
if (obj == NULL)
return;
netinfo_cell_clear(obj);
trunnel_memwipe(obj, sizeof(netinfo_cell_t));
trunnel_free_(obj);
}
uint32_t
netinfo_cell_get_timestamp(const netinfo_cell_t *inp)
{
return inp->timestamp;
}
int
netinfo_cell_set_timestamp(netinfo_cell_t *inp, uint32_t val)
{
inp->timestamp = val;
return 0;
}
struct netinfo_addr_st *
netinfo_cell_get_other_addr(netinfo_cell_t *inp)
{
return inp->other_addr;
}
const struct netinfo_addr_st *
netinfo_cell_getconst_other_addr(const netinfo_cell_t *inp)
{
return netinfo_cell_get_other_addr((netinfo_cell_t*) inp);
}
int
netinfo_cell_set_other_addr(netinfo_cell_t *inp, struct netinfo_addr_st *val)
{
if (inp->other_addr && inp->other_addr != val)
netinfo_addr_free(inp->other_addr);
return netinfo_cell_set0_other_addr(inp, val);
}
int
netinfo_cell_set0_other_addr(netinfo_cell_t *inp, struct netinfo_addr_st *val)
{
inp->other_addr = val;
return 0;
}
uint8_t
netinfo_cell_get_n_my_addrs(const netinfo_cell_t *inp)
{
return inp->n_my_addrs;
}
int
netinfo_cell_set_n_my_addrs(netinfo_cell_t *inp, uint8_t val)
{
inp->n_my_addrs = val;
return 0;
}
size_t
netinfo_cell_getlen_my_addrs(const netinfo_cell_t *inp)
{
return TRUNNEL_DYNARRAY_LEN(&inp->my_addrs);
}
struct netinfo_addr_st *
netinfo_cell_get_my_addrs(netinfo_cell_t *inp, size_t idx)
{
return TRUNNEL_DYNARRAY_GET(&inp->my_addrs, idx);
}
const struct netinfo_addr_st *
netinfo_cell_getconst_my_addrs(const netinfo_cell_t *inp, size_t idx)
{
return netinfo_cell_get_my_addrs((netinfo_cell_t*)inp, idx);
}
int
netinfo_cell_set_my_addrs(netinfo_cell_t *inp, size_t idx, struct netinfo_addr_st * elt)
{
netinfo_addr_t *oldval = TRUNNEL_DYNARRAY_GET(&inp->my_addrs, idx);
if (oldval && oldval != elt)
netinfo_addr_free(oldval);
return netinfo_cell_set0_my_addrs(inp, idx, elt);
}
int
netinfo_cell_set0_my_addrs(netinfo_cell_t *inp, size_t idx, struct netinfo_addr_st * elt)
{
TRUNNEL_DYNARRAY_SET(&inp->my_addrs, idx, elt);
return 0;
}
int
netinfo_cell_add_my_addrs(netinfo_cell_t *inp, struct netinfo_addr_st * elt)
{
#if SIZE_MAX >= UINT8_MAX
if (inp->my_addrs.n_ == UINT8_MAX)
goto trunnel_alloc_failed;
#endif
TRUNNEL_DYNARRAY_ADD(struct netinfo_addr_st *, &inp->my_addrs, elt, {});
return 0;
trunnel_alloc_failed:
TRUNNEL_SET_ERROR_CODE(inp);
return -1;
}
struct netinfo_addr_st * *
netinfo_cell_getarray_my_addrs(netinfo_cell_t *inp)
{
return inp->my_addrs.elts_;
}
const struct netinfo_addr_st * const *
netinfo_cell_getconstarray_my_addrs(const netinfo_cell_t *inp)
{
return (const struct netinfo_addr_st * const *)netinfo_cell_getarray_my_addrs((netinfo_cell_t*)inp);
}
int
netinfo_cell_setlen_my_addrs(netinfo_cell_t *inp, size_t newlen)
{
struct netinfo_addr_st * *newptr;
#if UINT8_MAX < SIZE_MAX
if (newlen > UINT8_MAX)
goto trunnel_alloc_failed;
#endif
newptr = trunnel_dynarray_setlen(&inp->my_addrs.allocated_,
&inp->my_addrs.n_, inp->my_addrs.elts_, newlen,
sizeof(inp->my_addrs.elts_[0]), (trunnel_free_fn_t) netinfo_addr_free,
&inp->trunnel_error_code_);
if (newlen != 0 && newptr == NULL)
goto trunnel_alloc_failed;
inp->my_addrs.elts_ = newptr;
return 0;
trunnel_alloc_failed:
TRUNNEL_SET_ERROR_CODE(inp);
return -1;
}
const char *
netinfo_cell_check(const netinfo_cell_t *obj)
{
if (obj == NULL)
return "Object was NULL";
if (obj->trunnel_error_code_)
return "A set function failed on this object";
{
const char *msg;
if (NULL != (msg = netinfo_addr_check(obj->other_addr)))
return msg;
}
{
const char *msg;
unsigned idx;
for (idx = 0; idx < TRUNNEL_DYNARRAY_LEN(&obj->my_addrs); ++idx) {
if (NULL != (msg = netinfo_addr_check(TRUNNEL_DYNARRAY_GET(&obj->my_addrs, idx))))
return msg;
}
}
if (TRUNNEL_DYNARRAY_LEN(&obj->my_addrs) != obj->n_my_addrs)
return "Length mismatch for my_addrs";
return NULL;
}
ssize_t
netinfo_cell_encoded_len(const netinfo_cell_t *obj)
{
ssize_t result = 0;
if (NULL != netinfo_cell_check(obj))
return -1;
/* Length of u32 timestamp */
result += 4;
/* Length of struct netinfo_addr other_addr */
result += netinfo_addr_encoded_len(obj->other_addr);
/* Length of u8 n_my_addrs */
result += 1;
/* Length of struct netinfo_addr my_addrs[n_my_addrs] */
{
unsigned idx;
for (idx = 0; idx < TRUNNEL_DYNARRAY_LEN(&obj->my_addrs); ++idx) {
result += netinfo_addr_encoded_len(TRUNNEL_DYNARRAY_GET(&obj->my_addrs, idx));
}
}
return result;
}
int
netinfo_cell_clear_errors(netinfo_cell_t *obj)
{
int r = obj->trunnel_error_code_;
obj->trunnel_error_code_ = 0;
return r;
}
ssize_t
netinfo_cell_encode(uint8_t *output, const size_t avail, const netinfo_cell_t *obj)
{
ssize_t result = 0;
size_t written = 0;
uint8_t *ptr = output;
const char *msg;
#ifdef TRUNNEL_CHECK_ENCODED_LEN
const ssize_t encoded_len = netinfo_cell_encoded_len(obj);
#endif
if (NULL != (msg = netinfo_cell_check(obj)))
goto check_failed;
#ifdef TRUNNEL_CHECK_ENCODED_LEN
trunnel_assert(encoded_len >= 0);
#endif
/* Encode u32 timestamp */
trunnel_assert(written <= avail);
if (avail - written < 4)
goto truncated;
trunnel_set_uint32(ptr, trunnel_htonl(obj->timestamp));
written += 4; ptr += 4;
/* Encode struct netinfo_addr other_addr */
trunnel_assert(written <= avail);
result = netinfo_addr_encode(ptr, avail - written, obj->other_addr);
if (result < 0)
goto fail; /* XXXXXXX !*/
written += result; ptr += result;
/* Encode u8 n_my_addrs */
trunnel_assert(written <= avail);
if (avail - written < 1)
goto truncated;
trunnel_set_uint8(ptr, (obj->n_my_addrs));
written += 1; ptr += 1;
/* Encode struct netinfo_addr my_addrs[n_my_addrs] */
{
unsigned idx;
for (idx = 0; idx < TRUNNEL_DYNARRAY_LEN(&obj->my_addrs); ++idx) {
trunnel_assert(written <= avail);
result = netinfo_addr_encode(ptr, avail - written, TRUNNEL_DYNARRAY_GET(&obj->my_addrs, idx));
if (result < 0)
goto fail; /* XXXXXXX !*/
written += result; ptr += result;
}
}
trunnel_assert(ptr == output + written);
#ifdef TRUNNEL_CHECK_ENCODED_LEN
{
trunnel_assert(encoded_len >= 0);
trunnel_assert((size_t)encoded_len == written);
}
#endif
return written;
truncated:
result = -2;
goto fail;
check_failed:
(void)msg;
result = -1;
goto fail;
fail:
trunnel_assert(result < 0);
return result;
}
/** As netinfo_cell_parse(), but do not allocate the output object.
*/
static ssize_t
netinfo_cell_parse_into(netinfo_cell_t *obj, const uint8_t *input, const size_t len_in)
{
const uint8_t *ptr = input;
size_t remaining = len_in;
ssize_t result = 0;
(void)result;
/* Parse u32 timestamp */
CHECK_REMAINING(4, truncated);
obj->timestamp = trunnel_ntohl(trunnel_get_uint32(ptr));
remaining -= 4; ptr += 4;
/* Parse struct netinfo_addr other_addr */
result = netinfo_addr_parse(&obj->other_addr, ptr, remaining);
if (result < 0)
goto relay_fail;
trunnel_assert((size_t)result <= remaining);
remaining -= result; ptr += result;
/* Parse u8 n_my_addrs */
CHECK_REMAINING(1, truncated);
obj->n_my_addrs = (trunnel_get_uint8(ptr));
remaining -= 1; ptr += 1;
/* Parse struct netinfo_addr my_addrs[n_my_addrs] */
TRUNNEL_DYNARRAY_EXPAND(netinfo_addr_t *, &obj->my_addrs, obj->n_my_addrs, {});
{
netinfo_addr_t * elt;
unsigned idx;
for (idx = 0; idx < obj->n_my_addrs; ++idx) {
result = netinfo_addr_parse(&elt, ptr, remaining);
if (result < 0)
goto relay_fail;
trunnel_assert((size_t)result <= remaining);
remaining -= result; ptr += result;
TRUNNEL_DYNARRAY_ADD(netinfo_addr_t *, &obj->my_addrs, elt, {netinfo_addr_free(elt);});
}
}
trunnel_assert(ptr + remaining == input + len_in);
return len_in - remaining;
truncated:
return -2;
relay_fail:
trunnel_assert(result < 0);
return result;
trunnel_alloc_failed:
return -1;
}
ssize_t
netinfo_cell_parse(netinfo_cell_t **output, const uint8_t *input, const size_t len_in)
{
ssize_t result;
*output = netinfo_cell_new();
if (NULL == *output)
return -1;
result = netinfo_cell_parse_into(*output, input, len_in);
if (result < 0) {
netinfo_cell_free(*output);
*output = NULL;
}
return result;
}

226
src/trunnel/netinfo.h Normal file
View File

@ -0,0 +1,226 @@
/* netinfo.h -- generated by Trunnel v1.5.2.
* https://gitweb.torproject.org/trunnel.git
* You probably shouldn't edit this file.
*/
#ifndef TRUNNEL_NETINFO_H
#define TRUNNEL_NETINFO_H
#include <stdint.h>
#include "trunnel.h"
#define NETINFO_ADDR_TYPE_IPV4 4
#define NETINFO_ADDR_TYPE_IPV6 6
#if !defined(TRUNNEL_OPAQUE) && !defined(TRUNNEL_OPAQUE_NETINFO_ADDR)
struct netinfo_addr_st {
uint8_t addr_type;
uint8_t len;
uint32_t addr_ipv4;
uint8_t addr_ipv6[16];
uint8_t trunnel_error_code_;
};
#endif
typedef struct netinfo_addr_st netinfo_addr_t;
#if !defined(TRUNNEL_OPAQUE) && !defined(TRUNNEL_OPAQUE_NETINFO_CELL)
struct netinfo_cell_st {
uint32_t timestamp;
struct netinfo_addr_st *other_addr;
uint8_t n_my_addrs;
TRUNNEL_DYNARRAY_HEAD(, struct netinfo_addr_st *) my_addrs;
uint8_t trunnel_error_code_;
};
#endif
typedef struct netinfo_cell_st netinfo_cell_t;
/** Return a newly allocated netinfo_addr with all elements set to
* zero.
*/
netinfo_addr_t *netinfo_addr_new(void);
/** Release all storage held by the netinfo_addr in 'victim'. (Do
* nothing if 'victim' is NULL.)
*/
void netinfo_addr_free(netinfo_addr_t *victim);
/** Try to parse a netinfo_addr from the buffer in 'input', using up
* to 'len_in' bytes from the input buffer. On success, return the
* number of bytes consumed and set *output to the newly allocated
* netinfo_addr_t. On failure, return -2 if the input appears
* truncated, and -1 if the input is otherwise invalid.
*/
ssize_t netinfo_addr_parse(netinfo_addr_t **output, const uint8_t *input, const size_t len_in);
/** Return the number of bytes we expect to need to encode the
* netinfo_addr in 'obj'. On failure, return a negative value. Note
* that this value may be an overestimate, and can even be an
* underestimate for certain unencodeable objects.
*/
ssize_t netinfo_addr_encoded_len(const netinfo_addr_t *obj);
/** Try to encode the netinfo_addr from 'input' into the buffer at
* 'output', using up to 'avail' bytes of the output buffer. On
* success, return the number of bytes used. On failure, return -2 if
* the buffer was not long enough, and -1 if the input was invalid.
*/
ssize_t netinfo_addr_encode(uint8_t *output, size_t avail, const netinfo_addr_t *input);
/** Check whether the internal state of the netinfo_addr in 'obj' is
* consistent. Return NULL if it is, and a short message if it is not.
*/
const char *netinfo_addr_check(const netinfo_addr_t *obj);
/** Clear any errors that were set on the object 'obj' by its setter
* functions. Return true iff errors were cleared.
*/
int netinfo_addr_clear_errors(netinfo_addr_t *obj);
/** Return the value of the addr_type field of the netinfo_addr_t in
* 'inp'
*/
uint8_t netinfo_addr_get_addr_type(const netinfo_addr_t *inp);
/** Set the value of the addr_type field of the netinfo_addr_t in
* 'inp' to 'val'. Return 0 on success; return -1 and set the error
* code on 'inp' on failure.
*/
int netinfo_addr_set_addr_type(netinfo_addr_t *inp, uint8_t val);
/** Return the value of the len field of the netinfo_addr_t in 'inp'
*/
uint8_t netinfo_addr_get_len(const netinfo_addr_t *inp);
/** Set the value of the len field of the netinfo_addr_t in 'inp' to
* 'val'. Return 0 on success; return -1 and set the error code on
* 'inp' on failure.
*/
int netinfo_addr_set_len(netinfo_addr_t *inp, uint8_t val);
/** Return the value of the addr_ipv4 field of the netinfo_addr_t in
* 'inp'
*/
uint32_t netinfo_addr_get_addr_ipv4(const netinfo_addr_t *inp);
/** Set the value of the addr_ipv4 field of the netinfo_addr_t in
* 'inp' to 'val'. Return 0 on success; return -1 and set the error
* code on 'inp' on failure.
*/
int netinfo_addr_set_addr_ipv4(netinfo_addr_t *inp, uint32_t val);
/** Return the (constant) length of the array holding the addr_ipv6
* field of the netinfo_addr_t in 'inp'.
*/
size_t netinfo_addr_getlen_addr_ipv6(const netinfo_addr_t *inp);
/** Return the element at position 'idx' of the fixed array field
* addr_ipv6 of the netinfo_addr_t in 'inp'.
*/
uint8_t netinfo_addr_get_addr_ipv6(netinfo_addr_t *inp, size_t idx);
/** As netinfo_addr_get_addr_ipv6, but take and return a const pointer
*/
uint8_t netinfo_addr_getconst_addr_ipv6(const netinfo_addr_t *inp, size_t idx);
/** Change the element at position 'idx' of the fixed array field
* addr_ipv6 of the netinfo_addr_t in 'inp', so that it will hold the
* value 'elt'.
*/
int netinfo_addr_set_addr_ipv6(netinfo_addr_t *inp, size_t idx, uint8_t elt);
/** Return a pointer to the 16-element array field addr_ipv6 of 'inp'.
*/
uint8_t * netinfo_addr_getarray_addr_ipv6(netinfo_addr_t *inp);
/** As netinfo_addr_get_addr_ipv6, but take and return a const pointer
*/
const uint8_t * netinfo_addr_getconstarray_addr_ipv6(const netinfo_addr_t *inp);
/** Return a newly allocated netinfo_cell with all elements set to
* zero.
*/
netinfo_cell_t *netinfo_cell_new(void);
/** Release all storage held by the netinfo_cell in 'victim'. (Do
* nothing if 'victim' is NULL.)
*/
void netinfo_cell_free(netinfo_cell_t *victim);
/** Try to parse a netinfo_cell from the buffer in 'input', using up
* to 'len_in' bytes from the input buffer. On success, return the
* number of bytes consumed and set *output to the newly allocated
* netinfo_cell_t. On failure, return -2 if the input appears
* truncated, and -1 if the input is otherwise invalid.
*/
ssize_t netinfo_cell_parse(netinfo_cell_t **output, const uint8_t *input, const size_t len_in);
/** Return the number of bytes we expect to need to encode the
* netinfo_cell in 'obj'. On failure, return a negative value. Note
* that this value may be an overestimate, and can even be an
* underestimate for certain unencodeable objects.
*/
ssize_t netinfo_cell_encoded_len(const netinfo_cell_t *obj);
/** Try to encode the netinfo_cell from 'input' into the buffer at
* 'output', using up to 'avail' bytes of the output buffer. On
* success, return the number of bytes used. On failure, return -2 if
* the buffer was not long enough, and -1 if the input was invalid.
*/
ssize_t netinfo_cell_encode(uint8_t *output, size_t avail, const netinfo_cell_t *input);
/** Check whether the internal state of the netinfo_cell in 'obj' is
* consistent. Return NULL if it is, and a short message if it is not.
*/
const char *netinfo_cell_check(const netinfo_cell_t *obj);
/** Clear any errors that were set on the object 'obj' by its setter
* functions. Return true iff errors were cleared.
*/
int netinfo_cell_clear_errors(netinfo_cell_t *obj);
/** Return the value of the timestamp field of the netinfo_cell_t in
* 'inp'
*/
uint32_t netinfo_cell_get_timestamp(const netinfo_cell_t *inp);
/** Set the value of the timestamp field of the netinfo_cell_t in
* 'inp' to 'val'. Return 0 on success; return -1 and set the error
* code on 'inp' on failure.
*/
int netinfo_cell_set_timestamp(netinfo_cell_t *inp, uint32_t val);
/** Return the value of the other_addr field of the netinfo_cell_t in
* 'inp'
*/
struct netinfo_addr_st * netinfo_cell_get_other_addr(netinfo_cell_t *inp);
/** As netinfo_cell_get_other_addr, but take and return a const
* pointer
*/
const struct netinfo_addr_st * netinfo_cell_getconst_other_addr(const netinfo_cell_t *inp);
/** Set the value of the other_addr field of the netinfo_cell_t in
* 'inp' to 'val'. Free the old value if any. Steals the referenceto
* 'val'.Return 0 on success; return -1 and set the error code on
* 'inp' on failure.
*/
int netinfo_cell_set_other_addr(netinfo_cell_t *inp, struct netinfo_addr_st *val);
/** As netinfo_cell_set_other_addr, but does not free the previous
* value.
*/
int netinfo_cell_set0_other_addr(netinfo_cell_t *inp, struct netinfo_addr_st *val);
/** Return the value of the n_my_addrs field of the netinfo_cell_t in
* 'inp'
*/
uint8_t netinfo_cell_get_n_my_addrs(const netinfo_cell_t *inp);
/** Set the value of the n_my_addrs field of the netinfo_cell_t in
* 'inp' to 'val'. Return 0 on success; return -1 and set the error
* code on 'inp' on failure.
*/
int netinfo_cell_set_n_my_addrs(netinfo_cell_t *inp, uint8_t val);
/** Return the length of the dynamic array holding the my_addrs field
* of the netinfo_cell_t in 'inp'.
*/
size_t netinfo_cell_getlen_my_addrs(const netinfo_cell_t *inp);
/** Return the element at position 'idx' of the dynamic array field
* my_addrs of the netinfo_cell_t in 'inp'.
*/
struct netinfo_addr_st * netinfo_cell_get_my_addrs(netinfo_cell_t *inp, size_t idx);
/** As netinfo_cell_get_my_addrs, but take and return a const pointer
*/
const struct netinfo_addr_st * netinfo_cell_getconst_my_addrs(const netinfo_cell_t *inp, size_t idx);
/** Change the element at position 'idx' of the dynamic array field
* my_addrs of the netinfo_cell_t in 'inp', so that it will hold the
* value 'elt'. Free the previous value, if any.
*/
int netinfo_cell_set_my_addrs(netinfo_cell_t *inp, size_t idx, struct netinfo_addr_st * elt);
/** As netinfo_cell_set_my_addrs, but does not free the previous
* value.
*/
int netinfo_cell_set0_my_addrs(netinfo_cell_t *inp, size_t idx, struct netinfo_addr_st * elt);
/** Append a new element 'elt' to the dynamic array field my_addrs of
* the netinfo_cell_t in 'inp'.
*/
int netinfo_cell_add_my_addrs(netinfo_cell_t *inp, struct netinfo_addr_st * elt);
/** Return a pointer to the variable-length array field my_addrs of
* 'inp'.
*/
struct netinfo_addr_st * * netinfo_cell_getarray_my_addrs(netinfo_cell_t *inp);
/** As netinfo_cell_get_my_addrs, but take and return a const pointer
*/
const struct netinfo_addr_st * const * netinfo_cell_getconstarray_my_addrs(const netinfo_cell_t *inp);
/** Change the length of the variable-length array field my_addrs of
* 'inp' to 'newlen'.Fill extra elements with NULL; free removed
* elements. Return 0 on success; return -1 and set the error code on
* 'inp' on failure.
*/
int netinfo_cell_setlen_my_addrs(netinfo_cell_t *inp, size_t newlen);
#endif

View File

@ -0,0 +1,21 @@
const NETINFO_ADDR_TYPE_IPV4 = 4;
const NETINFO_ADDR_TYPE_IPV6 = 6;
struct netinfo_addr {
u8 addr_type IN [NETINFO_ADDR_TYPE_IPV4, NETINFO_ADDR_TYPE_IPV6];
u8 len IN [4, 16];
union addr[addr_type] {
NETINFO_ADDR_TYPE_IPV4: u32 ipv4;
NETINFO_ADDR_TYPE_IPV6: u8 ipv6[16];
default: fail;
};
}
struct netinfo_cell {
u32 timestamp;
struct netinfo_addr other_addr;
u8 n_my_addrs;
struct netinfo_addr my_addrs[n_my_addrs];
}