plugin:authpdo
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:authpdo [2017-09-20 16:35] – [Real World Examples] 27.34.16.165 | plugin:authpdo [2020-10-31 18:31] (current) – [Real World Examples] webtist_hanschur | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
---- plugin ---- | ---- plugin ---- | ||
Line 22: | Line 22: | ||
This plugin allows to configure your wiki to authenticate against an existing database using PHP's PDO extension. Typical use cases are integrating DokuWiki with a web forum, blog or bug tracker. | This plugin allows to configure your wiki to authenticate against an existing database using PHP's PDO extension. Typical use cases are integrating DokuWiki with a web forum, blog or bug tracker. | ||
+ | |||
===== Real World Examples ===== | ===== Real World Examples ===== | ||
+ | |||
Before you go forward to [[# | Before you go forward to [[# | ||
- | * [[plugin: | + | * [[plugin: |
- | * [[plugin: | + | * [[plugin: |
- | * [[plugin: | + | * [[plugin: |
- | + | * [[plugin: | |
+ | * [[plugin: | ||
+ | * [[plugin: | ||
===== Configuration ===== | ===== Configuration ===== | ||
To configure this plugin, some experience with database queries and the SQL query language is required. Sample configurations for popular systems will soon be provided by the community. | To configure this plugin, some experience with database queries and the SQL query language is required. Sample configurations for popular systems will soon be provided by the community. | ||
- | The configuration consists mostly of SQL statements to access your database. The plugin itself is completely database agnostic. You can use it to access any database supported by PDO - refer to [[http:// | + | The configuration consists mostly of SQL statements to access your database. The plugin itself is completely database agnostic. You can use it to access any database supported by PDO -- refer to [[http:// |
In most of the statements named PDO placeholders are used (colon prefixed alphanumeric). These represent the actual data that will be inserted into the statement. The PDO driver takes care of proper escaping - you do not have to worry about it. | In most of the statements named PDO placeholders are used (colon prefixed alphanumeric). These represent the actual data that will be inserted into the statement. The PDO driver takes care of proper escaping - you do not have to worry about it. | ||
Line 41: | Line 46: | ||
Each option below comes with an example that shows how the statement would look for a fictive [[#example database]] given at the end of this page. | Each option below comes with an example that shows how the statement would look for a fictive [[#example database]] given at the end of this page. | ||
+ | |||
==== General Settings ==== | ==== General Settings ==== | ||
+ | |||
=== Option ' | === Option ' | ||
This setting will output detailed error messages whenever something goes wrong. You most probably want to enable this during the initial configuration of the plugin. Once everything works you should definitely disable this again as it may leak important information to possible attackers. | This setting will output detailed error messages whenever something goes wrong. You most probably want to enable this during the initial configuration of the plugin. Once everything works you should definitely disable this again as it may leak important information to possible attackers. | ||
+ | |||
=== Option ' | === Option ' | ||
Line 64: | Line 72: | ||
* [[http:// | * [[http:// | ||
* [[http:// | * [[http:// | ||
+ | |||
=== Option ' | === Option ' | ||
This option configures the user to use to connect to the database. You can leave it empty for sqlite databases. | This option configures the user to use to connect to the database. You can leave it empty for sqlite databases. | ||
+ | |||
=== Option ' | === Option ' | ||
This is the password for above user. You can leave it empty for sqlite databases. | This is the password for above user. You can leave it empty for sqlite databases. | ||
+ | |||
==== Related Core Settings ==== | ==== Related Core Settings ==== | ||
Line 77: | Line 88: | ||
There are a couple of settings you most probably want to tune when enabling authpdo: | There are a couple of settings you most probably want to tune when enabling authpdo: | ||
- | * [[config: | + | * [[config: |
- | * [[config: | + | * [[config: |
- | * [[config: | + | * [[config: |
+ | * [[config: | ||
==== Minimal SQL Setup ==== | ==== Minimal SQL Setup ==== | ||
This plugin gains more capabilities the more of the configuration you fill in. You can leave out configuration at the expense of functionality. However a few statements are required to have minimal login functionality: | This plugin gains more capabilities the more of the configuration you fill in. You can leave out configuration at the expense of functionality. However a few statements are required to have minimal login functionality: | ||
+ | |||
=== Option ' | === Option ' | ||
Line 109: | Line 123: | ||
WHERE " | WHERE " | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 129: | Line 144: | ||
AND m." | AND m." | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 148: | Line 164: | ||
Example: | Example: | ||
- | < | + | < |
SELECT uid | SELECT uid | ||
FROM user | FROM user | ||
Line 154: | Line 170: | ||
AND pass = MD5(CONCAT(MD5(user), | AND pass = MD5(CONCAT(MD5(user), | ||
</ | </ | ||
+ | |||
+ | |||
==== Additional SQL Setup ==== | ==== Additional SQL Setup ==== | ||
Line 218: | Line 236: | ||
| | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 232: | Line 251: | ||
DELETE FROM " | DELETE FROM " | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 239: | Line 259: | ||
^ Guaranteed Placeholders ^^ | ^ Guaranteed Placeholders ^^ | ||
| '': | | '': | ||
- | | '': | + | | '': |
| '': | | '': | ||
| '': | | '': | ||
- | | '': | + | | '': |
- | | '': | + | | '': |
- | | '': | + | | '': |
^ Mandatory fields to return ^^ | ^ Mandatory fields to return ^^ | ||
| '' | | '' | ||
Line 263: | Line 283: | ||
LIMIT : | LIMIT : | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 270: | Line 291: | ||
^ Guaranteed Placeholders ^^ | ^ Guaranteed Placeholders ^^ | ||
| '': | | '': | ||
- | | '': | + | | '': |
| '': | | '': | ||
| '': | | '': | ||
^ Mandatory fields to return ^^ | ^ Mandatory fields to return ^^ | ||
- | | '' | + | | '' |
<code tsql> | <code tsql> | ||
Line 289: | Line 309: | ||
AND U." | AND U." | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 306: | Line 327: | ||
WHERE " | WHERE " | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 327: | Line 349: | ||
WHERE " | WHERE " | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 346: | Line 369: | ||
WHERE " | WHERE " | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 358: | Line 382: | ||
| | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 374: | Line 399: | ||
| | ||
</ | </ | ||
+ | |||
=== Option ' | === Option ' | ||
Line 390: | Line 416: | ||
AND " | AND " | ||
</ | </ | ||
+ | |||
===== Example Database ===== | ===== Example Database ===== | ||
Line 397: | Line 424: | ||
{{ : | {{ : | ||
- | < | + | < |
CREATE TABLE user ( | CREATE TABLE user ( | ||
" | " | ||
Line 415: | Line 442: | ||
); | ); | ||
</ | </ | ||
+ | |||
===== A Warning on MySQL MyISAM ===== | ===== A Warning on MySQL MyISAM ===== |
plugin/authpdo.1505918133.txt.gz · Last modified: 2017-09-20 16:35 by 27.34.16.165