Finished readme

Author: exploit

CFGGenerator.php

@@ -1067,16 +1067,15 @@ public function sinkTracebackBlock($argName,$block,$flowsNum){
 // echo "<pre>" ;
 
 
-// // //从用户那接受项目路径
-// // $project_path = 'E:/School_of_software/information_security/PHPVulScanner_project/simple-log_v1.3.12/upload/';
-// // $project_path = "D:/MySoftware/wamp/www/code/phpvulhunter/test/test.php" ;
-// // $project_path = "E:/School_of_software/information_security/PHPVulScanner_project/74cms_3.3/" ;
-// // $allFiles = FileUtils::getPHPfile($project_path);
-
-// // //初始化
-// // $initModule = new InitModule() ;
-// // $initModule->init($project_path, $allFiles) ;
+// //从用户那接受项目路径
+// $project_path = 'E:/School_of_software/information_security/PHPVulScanner_project/simple-log_v1.3.12/upload/';
+// $project_path = "D:/MySoftware/wamp/www/code/phpvulhunter/test" ;
+// //$project_path = "E:/School_of_software/information_security/PHPVulScanner_project/74cms_3.3/" ;
+// $allFiles = FileUtils::getPHPfile($project_path);
 
+// //初始化
+// $initModule = new InitModule() ;
+// $initModule->init($project_path, $allFiles) ;
 
 // $cfg = new CFGGenerator() ;
 // $visitor = new MyVisitor() ;
@@ -1094,7 +1093,6 @@ public function sinkTracebackBlock($argName,$block,$flowsNum){
 // $pEntryBlock->is_entry = true ;
 // $ret = $cfg->CFGBuilder($nodes, NULL, NULL, NULL) ;
 
-// echo '456';
 
 
 ?>

FileSummaryGenerator.php

@@ -8,7 +8,7 @@ class FileSummaryGenerator {
      * @return array(fileSummarys)
      */
     public static function getIncludeFilesDataFlows($fileSummary){
-        if (is_object($fileSummary)){
+        if (!is_object($fileSummary)){
             return;
         }
         //1.得到include files
@@ -29,7 +29,6 @@ public static function getIncludeFilesDataFlows($fileSummary){
                 //查看此文件是否有include文件
                 $pRetFiles = self::getIncludeFilesDataFlows($ret);
                 $retFileSummary = array_merge($pRetFiles, $retFileSummary);
-                
                 $retFileSummary = array_merge(array($ret), $retFileSummary);
             }else{
                 $includeFileSummary = self::getFileSummary($absPath);

README.md

@@ -1,6 +1,45 @@
 # phpvulhunter
-A tool that can scan php vulnerabilities automatically using static analysis methods
-------
-##Email
+phpvulhunter是一款PHP源码自动化审计工具，通过这个工具，可以对一些开源CMS进行自动化的代码审计，并生成漏洞报告。
+##安装
+首先从github上进行获取：
+
+```
+git clone https://github.com/OneSourceCat/phpvulhunter
+```
+
+下载完成后，将工程目录放置于WAMP等PHP-Web运行环境中即可访问`main.php`：
+
+```
+http://127.0.0.1/phpvulhunter/main.php
+```
+##使用
+搭建好环境，访问main.php后，效果如下：
+![](http://7xjb22.com1.z0.glb.clouddn.com/mainpage.png)
+
+有几个参数需要填写：
+> * Project Path:需要扫描的工程绝对路径（文件夹）
+> * File Path：需要扫描的文件绝对路径（文件或者文件夹）
+> * Vuln Turp：扫描的漏洞类型，默认为ALL
+> * Encoding：CMS的编码类型
+
+如果需要扫描整个工程，则`Project Path`与`File Path`填写一致即可。对于大的工程，由于代码量较多且内部引用复杂，所以可能会占用较多的CPU资源、花费较长的时间才能扫描完成。
+
+配置好参数之后，点击`scan`按钮即可进行扫描，扫描中效果如下：
+![](http://7xjb22.com1.z0.glb.clouddn.com/scanning.png)
+##扫描报告
+扫描完成后，就会生成扫描报告，具体如下：
+![](http://7xjb22.com1.z0.glb.clouddn.com/report1.png)
+相关参数含义如下：
+> * File Path:出现漏洞的文件绝对路径
+> * Vlun Type:漏洞的类型
+> * Sink Call:危险函数调用的位置
+> * Sensitive Arg:最后跟踪到的危险参数
+
+查看代码时，点击`Code Viewer`即可：
+![](http://7xjb22.com1.z0.glb.clouddn.com/report2.png)
+##关于Bug和维护
+由于作者马上面临实习，单靠个人精力已无力继续维护下去，因此可能会在扫描中出现bug。如果你有兴趣和足够的精力继续扩展与修正，并有信心能够应对大量繁琐的调试与扩展工作，请联系下面的邮箱索要详细的设计与实现文档。
+
 Exploit:exploitcat@foxmail.com
+
 xyw55:xyw5255@163.com

analyser/TaintAnalyser.class.php

@@ -1,4 +1,5 @@
 <?php
+
 require_once 'SqliAnalyser.class.php';
 require_once 'XssAnalyser.class.php';
 require_once 'FileAffectAnalyser.class.php';
@@ -9,7 +10,9 @@
 require_once 'IncludeAnalyser.class.php';
 require_once 'LDPAAnalyser.class.php';
 require_once 'XPathAnalyser.class.php';
+
 use PhpParser\Node ;
+
 /**
  * 用于污点分析的类
  * 污点分析的任务：
@@ -217,14 +220,17 @@ public function currBlockTaintHandler($block,$node,$argName,$fileSummary, $flowN
 					$varName = $this->getVarName($var) ;
 					//如果var右边有source项
 					if(in_array($varName, $this->sourcesArr)){
+// 					    $ret = $this->multiFileHandler($block, $varName, $node, $fileSummary) ;
+// 					    if($ret == 'safe'){
+// 					        continue ;
+// 					    }
 						//报告漏洞
 						$path = $fileSummary->getPath() ;
 						$this->report($path, $path, $node, $flow->getLocation(), $type) ;
 						continue ;
 					}else{				
 						//首先进行文件夹的分析
 						$this->multiFileHandler($block, $varName, $node, $fileSummary) ;
-						
 						//文件间分析失败，递归
 						$this->currBlockTaintHandler($block, $node, $varName, $fileSummary, $flowNum) ;
 					}
@@ -515,7 +521,6 @@ public function multiFileHandler($block, $argName, $node, $fileSummary,$flowNum=
 					        $type = TypeUtils::getTypeByFuncName(NodeUtils::getNodeFunctionName($node)) ;
 					        $encodingArr = $target->getEncoding() ;
 					        $saniArr =  $target->getSanitization() ;
-					    
 					        $res = $this->isSanitization($type, $target, $saniArr, $encodingArr) ;
 					        if($res == true){
 					            return "safe" ;

context/InitModule.class.php

@@ -12,10 +12,8 @@ class InitModule {
      * @param string $project_path
      */    
     public function init($project_path, $allFiles){
-        
         $this->initContext($project_path);
         $context = Context::getInstance() ;
-        
         $this->initFileSummaryContext($project_path, $allFiles) ;
     }
     /**

context/ResultContext.class.php

@@ -62,7 +62,16 @@ public function getResArr() {
 		return $this->resArr;
 	}
 
-	//--------------------单例模式---------------------------------
+	
+	/**
+     * @param multitype: $resArr
+     */
+    public function setResArr($resArr)
+    {
+        $this->resArr = $resArr;
+    }
+
+ //--------------------单例模式---------------------------------
 	private function __construct(){}
 
 	private function __clone(){}