| Server IP : 134.29.175.74 / Your IP : 216.73.216.160 Web Server : nginx/1.10.2 System : Windows NT CST-WEBSERVER 10.0 build 19045 (Windows 10) i586 User : Administrator ( 0) PHP Version : 7.1.0 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/nginx/html/JimMartinson/CST1611/VM_Data/Install/ApachePerlFiles/Perl/html/site/lib/APR/ |
Upload File : |
<?xml version="1.0" ?>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<!-- saved from url=(0017)http://localhost/ -->
<script language="JavaScript" src="../../../displayToc.js"></script>
<script language="JavaScript" src="../../../tocParas.js"></script>
<script language="JavaScript" src="../../../tocTab.js"></script>
<link rel="stylesheet" type="text/css" href="../../../scineplex.css">
<title>APR::Util - Perl API for Various APR Utilities</title>
<link rel="stylesheet" href="../../../Active.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>
<body>
<!-- INDEX BEGIN -->
<div name="index">
<script>writelinks('__top__',3);</script>
<h1><a>APR::Util - Perl API for Various APR Utilities</a></h1>
<p><a name="__index__"></a></p>
<ul>
<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></li>
<ul>
<li><a href="#password_validate"><code>password_validate</code></a></li>
</ul>
<li><a href="#unsupported_api">Unsupported API</a></li>
<ul>
<li><a href="#filepath_name_get"><code>filepath_name_get</code></a></li>
<li><a href="#password_get"><code>password_get</code></a></li>
</ul>
<li><a href="#see_also">See Also</a></li>
<li><a href="#copyright">Copyright</a></li>
<li><a href="#authors">Authors</a></li>
</ul>
<hr name="index" />
</div>
<!-- INDEX END -->
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>APR::Util - Perl API for Various APR Utilities</p>
<p>
</p>
<hr />
<h1><a name="synopsis">Synopsis</a></h1>
<pre>
<span class="keyword">use</span> <span class="variable">APR::Util</span> <span class="operator">();</span>
<span class="variable">$ok</span> <span class="operator">=</span> <span class="variable">password_validate</span><span class="operator">(</span><span class="variable">$passwd</span><span class="operator">,</span> <span class="variable">$hash</span><span class="operator">);</span>
</pre>
<p>
</p>
<hr />
<h1><a name="description">Description</a></h1>
<p>Various APR utilities that don't fit into any other group.</p>
<p>
</p>
<hr />
<h1><a name="api">API</a></h1>
<p><code>APR::Util</code> provides the following functions and/or methods:</p>
<p>
</p>
<h2><a name="password_validate"><code>password_validate</code></a></h2>
<p>Validate an encrypted password hash against a plain text password
(with lots of restrictions and peculiarities).</p>
<pre>
<span class="variable">$ok</span> <span class="operator">=</span> <span class="variable">password_validate</span><span class="operator">(</span><span class="variable">$passwd</span><span class="operator">,</span> <span class="variable">$hash</span><span class="operator">);</span>
</pre>
<dl>
<dt><strong><a name="passwd" class="item">arg1: <code>$passwd</code> ( string )</a></strong>
<dd>
<p>Plain text password string</p>
</dd>
</li>
<dt><strong><a name="hash" class="item">arg2: <code>$hash</code> ( string )</a></strong>
<dd>
<p>Encrypted or encoded hash. See below for supported hash formats.</p>
</dd>
</li>
<dt><strong><a name="ok" class="item">ret: <code>$ok</code> ( boolean )</a></strong>
<dd>
<p>The password either matches or not.</p>
</dd>
</li>
<dt><strong><a name="since_2_0_00309" class="item">since: 2.0.00</a></strong>
</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><strong><a name="md5" class="item">md5</a></strong>
<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><strong><a name="sha1" class="item">sha1</a></strong>
<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><strong><a name="crypt" class="item">crypt</a></strong>
<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>
<p>
</p>
<hr />
<h1><a name="unsupported_api">Unsupported API</a></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 href="../../../maillist/dev.html">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>
<p>
</p>
<h2><a name="filepath_name_get"><code>filepath_name_get</code></a></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>
<span class="variable">$ret</span> <span class="operator">=</span> <span class="variable">filepath_name_get</span><span class="operator">(</span><span class="variable">$pathname</span><span class="operator">);</span>
</pre>
<dl>
<dt><strong><a name="pathname" class="item">arg1: <code>$pathname</code> ( string )</a></strong>
<dd>
<p>The path to get the final element of</p>
</dd>
</li>
<dt><strong><a name="ret" class="item">ret: <code>$ret</code> ( string )</a></strong>
<dd>
<p>the final element of the path</p>
</dd>
<dd>
<p>For example:</p>
</dd>
<dd>
<pre>
"/foo/bar/gum" => "gum"
"/foo/bar/gum/" => ""
"gum" => "gum"
"bs\\path\\stuff" => "stuff"</pre>
</dd>
</li>
<dt><strong><a name="since_subject_to_change25" class="item">since: subject to change</a></strong>
</dl>
<p>
</p>
<h2><a name="password_get"><code>password_get</code></a></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>Display a prompt and read in the password from stdin.</p>
<pre>
<span class="variable">$ret</span> <span class="operator">=</span> <span class="variable">password_get</span><span class="operator">(</span><span class="variable">$prompt</span><span class="operator">,</span> <span class="variable">$pwbuf</span><span class="operator">,</span> <span class="variable">$bufsize</span><span class="operator">);</span>
</pre>
<dl>
<dt><strong><a name="prompt" class="item">arg1: <code>$prompt</code> ( string )</a></strong>
<dd>
<p>The prompt to display</p>
</dd>
</li>
<dt><strong><a name="pwbuf" class="item">arg2: <code>$pwbuf</code> ( string )</a></strong>
<dd>
<p>Buffer to store the password</p>
</dd>
</li>
<dt><strong><a name="bufsize" class="item">arg3: <code>$bufsize</code> (number)</a></strong>
<dd>
<p>The length of the password buffer.</p>
</dd>
</li>
<dt><strong>ret: <code>$ret</code> (integer)</strong>
<dt><strong><a name="since_subject_to_change26" class="item">since: subject to change</a></strong>
</dl>
<p>
</p>
<hr />
<h1><a name="see_also">See Also</a></h1>
<p><a href="../../../docs/2.0/index.html">mod_perl 2.0 documentation</a>.</p>
<p>
</p>
<hr />
<h1><a name="copyright">Copyright</a></h1>
<p>mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.</p>
<p>
</p>
<hr />
<h1><a name="authors">Authors</a></h1>
<p><a href="../../../about/contributors/people.html">The mod_perl development team and numerous contributors</a>.</p>
</body>
</html>