.. _corelight-client:

.. Version number is filled in automatically. .. |version| replace:: 1.5.17

==================================== Cliente de línea de comandos de Corelight Sensor

.. contents::

Resumen

Esta herramienta proporciona un cliente de línea de comandos para el Sensor Corelight <https://www.corelight.com>, un dispositivo Bro <https://www.bro.org> diseñado desde cero por los creadores de Bro para transformar el tráfico de red en datos de alta fidelidad para su canal de análisis. Con el cliente de línea de comandos, puede configurar y controlar un Sensor Corelight de forma remota a través de su completa API RESTful. Consulte la documentación del Sensor Corelight para obtener una versión ampliada de esta descripción general del cliente.

:Versión: |version| :Página principal: http://www.corelight.com :GitHub: https://github.com/corelight/corelight-client :Autor: Corelight, Inc. <https://www.corelight.com>_ [email protected]

Licencia

Este cliente es de código abierto bajo una licencia BSD. Consulte COPYING para obtener más detalles.

Instalación

El cliente de línea de comandos necesita Python >= 3.4 con el módulo requests instalado como su principal dependencia.

La forma más sencilla de instalar el cliente es a través del Python Package Index::

# pip3 install corelight-client

Alternativamente, puede instalar la última versión desde GitHub::

# git clone https://github.com/corelight/corelight-client
# cd corelight-client
# python3 setup.py install

Si todo está instalado correctamente, --help le mostrará un mensaje de uso::

# corelight-client --help
Usage: corelight-client [<global options>] <command> <subcommand> [<options>]
          [--ssl-ca-cert SSL_CA_CERT] [--ssl-no-verify-certificate]
          [--ssl-no-verify-hostname] [--cache CACHE]
[...]

Tenga en cuenta que inicialmente, --help no le mostrará todavía ningún comando adicional para usar. Continúe con la siguiente sección para permitir que el cliente se conecte a su dispositivo.

Acceso y autenticación

Debe habilitar el acceso a la API de Corelight a través de la interfaz de configuración del dispositivo. También debe establecer contraseñas para los usuarios de la API admin (para acceso ilimitado) y monitor (para acceso de solo lectura). Consulte la documentación del Sensor Corelight para obtener más información.

A continuación, debe indicar al corelight-client la dirección de red de su Sensor Corelight. Tiene tres opciones para hacerlo:

• Añada -b <address> a la línea de comandos.

• Cree un archivo de configuración ~/.corelight-client.rc con el contenido device=<address>.

• Establezca la variable de entorno CORELIGHT_DEVICE=<address>.

Si todo está configurado, corelight-client --help le pedirá ahora un nombre de usuario y una contraseña, y luego le mostrará la lista completa de comandos que la API del dispositivo permite ofrecer al cliente. Si confirma guardar las credenciales, el cliente las almacenará en ~/.corelight-client/credentials para su reutilización futura. También puede especificar la información de autenticación mediante el Archivo de configuración_ o como Opciones globales_.

Uso

El cliente ofrece la funcionalidad de la API mediante un conjunto de comandos con el formato <command> <subcommand> [options]. Al añadir --help a cualquier comando, obtiene una descripción de toda su funcionalidad y opciones.

Si la salida de --help indica que la opción de un comando es de tipo file, el cliente requiere que especifique la ruta a un archivo para enviar. Además, puede prefijar el valor de cualquier opción con file:// para leer su contenido desde un archivo en lugar de proporcionarlo en la propia línea de comandos.

(Nota: La salida de --help contendrá la lista de comandos solo si el cliente puede conectarse y autenticarse en el dispositivo).

.. _corelight-client-options:

Opciones globales

El corelight-client admite las siguientes opciones globales de línea de comandos. Las opciones --device y --fleet deben usarse de manera mutuamente excluyente entre sí. Todas las demás opciones se aplican a todas las solicitudes:

--async No espera a que los comandos asíncronos se completen antes de salir.

--device Especifica la dirección de red de un dispositivo Sensor Corelight.

--fleet Especifica la dirección de red de un Corelight Fleet Manager.

--uid Especifica el UID de un Sensor Corelight administrado a través del Corelight Fleet Manager especificado.

--cache=<file> Establece un archivo personalizado para almacenar en caché los metadatos del Sensor Corelight.

--debug Habilita la salida de depuración que muestra las solicitudes y respuestas HTTP.

--password Especifica la contraseña para la autenticación.

--mfa Especifica el código de verificación 2FA para la autenticación con el Corelight Fleet Manager especificado. Use '-' para preguntar al usuario.

--ssl-ca-cert Especifica un archivo que contiene un certificado SSL CA personalizado para validar la autenticidad del dispositivo.

--ssl-no-verify-certificate Indica al cliente que acepte cualquier certificado SSL del Sensor Corelight.

--ssl-no-verify-hostname Indica al cliente que acepte el certificado SSL del Sensor Corelight incluso si no coincide con su nombre de host.

--socket Indica al cliente que utilice un socket de dominio unix para enviar solicitudes.

--user Especifica el nombre de usuario para la autenticación.

--version Muestra la versión de corelight-client y sale.

--ignore-meta No envíe información de metadatos a la llamada de API del sensor, a menos que se especifique en la CLI.

.. _corelight-client-config:

Archivo de configuración

El corelight-client busca un archivo de configuración ~/.corelight-client.rc. El archivo debe consistir en líneas <key>=<value>. Los comentarios que comienzan con # se ignoran. corelight-client admite las siguientes claves:

device La dirección de red de un dispositivo Sensor Corelight.

fleet La dirección de red de un Corelight Fleet Manager.

uid El UID de un Sensor Corelight administrado a través del Corelight Fleet Manager especificado.

user El nombre de usuario para la autenticación.

password La contraseña para la autenticación.

mfa El código de verificación 2FA para la autenticación con un Corelight Fleet Manager. Use '-' para preguntar al usuario.

ssl-ca-cert Un archivo que contiene un certificado SSL CA personalizado para validar la autenticidad del dispositivo.

ssl-no-verify-certificate Si se establece en false, el cliente aceptará cualquier certificado SSL del Sensor Corelight.

ssl-no-verify-hostname Si se establece en false, el cliente aceptará el certificado SSL del Sensor Corelight incluso si no coincide con su nombre de host.

socket Un socket de dominio unix para usar en el envío de solicitudes.