124 lines
4.5 KiB
C++
124 lines
4.5 KiB
C++
/* Copyright (c) 2010, 2019, Oracle and/or its affiliates. All rights reserved.
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License, version 2.0,
|
|
as published by the Free Software Foundation.
|
|
|
|
This program is also distributed with certain software (including
|
|
but not limited to OpenSSL) that is licensed under separate terms,
|
|
as designated in a particular file or component or in included license
|
|
documentation. The authors of MySQL hereby grant you an additional
|
|
permission to link the program and your derivative works with the
|
|
separately licensed software that they have included with MySQL.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License, version 2.0, for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
|
|
|
|
#include <mysql/client_plugin.h>
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
|
|
/**
|
|
first byte of the question string is the question "type".
|
|
It can be a "ordinary" or a "password" question.
|
|
The last bit set marks a last question in the authentication exchange.
|
|
*/
|
|
#define ORDINARY_QUESTION "\2"
|
|
#define LAST_QUESTION "\3"
|
|
#define LAST_PASSWORD "\4"
|
|
#define PASSWORD_QUESTION "\5"
|
|
|
|
/********************* CLIENT SIDE ***************************************/
|
|
/*
|
|
client plugin used for testing the plugin API
|
|
*/
|
|
#include <mysql.h>
|
|
#include "my_compiler.h"
|
|
|
|
#ifdef __clang__
|
|
// Clang UBSAN false positive?
|
|
// Call to function through pointer to incorrect function type
|
|
static int test_plugin_client(MYSQL_PLUGIN_VIO *vio,
|
|
MYSQL *mysql) SUPPRESS_UBSAN;
|
|
#endif // __clang__
|
|
|
|
/**
|
|
The main function of the test plugin.
|
|
|
|
Reads the prompt, check if the handshake is done and if the prompt is a
|
|
password request and returns the password. Otherwise return error.
|
|
|
|
@note
|
|
1. this plugin shows how a client authentication plugin
|
|
may read a MySQL protocol OK packet internally - which is important
|
|
where a number of packets is not known in advance.
|
|
2. the first byte of the prompt is special. it is not
|
|
shown to the user, but signals whether it is the last question
|
|
(prompt[0] & 1 == 1) or not last (prompt[0] & 1 == 0),
|
|
and whether the input is a password (not echoed).
|
|
3. the prompt is expected to be sent zero-terminated
|
|
*/
|
|
static int test_plugin_client(MYSQL_PLUGIN_VIO *vio, MYSQL *mysql) {
|
|
unsigned char *pkt, cmd = 0;
|
|
int pkt_len, res;
|
|
char *reply;
|
|
|
|
do {
|
|
/* read the prompt */
|
|
pkt_len = vio->read_packet(vio, &pkt);
|
|
if (pkt_len < 0) return CR_ERROR;
|
|
|
|
if (pkt == 0) {
|
|
/*
|
|
in mysql_change_user() the client sends the first packet, so
|
|
the first vio->read_packet() does nothing (pkt == 0).
|
|
|
|
We send the "password", assuming the client knows what its doing.
|
|
(in other words, the dialog plugin should be only set as a default
|
|
authentication plugin on the client if the first question
|
|
asks for a password - which will be sent in cleat text, by the way)
|
|
*/
|
|
reply = mysql->passwd;
|
|
} else {
|
|
cmd = *pkt++;
|
|
|
|
/* is it MySQL protocol (0=OK or 254=need old password) packet ? */
|
|
if (cmd == 0 || cmd == 254)
|
|
return CR_OK_HANDSHAKE_COMPLETE; /* yes. we're done */
|
|
|
|
/*
|
|
asking for a password with an empty prompt means mysql->password
|
|
otherwise return an error
|
|
*/
|
|
if ((cmd == LAST_PASSWORD[0] || cmd == PASSWORD_QUESTION[0]) && *pkt == 0)
|
|
reply = mysql->passwd;
|
|
else
|
|
return CR_ERROR;
|
|
}
|
|
if (!reply) return CR_ERROR;
|
|
/* send the reply to the server */
|
|
res = vio->write_packet(vio, (const unsigned char *)reply,
|
|
(int)strlen(reply) + 1);
|
|
|
|
if (res) return CR_ERROR;
|
|
|
|
/* repeat unless it was the last question */
|
|
} while (cmd != LAST_QUESTION[0] && cmd != PASSWORD_QUESTION[0]);
|
|
|
|
/* the job of reading the ok/error packet is left to the server */
|
|
return CR_OK;
|
|
}
|
|
|
|
mysql_declare_client_plugin(AUTHENTICATION) "qa_auth_client", "Horst Hunger",
|
|
"Dialog Client Authentication Plugin", {0, 1, 0},
|
|
"GPL", NULL, NULL, NULL, NULL,
|
|
test_plugin_client, NULL mysql_end_client_plugin;
|