Blame doc/manpages/gnutls_prf_raw.3

Packit 549fdc
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit 549fdc
.TH "gnutls_prf_raw" 3 "3.6.2" "gnutls" "gnutls"
Packit 549fdc
.SH NAME
Packit 549fdc
gnutls_prf_raw \- API function
Packit 549fdc
.SH SYNOPSIS
Packit 549fdc
.B #include <gnutls/gnutls.h>
Packit 549fdc
.sp
Packit 549fdc
.BI "int gnutls_prf_raw(gnutls_session_t " session ", size_t " label_size ", const char * " label ", size_t " seed_size ", const char * " seed ", size_t " outsize ", char * " out ");"
Packit 549fdc
.SH ARGUMENTS
Packit 549fdc
.IP "gnutls_session_t session" 12
Packit 549fdc
is a \fBgnutls_session_t\fP type.
Packit 549fdc
.IP "size_t label_size" 12
Packit 549fdc
length of the  \fIlabel\fP variable.
Packit 549fdc
.IP "const char * label" 12
Packit 549fdc
label used in PRF computation, typically a short string.
Packit 549fdc
.IP "size_t seed_size" 12
Packit 549fdc
length of the  \fIseed\fP variable.
Packit 549fdc
.IP "const char * seed" 12
Packit 549fdc
optional extra data to seed the PRF with.
Packit 549fdc
.IP "size_t outsize" 12
Packit 549fdc
size of pre\-allocated output buffer to hold the output.
Packit 549fdc
.IP "char * out" 12
Packit 549fdc
pre\-allocated buffer to hold the generated data.
Packit 549fdc
.SH "DESCRIPTION"
Packit 549fdc
Apply the TLS Pseudo\-Random\-Function (PRF) on the master secret
Packit 549fdc
and the provided data.
Packit 549fdc
Packit 549fdc
The  \fIlabel\fP variable usually contains a string denoting the purpose
Packit 549fdc
for the generated data.  The  \fIseed\fP usually contains data such as the
Packit 549fdc
client and server random, perhaps together with some additional
Packit 549fdc
data that is added to guarantee uniqueness of the output for a
Packit 549fdc
particular purpose.
Packit 549fdc
Packit 549fdc
Because the output is not guaranteed to be unique for a particular
Packit 549fdc
session unless  \fIseed\fP includes the client random and server random
Packit 549fdc
fields (the PRF would output the same data on another connection
Packit 549fdc
resumed from the first one), it is not recommended to use this
Packit 549fdc
function directly.  The \fBgnutls_prf()\fP function seeds the PRF with the
Packit 549fdc
client and server random fields directly, and is recommended if you
Packit 549fdc
want to generate pseudo random data unique for each session.
Packit 549fdc
.SH "RETURNS"
Packit 549fdc
\fBGNUTLS_E_SUCCESS\fP on success, or an error code.
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