Commit 0d56490c authored by Georgi Kodinov's avatar Georgi Kodinov

Bug #57774: Typos/ambiguities in the WL1054 comments

Fixed few typos and added better wording as suggested.
parent 67105858
...@@ -90,8 +90,8 @@ typedef struct st_mysql_server_auth_info ...@@ -90,8 +90,8 @@ typedef struct st_mysql_server_auth_info
int password_used; int password_used;
/** /**
Set to the name of the connected client if it can be resolved, or to Set to the name of the connected client host, if it can be resolved,
the address otherwise or to its IP address otherwise.
*/ */
const char *host_or_ip; const char *host_or_ip;
...@@ -107,7 +107,7 @@ typedef struct st_mysql_server_auth_info ...@@ -107,7 +107,7 @@ typedef struct st_mysql_server_auth_info
*/ */
struct st_mysql_auth struct st_mysql_auth
{ {
int interface_version; /**< version plugin uses */ int interface_version; /** version plugin uses */
/** /**
A plugin that a client must use for authentication with this server A plugin that a client must use for authentication with this server
plugin. Can be NULL to mean "any plugin". plugin. Can be NULL to mean "any plugin".
......
...@@ -52,7 +52,7 @@ ...@@ -52,7 +52,7 @@
/** /**
first byte of the question string is the question "type". first byte of the question string is the question "type".
It can be a "ordinary" or a "password" question. It can be an "ordinary" or a "password" question.
The last bit set marks a last question in the authentication exchange. The last bit set marks a last question in the authentication exchange.
*/ */
#define ORDINARY_QUESTION "\2" #define ORDINARY_QUESTION "\2"
...@@ -176,7 +176,7 @@ mysql_declare_plugin_end; ...@@ -176,7 +176,7 @@ mysql_declare_plugin_end;
This plugin performs a dialog with the user, asking questions and This plugin performs a dialog with the user, asking questions and
reading answers. Depending on the client it may be desirable to do it reading answers. Depending on the client it may be desirable to do it
using GUI, or console, with or without curses, or read answers using GUI, or console, with or without curses, or read answers
from a smardcard, for example. from a smartcard, for example.
To support all this variety, the dialog plugin has a callback function To support all this variety, the dialog plugin has a callback function
"authentication_dialog_ask". If the client has a function of this name "authentication_dialog_ask". If the client has a function of this name
...@@ -256,7 +256,7 @@ static int perform_dialog(MYSQL_PLUGIN_VIO *vio, MYSQL *mysql) ...@@ -256,7 +256,7 @@ static int perform_dialog(MYSQL_PLUGIN_VIO *vio, MYSQL *mysql)
in mysql_change_user() the client sends the first packet, so in mysql_change_user() the client sends the first packet, so
the first vio->read_packet() does nothing (pkt == 0). the first vio->read_packet() does nothing (pkt == 0).
We send the "password", assuming the client knows what its doing. We send the "password", assuming the client knows what it's doing.
(in other words, the dialog plugin should be only set as a default (in other words, the dialog plugin should be only set as a default
authentication plugin on the client if the first question authentication plugin on the client if the first question
asks for a password - which will be sent in clear text, by the way) asks for a password - which will be sent in clear text, by the way)
......
...@@ -17,22 +17,12 @@ ...@@ -17,22 +17,12 @@
/** /**
@file @file
dialog client authentication plugin with examples Test driver for the mysql-test/t/plugin_auth.test
dialog is a general purpose client authentication plugin, it simply This is a set of test plugins used to test the external authentication
asks the user the question, as provided by the server and reports implementation.
the answer back to the server. No encryption is involved, See the above test file for more details.
the answers are sent in clear text. This test plugin is based on the dialog plugin example.
Two examples are provided: two_questions server plugin, that asks
the password and an "Are you sure?" question with a reply "yes, of course".
It demonstrates the usage of "password" (input is hidden) and "ordinary"
(input can be echoed) questions, and how to mark the last question,
to avoid an extra roundtrip.
And three_attempts plugin that gives the user three attempts to enter
a correct password. It shows the situation when a number of questions
is not known in advance.
*/ */
#include <my_global.h> #include <my_global.h>
...@@ -55,7 +45,7 @@ ...@@ -55,7 +45,7 @@
/********************* SERVER SIDE ****************************************/ /********************* SERVER SIDE ****************************************/
/** /**
dialog test plugin mimicing the ordinary auth mechanism. Used to test the auth plugin API dialog test plugin mimicking the ordinary auth mechanism. Used to test the auth plugin API
*/ */
static int auth_test_plugin(MYSQL_PLUGIN_VIO *vio, MYSQL_SERVER_AUTH_INFO *info) static int auth_test_plugin(MYSQL_PLUGIN_VIO *vio, MYSQL_SERVER_AUTH_INFO *info)
{ {
...@@ -150,10 +140,10 @@ static int test_plugin_client(MYSQL_PLUGIN_VIO *vio, MYSQL *mysql) ...@@ -150,10 +140,10 @@ static int test_plugin_client(MYSQL_PLUGIN_VIO *vio, MYSQL *mysql)
in mysql_change_user() the client sends the first packet, so in mysql_change_user() the client sends the first packet, so
the first vio->read_packet() does nothing (pkt == 0). the first vio->read_packet() does nothing (pkt == 0).
We send the "password", assuming the client knows what its doing. We send the "password", assuming the client knows what it's doing.
(in other words, the dialog plugin should be only set as a default (in other words, the dialog plugin should be only set as a default
authentication plugin on the client if the first question authentication plugin on the client if the first question
asks for a password - which will be sent in cleat text, by the way) asks for a password - which will be sent in clear text, by the way)
*/ */
reply= mysql->passwd; reply= mysql->passwd;
} }
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment