Add documentation for kerberos support in libsmbclient.

[gd/samba/.git] / source / include / libsmbclient.h

diff --git a/source/include/libsmbclient.h b/source/include/libsmbclient.h
index 96002643efe0c004de6529c6868b3a32446b448f..74d0d5c9ddb990f3701c42e99fa74146242af49c 100644 (file)
--- a/source/include/libsmbclient.h
+++ b/source/include/libsmbclient.h
@@ -259,6 +259,11 @@ typedef struct _SMBCCTX SMBCCTX;
  * Type for the the authentication function called by the library to
  * obtain authentication credentals
  *
+ * For kerberos support the function should just be called without
+ * prompting the user for credentials. Which means a simple 'return'
+ * should work. Take a look at examples/libsmbclient/get_auth_data_fn.h
+ * and examples/libsmbclient/testbrowse.c.
+ *
  * @param srv       Server being authenticated to
  *
  * @param shr       Share being authenticated to
@@ -293,6 +298,11 @@ typedef void (*smbc_get_auth_data_fn)(const char *srv,
  * Type for the the authentication function called by the library to
  * obtain authentication credentals
  *
+ * For kerberos support the function should just be called without
+ * prompting the user for credentials. Which means a simple 'return'
+ * should work. Take a look at examples/libsmbclient/get_auth_data_fn.h
+ * and examples/libsmbclient/testbrowse.c.
+ *
  * @param c         Pointer to the smb context
  *
  * @param srv       Server being authenticated to