summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2016-08-29 11:41:04 +0200
committerAndrew Bartlett <abartlet@samba.org>2016-08-31 20:59:16 +0200
commit294df2e52c37ae4be1f8995db90d930f29a4713c (patch)
tree2135982319a0a709029c9349cd37a9012d998618 /lib
parent15c5dd700cba24b97ab8ab96710c068335e1edb1 (diff)
downloadsamba-294df2e52c37ae4be1f8995db90d930f29a4713c.tar.gz
krb5_wrap: Improve smb_krb5_kinit_keyblock_cache() documentation
Signed-off-by: Andreas Schneider <asn@samba.org> Reviewed-by: Andrew Bartlett <abartlet@samba.org>
Diffstat (limited to 'lib')
-rw-r--r--lib/krb5_wrap/krb5_samba.c38
1 files changed, 25 insertions, 13 deletions
diff --git a/lib/krb5_wrap/krb5_samba.c b/lib/krb5_wrap/krb5_samba.c
index 656fd7791ce..53660c88536 100644
--- a/lib/krb5_wrap/krb5_samba.c
+++ b/lib/krb5_wrap/krb5_samba.c
@@ -1710,19 +1710,31 @@ krb5_error_code smb_krb5_keyblock_init_contents(krb5_context context,
#endif
}
-/*
- simulate a kinit, putting the tgt in the given credentials cache.
- Orignally by remus@snapserver.com
-
- This version is built to use a keyblock, rather than needing the
- original password.
-
- The impersonate_principal is the principal if NULL, or the principal
- to impersonate
-
- The target_service defaults to the krbtgt if NULL, but could be
- kpasswd/realm or the local service (if we are doing s4u2self)
-*/
+/**
+ * @brief Simulate a kinit by putting the tgt in the given credential cache.
+ *
+ * This function uses a keyblock rather than needingthe original password.
+ *
+ * @param[in] ctx The library context
+ *
+ * @param[in] cc The credential cache to put the tgt in.
+ *
+ * @param[in] principal The client princial
+ *
+ * @param[in] keyblock The keyblock to use.
+ *
+ * @param[in] target_service The service name of the initial credentials (or NULL).
+ *
+ * @param[in] krb_options Initial credential options.
+ *
+ * @param[in] expire_time A pointer to store the experation time of the
+ * credentials (or NULL).
+ *
+ * @param[in] kdc_time A pointer to store the time when the ticket becomes
+ * valid (or NULL).
+ *
+ * @return 0 on success, a Kerberos error code otherwise.
+ */
krb5_error_code smb_krb5_kinit_keyblock_ccache(krb5_context ctx,
krb5_ccache cc,
krb5_principal principal,