summaryrefslogtreecommitdiffstats
path: root/doc/functions/gnutls_srp_set_client_credentials
blob: 24b18dfac0d915b9538e990d3176854515982f72 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@deftypefun {int} {gnutls_srp_set_client_credentials} (gnutls_srp_client_credentials_t @var{res}, const char * @var{username}, const char * @var{password})
@var{res}: is a @code{gnutls_srp_client_credentials_t}  type.

@var{username}: is the user's userid

@var{password}: is the user's password

This function sets the username and password, in a
@code{gnutls_srp_client_credentials_t}  type.  Those will be used in
SRP authentication.   @code{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 @code{gnutls_utf8_password_normalize()} .

@strong{Returns:} On success, @code{GNUTLS_E_SUCCESS}  (0) is returned, or an
error code.
@end deftypefun