.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "shisa_key_update" 3 "1.0.3" "shishi" "shishi"
.SH NAME
shisa_key_update \- API function
.SH SYNOPSIS
.B #include <shisa.h>
.sp
.BI "int shisa_key_update(Shisa * " dbh ", const char * " realm ", const char * " principal ", const Shisa_key * " oldkey ", const Shisa_key * " newkey ");"
.SH ARGUMENTS
.IP "Shisa * dbh" 12
Shisa library handle created by \fBshisa()\fP.
.IP "const char * realm" 12
Name of the realm the principal belongs to.
.IP "const char * principal" 12
Name of the principal needing an updated key.
.IP "const Shisa_key * oldkey" 12
Pointer to a Shisa key structure giving matching
criteria for locating the key to be updated.
.IP "const Shisa_key * newkey" 12
Pointer to a complete Shisa key structure, in which
all fields are used for the new key.  Note that \fIoldkey\fP
normally has far fewer fields filled\-in.
.SH "DESCRIPTION"
Modifies data about a key stored in the database, a key
belonging to the principal selected by \fIprincipal\fP and \fIrealm\fP.
First \fIoldkey\fP is used to locate the key to update, as does
\fBshisa_keys_find()\fP.  Then the found key is modified to carry
whatever information is stored in \fInewkey\fP.

Not all elements of \fIoldkey\fP need to be filled out, only
sufficiently many so as to uniquely identify the desired key.
For example, if you want to modify the information stored about
a unique key of etype 3, i.e., DES\-CBC\-MD5, then set the field
\fIkey\fP\->etype to 3, leaving all other fields as zero.
.SH "RETURN VALUE"
Returns \fBSHISA_OK\fP on success, \fBSHISA_NO_KEY\fP if no
key could be located, \fBSHISA_MULTIPLE_KEY_MATCH\fP if more
than a single key matched the given criteria, or an error code
otherwise.
.SH "REPORTING BUGS"
Report bugs to <bug-shishi@gnu.org>.
GNU Shishi home page: http://www.gnu.org/software/shishi/
General help using GNU software: http://www.gnu.org/gethelp/
.SH COPYRIGHT
Copyright \(co 2002-2022 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.