123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195 |
- /* circpad_negotiation.h -- generated by Trunnel v1.5.3.
- * https://gitweb.torproject.org/trunnel.git
- * You probably shouldn't edit this file.
- */
- #ifndef TRUNNEL_CIRCPAD_NEGOTIATION_H
- #define TRUNNEL_CIRCPAD_NEGOTIATION_H
- #include <stdint.h>
- #include "trunnel.h"
- #define CIRCPAD_COMMAND_STOP 1
- #define CIRCPAD_COMMAND_START 2
- #define CIRCPAD_RESPONSE_OK 1
- #define CIRCPAD_RESPONSE_ERR 2
- #define CIRCPAD_MACHINE_CIRC_SETUP 1
- /**
- * This command tells the relay to alter its min and max netflow
- * timeout range values, and send padding at that rate (resuming
- * if stopped). */
- #if !defined(TRUNNEL_OPAQUE) && !defined(TRUNNEL_OPAQUE_CIRCPAD_NEGOTIATE)
- struct circpad_negotiate_st {
- uint8_t version;
- uint8_t command;
- /** Machine type is left unbounded because we can specify
- * new machines in the consensus */
- uint8_t machine_type;
- /** If true, send a relay_drop reply.. */
- uint8_t echo_request;
- uint8_t trunnel_error_code_;
- };
- #endif
- typedef struct circpad_negotiate_st circpad_negotiate_t;
- /**
- * This command tells the relay to alter its min and max netflow
- * timeout range values, and send padding at that rate (resuming
- * if stopped). */
- #if !defined(TRUNNEL_OPAQUE) && !defined(TRUNNEL_OPAQUE_CIRCPAD_NEGOTIATED)
- struct circpad_negotiated_st {
- uint8_t version;
- uint8_t command;
- uint8_t response;
- /** Machine type is left unbounded because we can specify
- * new machines in the consensus */
- uint8_t machine_type;
- uint8_t trunnel_error_code_;
- };
- #endif
- typedef struct circpad_negotiated_st circpad_negotiated_t;
- /** Return a newly allocated circpad_negotiate with all elements set
- * to zero.
- */
- circpad_negotiate_t *circpad_negotiate_new(void);
- /** Release all storage held by the circpad_negotiate in 'victim'. (Do
- * nothing if 'victim' is NULL.)
- */
- void circpad_negotiate_free(circpad_negotiate_t *victim);
- /** Try to parse a circpad_negotiate 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
- * circpad_negotiate_t. On failure, return -2 if the input appears
- * truncated, and -1 if the input is otherwise invalid.
- */
- ssize_t circpad_negotiate_parse(circpad_negotiate_t **output, const uint8_t *input, const size_t len_in);
- /** Return the number of bytes we expect to need to encode the
- * circpad_negotiate 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 circpad_negotiate_encoded_len(const circpad_negotiate_t *obj);
- /** Try to encode the circpad_negotiate 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 circpad_negotiate_encode(uint8_t *output, size_t avail, const circpad_negotiate_t *input);
- /** Check whether the internal state of the circpad_negotiate in 'obj'
- * is consistent. Return NULL if it is, and a short message if it is
- * not.
- */
- const char *circpad_negotiate_check(const circpad_negotiate_t *obj);
- /** Clear any errors that were set on the object 'obj' by its setter
- * functions. Return true iff errors were cleared.
- */
- int circpad_negotiate_clear_errors(circpad_negotiate_t *obj);
- /** Return the value of the version field of the circpad_negotiate_t
- * in 'inp'
- */
- uint8_t circpad_negotiate_get_version(const circpad_negotiate_t *inp);
- /** Set the value of the version field of the circpad_negotiate_t in
- * 'inp' to 'val'. Return 0 on success; return -1 and set the error
- * code on 'inp' on failure.
- */
- int circpad_negotiate_set_version(circpad_negotiate_t *inp, uint8_t val);
- /** Return the value of the command field of the circpad_negotiate_t
- * in 'inp'
- */
- uint8_t circpad_negotiate_get_command(const circpad_negotiate_t *inp);
- /** Set the value of the command field of the circpad_negotiate_t in
- * 'inp' to 'val'. Return 0 on success; return -1 and set the error
- * code on 'inp' on failure.
- */
- int circpad_negotiate_set_command(circpad_negotiate_t *inp, uint8_t val);
- /** Return the value of the machine_type field of the
- * circpad_negotiate_t in 'inp'
- */
- uint8_t circpad_negotiate_get_machine_type(const circpad_negotiate_t *inp);
- /** Set the value of the machine_type field of the circpad_negotiate_t
- * in 'inp' to 'val'. Return 0 on success; return -1 and set the error
- * code on 'inp' on failure.
- */
- int circpad_negotiate_set_machine_type(circpad_negotiate_t *inp, uint8_t val);
- /** Return the value of the echo_request field of the
- * circpad_negotiate_t in 'inp'
- */
- uint8_t circpad_negotiate_get_echo_request(const circpad_negotiate_t *inp);
- /** Set the value of the echo_request field of the circpad_negotiate_t
- * in 'inp' to 'val'. Return 0 on success; return -1 and set the error
- * code on 'inp' on failure.
- */
- int circpad_negotiate_set_echo_request(circpad_negotiate_t *inp, uint8_t val);
- /** Return a newly allocated circpad_negotiated with all elements set
- * to zero.
- */
- circpad_negotiated_t *circpad_negotiated_new(void);
- /** Release all storage held by the circpad_negotiated in 'victim'.
- * (Do nothing if 'victim' is NULL.)
- */
- void circpad_negotiated_free(circpad_negotiated_t *victim);
- /** Try to parse a circpad_negotiated 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 circpad_negotiated_t. On failure, return -2 if the input
- * appears truncated, and -1 if the input is otherwise invalid.
- */
- ssize_t circpad_negotiated_parse(circpad_negotiated_t **output, const uint8_t *input, const size_t len_in);
- /** Return the number of bytes we expect to need to encode the
- * circpad_negotiated 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 circpad_negotiated_encoded_len(const circpad_negotiated_t *obj);
- /** Try to encode the circpad_negotiated 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 circpad_negotiated_encode(uint8_t *output, size_t avail, const circpad_negotiated_t *input);
- /** Check whether the internal state of the circpad_negotiated in
- * 'obj' is consistent. Return NULL if it is, and a short message if
- * it is not.
- */
- const char *circpad_negotiated_check(const circpad_negotiated_t *obj);
- /** Clear any errors that were set on the object 'obj' by its setter
- * functions. Return true iff errors were cleared.
- */
- int circpad_negotiated_clear_errors(circpad_negotiated_t *obj);
- /** Return the value of the version field of the circpad_negotiated_t
- * in 'inp'
- */
- uint8_t circpad_negotiated_get_version(const circpad_negotiated_t *inp);
- /** Set the value of the version field of the circpad_negotiated_t in
- * 'inp' to 'val'. Return 0 on success; return -1 and set the error
- * code on 'inp' on failure.
- */
- int circpad_negotiated_set_version(circpad_negotiated_t *inp, uint8_t val);
- /** Return the value of the command field of the circpad_negotiated_t
- * in 'inp'
- */
- uint8_t circpad_negotiated_get_command(const circpad_negotiated_t *inp);
- /** Set the value of the command field of the circpad_negotiated_t in
- * 'inp' to 'val'. Return 0 on success; return -1 and set the error
- * code on 'inp' on failure.
- */
- int circpad_negotiated_set_command(circpad_negotiated_t *inp, uint8_t val);
- /** Return the value of the response field of the circpad_negotiated_t
- * in 'inp'
- */
- uint8_t circpad_negotiated_get_response(const circpad_negotiated_t *inp);
- /** Set the value of the response field of the circpad_negotiated_t in
- * 'inp' to 'val'. Return 0 on success; return -1 and set the error
- * code on 'inp' on failure.
- */
- int circpad_negotiated_set_response(circpad_negotiated_t *inp, uint8_t val);
- /** Return the value of the machine_type field of the
- * circpad_negotiated_t in 'inp'
- */
- uint8_t circpad_negotiated_get_machine_type(const circpad_negotiated_t *inp);
- /** Set the value of the machine_type field of the
- * circpad_negotiated_t in 'inp' to 'val'. Return 0 on success; return
- * -1 and set the error code on 'inp' on failure.
- */
- int circpad_negotiated_set_machine_type(circpad_negotiated_t *inp, uint8_t val);
- #endif
|