Move all authenticators into separate subdirectories

server/modules/authenticator/MySQLBackendAuth/mysql_backend_auth.c

@@ -0,0 +1,215 @@
+/*
+ * Copyright (c) 2016 MariaDB Corporation Ab
+ *
+ * Use of this software is governed by the Business Source License included
+ * in the LICENSE.TXT file and at www.mariadb.com/bsl.
+ *
+ * Change Date: 2019-07-01
+ *
+ * On the date above, in accordance with the Business Source License, use
+ * of this software will be governed by version 2 or later of the General
+ * Public License.
+ */
+
+/**
+ * @file mysql_backend_auth.c - MySQL backend authenticator
+ *
+ * Backend authentication module for the MySQL protocol. Implements the
+ * client side of the 'mysql_native_password' authentication plugin.
+ *
+ * The "heavy lifting" of the authentication is done by the protocol module so
+ * the only thing left for this module is to read the final OK packet from the
+ * server.
+ *
+ * @verbatim
+ * Revision History
+ * Date         Who                     Description
+ * 27/09/2016   Markus Makela           Initial version
+ *
+ * @endverbatim
+ */
+
+#include <maxscale/gw_authenticator.h>
+#include <maxscale/protocol/mysql.h>
+#include <maxscale/alloc.h>
+#include <maxscale/utils.h>
+
+/** Authentication states */
+enum mba_state
+{
+    MBA_NEED_OK,                /**< Waiting for server's OK packet */
+    MBA_AUTH_OK,                /**< Authentication completed successfully */
+    MBA_AUTH_FAILED             /**< Authentication failed */
+};
+
+/** Structure representing the authentication state */
+typedef struct mysql_backend_auth
+{
+    enum mba_state state; /**< Authentication state */
+} mysql_backend_auth_t;
+
+/**
+ * @brief Allocate a new mysql_backend_auth object
+ * @return Allocated object or NULL if memory allocation failed
+ */
+void* auth_backend_create(void *instance)
+{
+    mysql_backend_auth_t* mba = MXS_MALLOC(sizeof(*mba));
+
+    if (mba)
+    {
+        mba->state = MBA_NEED_OK;
+    }
+
+    return mba;
+}
+
+/**
+ * @brief Free allocated mysql_backend_auth object
+ * @param data Allocated mysql_backend_auth object
+ */
+void auth_backend_destroy(void *data)
+{
+    if (data)
+    {
+        MXS_FREE(data);
+    }
+}
+/**
+ * @brief Extract backend response
+ *
+ * @param dcb Request handler DCB connected to the client
+ * @param buffer Buffer containing data from client
+ * @return Authentication status
+ * @see gw_quthenticator.h
+ * @see https://dev.mysql.com/doc/internals/en/client-server-protocol.html
+ */
+static int auth_backend_extract(DCB *dcb, GWBUF *buf)
+{
+    int rval = MXS_AUTH_FAILED;
+    mysql_backend_auth_t *mba = (mysql_backend_auth_t*)dcb->authenticator_data;
+
+    switch (mba->state)
+    {
+        case MBA_NEED_OK:
+            if (mxs_mysql_is_ok_packet(buf))
+            {
+                rval = MXS_AUTH_SUCCEEDED;
+                mba->state = MBA_AUTH_OK;
+            }
+            else
+            {
+                mba->state = MBA_AUTH_FAILED;
+            }
+            break;
+
+        default:
+            MXS_ERROR("Unexpected call to MySQLBackendAuth::extract");
+            ss_dassert(false);
+            break;
+    }
+
+    return rval;
+}
+
+/**
+ * @brief Authenticates as a MySQL user
+ *
+ * @param dcb Backend DCB
+ * @return Authentication status
+ * @see gw_authenticator.h
+ */
+static int auth_backend_authenticate(DCB *dcb)
+{
+    int rval = MXS_AUTH_FAILED;
+    mysql_backend_auth_t *mba = (mysql_backend_auth_t*)dcb->authenticator_data;
+
+    if (mba->state == MBA_AUTH_OK)
+    {
+        /** Authentication completed successfully */
+        rval = MXS_AUTH_SUCCEEDED;
+    }
+
+    return rval;
+}
+
+/**
+ * @brief Determine whether the client is SSL capable
+ *
+ * The authentication request from the client will indicate whether the client
+ * is expecting to make an SSL connection. The information has been extracted
+ * in the previous functions.
+ *
+ * @param dcb Request handler DCB connected to the client
+ * @return Boolean indicating whether client is SSL capable
+ */
+static bool auth_backend_ssl(DCB *dcb)
+{
+    return dcb->server->server_ssl != NULL;
+}
+
+/* @see function load_module in load_utils.c for explanation of the following
+ * lint directives.
+*/
+/*lint -e14 */
+MODULE_INFO info =
+{
+    MODULE_API_AUTHENTICATOR,
+    MODULE_GA,
+    GWAUTHENTICATOR_VERSION,
+    "The MySQL MaxScale to backend server authenticator"
+};
+/*lint +e14 */
+
+static char *version_str = "V1.0.0";
+
+/*
+ * The "module object" for mysql client authenticator module.
+ */
+static GWAUTHENTICATOR MyObject =
+{
+    NULL,                      /* No initialize entry point */
+    auth_backend_create,       /* Create authenticator */
+    auth_backend_extract,      /* Extract data into structure   */
+    auth_backend_ssl,          /* Check if client supports SSL  */
+    auth_backend_authenticate, /* Authenticate user credentials */
+    NULL,                      /* The shared data is freed by the client DCB */
+    auth_backend_destroy,      /* Destroy authenticator */
+    NULL                       /* We don't need to load users */
+};
+
+/**
+ * Implementation of the mandatory version entry point
+ *
+ * @return version string of the module
+ *
+ * @see function load_module in load_utils.c for explanation of the following
+ * lint directives.
+ */
+/*lint -e14 */
+char* version()
+{
+    return version_str;
+}
+
+/**
+ * The module initialisation routine, called when the module
+ * is first loaded.
+ */
+void ModuleInit()
+{
+}
+
+/**
+ * The module entry point routine. It is this routine that
+ * must populate the structure that is referred to as the
+ * "module object", this is a structure with the set of
+ * external entry points for this module.
+ *
+ * @return The module object
+ */
+GWAUTHENTICATOR* GetModuleObject()
+{
+    return &MyObject;
+}
+/*lint +e14 */