mysql.user table reader. More...

#include <acl_table_user.h>

Inheritance diagram for acl_table::Acl_table_user_reader:

Public Member Functions
	Acl_table_user_reader (THD thd, TABLE table)
	mysql.user table reader constructor. More...

	~Acl_table_user_reader () override
	Free resources before we destroy. More...

bool	driver ()
	Driver function for mysql.user reader. More...

bool	setup_table (bool &is_old_db_layout)
	Make table ready to read. More...

bool	read_row (bool &super_users_with_empty_plugin)
	Read a row from mysql.user table and add it to in-memory structure. More...

Acl_table_op_status	finish_operation (Table_op_error_code &error) override
	Finish mysql.user table read operation. More...

void	reset_acl_user (ACL_USER &user)
	Scrub ACL_USER. More...

void	read_account_name (ACL_USER &user)
	Get user and host information for the account. More...

bool	read_authentication_string (ACL_USER &user)
	Read authentication string for the account. More...

void	read_privileges (ACL_USER &user)
	Get global privilege information. More...

void	read_ssl_fields (ACL_USER &user)
	Read SSL restrictions. More...

void	read_user_resources (ACL_USER &user)
	Read user resource restrictions. More...

bool	read_plugin_info (ACL_USER &user, bool &super_users_with_empty_plugin)
	Read plugin information. More...

bool	read_password_expiry (ACL_USER &user, bool &password_expired)
	Read password expiry field. More...

void	read_password_locked (ACL_USER &user)
	Determine if user account is locked. More...

void	read_password_last_changed (ACL_USER &user)
	Get password change time. More...

void	read_password_lifetime (ACL_USER &user)
	Get password expiry policy infomration. More...

void	read_password_history_fields (ACL_USER &user)
	Get password history restriction. More...

void	read_password_reuse_time_fields (ACL_USER &user)
	Get password reuse time restriction. More...

void	read_password_require_current (ACL_USER &user)
	Get information about requiring current password while changing password. More...

bool	read_user_attributes (ACL_USER &user)
	Read user attributes. More...

void	add_row_to_acl_users (ACL_USER &user)
	Add a recently read row in acl_users. More...

Public Member Functions inherited from acl_table::Acl_table
	Acl_table (THD thd, TABLE table, Acl_table_operation operation)

virtual	~Acl_table ()=default

	Acl_table (const Acl_table &)=delete

const Acl_table &	operator= (const Acl_table &)=delete

	Acl_table (const Acl_table &&)=delete

const Acl_table &	operator= (const Acl_table &&)=delete

Acl_table_operation	get_operation_mode ()

Private Attributes
User_table_schema *	m_table_schema = nullptr

unique_ptr_destroy_only< RowIterator >	m_iterator

MEM_ROOT	m_mem_root {PSI_NOT_INSTRUMENTED, ACL_ALLOC_BLOCK_SIZE}

Restrictions *	m_restrictions = nullptr

Json_object *	m_user_application_user_metadata_json = nullptr

Additional Inherited Members
Protected Member Functions inherited from acl_table::Acl_table
Acl_table_op_status	convert_table_op_error_code ()

Protected Attributes inherited from acl_table::Acl_table
THD *	m_thd

TABLE *	m_table

Acl_table_operation	m_operation

Table_op_error_code	m_error

Detailed Description

mysql.user table reader.

It reads all raws from table and create in-memory cache.

Constructor & Destructor Documentation

◆ Acl_table_user_reader()

acl_table::Acl_table_user_reader::Acl_table_user_reader	(	THD *	thd,
		TABLE *	table
	)

mysql.user table reader constructor.

Parameters

[in]	thd	Handle to THD object. Must be non-null
[in]	table	mysql.user table handle. Must be non-null

◆ ~Acl_table_user_reader()

acl_table::Acl_table_user_reader::~Acl_table_user_reader ( )

override

Free resources before we destroy.

Member Function Documentation

◆ add_row_to_acl_users()

void acl_table::Acl_table_user_reader::add_row_to_acl_users ( ACL_USER & user )

Add a recently read row in acl_users.

Parameters

[in] user ACL_USER structure

◆ driver()

bool acl_table::Acl_table_user_reader::driver ( )

Driver function for mysql.user reader.

Reads rows from table. If a row is valid, adds corresponding information to in-memory structure.

Returns: status of reading mysql.user table

Return values

false	Success
true	Error reading the table. Probably corrupt.

◆ finish_operation()

Acl_table_op_status acl_table::Acl_table_user_reader::finish_operation ( Table_op_error_code & error )

overridevirtual

Finish mysql.user table read operation.

Parameters

[in] error Table operation error.

Returns: OK status, always.

Implements acl_table::Acl_table.

◆ read_account_name()

void acl_table::Acl_table_user_reader::read_account_name ( ACL_USER & user )

Get user and host information for the account.

Parameters

[out] user ACL_USER structure

◆ read_authentication_string()

bool acl_table::Acl_table_user_reader::read_authentication_string ( ACL_USER & user )

Read authentication string for the account.

We do verification later.

Parameters

[out] user ACL_USER structure

Returns: Status of reading authentication data.

Return values

false	Success
true	Error reading the field. Skip user.

◆ read_password_expiry()

bool acl_table::Acl_table_user_reader::read_password_expiry	(	ACL_USER &	user,
		bool &	password_expired
	)

Read password expiry field.

Parameters

[out]	user	ACL_USER structure
[out]	password_expired	Whether password is expired or not

Returns: Status of reading password expiry value

Return values

false	Success
true	Password expiry was set to TRUE for a plugin that does not support password expiration. Skip user.

◆ read_password_history_fields()

void acl_table::Acl_table_user_reader::read_password_history_fields ( ACL_USER & user )

Get password history restriction.

Parameters

[out] user ACL_USER structure

◆ read_password_last_changed()

void acl_table::Acl_table_user_reader::read_password_last_changed ( ACL_USER & user )

Get password change time.

Parameters

[out] user ACL_USER structure

◆ read_password_lifetime()

void acl_table::Acl_table_user_reader::read_password_lifetime ( ACL_USER & user )

Get password expiry policy infomration.

Parameters

[out] user ACL_USER structure

◆ read_password_locked()

void acl_table::Acl_table_user_reader::read_password_locked ( ACL_USER & user )

Determine if user account is locked.

Parameters

[out] user ACL_USER structure

◆ read_password_require_current()

void acl_table::Acl_table_user_reader::read_password_require_current ( ACL_USER & user )

Get information about requiring current password while changing password.

Parameters

[out] user ACL_USER structure

◆ read_password_reuse_time_fields()

void acl_table::Acl_table_user_reader::read_password_reuse_time_fields ( ACL_USER & user )

Get password reuse time restriction.

Parameters

[out] user ACL_USER structure

◆ read_plugin_info()

bool acl_table::Acl_table_user_reader::read_plugin_info	(	ACL_USER &	user,
		bool &	super_users_with_empty_plugin
	)

Read plugin information.

Also, validate authentication string against expected format for the plugin.

Parameters

[out]	user	ACL_USER structure
[out]	super_users_with_empty_plugin	User has SUPER privilege or not

Returns: status of reading plugin information

Return values

false	Success
true	Error. Skip user.

◆ read_privileges()

void acl_table::Acl_table_user_reader::read_privileges ( ACL_USER & user )

Get global privilege information.

Parameters

[out] user ACL_USER structure

◆ read_row()

bool acl_table::Acl_table_user_reader::read_row ( bool & super_users_with_empty_plugin )

Read a row from mysql.user table and add it to in-memory structure.

Parameters

[in] super_users_with_empty_plugin User has SUPER privilege

Returns: Status of reading a row

Return values

false	Success
true	Error reading the row. Unless critical, keep reading further.

◆ read_ssl_fields()

void acl_table::Acl_table_user_reader::read_ssl_fields ( ACL_USER & user )

Read SSL restrictions.

Parameters

[out] user ACL_USER structure

◆ read_user_attributes()

bool acl_table::Acl_table_user_reader::read_user_attributes ( ACL_USER & user )

Read user attributes.

Parameters

[out] user ACL_USER structure

Returns: status of reading user_attributes column

Return values

false	Success
true	Error reading user_attributes column

◆ read_user_resources()

void acl_table::Acl_table_user_reader::read_user_resources ( ACL_USER & user )

Read user resource restrictions.

Parameters

[out] user ACL_USER structure

◆ reset_acl_user()

void acl_table::Acl_table_user_reader::reset_acl_user ( ACL_USER & user )

Scrub ACL_USER.

Parameters

[out] user ACL_USER to be updated

◆ setup_table()

bool acl_table::Acl_table_user_reader::setup_table ( bool & is_old_db_layout )

Make table ready to read.

Parameters

[out] is_old_db_layout To see if this is a case of running new binary with old data directory without running mysql_upgrade.

Returns: status of initialization

Return values

false	Success
true	Error initializing table

Member Data Documentation

◆ m_iterator

unique_ptr_destroy_only<RowIterator> acl_table::Acl_table_user_reader::m_iterator

private

◆ m_mem_root

MEM_ROOT acl_table::Acl_table_user_reader::m_mem_root {PSI_NOT_INSTRUMENTED, ACL_ALLOC_BLOCK_SIZE}

private

◆ m_restrictions

Restrictions* acl_table::Acl_table_user_reader::m_restrictions = nullptr

private

◆ m_table_schema

User_table_schema* acl_table::Acl_table_user_reader::m_table_schema = nullptr

private

◆ m_user_application_user_metadata_json

Json_object* acl_table::Acl_table_user_reader::m_user_application_user_metadata_json = nullptr

private

The documentation for this class was generated from the following files:

sql/auth/acl_table_user.h
sql/auth/acl_table_user.cc

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Acl_table_user_reader()

◆ ~Acl_table_user_reader()

Member Function Documentation

◆ add_row_to_acl_users()

◆ driver()

◆ finish_operation()

◆ read_account_name()

◆ read_authentication_string()

◆ read_password_expiry()

◆ read_password_history_fields()

◆ read_password_last_changed()

◆ read_password_lifetime()

◆ read_password_locked()

◆ read_password_require_current()

◆ read_password_reuse_time_fields()

◆ read_plugin_info()

◆ read_privileges()

◆ read_row()

◆ read_ssl_fields()

◆ read_user_attributes()

◆ read_user_resources()

◆ reset_acl_user()

◆ setup_table()

Member Data Documentation

◆ m_iterator

◆ m_mem_root

◆ m_restrictions

◆ m_table_schema

◆ m_user_application_user_metadata_json