← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/auth_schema/auth_schema.h

  • Committer: Mark Atwood
  • Date: 2011-10-14 15:57:51 UTC
  • mfrom: (2425.1.5 auth_db)
  • Revision ID: me@mark.atwood.name-20111014155751-yf1y5jk190g4xyo5
merge lp:~daniel-nichter/drizzle/auth_schema

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/auth_schema/auth_schema.h
 
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright 2011 Daniel Nichter
 
5
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; version 2 of the License.
 
9
 *
 
10
 *  This program is distributed in the hope that it will be useful,
 
11
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 *  GNU General Public License for more details.
 
14
 *
 
15
 *  You should have received a copy of the GNU General Public License
 
16
 *  along with this program; if not, write to the Free Software
 
17
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
18
 */
 
19
 
 
20
#pragma once
 
21
#include <drizzled/session.h>
 
22
#include <drizzled/plugin/authentication.h>
 
23
#include PCRE_HEADER
 
24
 
 
25
using namespace std;
 
26
using namespace drizzled;
 
27
 
 
28
namespace drizzle_plugin {
 
29
namespace auth_schema {
 
30
 
 
31
class AuthSchema : public drizzled::plugin::Authentication
 
32
{
 
33
public:
 
34
  AuthSchema(bool enabled);
 
35
  ~AuthSchema();
 
36
 
 
37
  /**
 
38
   * @brief
 
39
   *   Set the authentication table.
 
40
   *
 
41
   * @param[in] table Schema-qualified table name.
 
42
   *
 
43
   * @retval false Success, new auth table set
 
44
   * @retval true  Failure, auth table not changed
 
45
   */
 
46
  bool setTable(const string &table);
 
47
 
 
48
  /**
 
49
   * These are the query_log system variables.  So sysvar_enabled is
 
50
   * auth_schema_enabled in SHOW VARIABLES, etc.  They are all global
 
51
   * and dynamic.
 
52
   */
 
53
  bool sysvar_enabled;
 
54
  string sysvar_table;
 
55
 
 
56
private:
 
57
  /**
 
58
   * Base class method to check authentication for a user.
 
59
   */
 
60
  bool authenticate(const identifier::User &sctx, const string &password);
 
61
 
 
62
  /**
 
63
   * @brief
 
64
   *   Verify that the client password matches the real password.
 
65
   *
 
66
   * @details
 
67
   *   This method compares two MySQL hashed passwords: one from the
 
68
   *   client who is trying to authenticate, and the other from an
 
69
   *   auth table with the real password.  The client's password is
 
70
   *   hashed with the scramble bytes that Drizzle sent when the client
 
71
   *   connected, so we hash the real password with these bytes, too.
 
72
   *   This method is a modified copy of auth_file::verifyMySQLHash(),
 
73
   *   written by Eric Day, so credit the credit is his for the algos.
 
74
   *
 
75
   * @param[in] real_password   Real password, double-hashed but not yet
 
76
   *                            scrambled with the scramble bytes.
 
77
   * @param[in] scramble_bytes  Random bytes sent by Drizzle to client.
 
78
   * @param[in] client_password Password sent by client, double-hashed and
 
79
   *                            scrambled with the scramble bytes.
 
80
   *
 
81
   * @return True if the passwords match, else false.
 
82
   */
 
83
  bool verifyMySQLPassword(const string &real_password,
 
84
                           const string &scramble_bytes,
 
85
                           const string &client_password);
 
86
 
 
87
  /**
 
88
   * @brief
 
89
   *   Split, escape, and quote the auth table name.
 
90
   *
 
91
   * @details
 
92
   *   This function is called by setTable().
 
93
   *   The auth table name must be schema-qualified, so it should have
 
94
   *   the form schema.table or `schema`.`table`, etc.  This function
 
95
   *   splits the table name on the period, checks each half (the schema
 
96
   *   name and the table name), and escapes and backtick quotes each
 
97
   *   if necessary.  The result is that the auth table name is always
 
98
   *   finally of the form `schema`.`table`.
 
99
   *
 
100
   * @param[in] table Schema-qualified auth table name
 
101
   *
 
102
   * @return Escaped and backtick-quoted auth table name
 
103
   */
 
104
  string escapeQuoteAuthTable(const string &table);
 
105
 
 
106
  /**
 
107
   * @brief
 
108
   *   Escape and quote an identifier.
 
109
   *
 
110
   * @param[in] input Identifer, possibly already quoted
 
111
   *
 
112
   * @return Escaped and backtick-quoted identifier
 
113
   */
 
114
  string escapeQuoteIdentifier(const string &input);
 
115
 
 
116
  /**
 
117
   * @brief
 
118
   *   Escape a string for use as a single-quoted string value.
 
119
   *
 
120
   * @details
 
121
   *   The string is escaped so that it can be used as a value in single quotes, like:
 
122
   *   col='untrusted value'.  Therefore, double quotes are not escaped because they're
 
123
   *   valid inside single-quoted values.  Escaping helps avoid SQL injections.
 
124
   *
 
125
   * @param[in] input Untrusted string
 
126
   *
 
127
   * @return Escaped string
 
128
   */
 
129
  string escapeString(const string &input);
 
130
 
 
131
  pcre *_ident_re;
 
132
  Session::shared_ptr _session; ///< Internal session for querying auth table
 
133
};
 
134
 
 
135
} /* end namespace drizzle_plugin::auth_schema */
 
136
} /* end namespace drizzle_plugin */