PHP詳細解析之phar

這篇文章為大家帶來了關於PHP的相關知識，其中主要介紹了關於phar的相關內容，phar全稱為PHP Archive，phar擴展提供了一種將整個PHP應用程序放入phar檔案的方法，方便移動、安裝，下面一起來看一下，希望對大家有幫助。

推薦學習：《PHP影片教學》

一  phar檔案是什麼

        Jar（Java Archive）文件，一個應用，包括所有的可執行，可訪問的文件，都打包進了一個JAR文件裡，使得部署過程十分簡單。

        類似JAR。 phar全稱為PHP Archive，phar擴充提供了一種將整個PHP應用程式放入.phar檔案中的方法，以方便移動、安裝。 phar文件的最大特點是將幾個文件組合成一個文件的便捷方式。 .phar檔案提供了一種將完整的PHP程式分佈在一個檔案中並從該檔案中運行的方法。

        與 JAR 不同的是Phar 可由 PHP 本身處理，因此不需要使用額外的工具來創建或使用，使用php腳本就能創建或提取它。

        phar檔案有三種格式：tar歸檔、zip歸檔、phar歸檔，前兩種執行需要php安裝Phar 擴充支援，用的也比較少，這裡主要講phar歸檔格式。

二  phar的創建

1  修改php.ini設定檔

##        PHAR檔案缺省狀態是唯讀的，使用Phar檔案不需要任何的配置。部署非常方便。因為我們現在需要建立一個自己的Phar文件，所以需要允許寫入Phar文件，這需要修改一下

php.ini

我的php.ini文件中，phar.readonly = On。

[Phar]
; http://php.net/phar.readonly
;phar.readonly = On

        首先在php.ini修改phar.readonly這個選項，去掉前面的分號，並改值為off，由於安全原因該選項默認是on，如果在php.ini中是禁用的（值為0或off），那麼在使用者腳本中可以開啟或關閉，如果在php.ini中是開啟的，那麼使用者腳本是無法關閉的，所以這裡設定為off來展示範例。

現在，我們就可以來把PHP應用程式打包成Phar檔案了。

2  創建我們自己的PHP檔案專案

這裡我都是藉助別人部落格的專案直接Copy的，並沒有進行演示，因為我整理這篇部落格的初衷是為了解phar://漏洞打ctf的。所以其中的檔名就依照原作者的不進行修改了。最後會加上參考文章的。

首先我要依照依照一個的規則建立應用的目錄結構，根目錄為project，project下的目錄如下面這樣：

file
    -yunek.js
    -yunke.css
lib
    -lib_a.php
template
    -msg.html
index.php
Lib.php

其中file資料夾有兩個內容為空的js和css文件，僅示範phar可以包含多種文件格式

lib_a.php內容如下：

<?php /**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/10
 * Time: 9:23
 */
function show(){
    echo "l am show()";
}

msg.html內容如下：

nbsp;html>


    <meta>
    <title>phar</title>


=$str; ?>

index.php內容如下：

<?php /**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/10
 * Time: 9:17
 */
require "lib/lib_a.php";
show();
 
$str = isset($_GET["str"]) ? $_GET["str"] : "hello world";
include "template/msg.html";

Lib.php內容如下：

<?php /**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/10
 * Time: 9:20
 */
function yunke()
{
    echo "l am yunke()";
}

3  建立phar檔案

專案檔案準備好了，現在在project資料夾同級目錄建立一個yunkeBuild.php，用於產生phar格式文件，內容如下：

<?php /**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/10
 * Time: 9:36
 */
 
//产生一个yunke.phar文件
$phar = new Phar(&#39;yunke.phar&#39;, 0, &#39;yunke.phar&#39;);
// 添加project里面的所有文件到yunke.phar归档文件
$phar->buildFromDirectory(dirname(__FILE__) . '/project');
//设置执行时的入口文件，第一个用于命令行，第二个用于浏览器访问，这里都设置为index.php
$phar->setDefaultStub('index.php', 'index.php');

然後在瀏覽器中訪問這個yunkeBuild.php文件，將產生一個yunke.phar文件，此時伺服器根目錄結構如下：

project

yunkeBuild.php

yunke.phar

這就是產生一個phar歸檔檔案最簡單的過程了。

這裡我再做一些其他的補充，方便更好的理解：

#1）

phar檔案的產生是透過存取yunkeBuild.php，相當於執行。因此可以在終端機執行如下程式碼產生

aabouzekry@platinum:~/myapp$ php yunkeBuild.php

然後就產生了yunke.phar檔案。

2）

new phar（）產生phar物件。對其中的參數進行一下解讀。

<?php $phar = new Phar("/yunke.phar", 
        FilesystemIterator::CURRENT_AS_FILEINFO |
        FilesystemIterator::KEY_AS_FILENAME, "yunke.phar");

解釋：

一個新

Phar 物件的建立通常需要三個參數。

第一個參數是Phar檔案的路徑。你不僅可以透過它建立Phar文件，還可以對現存的Phar文件進行操作。

第二個參數是設定

Phar 物件如何處理檔案。 Phar 物件繼承了 PHP RecursiveDirectoryIterator 對象，這個參數直接傳遞到父類別。這裡提供的值是RecursiveDirectoryIterator 的預設值，能滿足目前的要求。

第三個參數是Phar檔案的別名，在內部引用這個Phar檔案時都要使用這個別名。

通常只需傳入檔案名稱。也就是第三個參數。

3）

往phar中新增檔案。新增檔案有幾種如下方法：

• 手动添加已有文件

调用类方法Phar::addFile($filepath,$localpath=?)添加文件，参数是文件绝对路径和（可选）存储到phar的相对路径

<?php $phar = new Phar(&#39;yunke.phar&#39;);
	$phar->addFile('test.php');
	include('phar://yunke.phar/test.php') // in test.php
?>

这里出现的phar：//就是访问phar文件的一种方法，所以不需要太在意。

• 以字符串添加文件内容

调用类方法Phar::addFromString($localpath,$contents)以字符串形式添加文件

<?php $phar = new Phar(&#39;yunke.phar&#39;);
	$phar->addFromString('test.php','<?php  echo \&#39;in test.php\&#39;?>');
	include('phar://yunke.phar/test.php'); // in test.php
?>

• 添加空目录

调用类方法Phar::addEmptyDir($dirname)添加空目录，使用方法Phar::getContent()获取文件结构

<?php $phar = new Phar(&#39;yunke.phar&#39;);
	$phar->addEmptyDir('test'); // yunke.phar/test/
?>

• 手动选择添加已有目录

调用类方法Phar::buildFromDirectory($dir,$pattern = "")添加整个目录

<?php $phar = new Phar(&#39;yunke.phar&#39;);
	$phar->buildFromDirectory('test'); // test.php in test/
	include('phar://yunke.phar/test/test.php'); // in test/test.php
?>

4） 存根文件Stub，理解这个很重要。

归档文件中有一个存根文件stub，其实就是一段php执行代码，在制作归档时可以设置，直接执行归档文件时，其实就是执行它，所以它是启动文件；在脚本中包含归档文件时就像包含普通php文件一样包含它并运行，但直接以phar://的方式包含归档中某一个文件时不会执行存根代码， 往往在存根文件里面require包含要运行的其他文件，对存根文件的限制仅为以__HALT_COMPILER(); 结束，默认的存根设计是为在没有phar扩展时能够运行，它提取phar文件内容到一个临时目录再执行，不过从php5.3开始该扩展默认内置启用了。

stub是phar文件的文件头，格式为...<?php ...;__HALT_COMPILER();?>，…可以是任意字符，包括留空，且php闭合符与最后一个分号之间不能有多于一个的空格符。另外php闭合符也可省略。最短省略闭合符的stub是__HALT_COMPILER();?></p> <p>运行Phar文件时，stub文件被当做一个meta文件来初始化Phar， 并告诉Phar文件在被调用时该做什么。</p> <p>在我们的例子中，使用的是 <code>createDefaultStub() 方法。

其他的方式如下:

方法一：调用类方法Phar::setStub($string)为实例创建自定义stub

<?php $phar = new Phar(&#39;yunke.phar&#39;);
	$phar->setStub('<?php  echo \&#39;in stub!\&#39;;__HALT_COMPILER();?>');
	include('phar://yunke.phar');	// in stub!
?>

也可以

$phar->setStub($phar->createDefaultStub("index.php"));

生成的缺省stub文件包含如下的代码：

<?php Phar::mapPhar();
include "phar://yunke.phar/index.php";
__HALT_COMPILER();

createDefaultStub() 方法缺省创建的stub文件的内容很简单。 Phar::mapPhar() 用来分析Phar文件的元数据，并初始化它。stub文件的结尾处需要调用 __HALT_COMPILER() 方法，这个方法后不能留空格。__HALT_COMPILER() 会立即终止PHP的运行，防止include的文件在此方法后仍然执行。这是Phar必须的，没有它Phar将不能正常运行。

除此之外，我们还可以创建自己的stub文件来执行自定义的初始化过程，像这样加载自定义文件

<?php $phar->setStub(file_get_contents("stub.php"));

方法二：使用默认stub，调用类方法Phar::setDefaultStub()为实例设置默认stub，使用方法Phar::getStub()获取实例的stub

<?php     $phar = new Phar(&#39;yunke.phar&#39;);
    $phar->setDefaultStub();
    print_r($phar->getStub()); // 2, 'c' => 'text/plain', 'cc' => 'text/plain', ...
?>

如果缺省创建stub，PHP会使用默认stub

<?php $phar = new Phar(&#39;yunke.phar&#39;);
	$phar[&#39;demo.txt&#39;] = &#39;demo&#39;;
	print_r($phar->getStub()); // 2, 'c' => 'text/plain', 'cc' => 'text/plain', ...
?>

4 phar文件的运行

我们在服务器根目录建立一个index.php文件来演示如何使用上面创建的phar文件，内容如下：

<?php  
/**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/8
 * Time: 9:33
 */
 
require "yunke.phar";
require "phar://yunke.phar/Lib.php";
yunke();

如果index.php文件中只有第一行，那么和不使用归档文件时，添加如下代码完全相同：

require "project/index.php";

如果没有第二行，那么第三行的yunke()将提示未定义，所以可见require一个phar文件时并不是导入了里面所有的文件，而只是导入了入口执行文件而已，但在实际项目中往往在这个入口文件里导入其他需要使用的文件，在本例中入口执行文件为project/index.php。

补充：

可以为归档设置别名，别名保存在归档文件中永久保存，它可以用一个简短的名字引用归档，而不管归档文件在文件系统中存储在那里，设置别名：

$phar = new Phar('lib/yunke.phar', 0);
$phar->setAlias ( "yun.phar");

设置别名后可以如下使用：

<?php require "lib/yunke.phar";
require "phar://yun.phar/Lib.php";  //使用别名访问归档文件
require "phar://lib/yunke.phar/Lib.php"; //当然仍然可以使用这样的方式去引用

如果在制作phar文件时没有指定别名，也可以在存根文件里面使用Phar::mapPhar('yunke.phar');指定。

5 phar文件的提取还原

我们有时候会好奇phar里面包含的文件源码，这个时候就需要将phar文件还原，如果只是看一看的话可以使用一些ide工具，比如phpstorm 10就能直接打开它，如果需要修改那么就需要提取操作了，为了演示，我们下载一个composer.phar放在服务器目录，在根目录建立一个get.php文件，内容如下

<?php /**
 * Created by yunke.
 * User: yunke
 * Date: 2017/2/9
 * Time: 19:02
 */
 
$phar = new Phar(&#39;composer.phar&#39;);
$phar->extractTo('composer'); //提取一份原项目文件
$phar->convertToData(Phar::ZIP); //另外再提取一份，和上行二选一即可

用浏览器访问这个文件，即可提取出来，以上列子展示了两种提取方式：

第二行將建立一個composer目錄，並將提取出來的內容放入；

第三行將產生一個composer.zip文件，解壓縮即可得到提取還原的項目文件。

至於phar://偽協定造成的伺服器驗證繞過：

推薦學習：《PHP影片教學》

以上是PHP詳細解析之phar的詳細內容。更多資訊請關注PHP中文網其他相關文章！