[tor-commits] [tor/master] Document a requirement for cells to be encrypted.

[nickm at torproject.org]

commit a9fa483004b0951c3fc7f8a9f5a097b917da6fa8
Author: Nick Mathewson <nickm at torproject.org>
Date:   Sat Mar 24 13:49:44 2018 -0400

    Document a requirement for cells to be encrypted.
---
 src/or/relay_crypto.c | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/or/relay_crypto.c b/src/or/relay_crypto.c
index 9d61ecd42..c42a4f9cc 100644
--- a/src/or/relay_crypto.c
+++ b/src/or/relay_crypto.c
@@ -170,6 +170,9 @@ relay_decrypt_cell(circuit_t *circ, cell_t *cell,
 /**
  * Encrypt a cell <b>cell</b> that we are creating, and sending outbound on
  * <b>circ</b> until the hop corresponding to <b>layer_hint</b>.
+ *
+ * The integrity field and recognized field of <b>cell</b>'s relay headers
+ * must be set to zero.
  */
 void
 relay_encrypt_cell_outbound(cell_t *cell,
@@ -193,6 +196,9 @@ relay_encrypt_cell_outbound(cell_t *cell,
 /**
  * Encrypt a cell <b>cell</b> that we are creating, and sending on
  * <b>circuit</b> to the origin.
+ *
+ * The integrity field and recognized field of <b>cell</b>'s relay headers
+ * must be set to zero.
  */
 void
 relay_encrypt_cell_inbound(cell_t *cell,