免责声明

• 本程序仅供于学习交流，请使用者遵守《中华人民共和国网络安全法》，勿将此工具用于非法操作，开发者不负任何连带法律责任。
  
• 如有任何侵权相关问题，请联系作者。
  
• 本工具仅面向合法授权的企业安全建设行为，如您需要测试本工具的可用性，请自行搭建测试环境。
  
• 在使用本工具进行时，您应确保该行为符合当地的法律法规，并且已经取得了足够的授权。

什么是unveilr?

unveilr 是一款小程序安全评估工具，支持小程序的代码审计和发现敏感信息泄露、接口未授权等安全问题

✅安装方法

环境配置

* node.js == 20.3.0
* npm == 9.6.7
* cnpm == 9.2.0

• 方法1：使用cnpm安装 （推荐，本仓库以此方法为基准）（不知为什么，npm有网络问题和版本冲突问题）

  cd /utils/unveilr
  //安装依赖
  cnpm install
  //构建项目
  cnpm run build
  //运行
  cd dist
  node index.js -h

• 方法2：打包为可执行文件（pkg在node20打包会出问题）

  //进入unveilr目录
  cd /utils/unveilr
  //安装pkg
  npm install -g pkg
  //打包为可执行文件
  pkg -t <win/linux> package.json -o <OUTPUT_NAME>
  

📝参数详解

• 子命令默认为 wx

子命令	参数	解释
	-l, --log-level <level>	设置日志等级 debug，info，warn，error 默认 info
	-v, --version	打印版本号并退出
wx	<packages...>	包的路径，可以是多个，也可以是一个目录
wx	-i, --appid <appid>	手动提供appid (仅在评估windows上的包时有效)
wx	-f, --format	格式化输出
wx	--no-clear-decompile	解析后的残留文件将不会被清除
wx	--no-clear-save	要保存的路径将不会被清除
wx	--no-parse	只提取文件，但不会解析
wx	-d, --depth <depth>	设置从目录中查找深度，默认: 1 设置为0时不限制深度
wx	-o, --output <path>	设置输出目录
wx	--clear-output	当输出目录不为空时程序将终止，提供该参数表示强制清空输出目录

💡提交问题

📝更改日志

💬其他说明

• 本程序现在使用的开源协议是 GPL-3.0
• 使用请标明出处，并遵循开源协议