/usr/share/doc/libapache2-mod-perl2-doc/docs/2.0/api/APR/Util.html is in libapache2-mod-perl2-doc 2.0.8+httpd24-r1449661-6ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#Synopsis">Synopsis</a></li>
<li><a href="#Description">Description</a></li>
<li><a href="#API">API</a>
<ul>
<li><a href="#password_validate">password_validate</a></li>
</ul>
</li>
<li><a href="#Unsupported-API">Unsupported API</a>
<ul>
<li><a href="#filepath_name_get">filepath_name_get</a></li>
<li><a href="#password_get">password_get</a></li>
</ul>
</li>
<li><a href="#See-Also">See Also</a></li>
<li><a href="#Copyright">Copyright</a></li>
<li><a href="#Authors">Authors</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>APR::Util - Perl API for Various APR Utilities</p>
<h1 id="Synopsis">Synopsis</h1>
<pre><code> use APR::Util ();
$ok = password_validate($passwd, $hash);</code></pre>
<h1 id="Description">Description</h1>
<p>Various APR utilities that don't fit into any other group.</p>
<h1 id="API">API</h1>
<p><code>APR::Util</code> provides the following functions and/or methods:</p>
<h2 id="password_validate"><code>password_validate</code></h2>
<p>Validate an encrypted password hash against a plain text password (with lots of restrictions and peculiarities).</p>
<pre><code> $ok = password_validate($passwd, $hash);</code></pre>
<dl>
<dt id="arg1:-passwd-string">arg1: <code>$passwd</code> ( string )</dt>
<dd>
<p>Plain text password string</p>
</dd>
<dt id="arg2:-hash-string">arg2: <code>$hash</code> ( string )</dt>
<dd>
<p>Encrypted or encoded hash. See below for supported hash formats.</p>
</dd>
<dt id="ret:-ok-boolean">ret: <code>$ok</code> ( boolean )</dt>
<dd>
<p>The password either matches or not.</p>
</dd>
<dt id="since:-2.0.00">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>The function handles the output of the following functions (it knows to tell md5 and sha1 from the others, since they are have a special pattern recognized by apr):</p>
<ul>
<li><p>md5</p>
<p>generated by <code>apr_md5_encode()</code> (for which at the moment we have no perl glue, ask if you need it).</p>
</li>
<li><p>sha1</p>
<p>generated by <code>apr_sha1_base64()</code> (for which at the moment we have no perl glue, ask if you need it).</p>
<p>and it's available only since Apache 2.0.50</p>
</li>
<li><p>crypt</p>
<p>On all but the following platforms: MSWin32, beos and NetWare. Therefore you probably don't want to use that feature, unless you know that your code will never end up running on those listed platforms.</p>
<p>Moreover on these three platforms if that function sees that the hash is not of md5 and sha1 formats, it'll do a clear to clear text matching, always returning success, no matter what the hashed value is.</p>
</li>
</ul>
<p>Warning: double check that you understand what this function does and does not before using it.</p>
<h1 id="Unsupported-API">Unsupported API</h1>
<p><code>APR::Socket</code> also provides auto-generated Perl interface for a few other methods which aren't tested at the moment and therefore their API is a subject to change. These methods will be finalized later as a need arises. If you want to rely on any of the following methods please contact the <a>the mod_perl development mailing list</a> so we can help each other take the steps necessary to shift the method to an officially supported API.</p>
<h2 id="filepath_name_get"><code>filepath_name_get</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>[We have File::Spec and File::Basename for this purpose, I can't see why this api is needed]</p>
<p>return the final element of the pathname</p>
<pre><code> $ret = filepath_name_get($pathname);</code></pre>
<dl>
<dt id="arg1:-pathname-string">arg1: <code>$pathname</code> ( string )</dt>
<dd>
<p>The path to get the final element of</p>
</dd>
<dt id="ret:-ret-string">ret: <code>$ret</code> ( string )</dt>
<dd>
<p>the final element of the path</p>
<p>For example:</p>
<pre><code> "/foo/bar/gum" => "gum"
"/foo/bar/gum/" => ""
"gum" => "gum"
"bs\\path\\stuff" => "stuff"</code></pre>
</dd>
<dt id="since:-subject-to-change">since: subject to change</dt>
<dd>
</dd>
</dl>
<h2 id="password_get"><code>password_get</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>Display a prompt and read in the password from stdin.</p>
<pre><code> $ret = password_get($prompt, $pwbuf, $bufsize);</code></pre>
<dl>
<dt id="arg1:-prompt-string">arg1: <code>$prompt</code> ( string )</dt>
<dd>
<p>The prompt to display</p>
</dd>
<dt id="arg2:-pwbuf-string">arg2: <code>$pwbuf</code> ( string )</dt>
<dd>
<p>Buffer to store the password</p>
</dd>
<dt id="arg3:-bufsize-number">arg3: <code>$bufsize</code> (number)</dt>
<dd>
<p>The length of the password buffer.</p>
</dd>
<dt id="ret:-ret-integer">ret: <code>$ret</code> (integer)</dt>
<dd>
</dd>
<dt id="since:-subject-to-change1">since: subject to change</dt>
<dd>
</dd>
</dl>
<h1 id="See-Also">See Also</h1>
<p><a>mod_perl 2.0 documentation</a>.</p>
<h1 id="Copyright">Copyright</h1>
<p>mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.</p>
<h1 id="Authors">Authors</h1>
<p><a>The mod_perl development team and numerous contributors</a>.</p>
</body>
</html>
|