{
    "info": {
        "author": "Corelight",
        "author_email": "info@corelight.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: BSD License",
            "Programming Language :: Python :: 3 :: Only"
        ],
        "description": "\n.. _corelight-client:\n\n.. Version number is filled in automatically.\n.. |version| replace:: 1.5.4\n\n====================================\nCorelight Sensor Command Line Client\n====================================\n\n.. contents::\n\nOverview\n========\n\nThis tool provides a command-line client for the `Corelight Sensor\n<https://www.corelight.com>`_, a `Bro <https://www.bro.org>`_\nappliance engineered from the ground up by Bro's creators to transform\nnetwork traffic into high-fidelity data for your analytics pipeline.\nUsing the command-line client, you can configure and control a\nCorelight Sensor remotely through its comprehensive RESTful API. See\nthe Corelight Sensor documentation for an extended version of this\nclient overview.\n\n:Version: |version|\n:Home: http://www.corelight.com\n:GitHub: https://github.com/corelight/corelight-client\n:Author: `Corelight, Inc. <https://www.corelight.com>`_ <info@corelight.com>\n\nLicense\n=======\n\nThis client is open-source under a BSD license. See ``COPYING`` for\ndetails.\n\nInstallation\n============\n\nThe command-line client needs Python >= 3.4 with the ``requests``\nmodule installed as its main dependency.\n\nThe easiest way to install the client is through the Python Package\nIndex::\n\n    # pip3 install corelight-client\n\nAlternatively, you can install the latest version from GitHub::\n\n    # git clone https://github.com/corelight/corelight-client\n    # cd corelight-client\n    # python3 setup.py install\n\nIf everything is installed correctly, ``--help`` will give you a usage\nmessage::\n\n    # corelight-client --help\n    Usage: corelight-client [<global options>] <command> <subcommand> [<options>]\n              [--ssl-ca-cert SSL_CA_CERT] [--ssl-no-verify-certificate]\n              [--ssl-no-verify-hostname] [--cache CACHE]\n    [...]\n\nNote that initially, ``--help`` will not yet show you any further\ncommands to use. Proceed to the next section to let the client connect\nto your device.\n\nAccess and Authentication\n=========================\n\nYou need to enable access to the Corelight API through the device's\nconfiguration interface. You also need to set passwords for the API\nusers ``admin`` (for unlimited access) and ``monitor`` (for read-only\naccess). See the Corelight Sensor documentation for more information.\n\nNext, you need to tell the ``corelight-client`` the network address of\nyour Corelight Sensor. You have three choices for doing that:\n\n- Add ``-b <address>`` to the command-line.\n\n- Create a configuration file ``~/.corelight-client.rc`` with the content\n  ``device=<address>``.\n\n- Set the environment variable ``CORELIGHT_DEVICE=<address>``.\n\nIf that's all set up, ``corelight-client --help`` will now ask you for a\nusername and password, and then show you the full list of commands\nthat the device API enables the client to offer. If you confirm saving\nthe credentials, the client will store them in\n``~/.corelight-client/credentials`` for future reuse. You can also specify\nauthentication information through the `Configuration File`_ or as\n`Global Options`_.\n\n\nUsage\n=====\n\nThe client offers the API's functionality through a set of commands of\nthe format ``<command> <subcommand> [options]``. By adding ``--help``\nto any command, you get a description of all its functionality and\noptions.\n\nIf the ``--help`` output lists a command's option as being of type\n``file``, the client requires you to specify the path to a file to\nsend. In addition, you can prefix any option's value with ``file://``\nto read its content from a file instead of giving it on the\ncommand-line itself.\n\n(Note: The ``--help`` output will contain the list of commands only if\nthe client can connect, and authenticate, to the device.)\n\n.. _corelight-client-options:\n\nGlobal Options\n--------------\n\nThe ``corelight-client`` supports the following global command line\noptions. The ``--device`` and ``--fleet`` options should be used\nmutually exclusively from each other. All other options apply to all\nrequests:\n\n``--async``\n    Does not wait for asynchronous commands to complete before exiting.\n\n``--device``\n    Specifies the network address of a Corelight Sensor device.\n\n``--fleet``\n    Specifies the network address of a Corelight Fleet Manager.\n\n``--uid``\n    Specifies the UID of a Corelight Sensor managed through the\n    specified Corelight Fleet Manager.\n\n``--cache=<file>``\n    Sets a custom file for caching Corelight Sensor meta data.\n\n``--debug``\n    Enables debugging output showing HTTP requests and replies.\n\n``--password``\n    Specifies the password for authentication.\n\n``--mfa``\n    Specifies the 2FA verification code for authentication with the\n    specifed Corelight Fleet Manager. Use '-' to ask the user.\n\n``--ssl-ca-cert``\n    Specifies a file containing a custom SSL CA certificate for\n    validating the device's authenticity.\n\n``--ssl-no-verify-certificate``\n    Instructs the client to accept any Corelight Sensor SSL certificate.\n\n``--ssl-no-verify-hostname``\n    Instructs the client to accept the Corelight Sensor's SSL certificate\n    even if it does not match its hostname.\n\n``--socket``\n    Instructs the client to use a unix domain socket for sending requests.\n\n``--user``\n    Specifies the user name for authentication.\n\n``--version``\n    Displays the version of the ``corelight-client`` and exits.\n\n\n.. _corelight-client-config:\n\nConfiguration File\n==================\n\nThe ``corelight-client`` looks for a configuration file ``~/.corelight-client.rc``.\nThe file must consist of lines ``<key>=<value>``. Comments starting\nwith ``#`` are ignored. ``corelight-client`` support the following keys:\n\n``device``\n    The network address of a Corelight Sensor device.\n\n``fleet``\n    The network address of a Corelight Fleet Manager.\n\n``uid``\n    The UID of a Corelight Sensor managed through the specified Corelight Fleet Manager.\n\n``user``\n    The user name for authentication.\n\n``password``\n    The password for authentication.\n\n``mfa``\n    The 2FA verification code for authentication with a Corelight\n    Fleet Manager. Use '-' to ask the user.\n\n``ssl-ca-cert``\n    A file containing a custom SSL CA certificate for validating the device's\n    authenticity.\n\n``ssl-no-verify-certificate``\n    If set to ``false``, the client will accept any Corelight Sensor's SSL\n    certificate.\n\n``ssl-no-verify-hostname``\n    If set to ``false``, the client will accept the Corelight Sensor's SSL\n    certificate even if it does not match its hostname.\n\n``socket``\n    A unix domain socket to use for sending requests.\n\n\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/corelight/corelight-client",
        "keywords": "",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "corelight-client",
        "package_url": "https://pypi.org/project/corelight-client/",
        "platform": "",
        "project_url": "https://pypi.org/project/corelight-client/",
        "project_urls": {
            "Homepage": "https://github.com/corelight/corelight-client"
        },
        "release_url": "https://pypi.org/project/corelight-client/1.5.4/",
        "requires_dist": [
            "requests (!=2.17.1,!=2.17.2,>=2.9.1)"
        ],
        "requires_python": "",
        "summary": "Corelight API client",
        "version": "1.5.4"
    },
    "last_serial": 5387626,
    "releases": {
        "1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e73b6569946685cfa0fc96e6afeaf746",
                    "sha256": "ab6dd83153075939170aef0ac9b28cc0458d1f504c30acb389f7431a1ed0739c"
                },
                "downloads": -1,
                "filename": "corelight_client-1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e73b6569946685cfa0fc96e6afeaf746",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 32936,
                "upload_time": "2017-10-05T22:18:23",
                "url": "https://files.pythonhosted.org/packages/10/b8/0ac67529a43dd12f469aee43f46a851e5c30433e016129757a275bafdb39/corelight_client-1.1-py3-none-any.whl"
            }
        ],
        "1.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ae27980c46c13e10f8acb75d16e86a46",
                    "sha256": "79b06f194acb7f36bce8cc0091290795e44d5b4131923c2c4e49c631e41e502d"
                },
                "downloads": -1,
                "filename": "corelight_client-1.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ae27980c46c13e10f8acb75d16e86a46",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 32971,
                "upload_time": "2017-10-12T17:37:05",
                "url": "https://files.pythonhosted.org/packages/63/f8/2ae218f3b16345f92215bb011c874e6b7fe9e97d15005de94005b83aed3d/corelight_client-1.1.1-py3-none-any.whl"
            }
        ],
        "1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6894294255d13c78031fcf8fa1a66fa3",
                    "sha256": "760b74281c5ec998f90ba085fb03a0dbb40a99a2ec56eca054840d47052241d0"
                },
                "downloads": -1,
                "filename": "corelight_client-1.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6894294255d13c78031fcf8fa1a66fa3",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 34055,
                "upload_time": "2018-02-15T16:29:53",
                "url": "https://files.pythonhosted.org/packages/96/48/4c5ae36f34877bb7763ac5bd89f5a945b4b642d08bfa1d1cbb1e9d211bcd/corelight_client-1.2-py3-none-any.whl"
            }
        ],
        "1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c58c4100a5e233f2e03d999bdb7a90ac",
                    "sha256": "9900171d264a431100d62a8d8b2af1b30d72ba2b5c4853de6d49e75aec472c65"
                },
                "downloads": -1,
                "filename": "corelight_client-1.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c58c4100a5e233f2e03d999bdb7a90ac",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 32104,
                "upload_time": "2018-10-20T01:16:21",
                "url": "https://files.pythonhosted.org/packages/d7/ea/0ee4fd40bdf8465c8b027d0ff87cc62c81c6092547851d96f387d934d12e/corelight_client-1.3-py3-none-any.whl"
            }
        ],
        "1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4926f8b7f52b4ab16f06785432983ce5",
                    "sha256": "79c0502b20f7460233feed41f0500918c0defc8791c734dfe8a833e3e9f4f9b2"
                },
                "downloads": -1,
                "filename": "corelight_client-1.5-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "4926f8b7f52b4ab16f06785432983ce5",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 43571,
                "upload_time": "2019-05-01T18:04:07",
                "url": "https://files.pythonhosted.org/packages/3a/a5/dc3cef677381e2166453f45555ea7ca6cf0bb13d6d1914533d892dca4de0/corelight_client-1.5-py3-none-any.whl"
            }
        ],
        "1.5.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0e94beb1bbff6e8dac2cab8126049365",
                    "sha256": "97b67ec22f1c19bad516be2693a7dac527931f78b61c6ab1de7c1ed9da91fa5e"
                },
                "downloads": -1,
                "filename": "corelight_client-1.5.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0e94beb1bbff6e8dac2cab8126049365",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 46738,
                "upload_time": "2019-06-11T18:03:46",
                "url": "https://files.pythonhosted.org/packages/6d/70/c97837fc7043dedeef3fe3202657c779e27a3bfbe4ac8900f05cb5e93f4e/corelight_client-1.5.4-py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "0e94beb1bbff6e8dac2cab8126049365",
                "sha256": "97b67ec22f1c19bad516be2693a7dac527931f78b61c6ab1de7c1ed9da91fa5e"
            },
            "downloads": -1,
            "filename": "corelight_client-1.5.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0e94beb1bbff6e8dac2cab8126049365",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 46738,
            "upload_time": "2019-06-11T18:03:46",
            "url": "https://files.pythonhosted.org/packages/6d/70/c97837fc7043dedeef3fe3202657c779e27a3bfbe4ac8900f05cb5e93f4e/corelight_client-1.5.4-py3-none-any.whl"
        }
    ]
}