28.2.4.10 编写密码验证插件

本节介绍如何编写服务器端密码验证插件。这些说明基于 MySQL 源代码发行版本plugin/password_validation目录中的源代码。该目录中的validate_password.cc源文件实现了名为validate_password的插件。

要编写密码验证插件,请在插件源文件中包含以下头文件。根据插件的功能和要求,可能还需要其他 MySQL 或常规头文件。

#include <mysql/plugin_validate_password.h>

plugin_validate_password.h包含plugin.h,因此您无需显式包括后者。 plugin.h定义MYSQL_VALIDATE_PASSWORD_PLUGIN服务器插件类型和声明插件所需的数据结构。 plugin_validate_password.h定义特定于密码验证插件的数据结构。

与任何 MySQL 服务器插件一样,密码验证插件具有通用的插件 Descriptors(请参见第 28.2.4.2.1 节,“服务器插件库和插件 Descriptors”)。在validate_password.cc中,validate_password的一般 Descriptors 如下所示:

mysql_declare_plugin(validate_password)
{
  MYSQL_VALIDATE_PASSWORD_PLUGIN,     /*   type                            */
  &validate_password_descriptor,      /*   descriptor                      */
  "validate_password",                /*   name                            */
  "Oracle Corporation",               /*   author                          */
  "check password strength",          /*   description                     */
  PLUGIN_LICENSE_GPL,
  validate_password_init,             /*   init function (when loaded)     */
  validate_password_deinit,           /*   deinit function (when unloaded) */
  0x0100,                             /*   version                         */
  NULL,
  validate_password_system_variables, /*   system variables                */
  NULL,
  0,
}
mysql_declare_plugin_end;

name成员(validate_password)table 示在诸如INSTALL PLUGINUNINSTALL PLUGIN之类的语句中用于引用插件的名称。这也是INFORMATION_SCHEMA.PLUGINSSHOW PLUGINS显示的名称。

通用 Descriptors 也指向validate_password_system_variables,该结构向SHOW VARIABLES语句公开了几个系统变量:

static struct st_mysql_sys_var* validate_password_system_variables[]= {
  MYSQL_SYSVAR(length),
  MYSQL_SYSVAR(number_count),
  MYSQL_SYSVAR(mixed_case_count),
  MYSQL_SYSVAR(special_char_count),
  MYSQL_SYSVAR(policy),
  MYSQL_SYSVAR(dictionary_file),
  NULL
};

validate_password_init初始化函数(如果已指定)读取字典文件,而validate_password_deinit函数则释放与该文件关联的数据结构。

常规 Descriptors 中的validate_password_descriptor值指向特定于类型的 Descriptors。对于密码验证插件,此 Descriptors 具有以下结构:

struct st_mysql_validate_password
{
  int interface_version;
  /*
    This function returns TRUE for passwords which satisfy the password
    policy (as chosen by plugin variable) and FALSE for all other
    password
  */
  int (*validate_password)(mysql_string_handle password);
  /*
    This function returns the password strength (0-100) depending
    upon the policies
  */
  int (*get_password_strength)(mysql_string_handle password);
};

特定于类型的 Descriptors 具有以下成员:

  • interface_version:按照惯例,类型特定的插件 Descriptors 以给定插件类型的接口版本开头。服务器在加载插件时会检查interface_version,以查看插件是否与其兼容。对于密码验证插件,interface_version成员的值为MYSQL_VALIDATE_PASSWORD_INTERFACE_VERSION(在plugin_validate_password.h中定义)。

  • validate_password:服务器调用该功能以测试密码是否满足当前密码策略。如果密码正确,则返回 1,否则返回 0.参数是作为mysql_string_handle值传递的密码。该数据类型由mysql_string服务器服务实现。有关详细信息,请参见sql目录中的string_service.hstring_service.cc源文件。

  • get_password_strength:服务器调用此功能以评估密码的强度。它返回从 0(弱)到 100(强)的值。参数是作为mysql_string_handle值传递的密码。

对于validate_password插件,特定于类型的 Descriptors 如下所示:

static struct st_mysql_validate_password validate_password_descriptor=
{
  MYSQL_VALIDATE_PASSWORD_INTERFACE_VERSION,
  validate_password,                         /* validate function          */
  get_password_strength                      /* validate strength function */
};

要编译和安装插件库文件,请使用第 28.2.4.3 节“编译和安装插件库”中的说明。要使该库文件可供使用,请将其安装在插件目录(由plugin_dir系统变量命名的目录)中。对于validate_password插件,当您从源代码构建 MySQL 时会对其进行编译和安装。它也包含在二进制发行版中。构建过程将生成一个共享对象库,其名称为validate_password.so(后缀.so可能因平台而异)。

要在运行时注册插件,请使用以下语句,并根据需要调整平台的.so后缀:

INSTALL PLUGIN validate_password SONAME 'validate_password.so';

有关插件加载的其他信息,请参见第 5.5.1 节“安装和卸载插件”

要验证插件安装,请检查INFORMATION_SCHEMA.PLUGINStable 或使用SHOW PLUGINS语句。参见第 5.5.2 节“获取服务器插件信息”

在安装validate_password插件后,它会公开指示密码检查参数的系统变量:

mysql> SHOW VARIABLES LIKE 'validate_password%';
+--------------------------------------+--------+
| Variable_name                        | Value  |
+--------------------------------------+--------+
| validate_password_dictionary_file    |        |
| validate_password_length             | 8      |
| validate_password_mixed_case_count   | 1      |
| validate_password_number_count       | 1      |
| validate_password_policy             | MEDIUM |
| validate_password_special_char_count | 1      |
+--------------------------------------+--------+

有关这些变量的说明,请参见第 6.4.3.2 节“密码验证插件选项和变量”

要在测试后禁用该插件,请使用以下语句将其卸载:

UNINSTALL PLUGIN validate_password;