summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_srp_base64_encode.3
blob: dd9e7cd996e60caeb4b95ff36d077fc5d03c0d58 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_srp_base64_encode" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_srp_base64_encode \- API function
.SH SYNOPSIS
.B #include <gnutls/gnutls.h>
.sp
.BI "int gnutls_srp_base64_encode(const gnutls_datum_t * " data ", char * " result ", size_t * " result_size ");"
.SH ARGUMENTS
.IP "const gnutls_datum_t * data" 12
contain the raw data
.IP "char * result" 12
the place where base64 data will be copied
.IP "size_t * result_size" 12
holds the size of the result
.SH "DESCRIPTION"
This function will convert the given data to printable data, using
the base64 encoding, as used in the libsrp.  This is the encoding
used in SRP password files.  If the provided buffer is not long
enough GNUTLS_E_SHORT_MEMORY_BUFFER is returned.

Warning!  This base64 encoding is not the "standard" encoding, so
do not use it for non\-SRP purposes.
.SH "RETURNS"
\fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP if the buffer given is not
long enough, or 0 on success.
.SH "REPORTING BUGS"
Report bugs to <bugs@gnutls.org>.
.br
Home page: https://www.gnutls.org

.SH COPYRIGHT
Copyright \(co 2001- Free Software Foundation, Inc., and others.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gnutls
is maintained as a Texinfo manual.
If the /usr/share/doc/gnutls/
directory does not contain the HTML form visit
.B
.IP https://www.gnutls.org/manual/
.PP