doc/manpages/gnutls_srp_verifier.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_srp_verifier" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_srp_verifier \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .BI "int gnutls_srp_verifier(const char * " username ", const char * " password ", const gnutls_datum_t * " salt ", const gnutls_datum_t * " generator ", const gnutls_datum_t * " prime ", gnutls_datum_t * " res ");"
   9 .SH ARGUMENTS
  10 .IP "const char * username" 12
  11 is the user's name
  12 .IP "const char * password" 12
  13 is the user's password
  14 .IP "const gnutls_datum_t * salt" 12
  15 should be some randomly generated bytes
  16 .IP "const gnutls_datum_t * generator" 12
  17 is the generator of the group
  18 .IP "const gnutls_datum_t * prime" 12
  19 is the group's prime
  20 .IP "gnutls_datum_t * res" 12
  21 where the verifier will be stored.
  22 .SH "DESCRIPTION"
  23 This function will create an SRP verifier, as specified in
  24 RFC2945.  The \fIprime\fP and \fIgenerator\fP should be one of the static
  25 parameters defined in gnutls/extra.h or may be generated using the
  26 libgcrypt functions \fBgcry_prime_generate()\fP and
  27 \fBgcry_prime_group_generator()\fP.
  28
  29 The verifier will be allocated with \fImalloc\fP and will be stored in
  30 \fIres\fP using binary format.
  31 .SH "RETURNS"
  32 On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, or an
  33 error code.
  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.