diario-commandline-client

• 这是什么？
• 前提条件
• 安装
• 项目设置
• 用法

这是什么？

一个用于简化批量 diario API 调用的实用工具仓库。目前以下功能已完全实现：

• 上传单个文件（PDF 或 Microsoft Office 文档）
• 上传完整目录的文件
• 查询单个哈希值
• 查询一批哈希值（从单个文件读取）

如何获取 DIARIO 账户

发送邮件至 [email protected]

警告与免责声明

尽管 DIARIO 理论上只会上传文档的一部分至我们的服务器——从而保护您的隐私（更多信息：https://diario.elevenpaths.com）——但本脚本会上传完整文档，因为假设它将用于恶意软件分析。如果您希望上传一批文档并仅上传部分内容以保护隐私，请使用我们带有用户界面的 Windows/Linux/Mac 客户端。可从 https://diario.elevenpaths.com 获取。

前提条件

• 您正在使用 Python 3.x
• 您已安装并配置 virtualenv 和 virtualenvwrapper

安装

cd diario-commandline-client
mkvirtualenv -p `which python3` diario-commandline-client
pip install -r requirements.txt

项目设置

确保虚拟环境已激活，若未激活，请运行 workon diario-bulk。

首先，您需要从 diario 管理门户创建一个 API 客户端，操作后会生成 app_id 和 secret。我们建议您使用环境变量存储这些信息，分别对应 API_CLIENT_APP_ID 和 API_CLIENT_SECRET。

您可以通过虚拟环境目录 bin 中的钩子 postactivate 和 predeactivate 来实现。如果虚拟环境已激活，可使用 cdvirtualenv 进入虚拟环境目录。

	# 此钩子在该虚拟环境激活后执行
	export API_CLIENT_APP_ID=XXXXXXXX
	export API_CLIENT_SECRET=XXXXXXXX

	# 此钩子在该虚拟环境停用前执行
	unset API_CLIENT_APP_ID
	unset API_CLIENT_SECRET

如果您更倾向于不使用推荐的环境变量，也可以将 app_id 和 secret 作为参数传递给脚本。脚本参数优先级高于任何环境变量。

用法

• 获取脚本使用帮助：

注意：凡指定 处，必须包含协议头（https://）

upload.py -h

gethash.py -h

• 上传单个文档（无需指定文件类型）：

./upload.py -f <路径至文件>

• 上传目录（同样无需指定文件类型）：

./upload.py -d <路径至目录>

• 查询单个哈希值：

./gethash.py --hash <哈希值>

• 从索引文件查询多个哈希值（无需指定文件类型）：

./gethash.py -f <包含哈希值的文件>

• 查询多个哈希值并将结果保存到文件而非标准输出：

./gethash.py -f <包含哈希值的文件> -l <日志文件>

• 将 diario 的 app_id 和 secret 作为参数提供（适用于所有脚本）。以下是一个上传示例：

./upload.py -s <diario_secret> -a <diario_client_id> -d <路径至目录>

文件和文件夹的参数可以是相对路径或绝对路径