From 7836be49ae5f747b4c13beb7dd0b740c1562ae46 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Love=20H=C3=B6rnquist=20=C3=85strand?= <lha@kth.se>
Date: Sun, 25 Jan 2004 19:02:59 +0000
Subject: [PATCH] document gss_krb5_ccache_name

git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@13286 ec53bebd-3082-4978-b11e-865c3cabbd6b
---
 lib/gssapi/gss_acquire_cred.3      | 21 +++++++++++++++++++++
 lib/gssapi/krb5/gss_acquire_cred.3 | 21 +++++++++++++++++++++
 2 files changed, 42 insertions(+)

diff --git a/lib/gssapi/gss_acquire_cred.3 b/lib/gssapi/gss_acquire_cred.3
index 091f1b950..c7d05a561 100644
--- a/lib/gssapi/gss_acquire_cred.3
+++ b/lib/gssapi/gss_acquire_cred.3
@@ -59,6 +59,7 @@
 .Nm gss_inquire_cred_by_mech ,
 .Nm gss_inquire_mechs_for_name ,
 .Nm gss_inquire_names_for_mech ,
+.Nm gss_krb5_ccache_name ,
 .Nm gss_krb5_copy_ccache ,
 .Nm gss_krb5_compat_des3_mic ,
 .Nm gss_krb5_extract_authz_data_from_sec_context ,
@@ -279,6 +280,12 @@ GSS-API library (libgssapi, -lgssapi)
 .Fa "gss_OID_set * name_types"
 .Fc
 .Ft OM_uint32
+.Fo gss_krb5_ccache_name
+.Fa "OM_uint32 *minor"
+.Fa "const char *name"
+.Fa "const char **old_name"
+.Fc
+.Ft OM_uint32
 .Fo gss_krb5_copy_ccache
 .Fa "OM_uint32 *minor"
 .Fa "gss_cred_id_t cred"
@@ -578,6 +585,20 @@ The functions should not be used for new applications.
 They are provided so that version 1 applications can link against the
 library.
 .Sh EXTENSIONS
+.Fn gss_krb5_ccache_name
+sets the internal kerberos 5 credential cache name to
+.Fa name .
+The old name is returned in
+.Fa old_name ,
+and must not be freed.
+The data allocated for
+.Fa old_name
+is free upon next call to
+.Fn gss_krb5_ccache_name .
+This function is not threadsafe if
+.Fa old_name
+argument is used.
+.Pp
 .Fn gss_krb5_copy_ccache
 will extract the krb5 credentials that are transferred from the
 initiator to the acceptor when using token delegation in the Kerberos
diff --git a/lib/gssapi/krb5/gss_acquire_cred.3 b/lib/gssapi/krb5/gss_acquire_cred.3
index 091f1b950..c7d05a561 100644
--- a/lib/gssapi/krb5/gss_acquire_cred.3
+++ b/lib/gssapi/krb5/gss_acquire_cred.3
@@ -59,6 +59,7 @@
 .Nm gss_inquire_cred_by_mech ,
 .Nm gss_inquire_mechs_for_name ,
 .Nm gss_inquire_names_for_mech ,
+.Nm gss_krb5_ccache_name ,
 .Nm gss_krb5_copy_ccache ,
 .Nm gss_krb5_compat_des3_mic ,
 .Nm gss_krb5_extract_authz_data_from_sec_context ,
@@ -279,6 +280,12 @@ GSS-API library (libgssapi, -lgssapi)
 .Fa "gss_OID_set * name_types"
 .Fc
 .Ft OM_uint32
+.Fo gss_krb5_ccache_name
+.Fa "OM_uint32 *minor"
+.Fa "const char *name"
+.Fa "const char **old_name"
+.Fc
+.Ft OM_uint32
 .Fo gss_krb5_copy_ccache
 .Fa "OM_uint32 *minor"
 .Fa "gss_cred_id_t cred"
@@ -578,6 +585,20 @@ The functions should not be used for new applications.
 They are provided so that version 1 applications can link against the
 library.
 .Sh EXTENSIONS
+.Fn gss_krb5_ccache_name
+sets the internal kerberos 5 credential cache name to
+.Fa name .
+The old name is returned in
+.Fa old_name ,
+and must not be freed.
+The data allocated for
+.Fa old_name
+is free upon next call to
+.Fn gss_krb5_ccache_name .
+This function is not threadsafe if
+.Fa old_name
+argument is used.
+.Pp
 .Fn gss_krb5_copy_ccache
 will extract the krb5 credentials that are transferred from the
 initiator to the acceptor when using token delegation in the Kerberos