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

diff --git a/imap/auth_gss.c b/imap/auth_gss.c
index 7d6d080a1edc5da51378562cec98a3b340a5a3f4..a08e7c2056a1f9793b5d5947185d2e309d52ff4e 100644 (file)
--- 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"