From 1dba7d295697dd7e315d390c2661e680b3d0cc01 Mon Sep 17 00:00:00 2001 From: Andreas Schneider Date: Mon, 29 Aug 2016 11:05:19 +0200 Subject: [PATCH] krb5_wrap: Document smb_krb5_kt_open() Signed-off-by: Andreas Schneider Reviewed-by: Andrew Bartlett --- lib/krb5_wrap/krb5_samba.c | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/lib/krb5_wrap/krb5_samba.c b/lib/krb5_wrap/krb5_samba.c index 29c5d914524..7c40bc4f2bf 100644 --- a/lib/krb5_wrap/krb5_samba.c +++ b/lib/krb5_wrap/krb5_samba.c @@ -1116,6 +1116,24 @@ out: return ret; } +/** + * @brief Open a key table readonly or with readwrite access. + * + * Allows to use a different keytab than the default one. The path needs to be + * an absolute path or an error will be returned. + * + * @param[in] context The library context + * + * @param[in] keytab_name_req The path to the key table. + * + * @param[in] write_access Open with readwrite access. + * + * @param[in] keytab A pointer o the opended key table. + * + * The keytab pointer should be freed using krb5_kt_close(). + * + * @return 0 on success, a Kerberos error code otherwise. + */ krb5_error_code smb_krb5_kt_open(krb5_context context, const char *keytab_name_req, bool write_access, -- 2.34.1