.. _corelight-client:

.. يتم ملء رقم الإصدار تلقائيًا. .. |version| replace:: 1.5.17

==================================== عميل سطر الأوامر لمستشعر Corelight

.. contents::

نظرة عامة

يوفر هذه الأداة عميلًا لسطر الأوامر لـ مستشعر Corelight <https://www.corelight.com>، وهو جهاز Bro <https://www.bro.org> صُمم من الألف إلى الياء بواسطة مبتكري Bro لتحويل حركة مرور الشبكة إلى بيانات عالية الدقة لخط أنابيب التحليلات لديك. باستخدام عميل سطر الأوامر، يمكنك تهيئة مستشعر Corelight والتحكم فيه عن بُعد عبر واجهة برمجة التطبيقات RESTful الشاملة. راجع وثائق مستشعر 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::

# 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 من خلال واجهة تكوين الجهاز. تحتاج أيضًا إلى تعيين كلمات مرور لمستخدمي الواجهة admin (للوصول غير المحدود) وmonitor (للوصول للقراءة فقط). راجع وثائق مستشعر Corelight لمزيد من المعلومات.

بعد ذلك، تحتاج إلى إخبار corelight-client بعنوان الشبكة لمستشعر Corelight الخاص بك. لديك ثلاثة خيارات للقيام بذلك:

• أضف -b <address> إلى سطر الأوامر.

• أنشئ ملف إعدادات ~/.corelight-client.rc بالمحتوى device=<address>.

• عيّن متغير البيئة CORELIGHT_DEVICE=<address>.

بمجرد إعداد كل ذلك، سيطلب منك corelight-client --help الآن اسم مستخدم وكلمة مرور، ثم يعرض لك القائمة الكاملة للأوامر التي تتيحها واجهة برمجة تطبيقات الجهاز للعميل. إذا أكدت حفظ بيانات الاعتماد، فسيخزنها العميل في ~/.corelight-client/credentials لإعادة استخدامها مستقبلًا. يمكنك أيضًا تحديد معلومات المصادقة عبر ملف الإعدادات_ أو كـالخيارات العامة_.

الاستخدام

يوفر العميل وظائف الواجهة البرمجية عبر مجموعة أوامر بالتنسيق <command> <subcommand> [options]. بإضافة --help إلى أي أمر، تحصل على وصف لجميع وظائفه وخياراته.

إذا كان ناتج --help يدرج خيار أمر كنوع file، يطلب منك العميل تحديد مسار ملف لإرساله. بالإضافة إلى ذلك، يمكنك إضافة بادئة file:// إلى قيمة أي خيار لقراءة محتواها من ملف بدلاً من إعطائها في سطر الأوامر نفسه.

(ملاحظة: سيحتوي ناتج --help على قائمة الأوامر فقط إذا تمكن العميل من الاتصال بالجهاز والمصادقة عليه.)

.. _corelight-client-options:

الخيارات العامة

يدعم corelight-client خيارات سطر الأوامر العامة التالية. يجب استخدام خياري --device و--fleet بشكل متبادل وحصري. تنطبق جميع الخيارات الأخرى على جميع الطلبات:

--async لا ينتظر اكتمال الأوامر غير المتزامنة قبل الخروج.

--device يحدد عنوان الشبكة لجهاز مستشعر Corelight.

--fleet يحدد عنوان الشبكة لمدير أسطول Corelight.

--uid يحدد UID الخاص بمستشعر Corelight المُدار عبر مدير أسطول Corelight المحدد.

--cache=<file> يعيّن ملفًا مخصصًا لتخزين بيانات وصفية لمستشعر Corelight مؤقتًا.

--debug يفعّل مخرجات التصحيح التي تعرض طلبات HTTP وردودها.

--password يحدد كلمة المرور للمصادقة.

--mfa يحدد رمز التحقق للمصادقة الثنائية (2FA) للمصادقة عبر مدير أسطول Corelight المحدد. استخدم '-' لسؤال المستخدم.

--ssl-ca-cert يحدد ملفًا يحتوي على شهادة SSL مخصصة من مرجع مصادقة (CA) للتحقق من صحة الجهاز.

--ssl-no-verify-certificate يوجّه العميل إلى قبول أي شهادة SSL لمستشعر Corelight.

--ssl-no-verify-hostname يوجّه العميل إلى قبول شهادة SSL الخاصة بمستشعر Corelight حتى لو لم تطابق اسم المضيف الخاص بها.

--socket يوجّه العميل إلى استخدام مقبس نطاق يونكس (Unix domain socket) لإرسال الطلبات.

--user يحدد اسم المستخدم للمصادقة.

--version يعرض إصدار corelight-client ويخرج.

--ignore-meta لا ترسل معلومات البيانات الوصفية إلى استدعاء واجهة برمجة التطبيقات الخاصة بالمستشعر، إلا إذا تم تحديدها في سطر الأوامر.

.. _corelight-client-config:

ملف الإعدادات

يبحث corelight-client عن ملف إعدادات ~/.corelight-client.rc. يجب أن يتكون الملف من أسطر <key>=<value>. يتم تجاهل التعليقات التي تبدأ بـ #. يدعم corelight-client المفاتيح التالية:

device عنوان الشبكة لجهاز مستشعر Corelight.

fleet عنوان الشبكة لمدير أسطول Corelight.

uid UID الخاص بمستشعر Corelight المُدار عبر مدير أسطول Corelight المحدد.

user اسم المستخدم للمصادقة.

password كلمة المرور للمصادقة.

mfa رمز التحقق للمصادقة الثنائية (2FA) للمصادقة عبر مدير أسطول Corelight. استخدم '-' لسؤال المستخدم.

ssl-ca-cert ملف يحتوي على شهادة SSL مخصصة من مرجع مصادقة (CA) للتحقق من صحة الجهاز.

ssl-no-verify-certificate إذا تم ضبطه على false، فسيقبل العميل أي شهادة SSL لمستشعر Corelight.

ssl-no-verify-hostname إذا تم ضبطه على false، فسيقبل العميل شهادة SSL الخاصة بمستشعر Corelight حتى لو لم تطابق اسم المضيف الخاص بها.

socket مقبس نطاق يونكس (Unix domain socket) لاستخدامه في إرسال الطلبات.