doc/manpages/gnutls_srp_set_client_credentials_function.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_srp_set_client_credentials_function" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_srp_set_client_credentials_function \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "void gnutls_srp_set_client_credentials_function(gnutls_srp_client_credentials_t                                             " cred ", gnutls_srp_client_credentials_function                                             * " func ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_srp_client_credentials_t                                             cred" 12
  11 is a \fBgnutls_srp_server_credentials_t\fP structure.
  12 .IP "gnutls_srp_client_credentials_function                                             * func" 12
  13 is the callback function
  14 .SH "DESCRIPTION"
  15 This function can be used to set a callback to retrieve the
  16 username and password for client SRP authentication.  The
  17 callback's function form is:
  18
  19 int (*callback)(gnutls_session_t, char** username, char**password);
  20
  21 The \fIusername\fP and \fIpassword\fP must be allocated using
  22 \fBgnutls_malloc()\fP.  \fIusername\fP and \fIpassword\fP should be ASCII strings
  23 or UTF\-8 strings prepared using the "SASLprep" profile of
  24 "stringprep".
  25
  26 The callback function will be called once per handshake before the
  27 initial hello message is sent.
  28
  29 The callback should not return a negative error code the second
  30 time called, since the handshake procedure will be aborted.
  31
  32 The callback function should return 0 on success.
  33 \-1 indicates an error.
  34 .SH "REPORTING BUGS"
  35 Report bugs to <bug-gnutls@gnu.org>.
  36 GnuTLS home page: http://www.gnu.org/software/gnutls/
  37 General help using GNU software: http://www.gnu.org/gethelp/
  38 .SH COPYRIGHT
  39 Copyright \(co 2008 Free Software Foundation.
  40 .br
  41 Copying and distribution of this file, with or without modification,
  42 are permitted in any medium without royalty provided the copyright
  43 notice and this notice are preserved.
  44 .SH "SEE ALSO"
  45 The full documentation for
  46 .B gnutls
  47 is maintained as a Texinfo manual.  If the
  48 .B info
  49 and
  50 .B gnutls
  51 programs are properly installed at your site, the command
  52 .IP
  53 .B info gnutls
  54 .PP
  55 should give you access to the complete manual.