diario-commandline-client

• ¿Qué es esto?
• Supuestos
• Instalación
• Configuración del proyecto
• Uso

¿Qué es esto?

Un repositorio de utilidades creado para facilitar el consumo masivo de la API de diario. Actualmente estas funciones están totalmente implementadas:

• Subir un archivo (documento PDF o Microsoft Office)
• Subir un directorio completo de archivos
• Consultar un único hash
• Consultar una lista de hashes (desde un único archivo)

¿Cómo obtengo una cuenta DIARIO?

Escribe un correo electrónico a [email protected]

Advertencia y descargo de responsabilidad

Aunque se supone que DIARIO sube solo una parte del documento a nuestros servidores —para que puedas estar seguro de que tu privacidad se conserva (más información: https://diario.elevenpaths.com)— este script sube el documento completo porque se asume que se utilizará para análisis de malware. Si deseas subir un lote de documentos y mantener tu privacidad subiendo solo una parte, utiliza nuestro cliente para Windows/Linux/Mac con interfaz de usuario. Está disponible en https://diario.elevenpaths.com

Supuestos

• Estás usando Python 3.x
• Tienes virtualenv y virtualenvwrapper instalados y funcionando.

Instalación

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

Configuración del proyecto

Asegúrate de que el virtualenv esté activado; si no lo está, ejecuta workon diario-bulk.

Primero necesitarás crear un cliente API desde el portal de administración de diario; al hacerlo se generarán un app_id y un secret. Recomendamos que utilices variables de entorno para almacenar esa información: API_CLIENT_APP_ID y API_CLIENT_SECRET, respectivamente.

Puedes hacerlo utilizando los hooks de virtualenv postactivate y predeactivate ubicados en 'bin' dentro de tu carpeta de virtualenv. Si tienes el virtualenv activado, puedes desplazarte a tu carpeta de virtualenv usando 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

Si prefieres no usar las variables de entorno recomendadas, puedes pasar tanto el app_id como el secret como argumentos al script. Los argumentos del script tendrán prioridad sobre cualquier variable de entorno encontrada.

Uso

• Obtener ayuda sobre el uso de los scripts:

Recuerda: donde se indique , el protocolo es obligatorio (https://)

upload.py -h

gethash.py -h

• Subir un único documento (no es necesario indicar el tipo de archivo):

./upload.py -f <path_to_file>

• Subir un directorio (de nuevo, no es necesario indicar el tipo de archivo):

./upload.py -d <path_to_directory>

• Consultar un único hash:

./gethash.py --hash <hash>

• Consultar múltiples hashes desde un archivo índice (de nuevo, no es necesario indicar el tipo de archivo):

./gethash.py -f <file_with_hashes>

• Consultar múltiples hashes y guardar los resultados en un archivo en lugar de en stdout

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

• Proporcionar app_id y secret de diario como argumentos (funciona en cualquier script). Veamos un ejemplo de subida

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

Los argumentos para archivos y carpetas pueden ser rutas relativas o absolutas