From 6c0a892750b80ced688f7ec689431c0e829ba341 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Love=20H=C3=B6rnquist=20=C3=85strand?= <lha@kth.se>
Date: Sun, 21 Mar 2004 13:40:54 +0000
Subject: [PATCH] document krb5_generate_subkey

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@13598 ec53bebd-3082-4978-b11e-865c3cabbd6b
---
 lib/krb5/krb5_keyblock.3 | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/lib/krb5/krb5_keyblock.3 b/lib/krb5/krb5_keyblock.3
index 1dc1cf33e..03f4de905 100644
--- a/lib/krb5/krb5_keyblock.3
+++ b/lib/krb5/krb5_keyblock.3
@@ -42,6 +42,7 @@
 .Nm krb5_free_keyblock ,
 .Nm krb5_free_keyblock_contents ,
 .Nm krb5_generate_random_keyblock ,
+.Nm krb5_generate_subkey ,
 .Nm krb5_keyblock_zero
 .Nd Kerberos 5 key handling functions.
 .Sh LIBRARY
@@ -81,6 +82,12 @@ Kerberos 5 Library (libkrb5, -lkrb5)
 .Fa "krb5_enctype type"
 .Fa "krb5_keyblock *key"
 .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
 .Fo krb5_keyblock_zero
 .Fa "krb5_keyblock *keyblock"
@@ -129,6 +136,14 @@ The content of
 is overwritten and not freed, so the caller should be sure it is
 freed before calling the function.
 .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
 zeros out the keyblock to to make sure no keymaterial is in
 memory.