Skip to content
KitploitKITPLOIT
工具漏洞利用博客
Log in
提交
工具漏洞利用博客
提交

黑客、渗透测试和网络安全工具,武装您的安全武器库!

Kitploit 是一个黑客、网络安全和渗透测试工具的目录。发现最新的项目更新,查找漏洞、分析系统、自动化测试并加强你的安全。

订阅源联系隐私© 2026 Kitploit

工具目录

分类

查看所有分类
Loading categories
corelight-client — Corelight Sensor API command-line client | Kitploit
工具/GitHubGitHub/corelight/corelight-client
Authentication & AuthorizationDefensive ToolsNetwork SecurityUtilities & FrameworksAPI Security
GitHubcorelight/corelight-client

corelight-client

Corelight Sensor API command-line client

查看仓库
176406天前尚未审核
分享
内容在请求的语言中不可用。显示英文版本。

.. _corelight-client:

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

==================================== Corelight Sensor Command Line Client

.. contents::

Overview

This tool provides a command-line client for the Corelight Sensor <https://www.corelight.com>, a Bro <https://www.bro.org> appliance engineered from the ground up by Bro's creators to transform network traffic into high-fidelity data for your analytics pipeline. Using the command-line client, you can configure and control a Corelight Sensor remotely through its comprehensive RESTful API. See the Corelight Sensor documentation for an extended version of this client overview.

:Version: |version| :Home: http://www.corelight.com :GitHub: https://github.com/corelight/corelight-client :Author: Corelight, Inc. <https://www.corelight.com>_ [email protected]

License

This client is open-source under a BSD license. See COPYING for details.

Installation

The command-line client needs Python >= 3.4 with the requests module installed as its main dependency.

The easiest way to install the client is through the Python Package Index::

# pip3 install corelight-client

Alternatively, you can install the latest version from GitHub::

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

If everything is installed correctly, --help will give you a usage message::

# 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]
[...]

Note that initially, --help will not yet show you any further commands to use. Proceed to the next section to let the client connect to your device.

Access and Authentication

You need to enable access to the Corelight API through the device's configuration interface. You also need to set passwords for the API users admin (for unlimited access) and monitor (for read-only access). See the Corelight Sensor documentation for more information.

Next, you need to tell the corelight-client the network address of your Corelight Sensor. You have three choices for doing that:

  • Add -b <address> to the command-line.

  • Create a configuration file ~/.corelight-client.rc with the content device=<address>.

  • Set the environment variable CORELIGHT_DEVICE=<address>.

If that's all set up, corelight-client --help will now ask you for a username and password, and then show you the full list of commands that the device API enables the client to offer. If you confirm saving the credentials, the client will store them in ~/.corelight-client/credentials for future reuse. You can also specify authentication information through the Configuration File_ or as Global Options_.

Usage

The client offers the API's functionality through a set of commands of the format <command> <subcommand> [options]. By adding --help to any command, you get a description of all its functionality and options.

If the --help output lists a command's option as being of type file, the client requires you to specify the path to a file to send. In addition, you can prefix any option's value with file:// to read its content from a file instead of giving it on the command-line itself.

(Note: The --help output will contain the list of commands only if the client can connect, and authenticate, to the device.)

.. _corelight-client-options:

Global Options

The corelight-client supports the following global command line options. The --device and --fleet options should be used mutually exclusively from each other. All other options apply to all requests:

--async Does not wait for asynchronous commands to complete before exiting.

--device Specifies the network address of a Corelight Sensor device.

--fleet Specifies the network address of a Corelight Fleet Manager.

--uid Specifies the UID of a Corelight Sensor managed through the specified Corelight Fleet Manager.

--cache=<file> Sets a custom file for caching Corelight Sensor meta data.

--debug Enables debugging output showing HTTP requests and replies.

--password Specifies the password for authentication.

--mfa Specifies the 2FA verification code for authentication with the specifed Corelight Fleet Manager. Use '-' to ask the user.

--ssl-ca-cert Specifies a file containing a custom SSL CA certificate for validating the device's authenticity.

--ssl-no-verify-certificate Instructs the client to accept any Corelight Sensor SSL certificate.

--ssl-no-verify-hostname Instructs the client to accept the Corelight Sensor's SSL certificate even if it does not match its hostname.

--socket Instructs the client to use a unix domain socket for sending requests.

--user Specifies the user name for authentication.

--version Displays the version of the corelight-client and exits.

--ignore-meta Do not send metadata info to sensor API call, unless it's specified on CLI.

--automation Enables a bundle of automation-friendly behavior: request timeouts, transient-failure retries, structured JSON errors, the curated exit-code taxonomy, and strict non-interactive confirmation. See Automation_ below for details. Can also be enabled by setting the environment variable CORELIGHT_AUTOMATION=1.

--timeout Sets the request timeout in seconds, either as a single number N (applied to both connect and read) or as connect,read. Defaults to 10,3600 when --automation is enabled.

--retries Sets the number of retries to attempt for transient failures (connection errors, and HTTP 429/502/503/504 for idempotent requests). Defaults to 3 when --automation is enabled, 0 otherwise.

--retry-max-time Sets the maximum total number of seconds to spend on retries. Defaults to 120 when --automation is enabled.

--error-format Sets the output/error format to text or json. Defaults to json when --automation is enabled, text otherwise.

--assume-yes Proceeds through confirmation-gated operations without prompting (alias: --confirm). Required to perform destructive operations while --automation is enabled; otherwise those operations fail with a confirmation-required error.

Automation

Passing --automation (or setting CORELIGHT_AUTOMATION=1) enables a bundle of automation-friendly behaviors and turns on the exit-code taxonomy below. It implies --noblock and defaults to a 10s connect / 3600s read timeout, 3 retries (capped at 120s total), and JSON output for both success and error. Each piece can be overridden with its own flag.

Without --automation there is no request timeout at all (the client blocks indefinitely), so enabling it never shortens a timeout that existed before. The default read timeout is deliberately long: it is meant only to bound a wedged connection, not to cap normal work. Some operations, such as large uploads, can legitimately take many minutes, and the read timeout applies per network read rather than to the whole transfer, so a steady upload keeps resetting it. Lower --timeout if you want automation to give up faster, or raise it for an unusually large transfer over a slow link.

下载工具

最受欢迎

查看全部 →

发现我们社区最常用的工具。

  • 1

    OsintHunter

    letox4/osinthunter

    🎯 终极 OSINT 工具包:调查图谱、置信度评分、别名家族、地图、时间线和报告。49 个模块、400+ 个站点,无需 API 密钥。

    891
  • 2

    ghostlock-app

    yukonga/ghostlock-app

    GhostLock 一键执行应用(CVE-2026-43499)

    547
  • 3

    ARTEX

    baarai/artex

    基于LLM的多智能体自主渗透测试平台,具备规划器/执行器智能体、资产与探索图谱、MITM流量记录以及漏洞复测功能。

    369
  • 4

    redforge

    cybersecurity91/redforge

    浏览器端红队工具包,包含 102 个离线工具,用于侦察、载荷生成、凭据攻击、加密、编码和交战报告。

    366
  • 5

    looking-glass

    anonghosty/looking-glass

    CSIRT 平台,可将 Shadowserver 报告导入 MongoDB,并将其重放为交互式地图、分析、发现、公告和高管仪表板。

    309
  • 6

    CyberStrikeAI

    ed1s0nz/cyberstrikeai

    AI原生网络安全的行动系统——在这里,意图转化为受治理的执行,证据沉淀为运营记忆,每一次操作都让下一次更出色。

    282

探索所有工具

浏览我们的工具集合

查看所有工具 →