推荐学习:《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.csslib -lib_a.phptemplate -msg.htmlindex.phpLib.php
其中file文件夹有两个内容为空的js和css文件,仅仅演示phar可以包含多种文件格式
lib_a.php内容如下:
msg.html内容如下:
phar =$str; ?>index.php内容如下:
Lib.php内容如下:
3 创建phar文件
项目文件准备好了,现在在project文件夹同级目录建立一个yunkeBuild.php,用于产生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对象。对其中的参数进行一下解读。
解释:
一个新
Phar
对象的创建通常需要三个参数。第一个参数是Phar文件的路径。你不仅可以通过它创建Phar文件,还可以对现存的Phar文件进行操作。
第二个参数是设定
Phar
对象如何处理文件。Phar
对象继承了 PHPRecursiveDirectoryIterator
对象,这个参数是直接传递到父类里。这里提供的值是RecursiveDirectoryIterator
的缺省值,能满足目前的要求。第三个参数是Phar文件的别名,在内部引用这个Phar文件时都要使用这个别名。
通常只需传入文件名。也就是第三个参数。
3)往phar中添加文件。添加文件有几种如下方法:
手动添加已有文件调用类方法
Phar::addFile($filepath,$localpath=?)
添加文件,参数是文件绝对路径和(可选)存储到phar的相对路径addFile("test.php");include("phar://yunke.phar/test.php") // in test.php?>这里出现的phar://就是访问phar文件的一种方法,所以不需要太在意。
以字符串添加文件内容
调用类方法
Phar::addFromString($localpath,$contents)
以字符串形式添加文件addFromString("test.php","");include("phar://yunke.phar/test.php"); // in test.php?>添加空目录调用类方法
Phar::addEmptyDir($dirname)
添加空目录,使用方法Phar::getContent()
获取文件结构addEmptyDir("test"); // yunke.phar/test/?>手动选择添加已有目录调用类方法
Phar::buildFromDirectory($dir,$pattern = "")
添加整个目录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闭合符与最后一个分号之间不能有多于一个的空格符。另外php闭合符也可省略。最短省略闭合符的stub是__HALT_COMPILER();?>运行Phar文件时,stub文件被当做一个meta文件来初始化Phar, 并告诉Phar文件在被调用时该做什么。
在我们的例子中,使用的是
createDefaultStub()
方法。其他的方式如下:
方法一:调用类方法
Phar::setStub($string)
为实例创建自定义stubsetStub("");include("phar://yunke.phar");// in stub!?>也可以
$phar->setStub($phar->createDefaultStub("index.php"));生成的缺省stub文件包含如下的代码:
createDefaultStub()
方法缺省创建的stub文件的内容很简单。Phar::mapPhar()
用来分析Phar文件的元数据,并初始化它。stub文件的结尾处需要调用__HALT_COMPILER()
方法,这个方法后不能留空格。__HALT_COMPILER()
会立即终止PHP的运行,防止include的文件在此方法后仍然执行。这是Phar必须的,没有它Phar将不能正常运行。除此之外,我们还可以创建自己的stub文件来执行自定义的初始化过程,像这样加载自定义文件
setStub(file_get_contents("stub.php"));方法二:使用默认stub,调用类方法
Phar::setDefaultStub()
为实例设置默认stub,使用方法Phar::getStub()
获取实例的stubsetDefaultStub(); print_r($phar->getStub()); // 2, "c" => "text/plain", "cc" => "text/plain", ...?>如果缺省创建stub,PHP会使用默认stub
getStub()); // 2, "c" => "text/plain", "cc" => "text/plain", ...?>4 phar文件的运行
我们在服务器根目录建立一个index.php文件来演示如何使用上面创建的phar文件,内容如下:
如果index.php文件中只有第一行,那么和不使用归档文件时,添加如下代码完全相同:
require "project/index.php";如果没有第二行,那么第三行的yunke()将提示未定义,所以可见require一个phar文件时并不是导入了里面所有的文件,而只是导入了入口执行文件而已,但在实际项目中往往在这个入口文件里导入其他需要使用的文件,在本例中入口执行文件为project/index.php。
补充:
可以为归档设置别名,别名保存在归档文件中永久保存,它可以用一个简短的名字引用归档,而不管归档文件在文件系统中存储在那里,设置别名:
$phar = new Phar("lib/yunke.phar", 0);$phar->setAlias ( "yun.phar");设置别名后可以如下使用:
如果在制作phar文件时没有指定别名,也可以在存根文件里面使用Phar::mapPhar("yunke.phar");指定。
5 phar文件的提取还原
我们有时候会好奇phar里面包含的文件源码,这个时候就需要将phar文件还原,如果只是看一看的话可以使用一些ide工具,比如phpstorm 10就能直接打开它,如果需要修改那么就需要提取操作了,为了演示,我们下载一个composer.phar放在服务器目录,在根目录建立一个get.php文件,内容如下
extractTo("composer"); //提取一份原项目文件$phar->convertToData(Phar::ZIP); //另外再提取一份,和上行二选一即可用浏览器访问这个文件,即可提取出来,以上列子展示了两种提取方式:
第二行将建立一个composer目录,并将提取出来的内容放入;
第三行将产生一个composer.zip文件,解压即可得到提取还原的项目文件。
至于phar://伪协议造成的服务器验证绕过:
推荐学习:《PHP视频教程》
以上就是PHP详细解析之phar的详细内容,更多请关注php中文网其它相关文章!