|
Packit |
549fdc |
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
|
|
Packit |
549fdc |
.TH "gnutls_srp_base64_encode" 3 "3.6.2" "gnutls" "gnutls"
|
|
Packit |
549fdc |
.SH NAME
|
|
Packit |
549fdc |
gnutls_srp_base64_encode \- API function
|
|
Packit |
549fdc |
.SH SYNOPSIS
|
|
Packit |
549fdc |
.B #include <gnutls/gnutls.h>
|
|
Packit |
549fdc |
.sp
|
|
Packit |
549fdc |
.BI "int gnutls_srp_base64_encode(const gnutls_datum_t * " data ", char * " result ", size_t * " result_size ");"
|
|
Packit |
549fdc |
.SH ARGUMENTS
|
|
Packit |
549fdc |
.IP "const gnutls_datum_t * data" 12
|
|
Packit |
549fdc |
contain the raw data
|
|
Packit |
549fdc |
.IP "char * result" 12
|
|
Packit |
549fdc |
the place where base64 data will be copied
|
|
Packit |
549fdc |
.IP "size_t * result_size" 12
|
|
Packit |
549fdc |
holds the size of the result
|
|
Packit |
549fdc |
.SH "DESCRIPTION"
|
|
Packit |
549fdc |
This function will convert the given data to printable data, using
|
|
Packit |
549fdc |
the base64 encoding, as used in the libsrp. This is the encoding
|
|
Packit |
549fdc |
used in SRP password files. If the provided buffer is not long
|
|
Packit |
549fdc |
enough GNUTLS_E_SHORT_MEMORY_BUFFER is returned.
|
|
Packit |
549fdc |
|
|
Packit |
549fdc |
Warning! This base64 encoding is not the "standard" encoding, so
|
|
Packit |
549fdc |
do not use it for non\-SRP purposes.
|
|
Packit |
549fdc |
.SH "RETURNS"
|
|
Packit |
549fdc |
\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not
|
|
Packit |
549fdc |
long enough, or 0 on success.
|
|
Packit |
549fdc |
.SH "REPORTING BUGS"
|
|
Packit |
549fdc |
Report bugs to <bugs@gnutls.org>.
|
|
Packit |
549fdc |
.br
|
|
Packit |
549fdc |
Home page: http://www.gnutls.org
|
|
Packit |
549fdc |
|
|
Packit |
549fdc |
.SH COPYRIGHT
|
|
Packit |
549fdc |
Copyright \(co 2001-2018 Free Software Foundation, Inc., and others.
|
|
Packit |
549fdc |
.br
|
|
Packit |
549fdc |
Copying and distribution of this file, with or without modification,
|
|
Packit |
549fdc |
are permitted in any medium without royalty provided the copyright
|
|
Packit |
549fdc |
notice and this notice are preserved.
|
|
Packit |
549fdc |
.SH "SEE ALSO"
|
|
Packit |
549fdc |
The full documentation for
|
|
Packit |
549fdc |
.B gnutls
|
|
Packit |
549fdc |
is maintained as a Texinfo manual.
|
|
Packit |
549fdc |
If the /usr/share/doc/gnutls/
|
|
Packit |
549fdc |
directory does not contain the HTML form visit
|
|
Packit |
549fdc |
.B
|
|
Packit |
549fdc |
.IP http://www.gnutls.org/manual/
|
|
Packit |
549fdc |
.PP
|