mirror of
https://github.com/MariaDB/server.git
synced 2025-01-16 12:02:42 +01:00
140 lines
3.5 KiB
C
140 lines
3.5 KiB
C
#ifndef MYSQL_PLUGIN_AUTH_INCLUDED
|
|
/* Copyright (C) 2010 Sergei Golubchik and Monty Program Ab
|
|
Copyright (c) 2010, Oracle and/or its affiliates.
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; version 2 of the License.
|
|
|
|
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 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 */
|
|
|
|
/**
|
|
@file
|
|
|
|
Authentication Plugin API.
|
|
|
|
This file defines the API for server authentication plugins.
|
|
*/
|
|
|
|
#define MYSQL_PLUGIN_AUTH_INCLUDED
|
|
|
|
#include <mysql/plugin.h>
|
|
|
|
#define MYSQL_AUTHENTICATION_INTERFACE_VERSION 0x0201
|
|
|
|
#include <mysql/plugin_auth_common.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* defines for MYSQL_SERVER_AUTH_INFO.password_used */
|
|
|
|
#define PASSWORD_USED_NO 0
|
|
#define PASSWORD_USED_YES 1
|
|
#define PASSWORD_USED_NO_MENTION 2
|
|
|
|
|
|
/**
|
|
Provides server plugin access to authentication information
|
|
*/
|
|
typedef struct st_mysql_server_auth_info
|
|
{
|
|
/**
|
|
User name as sent by the client and shown in USER().
|
|
NULL if the client packet with the user name was not received yet.
|
|
*/
|
|
char *user_name;
|
|
|
|
/**
|
|
Length of user_name
|
|
*/
|
|
unsigned int user_name_length;
|
|
|
|
/**
|
|
A corresponding column value from the mysql.user table for the
|
|
matching account name
|
|
*/
|
|
const char *auth_string;
|
|
|
|
/**
|
|
Length of auth_string
|
|
*/
|
|
unsigned long auth_string_length;
|
|
|
|
/**
|
|
Matching account name as found in the mysql.user table.
|
|
A plugin can override it with another name that will be
|
|
used by MySQL for authorization, and shown in CURRENT_USER()
|
|
*/
|
|
char authenticated_as[MYSQL_USERNAME_LENGTH+1];
|
|
|
|
|
|
/**
|
|
The unique user name that was used by the plugin to authenticate.
|
|
Not used by the server.
|
|
Available through the @@EXTERNAL_USER variable.
|
|
*/
|
|
char external_user[MYSQL_USERNAME_LENGTH+1];
|
|
|
|
/**
|
|
This only affects the "Authentication failed. Password used: %s"
|
|
error message. has the following values :
|
|
0 : %s will be NO.
|
|
1 : %s will be YES.
|
|
2 : there will be no %s.
|
|
Set it as appropriate or ignore at will.
|
|
*/
|
|
int password_used;
|
|
|
|
/**
|
|
Set to the name of the connected client host, if it can be resolved,
|
|
or to its IP address otherwise.
|
|
*/
|
|
const char *host_or_ip;
|
|
|
|
/**
|
|
Length of host_or_ip
|
|
*/
|
|
unsigned int host_or_ip_length;
|
|
|
|
/**
|
|
Current THD pointer (to use with various services)
|
|
*/
|
|
MYSQL_THD thd;
|
|
|
|
} MYSQL_SERVER_AUTH_INFO;
|
|
|
|
/**
|
|
Server authentication plugin descriptor
|
|
*/
|
|
struct st_mysql_auth
|
|
{
|
|
int interface_version; /**< version plugin uses */
|
|
/**
|
|
A plugin that a client must use for authentication with this server
|
|
plugin. Can be NULL to mean "any plugin".
|
|
*/
|
|
const char *client_auth_plugin;
|
|
/**
|
|
Function provided by the plugin which should perform authentication (using
|
|
the vio functions if necessary) and return 0 if successful. The plugin can
|
|
also fill the info.authenticated_as field if a different username should be
|
|
used for authorization.
|
|
*/
|
|
int (*authenticate_user)(MYSQL_PLUGIN_VIO *vio, MYSQL_SERVER_AUTH_INFO *info);
|
|
};
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|