<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Language" content="en-us" />
<meta name="ROBOTS" content="ALL" />
<meta http-equiv="imagetoolbar" content="no" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="Keywords" content="cherokee web server httpd http" />
<meta name="Description" content="Cherokee is a flexible, very fast, lightweight Web server. It is implemented entirely in C, and has no dependencies beyond a standard C library. It is embeddable and extensible with plug-ins. It supports on-the-fly configuration by reading files or strings, TLS/SSL (via GNUTLS or OpenSSL), virtual hosts, authentication, cache friendly features, PHP, custom error management, and much more." />
<link href="media/css/cherokee_doc.css" rel="stylesheet" type="text/css" media="all" />
</head>
<body>
<h2 id="_a_href_index_html_index_a_8594_a_href_modules_html_modules_a_8594_a_href_modules_validators_html_validators_a"><a href="index.html">Index</a> → <a href="modules.html">Modules</a> → <a href="modules_validators.html">Validators</a></h2>
<div class="sectionbody">
<h3 id="_validator_mysql">Validator: Mysql</h3><div style="clear:left"></div>
<div class="paragraph"><p>The MySQL validator allows you to authenticate a user against a MySQL database.</p></div>
<div class="tableblock" id="parameters">
<table rules="all"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<caption class="title">Parameters</caption>
<col width="20%" />
<col width="80%" />
<thead>
<tr>
<th align="left" valign="top">Parameter </th>
<th align="left" valign="top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table"><em>host</em></p></td>
<td align="left" valign="top"><p class="table">Optional. The server that is running the MySQL
database server. Default: <em>localhost</em>.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><em>port</em></p></td>
<td align="left" valign="top"><p class="table">Optional. The port that MySQL is listening on.
Default: <em>3306</em>.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><em>unix_socket</em></p></td>
<td align="left" valign="top"><p class="table">Optional. A Unix socket.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><em>user</em></p></td>
<td align="left" valign="top"><p class="table">The MySQL user to authenticate as.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><em>passwd</em></p></td>
<td align="left" valign="top"><p class="table">The MySQL user password to use.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><em>database</em></p></td>
<td align="left" valign="top"><p class="table">Required. The MySQL database to select upon
connection.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><em>query</em></p></td>
<td align="left" valign="top"><p class="table">Required. The query to execute to authenticate
the HTTP user.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table"><em>hash</em></p></td>
<td align="left" valign="top"><p class="table">Optional. What the passwords in the database table
are hashed with. Valid options are <em>sha1</em>
<em>md5</em> or <em>none</em>. Default: <em>none</em>.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="paragraph"><p>The <tt>query</tt> parameter is given an argument <tt>$\{user}</tt> so you can query
against it.</p></div>
<div class="listingblock">
<div class="title">Sample query</div>
<div class="content">
<pre><tt> SELECT password FROM auth_users WHERE username = '${user}'</tt></pre>
</div></div>
<div class="paragraph"><p>The query must return one row with one column as the password. The name of the
column does not matter.</p></div>
<h4 id="compatibility">Compatibility</h4>
<div class="paragraph"><p>This validator is compatible with both <strong>basic</strong> and <strong>digest</strong> schemes.</p></div>
</div>
<div id="footer">
<div id="footer-text">
</div>
</div>
</body>
</html>
