.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shisa_keys_find" 3 "1.0.1" "shishi" "shishi"
.SH NAME
shisa_keys_find \- API function
.SH SYNOPSIS
.B #include <shisa.h>
.sp
.BI "int shisa_keys_find(Shisa * " dbh ", const char * " realm ", const char * " principal ", const Shisa_key * " hint ", Shisa_key *** " keys ", size_t * " nkeys ");"
.SH ARGUMENTS
.IP "Shisa * dbh" 12
Shisa library handle created by \fBshisa()\fP.
.IP "const char * realm" 12
Name of realm the principal belongs in.
.IP "const char * principal" 12
Name of principal to add key for.
.IP "const Shisa_key * hint" 12
Pointer to Shisa key structure with hints on matching the key
to modify, may be \fBNULL\fP to match all keys.
.IP "Shisa_key *** keys" 12
pointer to newly allocated array with Shisa key structures.
.IP "size_t * nkeys" 12
pointer to number of newly allocated Shisa key structures in \fIkeys\fP.
.SH "DESCRIPTION"
Iterate through keys for given PRINCIPAL\fIREALM\fP and extract any keys
that match \fIhint\fP.  Not all elements of \fIhint\fP need to be filled out,
only use the fields you are interested in.  For example, if you
want to extract all keys with an etype of 3 (DES\-CBC\-MD5), set the
\fIkey\fP\->etype field to 3, and set all other fields to 0.
.SH "RETURN VALUE"
Returns \fBSHISA_OK\fP iff successful, or an error code.
.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.