Merge pull request #2066 from lminiero/connection-close-reason

Extend CONNECTION_CLOSE APIs to support reason string

Author: huitema

picoquic/frames.c

@@ -4389,12 +4389,20 @@ uint8_t * picoquic_format_connection_close_frame(picoquic_cnx_t* cnx,
 
 const uint8_t* picoquic_decode_connection_close_frame(picoquic_cnx_t* cnx, const uint8_t* bytes, const uint8_t* bytes_max)
 {
-    bytes = picoquic_frames_varint_decode(bytes + 1, bytes_max, &cnx->remote_error);
+    uint64_t reason_length = 0;
 
-    if (bytes == NULL ||
-        (bytes = picoquic_frames_varint_skip(bytes, bytes_max)) == NULL ||
-        (bytes = picoquic_frames_length_data_skip(bytes, bytes_max)) == NULL)
-    {
+    if ((bytes = picoquic_frames_varint_decode(bytes + 1, bytes_max, &cnx->remote_error)) != NULL &&
+        (bytes = picoquic_frames_varint_skip(bytes, bytes_max)) != NULL &&
+        (bytes = picoquic_frames_varint_decode(bytes, bytes_max, &reason_length)) != NULL){
+        const uint8_t* first_byte = bytes;
+        if (reason_length != 0 &&
+            (bytes = picoquic_frames_fixed_skip(bytes, bytes_max, reason_length)) != NULL &&
+            cnx->remote_error_reason == NULL) {
+            cnx->remote_error_reason = picoquic_string_create((char*)first_byte, (size_t)reason_length);
+        }
+    }
+
+    if (bytes == NULL) {
         picoquic_connection_error(cnx, PICOQUIC_TRANSPORT_FRAME_FORMAT_ERROR,
             picoquic_frame_type_connection_close);
     }
@@ -4421,7 +4429,7 @@ uint8_t * picoquic_format_application_close_frame(picoquic_cnx_t* cnx,
 
     if ((bytes = picoquic_frames_uint8_encode(bytes, bytes_max, picoquic_frame_type_application_close)) != NULL &&
         (bytes = picoquic_frames_varint_encode(bytes, bytes_max, cnx->application_error)) != NULL &&
-        (bytes = picoquic_frames_uint8_encode(bytes, bytes_max, 0)) != NULL) {
+        (bytes = picoquic_frames_charz_encode(bytes, bytes_max, cnx->local_error_reason)) != NULL) {
         *is_pure_ack = 0;
     }
     else {
@@ -4433,12 +4441,19 @@ uint8_t * picoquic_format_application_close_frame(picoquic_cnx_t* cnx,
 
 const uint8_t* picoquic_decode_application_close_frame(picoquic_cnx_t* cnx, const uint8_t* bytes, const uint8_t* bytes_max)
 {
-    bytes = picoquic_frames_varint_decode(bytes + 1, bytes_max, &cnx->remote_application_error);
+    uint64_t reason_length = 0;
 
-    if (bytes == NULL ||
-        /* TODO, maybe: skip frame type for compatibility with draft-13 */
-        (bytes = picoquic_frames_length_data_skip(bytes, bytes_max)) == NULL)
-    {
+    if ((bytes = picoquic_frames_varint_decode(bytes + 1, bytes_max, &cnx->remote_application_error)) != NULL &&
+        (bytes = picoquic_frames_varint_decode(bytes, bytes_max, &reason_length)) != NULL){
+        const uint8_t* first_byte = bytes;
+        if (reason_length != 0 &&
+            (bytes = picoquic_frames_fixed_skip(bytes, bytes_max, reason_length)) != NULL &&
+            cnx->remote_error_reason == NULL) {
+            cnx->remote_error_reason = picoquic_string_create((char*)first_byte, (size_t)reason_length);
+        }
+    }
+
+    if (bytes == NULL) {
         picoquic_connection_error(cnx, PICOQUIC_TRANSPORT_FRAME_FORMAT_ERROR,
             picoquic_frame_type_application_close);
     }

picoquic/picoquic.h

@@ -934,6 +934,8 @@ int picoquic_start_client_cnx(picoquic_cnx_t* cnx);
  */
 int picoquic_close(picoquic_cnx_t* cnx, uint64_t application_reason_code);
 
+int picoquic_close_ex(picoquic_cnx_t* cnx, uint64_t application_reason_code, char const* error_reason);
+
 void picoquic_close_immediate(picoquic_cnx_t* cnx);
 
 void picoquic_delete_cnx(picoquic_cnx_t* cnx);

picoquic/picoquic_internal.h

@@ -1357,6 +1357,7 @@ typedef struct st_picoquic_cnx_t {
     uint64_t remote_application_error;
     uint64_t remote_error;
     uint64_t offending_frame_type;
+    char * remote_error_reason;
     uint16_t retry_token_length;
     uint8_t * retry_token;
 

picoquic/quicctx.c

@@ -5102,6 +5102,11 @@ void picoquic_delete_cnx(picoquic_cnx_t* cnx)
             cnx->sni = NULL;
         }
 
+        if (cnx->remote_error_reason != NULL) {
+            free((void*)cnx->remote_error_reason);
+            cnx->remote_error_reason = NULL;
+        }
+
         if (cnx->retry_token != NULL) {
             free(cnx->retry_token);
             cnx->retry_token = NULL;

picoquic/sender.c

@@ -4196,6 +4196,11 @@ int picoquic_prepare_packet(picoquic_cnx_t* cnx,
 }
 
 int picoquic_close(picoquic_cnx_t* cnx, uint64_t application_reason_code)
+{
+    return picoquic_close_ex(cnx, application_reason_code, NULL);
+}
+
+int picoquic_close_ex(picoquic_cnx_t* cnx, uint64_t application_reason_code, char const* error_reason)
 {
     int ret = 0;
     uint64_t current_time = picoquic_get_quic_time(cnx->quic);
@@ -4211,6 +4216,7 @@ int picoquic_close(picoquic_cnx_t* cnx, uint64_t application_reason_code)
     } else {
         ret = -1;
     }
+    cnx->local_error_reason = error_reason;
     cnx->offending_frame_type = 0;
     picoquic_reinsert_by_wake_time(cnx->quic, cnx, current_time);
 

picoquic/util.c

@@ -861,7 +861,6 @@ const uint8_t* picoquic_frames_cid_decode(const uint8_t* bytes, const uint8_t* b
     return bytes;
 }
 
-
 /* Predict length of a varint encoding */
 size_t picoquic_frames_varint_encode_length(uint64_t n64)
 {