From 188df632a74ccbb65fbea4a6b9f4cf5c5672b665 Mon Sep 17 00:00:00 2001
From: Greg Beaver <cellog@php.net>
Date: Fri, 24 Jul 2009 15:42:17 +0000
Subject: [PATCH] fix signature generation/validation for zip archives by phar
 extension, fix a few edge cases where memory was leaked on error conditions
 by missing efree()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@284707 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/phar/Phar/getSignature.xml           | 11 ++++++-----
 reference/phar/Phar/getSupportedSignatures.xml |  3 ++-
 reference/phar/Phar/setSignatureAlgorithm.xml  |  7 +++----
 reference/phar/fileformat.xml                  |  2 +-
 4 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/reference/phar/Phar/getSignature.xml b/reference/phar/Phar/getSignature.xml
index 8dd85f5995..9b716961cc 100644
--- a/reference/phar/Phar/getSignature.xml
+++ b/reference/phar/Phar/getSignature.xml
@@ -3,7 +3,7 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.getsignature">
  <refnamediv>
   <refname>Phar::getSignature</refname>
-  <refpurpose>Return MD5/SHA1/SHA256/SHA512 signature of a Phar archive</refpurpose>
+  <refpurpose>Return MD5/SHA1/SHA256/SHA512/OpenSSL signature of a Phar archive</refpurpose>
  </refnamediv>
  <refsect1 role="description">
   &reftitle.description;
@@ -25,11 +25,12 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Array with the opened archive's signature in "hash" key and "md5", "sha1",
-   "sha256", or "sha512"
-   in "hash_type".  This signature is a hash calculated on the
+   Array with the opened archive's signature in <literal>hash</literal> key and <literal>MD5</literal>,
+   <literal>SHA-1</literal>,
+   <literal>SHA-256</literal>, <literal>SHA-512</literal>, or <literal>OpenSSL</literal>
+   in <literal>hash_type</literal>.  This signature is a hash calculated on the
    entire phar's contents, and may be used to verify the integrity of the archive.
-   A valid signature is absolutely required of all phar-based phars if the
+   A valid signature is absolutely required of all executable phar archives if the
    <link linkend="ini.phar.require-hash">phar.require_hash</link> INI variable
    is set to true.
   </para>
diff --git a/reference/phar/Phar/getSupportedSignatures.xml b/reference/phar/Phar/getSupportedSignatures.xml
index 43f2003c90..2b9c681857 100644
--- a/reference/phar/Phar/getSupportedSignatures.xml
+++ b/reference/phar/Phar/getSupportedSignatures.xml
@@ -27,7 +27,8 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an array containing any of "MD5", "SHA-1", "SHA-256", "SHA-512".
+   Returns an array containing any of <literal>MD5</literal>, <literal>SHA-1</literal>,
+   <literal>SHA-256</literal>, <literal>SHA-512</literal>, or <literal>OpenSSL</literal>.
   </para>
  </refsect1>
 
diff --git a/reference/phar/Phar/setSignatureAlgorithm.xml b/reference/phar/Phar/setSignatureAlgorithm.xml
index 2d4b78636f..51378b10be 100644
--- a/reference/phar/Phar/setSignatureAlgorithm.xml
+++ b/reference/phar/Phar/setSignatureAlgorithm.xml
@@ -22,8 +22,8 @@
    <literal>Phar::SHA512</literal>, or <literal>Phar::OPENSSL</literal>.
   </para>
   <para>
-   Note that all phar-based and tar-based phar archives have a signature created
-   automatically, <literal>SHA1</literal> by default.  data tar-based archives
+   Note that all executable phar archives have a signature created
+   automatically, <literal>SHA1</literal> by default.  data tar- or zip-based archives
    (archives created with the <classname>PharData</classname> class) must have
    their signature created and set explicitly via
    <function>Phar::setSignatureAlgorithm</function>.
@@ -81,8 +81,7 @@ $p->setSignatureAlgorithm(Phar::OPENSSL, $pkey);
   &reftitle.errors;
   <para>
    Throws <classname>UnexpectedValueException</classname> for many errors,
-   <classname>BadMethodCallException</classname> if called for a zip-based phar
-   archive, and a <classname>PharException</classname>
+   and a <classname>PharException</classname>
    if any problems occur flushing changes to disk.
   </para>
  </refsect1>
diff --git a/reference/phar/fileformat.xml b/reference/phar/fileformat.xml
index 2cce0fb8b7..7307b84425 100644
--- a/reference/phar/fileformat.xml
+++ b/reference/phar/fileformat.xml
@@ -114,7 +114,7 @@ __HALT_COMPILER();
       <entry>Whole-archive signature validation</entry>
       <entry>Yes</entry>
       <entry>Yes</entry>
-      <entry>No</entry>
+      <entry>Yes (PHP 5.3.1+)</entry>
      </row>
      <row>
       <entry>Web-specific application support</entry>