~ubuntu-branches/ubuntu/lucid/gnutls26/lucid-security

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
47
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_psk_set_client_credentials" 3 "2.8.4" "gnutls" "gnutls"
.SH NAME
gnutls_psk_set_client_credentials \- Used to set the username/password, in a gnutls_psk_client_credentials_t structure
.SH SYNOPSIS
.B #include <gnutls/gnutls.h>
.sp
.BI "int gnutls_psk_set_client_credentials(gnutls_psk_client_credentials_t " res ", const char * " username ", const gnutls_datum_t * " key ", gnutls_psk_key_flags " flags ");"
.SH ARGUMENTS
.IP "gnutls_psk_client_credentials_t res" 12
is a \fBgnutls_psk_client_credentials_t\fP structure.
.IP "const char * username" 12
is the user's zero\-terminated userid
.IP "const gnutls_datum_t * key" 12
is the user's key
.IP "gnutls_psk_key_flags flags" 12
.SH "DESCRIPTION"
This function sets the username and password, in a
gnutls_psk_client_credentials_t structure.  Those will be used in
PSK authentication. \fIusername\fP should be an ASCII string or UTF\-8
strings prepared using the "SASLprep" profile of "stringprep".
The key can be either in raw byte format or in Hex (not with the
'0x' prefix).
.SH "RETURNS"
\fBGNUTLS_E_SUCCESS\fP on success, or an error code.
.SH "REPORTING BUGS"
Report bugs to <bug-gnutls@gnu.org>.
GnuTLS home page: http://www.gnu.org/software/gnutls/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2008 Free Software Foundation.
.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
.B info
and
.B gnutls
programs are properly installed at your site, the command
.IP
.B info gnutls
.PP
should give you access to the complete manual.