.. _corelight-client:

.. संस्करण संख्या स्वचालित रूप से भरी जाती है। .. |version| replace:: 1.5.17

==================================== Corelight सेंसर कमांड लाइन क्लाइंट

.. contents::

अवलोकन

यह टूल Corelight सेंसर <https://www.corelight.com>_ के लिए एक कमांड-लाइन क्लाइंट प्रदान करता है, जो Bro <https://www.bro.org>_ उपकरण है जिसे Bro के निर्माताओं द्वारा शुरू से इस तरह इंजीनियर किया गया है कि यह नेटवर्क ट्रैफ़िक को आपके विश्लेषण पाइपलाइन के लिए उच्च-गुणवत्ता वाले डेटा में बदल दे। कमांड-लाइन क्लाइंट का उपयोग करके, आप अपने व्यापक RESTful API के माध्यम से Corelight सेंसर को दूरस्थ रूप से कॉन्फ़िगर और नियंत्रित कर सकते हैं। इस क्लाइंट अवलोकन के विस्तृत संस्करण के लिए Corelight सेंसर दस्तावेज़ देखें।

:संस्करण: |version| :गृह: http://www.corelight.com :GitHub: https://github.com/corelight/corelight-client :लेखक: Corelight, Inc. <https://www.corelight.com>_ [email protected]

लाइसेंस

यह क्लाइंट BSD लाइसेंस के तहत ओपन-सोर्स है। विवरण के लिए COPYING देखें।

स्थापना

कमांड-लाइन क्लाइंट को Python >= 3.4 की आवश्यकता है और इसकी मुख्य निर्भरता के रूप में requests मॉड्यूल स्थापित होना चाहिए।

क्लाइंट को स्थापित करने का सबसे आसान तरीका Python Package Index के माध्यम से है::

# pip3 install corelight-client

वैकल्पिक रूप से, आप GitHub से नवीनतम संस्करण स्थापित कर सकते हैं::

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

यदि सब कुछ सही ढंग से स्थापित हो जाता है, तो --help आपको उपयोग का संदेश देगा::

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

ध्यान दें कि शुरुआत में, --help आपको उपयोग करने के लिए कोई और कमांड नहीं दिखाएगा। क्लाइंट को अपने डिवाइस से कनेक्ट करने के लिए अगले अनुभाग पर जाएँ।

अभिगम और प्रमाणीकरण

आपको डिवाइस के कॉन्फ़िगरेशन इंटरफ़ेस के माध्यम से Corelight API तक अभिगम सक्षम करना होगा। आपको API उपयोगकर्ताओं admin (असीमित अभिगम के लिए) और monitor (केवल-पठन अभिगम के लिए) के लिए पासवर्ड सेट करने की भी आवश्यकता है। अधिक जानकारी के लिए Corelight सेंसर दस्तावेज़ देखें।

इसके बाद, आपको corelight-client को अपने Corelight सेंसर का नेटवर्क पता बताना होगा। ऐसा करने के लिए आपके पास तीन विकल्प हैं:

• कमांड-लाइन में -b <address> जोड़ें।

• सामग्री device=<address> के साथ एक कॉन्फ़िगरेशन फ़ाइल ~/.corelight-client.rc बनाएँ।

• पर्यावरण चर CORELIGHT_DEVICE=<address> सेट करें।

यदि यह सब सेट हो जाता है, तो corelight-client --help अब आपसे उपयोगकर्ता नाम और पासवर्ड पूछेगा, और फिर उन कमांडों की पूरी सूची दिखाएगा जिन्हें डिवाइस API क्लाइंट को प्रदान करने में सक्षम बनाता है। यदि आप क्रेडेंशियल सहेजने की पुष्टि करते हैं, तो क्लाइंट उन्हें भविष्य में पुन: उपयोग के लिए ~/.corelight-client/credentials में संग्रहीत करेगा। आप कॉन्फ़िगरेशन फ़ाइल_ के माध्यम से या वैश्विक विकल्प_ के रूप में भी प्रमाणीकरण जानकारी निर्दिष्ट कर सकते हैं।

उपयोग

क्लाइंट API की कार्यक्षमता को <command> <subcommand> [options] प्रारूप के कमांडों के एक सेट के माध्यम से प्रदान करता है। किसी भी कमांड में --help जोड़कर, आपको उसकी सभी कार्यक्षमता और विकल्पों का विवरण मिलता है।

यदि --help आउटपुट किसी कमांड के विकल्प को file प्रकार के रूप में सूचीबद्ध करता है, तो क्लाइंट को आपको भेजने के लिए एक फ़ाइल का पथ निर्दिष्ट करना आवश्यक होता है। इसके अलावा, आप किसी भी विकल्प के मान के आगे file:// लगा सकते हैं ताकि उसकी सामग्री कमांड-लाइन पर देने के बजाय किसी फ़ाइल से पढ़ी जाए।

(नोट: --help आउटपुट में कमांडों की सूची केवल तभी शामिल होगी जब क्लाइंट डिवाइस से कनेक्ट हो सकता है और प्रमाणित हो सकता है।)

.. _corelight-client-options:

वैश्विक विकल्प

corelight-client निम्नलिखित वैश्विक कमांड लाइन विकल्पों का समर्थन करता है। --device और --fleet विकल्पों का उपयोग एक-दूसरे के साथ परस्पर अनन्य रूप से किया जाना चाहिए। अन्य सभी विकल्प सभी अनुरोधों पर लागू होते हैं:

--async बाहर निकलने से पहले अतुल्यकालिक कमांडों के पूरा होने की प्रतीक्षा नहीं करता है।

--device Corelight सेंसर डिवाइस का नेटवर्क पता निर्दिष्ट करता है।

--fleet Corelight फ्लीट मैनेजर का नेटवर्क पता निर्दिष्ट करता है।

--uid निर्दिष्ट Corelight फ्लीट मैनेजर के माध्यम से प्रबंधित Corelight सेंसर का UID निर्दिष्ट करता है।

--cache=<file> Corelight सेंसर मेटा डेटा कैश करने के लिए एक कस्टम फ़ाइल सेट करता है।

--debug HTTP अनुरोधों और उत्तरों को दिखाने वाला डीबग आउटपुट सक्षम करता है।

--password प्रमाणीकरण के लिए पासवर्ड निर्दिष्ट करता है।

--mfa निर्दिष्ट Corelight फ्लीट मैनेजर के साथ प्रमाणीकरण के लिए 2FA सत्यापन कोड निर्दिष्ट करता है। उपयोगकर्ता से पूछने के लिए '-' का उपयोग करें।

--ssl-ca-cert डिवाइस की प्रामाणिकता को सत्यापित करने के लिए एक कस्टम SSL CA प्रमाणपत्र वाली फ़ाइल निर्दिष्ट करता है।

--ssl-no-verify-certificate क्लाइंट को किसी भी Corelight सेंसर SSL प्रमाणपत्र को स्वीकार करने का निर्देश देता है।

--ssl-no-verify-hostname क्लाइंट को Corelight सेंसर का SSL प्रमाणपत्र स्वीकार करने का निर्देश देता है, भले ही वह उसके होस्टनाम से मेल न खाता हो।

--socket क्लाइंट को अनुरोध भेजने के लिए यूनिक्स डोमेन सॉकेट का उपयोग करने का निर्देश देता है।

--user प्रमाणीकरण के लिए उपयोगकर्ता नाम निर्दिष्ट करता है।

--version corelight-client का संस्करण प्रदर्शित करता है और बाहर निकलता है।

--ignore-meta जब तक CLI पर निर्दिष्ट न किया जाए, सेंसर API कॉल को मेटाडेटा जानकारी न भेजें।

.. _corelight-client-config:

कॉन्फ़िगरेशन फ़ाइल

corelight-client एक कॉन्फ़िगरेशन फ़ाइल ~/.corelight-client.rc की खोज करता है। फ़ाइल में <key>=<value> प्रारूप की पंक्तियाँ होनी चाहिए। # से शुरू होने वाली टिप्पणियाँ अनदेखी की जाती हैं। corelight-client निम्नलिखित कुंजियों का समर्थन करता है:

device Corelight सेंसर डिवाइस का नेटवर्क पता।

fleet Corelight फ्लीट मैनेजर का नेटवर्क पता।

uid निर्दिष्ट Corelight फ्लीट मैनेजर के माध्यम से प्रबंधित Corelight सेंसर का UID।

user प्रमाणीकरण के लिए उपयोगकर्ता नाम।

password प्रमाणीकरण के लिए पासवर्ड।

mfa Corelight फ्लीट मैनेजर के साथ प्रमाणीकरण के लिए 2FA सत्यापन कोड। उपयोगकर्ता से पूछने के लिए '-' का उपयोग करें।

ssl-ca-cert डिवाइस की प्रामाणिकता सत्यापित करने के लिए एक कस्टम SSL CA प्रमाणपत्र वाली फ़ाइल।

ssl-no-verify-certificate यदि false पर सेट किया जाता है, तो क्लाइंट किसी भी Corelight सेंसर का SSL प्रमाणपत्र स्वीकार करेगा।

ssl-no-verify-hostname यदि false पर सेट किया जाता है, तो क्लाइंट Corelight सेंसर का SSL प्रमाणपत्र स्वीकार करेगा, भले ही वह उसके होस्टनाम से मेल न खाता हो।

socket अनुरोध भेजने के लिए उपयोग किया जाने वाला यूनिक्स डोमेन सॉकेट।