-
Notifications
You must be signed in to change notification settings - Fork 80
Expand file tree
/
Copy pathsetauthorizer.xml
More file actions
249 lines (236 loc) · 14.9 KB
/
setauthorizer.xml
File metadata and controls
249 lines (236 loc) · 14.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 22583751fbfdaa3eaa41aeb6470d1343f5cb2c78 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="sqlite3.setauthorizer" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SQLite3::setAuthorizer</refname>
<refpurpose>Устанавливает callback-функцию, которая будет использоваться в качестве авторизатора для ограничения действий выражения</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SQLite3">
<modifier>public</modifier> <type>bool</type><methodname>SQLite3::setAuthorizer</methodname>
<methodparam><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<para>
Устанавливает callback-функцию, которая будет вызываться SQLite каждый раз
при выполнении действия (чтение, удаление, модификация и т.д.). Это
используется при подготовке SQL-выражения из ненадёжного источника, чтобы
гарантировать, что SQL-выражения не будут пытаться получить доступ к данным,
которые им не разрешено видеть, или чтобы они не пытались выполнить
вредоносные выражения, которые повреждают базу данных. Например, приложение
может позволить пользователю вводить произвольные SQL-запросы для выполнения
в базе данных. Но приложение не хочет, чтобы пользователь мог вносить
произвольные изменения в базу данных. Тогда можно установить авторизатор,
который запрещает использование любых выражений, кроме SELECT, пока готовится
введённый пользователем SQL-запрос.
</para>
<para>
Callback-авторизатор может бывать вызван несколько раз для каждого выражения,
подготовленного SQLite. Запросы <literal>SELECT</literal> или
<literal>UPDATE</literal> будут вызывать авторизатор для каждой считываемой
или модифицируемой колонки.
</para>
<para>
При вызове авторизатора может использоваться до пяти параметров. Первый
параметр передаётся всегда, его тип - целое число (<type>int</type>) (код действия),
совпадающий с константой <literal>SQLite3</literal>. Другие параметры
передаются только для некоторых действий. Данная таблица описывает второй и
третий параметры в соответствии с действием:
<table>
<title>Список кодов действия и параметров</title>
<tgroup cols="3">
<thead>
<row>
<entry>Действие</entry>
<entry>Второй параметр</entry>
<entry>Третий параметр</entry>
</row>
</thead>
<tbody>
<row><entry><constant>SQLite3::CREATE_INDEX</constant></entry><entry>Имя индекса</entry><entry>Имя таблицы</entry></row>
<row><entry><constant>SQLite3::CREATE_TABLE</constant></entry><entry>Имя таблицы</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::CREATE_TEMP_INDEX</constant></entry><entry>Имя индекса</entry><entry>Имя таблицы</entry></row>
<row><entry><constant>SQLite3::CREATE_TEMP_TABLE</constant></entry><entry>Имя таблицы</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::CREATE_TEMP_TRIGGER</constant></entry><entry>Имя триггера</entry><entry>Имя таблицы</entry></row>
<row><entry><constant>SQLite3::CREATE_TEMP_VIEW</constant></entry><entry>Имя представления</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::CREATE_TRIGGER</constant></entry><entry>Имя триггера</entry><entry>Имя таблицы</entry></row>
<row><entry><constant>SQLite3::CREATE_VIEW</constant></entry><entry>Имя представления</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::DELETE</constant></entry><entry>Имя таблицы</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::DROP_INDEX</constant></entry><entry>Имя индекса</entry><entry>Имя таблицы</entry></row>
<row><entry><constant>SQLite3::DROP_TABLE</constant></entry><entry>Имя таблицы</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::DROP_TEMP_INDEX</constant></entry><entry>Имя индекса</entry><entry>Имя таблицы</entry></row>
<row><entry><constant>SQLite3::DROP_TEMP_TABLE</constant></entry><entry>Имя таблицы</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::DROP_TEMP_TRIGGER</constant></entry><entry>Имя триггера</entry><entry>Имя таблицы</entry></row>
<row><entry><constant>SQLite3::DROP_TEMP_VIEW</constant></entry><entry>Имя представления</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::DROP_TRIGGER</constant></entry><entry>Имя триггера</entry><entry>Имя таблицы</entry></row>
<row><entry><constant>SQLite3::DROP_VIEW</constant></entry><entry>Имя представления</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::INSERT</constant></entry><entry>Имя таблицы</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::PRAGMA</constant></entry><entry>Имя pragma</entry><entry>Первый аргумент, переданный pragma, или &null;</entry></row>
<row><entry><constant>SQLite3::READ</constant></entry><entry>Имя таблицы</entry><entry>Имя колонки</entry></row>
<row><entry><constant>SQLite3::SELECT</constant></entry><entry>&null;</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::TRANSACTION</constant></entry><entry>Операция</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::UPDATE</constant></entry><entry>Имя таблицы</entry><entry>Имя колонки</entry></row>
<row><entry><constant>SQLite3::ATTACH</constant></entry><entry>Имя файла</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::DETACH</constant></entry><entry>Имя базы данных</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::ALTER_TABLE</constant></entry><entry>Имя базы данных</entry><entry>Имя таблицы</entry></row>
<row><entry><constant>SQLite3::REINDEX</constant></entry><entry>Имя индекса</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::ANALYZE</constant></entry><entry>Имя таблицы</entry><entry>&null;</entry></row>
<row><entry><constant>SQLite3::CREATE_VTABLE</constant></entry><entry>Имя таблицы</entry><entry>Имя модуля</entry></row>
<row><entry><constant>SQLite3::DROP_VTABLE</constant></entry><entry>Имя таблицы</entry><entry>Имя модуля</entry></row>
<row><entry><constant>SQLite3::FUNCTION</constant></entry><entry>&null;</entry><entry>Имя функции</entry></row>
<row><entry><constant>SQLite3::SAVEPOINT</constant></entry><entry>Операция</entry><entry>Имя точки сохранения</entry></row>
<row><entry><constant>SQLite3::RECURSIVE</constant></entry><entry>&null;</entry><entry>&null;</entry></row>
</tbody>
</tgroup>
</table>
</para>
<para>
Четвёртым параметром будет имя базы данных (<literal>"main"</literal>,
<literal>"temp"</literal> и т.д.), если необходимо.
</para>
<para>
Пятый параметр callback-авторизатора - имя самого внутреннего триггера или
представления, ответственного за попытку получения доступа, или &null;, если
эта попытка получения доступа произведена напрямую из кода SQL верхнего уровня.
</para>
<para>
Когда callback-функция возвращает <constant>SQLite3::OK</constant>, это
значит, что запрошенная операция принята. Когда callback-функция возвращает
<constant>SQLite3::DENY</constant>, вызов, запустивший авторизатор, потерпит
неудачу с сообщением об ошибке, объясняющим, что доступ запрещён.
</para>
<para>
Если код действия - <constant>SQLite3::READ</constant>, и callback-функция
возвращает <constant>SQLite3::IGNORE</constant>, то подготовленное выражение
составляется для замены на &null; значения колонки таблицы, которое бы
считывалось, если бы вернулся код <constant>SQLite3::OK</constant>. Возврат
<constant>SQLite3::IGNORE</constant> может использоваться, чтобы запретить
недоверенному пользователю доступ к отдельным колонкам таблицы.
</para>
<para>
Когда на таблицу ссылаются через <literal>SELECT</literal>, но из неё не
извлекается ни одного значения колонок, (например, в запросе <literal>"SELECT
count(*) FROM table"</literal>), то callback-авторизатор <constant>SQLite3::READ
</constant> вызывается один раз для этой таблицы с именем колонки, которое
равно пустой строке.
</para>
<para>
Если код действия - <constant>SQLite3::DELETE</constant>, и callback-функция
возвращает <constant>SQLite3::IGNORE</constant>, тогда операция DELETE
продолжает свою работу, но с выключенной оптимизацией удаления, и все строки
удаляются по отдельности.
</para>
<para>
В соединении с базой данных одновременно может использоваться только один
авторизатор. Каждый вызов <methodname>SQLite3::setAuthorizer</methodname>
перезаписывает предыдущий. Отключить авторизатор можно, передав &null;
вместо callback-функции. По умолчанию авторизатор выключен.
</para>
<para>
Callback-авторизатор не должен делать ничего, что изменяет подключение к
базе данных, которое вызвало callback-авторизатор.
</para>
<para>
Заметьте, что авторизатор вызывается только тогда, когда выражение
подготавливается, а не тогда, когда оно исполняется.
</para>
<para>
Более подробную информацию можно найти в
<link xlink:href="&url.sqlite;c3ref/set_authorizer.html">Документации SQLite3</link>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
Функция <type>callable</type> для вызова.
</para>
<para>
Если передан &null;, то текущий callback-авторизатор будет отключён.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Этот метод не вызывает никаких ошибок, но если авторизатор включён и
возвращает некорректное значение, то при подготовке выражения будет вызвана
ошибка (или выброшено исключение, в зависимости от использования метода
<methodname>SQLite3::enableExceptions</methodname>).
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Пример использования <methodname>SQLite3::setAuthorizer</methodname></title>
<para>
В данном примере разрешён доступ только для чтения, и только некоторые из
колонок таблицы <literal>users</literal> будут возвращены. Остальные колонки
будут заменены на &null;.
</para>
<programlisting role="php">
<![CDATA[
<?php
$db = new SQLite3('data.sqlite');
$db->exec('CREATE TABLE users (id, name, password);');
$db->exec('INSERT INTO users VALUES (1, \'Pauline\', \'Snails4eva\');');
$allowed_columns = ['id', 'name'];
$db->setAuthorizer(function (int $action, ...$args) use ($allowed_columns) {
if ($action === SQLite3::READ) {
list($table, $column) = $args;
if ($table === 'users' && in_array($column, $allowed_columns)) {
return SQLite3::OK;
}
return SQLite3::IGNORE;
}
return SQLite3::DENY;
});
print_r($db->querySingle('SELECT * FROM users WHERE id = 1;'));
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[id] => 1
[name] => Pauline
[password] =>
)
]]>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->