srp/psk: update recommendations for usernames [ci skip]

Signed-off-by: Nikos Mavrogiannopoulos <nmav@redhat.com>

2 files changed, 17 insertions, 12 deletions

diff --git a/lib/psk.c b/lib/psk.c
index 0fd8cf2a11..2818a8450b 100644
--- a/lib/psk.c
+++ b/lib/psk.c
@@ -83,9 +83,9 @@ gnutls_psk_allocate_client_credentials(gnutls_psk_client_credentials_t *
  * This function sets the username and password, in a
  * gnutls_psk_client_credentials_t type.  Those will be used in
  * PSK authentication.  @username should be an ASCII string or UTF-8
- * strings prepared using the "SASLprep" profile of "stringprep".  The
- * key can be either in raw byte format or in Hex format (without the
- * 0x prefix).
+ * string. In case of a UTF-8 string it is recommended to be following
+ * the PRECIS framework for usernames (rfc8265). The key can be either
+ * in raw byte format or in Hex format (without the 0x prefix).
  *
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise
  *   an error code is returned.
@@ -296,8 +296,9 @@ gnutls_psk_set_server_credentials_function(gnutls_psk_server_credentials_t
  *  gnutls_datum_t* key);
  *
  * The @username and @key->data must be allocated using gnutls_malloc().
- * @username should be ASCII strings or UTF-8 strings prepared using
- * the "SASLprep" profile of "stringprep".
+ * The @username should be an ASCII string or UTF-8
+ * string. In case of a UTF-8 string it is recommended to be following
+ * the PRECIS framework for usernames (rfc8265).
  *
  * The callback function will be called once per handshake.
  *
diff --git a/lib/srp.c b/lib/srp.c
index 20132f89d4..27a28f2aab 100644
--- a/lib/srp.c
+++ b/lib/srp.c
@@ -459,10 +459,11 @@ gnutls_srp_allocate_client_credentials(gnutls_srp_client_credentials_t *
  *
  * This function sets the username and password, in a
  * #gnutls_srp_client_credentials_t type.  Those will be used in
- * SRP authentication.  @username and @password should be ASCII
- * strings or UTF-8 strings prepared using the "SASLprep" profile of
- * "stringprep".
- *
+ * SRP authentication.  @username should be an ASCII string or UTF-8
+ * string. In case of a UTF-8 string it is recommended to be following
+ * the PRECIS framework for usernames (rfc8265). The password can
+ * be in ASCII format, or normalized using gnutls_utf8_password_normalize().
+
  * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, or an
  *   error code.
  **/
@@ -671,9 +672,12 @@ gnutls_srp_set_server_credentials_function(gnutls_srp_server_credentials_t
  * int (*callback)(gnutls_session_t, char** username, char**password);
  *
  * The @username and @password must be allocated using
- * gnutls_malloc().  @username and @password should be ASCII strings
- * or UTF-8 strings prepared using the "SASLprep" profile of
- * "stringprep".
+ * gnutls_malloc().
+ *
+ * The @username should be an ASCII string or UTF-8
+ * string. In case of a UTF-8 string it is recommended to be following
+ * the PRECIS framework for usernames (rfc8265). The password can
+ * be in ASCII format, or normalized using gnutls_utf8_password_normalize().
  *
  * The callback function will be called once per handshake before the
  * initial hello message is sent.