hs-v3: Keep descriptor in cache if client auth is missing or bad

We now keep the descriptor in the cache, obviously not decoded, if it can't be
decrypted for which we believe client authorization is missing or unusable
(bad).

This way, it can be used later once the client authorization are added or
updated.

Part of #30382

Signed-off-by: David Goulet <dgoulet@torproject.org>

1 files changed, 21 insertions, 5 deletions

diff --git a/src/feature/hs/hs_descriptor.h b/src/feature/hs/hs_descriptor.h
index 8d9dac1747..4f726f8c97 100644
--- a/src/feature/hs/hs_descriptor.h
+++ b/src/feature/hs/hs_descriptor.h
@@ -71,11 +71,27 @@ typedef enum {
 
 /** Error code when decoding a descriptor. */
 typedef enum {
-  HS_DESC_DECODE_ENCRYPTED_ERROR = -4,
-  HS_DESC_DECODE_SUPERENC_ERROR  = -3,
-  HS_DESC_DECODE_PLAINTEXT_ERROR = -2,
-  HS_DESC_DECODE_GENERIC_ERROR   = -1,
-  HS_DESC_DECODE_OK              =  0,
+  /* The configured client authorization for the requested .onion address
+   * failed to decode the descriptor. */
+  HS_DESC_DECODE_BAD_CLIENT_AUTH  = -6,
+
+  /* The requested .onion address requires a client authorization. */
+  HS_DESC_DECODE_NEED_CLIENT_AUTH = -5,
+
+  /* Error during decryption of the encrypted layer. */
+  HS_DESC_DECODE_ENCRYPTED_ERROR  = -4,
+
+  /* Error during decryption of the super encrypted layer. */
+  HS_DESC_DECODE_SUPERENC_ERROR   = -3,
+
+  /* Error while decoding the plaintext section. */
+  HS_DESC_DECODE_PLAINTEXT_ERROR  = -2,
+
+  /* Generic error. */
+  HS_DESC_DECODE_GENERIC_ERROR    = -1,
+
+  /* Decoding a descriptor was successful. */
+  HS_DESC_DECODE_OK               =  0,
 } hs_desc_decode_status_t;
 
 /** Introduction point information located in a descriptor. */