From: Kevin McCarthy <kevin@8t8.us>
Date: Sun, 15 Apr 2018 22:57:28 +0000 (-0700)
Subject: Add a comment in auth_gss about RFCs and null-termination.
X-Git-Tag: mutt-1-10-rel~28
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=79939350c4aaddfa95fb08a45dee0d0d2d226983;p=mutt

Add a comment in auth_gss about RFCs and null-termination.
---

diff --git a/imap/auth_gss.c b/imap/auth_gss.c
index 7d6d080a..a08e7c20 100644
--- a/imap/auth_gss.c
+++ b/imap/auth_gss.c
@@ -16,7 +16,15 @@
  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  */ 
 
-/* GSS login/authentication code */
+/* GSS login/authentication code
+ *
+ * An overview of the authentication method is in RFC 1731.
+ *
+ * An overview of the C API used is in RFC 2744.
+ * Of note is section 3.2, which describes gss_buffer_desc.
+ * The length should not include a terminating '\0' byte, and the client
+ * should not expect the value field to be '\0'terminated.
+ */
 
 #if HAVE_CONFIG_H
 # include "config.h"