From: Daiki Ueno <ueno@gnu.org>
Date: Sat, 24 Oct 2020 07:48:07 +0000 (+0200)
Subject: gnutls_psk_set_server_credentials_file: document the file format
X-Git-Tag: 3.7.0~19^2~2^2~4
X-Git-Url: http://git.ipfire.org/gitweb/?a=commitdiff_plain;h=350394353fac9901b7abbc88ba164b7cfc45e98d;p=thirdparty%2Fgnutls.git

gnutls_psk_set_server_credentials_file: document the file format

Signed-off-by: Daiki Ueno <ueno@gnu.org>
---

diff --git a/lib/psk.c b/lib/psk.c
index 6ea3adb63c..e5f2b05311 100644
--- a/lib/psk.c
+++ b/lib/psk.c
@@ -231,6 +231,11 @@ gnutls_psk_allocate_server_credentials(gnutls_psk_server_credentials_t *
  * #gnutls_psk_server_credentials_t type.  This password file
  * holds usernames and keys and will be used for PSK authentication.
  *
+ * Each entry in the file consists of a username, followed by a colon
+ * (':') and a hex-encoded key.  If the username contains a colon or
+ * any other special character, it can be hex-encoded preceded by a
+ * '#'.
+ *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
  *   an error code is returned.
  **/