.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shishi_string_to_key" 3 "1.0.2" "shishi" "shishi"
.SH NAME
shishi_string_to_key \- API function
.SH SYNOPSIS
.B #include <shishi.h>
.sp
.BI "int shishi_string_to_key(Shishi * " handle ", int32_t " keytype ", const char * " password ", size_t " passwordlen ", const char * " salt ", size_t " saltlen ", const char * " parameter ", Shishi_key * " outkey ");"
.SH ARGUMENTS
.IP "Shishi * handle" 12
shishi handle as allocated by \fBshishi_init()\fP.
.IP "int32_t keytype" 12
cryptographic encryption type, see Shishi_etype.
.IP "const char * password" 12
input array with password.
.IP "size_t passwordlen" 12
length of input array with password.
.IP "const char * salt" 12
input array with salt.
.IP "size_t saltlen" 12
length of input array with salt.
.IP "const char * parameter" 12
input array with opaque encryption type specific information.
.IP "Shishi_key * outkey" 12
allocated key handle that will contain new key.
.SH "DESCRIPTION"
Derive key from a string (password) and salt (commonly
concatenation of realm and principal) for specified key type, and
set the type and value in the given key to the computed values.
The parameter value is specific for each keytype, and can be set if
the parameter information is not available.
.SH "RETURN VALUE"
Returns \fBSHISHI_OK\fP iff successful.
.SH "REPORTING BUGS"
Report bugs to <bug-shishi@gnu.org>.
.SH COPYRIGHT
Copyright \(co 2002-2010 Simon Josefsson.
.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 shishi
is maintained as a Texinfo manual.  If the
.B info
and
.B shishi
programs are properly installed at your site, the command
.IP
.B info shishi
.PP
should give you access to the complete manual.