diario-commandline-client

• Что это?
• Предположения
• Установка
• Настройка проекта
• Использование

Что это?

Вспомогательный репозиторий, созданный для упрощения пакетного использования API diario. В настоящее время полностью реализованы следующие функции:

• Загрузка файла (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.

Сначала вам нужно создать API-клиент в административном портале diario — это позволит сгенерировать app_id и secret. Мы рекомендуем хранить эту информацию в переменных окружения API_CLIENT_APP_ID и API_CLIENT_SECRET соответственно.

Это можно сделать с помощью хуков virtualenv postactivate и predeactivate, расположенных в 'bin' внутри вашей папки виртуальной среды. Если виртуальная среда активирована, вы можете перейти в её папку с помощью cdvirtualenv.

	# This hook is sourced after this virtualenv is activated.
	export API_CLIENT_APP_ID=XXXXXXXX
	export API_CLIENT_SECRET=XXXXXXXX

	# This hook is sourced before this virtualenv is deactivated.
	unset API_CLIENT_APP_ID
	unset API_CLIENT_SECRET

Если вы предпочитаете не использовать рекомендуемые переменные окружения, вы можете передать и app_id, и secret скрипту в качестве аргументов. Аргументы скрипта будут иметь приоритет над любыми найденными переменными окружения.

Использование

• Получите справку по использованию скриптов:

Помните: где указан , обязательно указывать протокол (https://)

upload.py -h

gethash.py -h

• Загрузка одного документа (указывать тип файла не обязательно):

./upload.py -f <path_to_file>

• Загрузка каталога (опять же, указывать тип файла не обязательно):

./upload.py -d <path_to_directory>

• Запрос одного хеша:

./gethash.py --hash <hash>

• Запрос нескольких хешей из индексного файла (опять же, указывать тип файла не обязательно):

./gethash.py -f <file_with_hashes>

• Запрос нескольких хешей с сохранением результатов в файл вместо stdout

./gethash.py -f <file_with_hashes> -l <logfile>

• Передача app_id и secret diario в качестве аргументов (работает в любом скрипте). Рассмотрим пример загрузки

./upload.py -s <diario_secret> -a <diario_client_id> -d <path_to_directory>

Аргументы для файлов и папок могут быть относительными или абсолютными путями