From c94db039e4ea6b5b402a45f5cd33488d6c7af94c Mon Sep 17 00:00:00 2001
From: ale <ale@incal.net>
Date: Thu, 19 Jun 2014 11:34:22 +0100
Subject: [PATCH] add docstrings
---
pam/auth_client.h | 47 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 47 insertions(+)
diff --git a/pam/auth_client.h b/pam/auth_client.h
index bdbe566..0d86ba5 100644
--- a/pam/auth_client.h
+++ b/pam/auth_client.h
@@ -16,14 +16,61 @@ typedef struct auth_client* auth_client_t;
#define auth_client_err_to_curl(e) (-(e)+(AC_ERR_CURL_BASE))
#define auth_client_err_from_curl(e) ((AC_ERR_CURL_BASE)-(e))
+/*
+ * Create a new auth client instance.
+ *
+ * @param service Service name
+ * @param servers A comma-separated list of host:port auth server
+ * addresses
+ */
auth_client_t auth_client_new(const char *service, const char *servers);
+
+/*
+ * Free all resources associated with an auth client instance.
+ */
void auth_client_free(auth_client_t ac);
+
+/*
+ * Return a human readable error string.
+ *
+ * @param err Error code returned by one of the auth_client_* methods
+ */
const char *auth_client_strerror(int err);
+
+/*
+ * Set request verbosity.
+ *
+ * If verbose is set to 1, libcurl will dump the outbound requests to
+ * standard error.
+ *
+ * @param ac Auth client
+ * @param verbose Verbosity: 1 to enable, 0 to disable
+ */
void auth_client_set_verbose(auth_client_t ac, int verbose);
+
+/*
+ * Set up SSL credentials, and enable HTTPS.
+ *
+ * @param ac Auth client
+ * @param ca_file Path to the CA certificate (PEM format)
+ * @param crt_file Path to the client certificate (PEM format)
+ * @param key_file Path to the client certificate key
+ */
int auth_client_set_certificate(auth_client_t ac,
const char *ca_file,
const char *crt_file,
const char *key_file);
+
+/*
+ * Authenticate a user.
+ *
+ * @param ac Auth client
+ * @param username Username
+ * @param password Password
+ * @param otp_token OTP token, if present (as a string)
+ * @param source_ip Source IP of the user, where available
+ * @param shard Shard identifier (as a string)
+ */
int auth_client_authenticate(auth_client_t ac,
const char *username,
const char *password,
--
GitLab