|
2425.2.2
by Daniel Nichter
A lot of doc changes: rewrite and expand Configuration and Administration, re-order top-level sections, enhance Contributing, add Release Notes, add Help and Support, fix title casing, label all plugins, other misc. enhancements. |
1 |
.. _regex_policy_plugin: |
2 |
||
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
3 |
Regex-based Authorization
|
4 |
=========================
|
|
5 |
||
|
2397.1.3
by Daniel Nichter
Complete documenting 2nd half of plugins. |
6 |
:program:`regex_policy` is an :doc:`/administration/authorization` plugin |
7 |
that uses regex patterns to match policies. |
|
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
8 |
|
9 |
.. _regex_policy_loading: |
|
10 |
||
11 |
Loading
|
|
12 |
-------
|
|
13 |
||
14 |
To load this plugin, start :program:`drizzled` with:: |
|
15 |
||
16 |
--plugin-add=regex_policy
|
|
17 |
||
18 |
Loading the plugin may not enable or configure it. See the plugin's |
|
19 |
:ref:`regex_policy_configuration` and :ref:`regex_policy_variables`. |
|
20 |
||
|
2425.2.1
by Daniel Nichter
Rewrite Configuration docs. |
21 |
.. seealso:: :ref:`drizzled_plugin_options` for more information about adding and removing plugins. |
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
22 |
|
23 |
.. _regex_policy_configuration: |
|
24 |
||
25 |
Configuration
|
|
26 |
-------------
|
|
27 |
||
28 |
These command line options configure the plugin when :program:`drizzled` |
|
|
2425.2.1
by Daniel Nichter
Rewrite Configuration docs. |
29 |
is started. See :ref:`command_line_options` for more information about specifying |
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
30 |
command line options. |
31 |
||
32 |
.. program:: drizzled |
|
33 |
||
34 |
.. option:: --regex-policy.policy ARG |
|
35 |
||
|
2397.1.3
by Daniel Nichter
Complete documenting 2nd half of plugins. |
36 |
:Default: :file:`drizzle.policy` |
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
37 |
:Variable: :ref:`regex_policy_policy <regex_policy_policy>` |
38 |
||
|
2397.1.3
by Daniel Nichter
Complete documenting 2nd half of plugins. |
39 |
File to load for regex authorization policies. |
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
40 |
|
41 |
.. _regex_policy_variables: |
|
42 |
||
43 |
Variables
|
|
44 |
---------
|
|
45 |
||
46 |
These variables show the running configuration of the plugin. |
|
47 |
See `variables` for more information about querying and setting variables.
|
|
48 |
||
49 |
.. _regex_policy_policy: |
|
50 |
||
51 |
* ``regex_policy_policy`` |
|
52 |
||
53 |
:Scope: Global
|
|
54 |
:Dynamic: No
|
|
55 |
:Option: :option:`--regex-policy.policy` |
|
56 |
||
|
2397.1.3
by Daniel Nichter
Complete documenting 2nd half of plugins. |
57 |
File to load for regex authorization policies. |
58 |
||
59 |
.. _regex_policy_file_format: |
|
60 |
||
61 |
Regex Policy File Format
|
|
62 |
------------------------
|
|
63 |
||
64 |
The general line format of a regex policy file is::
|
|
65 |
||
66 |
USER_PATTERN SCHEMA_OBJECT_PATTERN POLICY
|
|
67 |
||
68 |
For example::
|
|
69 |
||
70 |
# This is a comment line and should be skipped
|
|
71 |
.+ schema=DATA_DICTIONARY ACCEPT
|
|
72 |
.+ schema=INFORMATION_SCHEMA ACCEPT
|
|
73 |
.+ schema=data_dictionary ACCEPT
|
|
74 |
.+ schema=information_schema ACCEPT
|
|
75 |
root table=.+ ACCEPT
|
|
76 |
root schema=.+ ACCEPT
|
|
77 |
root process=.+ ACCEPT
|
|
78 |
user1 schema=user1 ACCEPT
|
|
79 |
user2 schema=user2 ACCEPT
|
|
80 |
user1 process=user1 ACCEPT
|
|
81 |
user2 process=user2 ACCEPT
|
|
82 |
# Default to denying everything
|
|
83 |
.+ schema=.+ DENY
|
|
84 |
.+ process=.+ DENY
|
|
|
2397.1.1
by Daniel Nichter
Skeleton documentation for all plugins, more complete docu for first half of plugins. |
85 |
|
86 |
Examples
|
|
87 |
--------
|
|
88 |
||
89 |
Sorry, there are no examples for this plugin. |
|
90 |
||
91 |
.. _regex_policy_authors: |
|
92 |
||
93 |
Authors
|
|
94 |
-------
|
|
95 |
||
96 |
Clint Byrum |
|
97 |
||
98 |
.. _regex_policy_version: |
|
99 |
||
100 |
Version
|
|
101 |
-------
|
|
102 |
||
103 |
This documentation applies to **regex_policy 1.0**.
|
|
104 |
||
105 |
To see which version of the plugin a Drizzle server is running, execute: |
|
106 |
||
107 |
.. code-block:: mysql |
|
108 |
||
109 |
SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='regex_policy' |
|
110 |
||
|
2397.1.3
by Daniel Nichter
Complete documenting 2nd half of plugins. |
111 |
Changelog
|
112 |
---------
|
|
113 |
||
114 |
v1.0
|
|
115 |
^^^^
|
|
116 |
* First release.
|