Richkit

Richkit es un paquete de python3 que proporciona herramientas que toman un nombre de dominio como entrada y devuelven información adicional sobre ese dominio. Puede ser un análisis del dominio en sí, consultas desde bases de datos, recuperación de otros servicios o alguna combinación de estos.

El propósito de richkit es proporcionar una biblioteca reutilizable de funciones de análisis, consulta y recuperación relacionadas con nombres de dominio, que sean compartidas dentro del grupo de investigación de Seguridad de Redes de la Universidad de Aalborg, y también estén disponibles al público para su reutilización y modificación.

La documentación se encuentra en https://richkit.readthedocs.io/en/latest/.

Requisitos

• Python >= 3.5

Instalación

Para instalar richikit solo escribe en la terminal pip install richkit

Uso

Los siguientes códigos se pueden usar para recuperar el TLD y la categoría de la URL, respectivamente.

• Obteniendo el dominio de nivel superior efectivo de una URL dada:

  root@kitploit:~

  >>> from richkit.analyse import tld
  >>> urls = ["www.aau.dk","www.github.com","www.google.com"]
  >>>
  >>> for url in urls:
  ...     print(tld(url))
  dk
  com
  com
  
  

• Obteniendo la categoría de una URL dada:

  root@kitploit:~

  >>> from richkit.retrieve.symantec import fetch_from_internet
  >>> from richkit.retrieve.symantec import LocalCategoryDB
  >>>
  >>> urls = ["www.aau.dk","www.github.com","www.google.com"]
  >>>
  >>> local_db = LocalCategoryDB()
  >>> for url in urls:
  ...     url_category=local_db.get_category(url)
  ...     if url_category=='':
  ...         url_category=fetch_from_internet(url)
  ...     print(url_category)
  Education
  Technology/Internet
  Search Engines/Portals
  
  

Módulos

Richkit define un conjunto de funciones categorizadas por los siguientes módulos:

• richkit.analyse: Este módulo proporciona funciones que pueden aplicarse a un nombre de dominio. De manera similar a richkit.lookup, y a diferencia de richkit.retrieve, esto se hace sin divulgar el nombre de dominio a terceros y violando la confidencialidad.

• richkit.lookup: Este módulo proporciona la capacidad de consultar nombres de dominio en recursos locales, es decir, el nombre de dominio no puede enviarse a terceros. El módulo puede obtener recursos, como listas o bases de datos, pero esto debe hacerse de manera que el nombre de dominio se mantenga confidencial. Compárese con richkit.retrieve.

• richkit.retrieve: Este módulo proporciona la capacidad de recuperar datos de nombres de dominio de cualquier tipo. Viene sin el "contrato de confidencialidad" de richkit.lookup.

Ejecutar Pruebas en Docker

Para evitar cualquier problema relacionado con el entorno, proporcionamos el archivo Dockerfile.test que básicamente construye una imagen de Docker para ejecutar las pruebas de Richkit.

• Lo único que hay que añadir es MAXMIND_LICENCE_KEY en .github/local-test/run-test.sh en la línea 3. Es necesario para pasar los casos de prueba del módulo lookup.

Comandos para probarlos en el entorno Docker.

• docker build -t richkit-test -f Dockerfile.test . : Construye la imagen necesaria para ejecutar los casos de prueba

• docker run -e MAXMIND_LICENSE_KEY="<licence-key> " richkit-test : Ejecuta el archivo run-test.sh en la imagen de Docker.

Contribuir

Las contribuciones son más que bienvenidas.

Usamos la estrategia de ramificación gitflow, así que si planeas enviar una rama a este repositorio, por favor sigue esa estrategia. Ten en cuenta que probamos los nombres de las ramas con .githooks/check-branch-name.py. El hook de pre-commit de git se puede usar para verificar esto automáticamente al hacer commit. Un ejemplo que se puede usar directamente como se indica a continuación está disponible en Linux, y se puede habilitar así (asumiendo python>=3.6 y bash):

ln -s $(pwd)/.githooks/pre-commit.linux.sample $(pwd)/.git/hooks/pre-commit

Créditos

• Logo diseñado por indepedenthand