|
Packit Service |
4684c1 |
.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
|
|
Packit Service |
4684c1 |
.TH "gnutls_prf" 3 "3.6.14" "gnutls" "gnutls"
|
|
Packit Service |
4684c1 |
.SH NAME
|
|
Packit Service |
4684c1 |
gnutls_prf \- API function
|
|
Packit Service |
4684c1 |
.SH SYNOPSIS
|
|
Packit Service |
4684c1 |
.B #include <gnutls/gnutls.h>
|
|
Packit Service |
4684c1 |
.sp
|
|
Packit Service |
4684c1 |
.BI "int gnutls_prf(gnutls_session_t " session ", size_t " label_size ", const char * " label ", int " server_random_first ", size_t " extra_size ", const char * " extra ", size_t " outsize ", char * " out ");"
|
|
Packit Service |
4684c1 |
.SH ARGUMENTS
|
|
Packit Service |
4684c1 |
.IP "gnutls_session_t session" 12
|
|
Packit Service |
4684c1 |
is a \fBgnutls_session_t\fP type.
|
|
Packit Service |
4684c1 |
.IP "size_t label_size" 12
|
|
Packit Service |
4684c1 |
length of the \fIlabel\fP variable.
|
|
Packit Service |
4684c1 |
.IP "const char * label" 12
|
|
Packit Service |
4684c1 |
label used in PRF computation, typically a short string.
|
|
Packit Service |
4684c1 |
.IP "int server_random_first" 12
|
|
Packit Service |
4684c1 |
non\-zero if server random field should be first in seed
|
|
Packit Service |
4684c1 |
.IP "size_t extra_size" 12
|
|
Packit Service |
4684c1 |
length of the \fIextra\fP variable.
|
|
Packit Service |
4684c1 |
.IP "const char * extra" 12
|
|
Packit Service |
4684c1 |
optional extra data to seed the PRF with.
|
|
Packit Service |
4684c1 |
.IP "size_t outsize" 12
|
|
Packit Service |
4684c1 |
size of pre\-allocated output buffer to hold the output.
|
|
Packit Service |
4684c1 |
.IP "char * out" 12
|
|
Packit Service |
4684c1 |
pre\-allocated buffer to hold the generated data.
|
|
Packit Service |
4684c1 |
.SH "DESCRIPTION"
|
|
Packit Service |
4684c1 |
Applies the TLS Pseudo\-Random\-Function (PRF) on the master secret
|
|
Packit Service |
4684c1 |
and the provided data, seeded with the client and server random fields.
|
|
Packit Service |
4684c1 |
For the key expansion specified in RFC5705 see \fBgnutls_prf_rfc5705()\fP.
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
The \fIlabel\fP variable usually contains a string denoting the purpose
|
|
Packit Service |
4684c1 |
for the generated data. The \fIserver_random_first\fP indicates whether
|
|
Packit Service |
4684c1 |
the client random field or the server random field should be first
|
|
Packit Service |
4684c1 |
in the seed. Non\-zero indicates that the server random field is first,
|
|
Packit Service |
4684c1 |
0 that the client random field is first.
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
The \fIextra\fP variable can be used to add more data to the seed, after
|
|
Packit Service |
4684c1 |
the random variables. It can be used to make sure the
|
|
Packit Service |
4684c1 |
generated output is strongly connected to some additional data
|
|
Packit Service |
4684c1 |
(e.g., a string used in user authentication).
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
The output is placed in \fIout\fP , which must be pre\-allocated.
|
|
Packit Service |
4684c1 |
.SH "NOTE"
|
|
Packit Service |
4684c1 |
This function produces identical output with \fBgnutls_prf_rfc5705()\fP
|
|
Packit Service |
4684c1 |
when \fIserver_random_first\fP is set to 0 and \fIextra\fP is \fBNULL\fP. Under TLS1.3
|
|
Packit Service |
4684c1 |
this function will only operate when these conditions are true, or otherwise
|
|
Packit Service |
4684c1 |
return \fBGNUTLS_E_INVALID_REQUEST\fP.
|
|
Packit Service |
4684c1 |
.SH "RETURNS"
|
|
Packit Service |
4684c1 |
\fBGNUTLS_E_SUCCESS\fP on success, or an error code.
|
|
Packit Service |
4684c1 |
.SH "REPORTING BUGS"
|
|
Packit Service |
4684c1 |
Report bugs to <bugs@gnutls.org>.
|
|
Packit Service |
4684c1 |
.br
|
|
Packit Service |
4684c1 |
Home page: https://www.gnutls.org
|
|
Packit Service |
4684c1 |
|
|
Packit Service |
4684c1 |
.SH COPYRIGHT
|
|
Packit Service |
4684c1 |
Copyright \(co 2001- Free Software Foundation, Inc., and others.
|
|
Packit Service |
4684c1 |
.br
|
|
Packit Service |
4684c1 |
Copying and distribution of this file, with or without modification,
|
|
Packit Service |
4684c1 |
are permitted in any medium without royalty provided the copyright
|
|
Packit Service |
4684c1 |
notice and this notice are preserved.
|
|
Packit Service |
4684c1 |
.SH "SEE ALSO"
|
|
Packit Service |
4684c1 |
The full documentation for
|
|
Packit Service |
4684c1 |
.B gnutls
|
|
Packit Service |
4684c1 |
is maintained as a Texinfo manual.
|
|
Packit Service |
4684c1 |
If the /usr/share/doc/gnutls/
|
|
Packit Service |
4684c1 |
directory does not contain the HTML form visit
|
|
Packit Service |
4684c1 |
.B
|
|
Packit Service |
4684c1 |
.IP https://www.gnutls.org/manual/
|
|
Packit Service |
4684c1 |
.PP
|