s_mysql_validate_password Struct Reference

Interfaces to enforce a password policy. More...

#include <validate_password.h>

Public Attributes
mysql_service_status_t(*	validate )(void *thd, my_h_string password)
	Checks if a password is valid by the password policy. More...
mysql_service_status_t(*	get_strength )(void *thd, my_h_string password, unsigned int *strength)
	Calculates the strength of a password in the scale of 0 to 100. More...

Detailed Description

Interfaces to enforce a password policy.

The policy is enfoced through two methods 1) validate() that answers the question of whether this password is good enough or not.

2) get_strength() that can be used by password changing UIs to display a password strength meter in the range of [0-100] as the user enters a password.

REQUIRES_SERVICE(validate_password);
bool validate_password(THD *thd, const char *password,
                       unsigned int password_length) {
  String password_string;
  password_string.set(password, password_length, &my_charset_utf8mb3_bin);
  if (mysql_service_validate_password->validate(thd, password_string)) {
    // Emit error that password does not adhere to policy criteria
    return true;
  }
  return false;
}
 
unsigned int get_password_strength(THD *thd, const char *password,
                                   unsigned int password_length) {
  String password_string;
  password_string.set(password, password_length, &my_charset_utf8mb3_bin);
  unsigned int strength = 0;
  if (mysql_service_validate_password->get_strength(thd, password_string,
                                                &strength)) {
    return 0;
  }
  return strength;
}

Member Data Documentation

get_strength

mysql_service_status_t(* s_mysql_validate_password::get_strength) (void *thd, my_h_string password, unsigned int *strength)

Calculates the strength of a password in the scale of 0 to 100.

Parameters

	thd	MYSQL THD object
	password	Given Password
[out]	strength	pointer to handle the strength of the given password. in the range of [0-100], where 0 is week password and 100 is strong password

Returns

Status of performed operation

false success

true failure

validate

mysql_service_status_t(* s_mysql_validate_password::validate) (void *thd, my_h_string password)

Checks if a password is valid by the password policy.

Parameters

thd	MYSQL THD object
password	Given Password

Returns

Status of performed operation

false success (valid password)

true failure (invalid password)

---

The documentation for this struct was generated from the following file:

• include/mysql/components/services/validate_password.h