document krb5_generate_subkey

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@13598 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2004-03-21 13:40:54 +00:00
parent 47591e38ca
commit 6c0a892750

View File

@@ -42,6 +42,7 @@
.Nm krb5_free_keyblock , .Nm krb5_free_keyblock ,
.Nm krb5_free_keyblock_contents , .Nm krb5_free_keyblock_contents ,
.Nm krb5_generate_random_keyblock , .Nm krb5_generate_random_keyblock ,
.Nm krb5_generate_subkey ,
.Nm krb5_keyblock_zero .Nm krb5_keyblock_zero
.Nd Kerberos 5 key handling functions. .Nd Kerberos 5 key handling functions.
.Sh LIBRARY .Sh LIBRARY
@@ -81,6 +82,12 @@ Kerberos 5 Library (libkrb5, -lkrb5)
.Fa "krb5_enctype type" .Fa "krb5_enctype type"
.Fa "krb5_keyblock *key" .Fa "krb5_keyblock *key"
.Fc .Fc
.Ft krb5_error_code
.Fo krb5_generate_subkey
.Fo "krb5_context context"
.Fa "const krb5_keyblock *key"
.Fa "krb5_keyblock **subkey"
.Fc
.Ft void .Ft void
.Fo krb5_keyblock_zero .Fo krb5_keyblock_zero
.Fa "krb5_keyblock *keyblock" .Fa "krb5_keyblock *keyblock"
@@ -129,6 +136,14 @@ The content of
is overwritten and not freed, so the caller should be sure it is is overwritten and not freed, so the caller should be sure it is
freed before calling the function. freed before calling the function.
.Pp .Pp
.Fn krb5_generate_subkey
generates a
.Fa subkey
of the same type as
.Fa key .
The caller must free the subkey with
.Fa krb5_free_keyblock .
.Pp
.Fn krb5_keyblock_zero .Fn krb5_keyblock_zero
zeros out the keyblock to to make sure no keymaterial is in zeros out the keyblock to to make sure no keymaterial is in
memory. memory.