Python SDK-এর সাহায্যে চেক পয়েন্ট API-কে সরলীকরণ করা

API-এর সাথে মিথস্ক্রিয়া করার সম্পূর্ণ শক্তি যখন প্রোগ্রাম কোডের সাথে একসাথে ব্যবহার করা হয় তখন প্রকাশিত হয়, যখন API প্রতিক্রিয়া বিশ্লেষণের জন্য গতিশীলভাবে API অনুরোধ এবং সরঞ্জামগুলি তৈরি করা সম্ভব হয়। যাইহোক, এটি এখনও অলক্ষিত থেকে যায় পাইথন সফটওয়্যার ডেভেলপমেন্ট কিট (এর পরে পাইথন SDK হিসাবে উল্লেখ করা হয়েছে) এর জন্য পয়েন্ট ম্যানেজমেন্ট API চেক করুন, কিন্তু নিরর্থক. এটি উল্লেখযোগ্যভাবে বিকাশকারী এবং অটোমেশন উত্সাহীদের জীবনকে সহজ করে তোলে। পাইথন সম্প্রতি প্রচুর জনপ্রিয়তা অর্জন করেছে এবং আমি শূন্যস্থান পূরণ করার এবং প্রধান বৈশিষ্ট্যগুলি পর্যালোচনা করার সিদ্ধান্ত নিয়েছি। পয়েন্ট এপিআই পাইথন ডেভেলপমেন্ট কিট চেক করুন. এই নিবন্ধটি Habré-এর উপর আরেকটি নিবন্ধে একটি চমৎকার সংযোজন হিসেবে কাজ করে পয়েন্ট R80.10 API চেক করুন। CLI, স্ক্রিপ্ট এবং আরও অনেক কিছুর মাধ্যমে ব্যবস্থাপনা. আমরা পাইথন SDK ব্যবহার করে কীভাবে স্ক্রিপ্ট লিখতে হয় তা দেখব এবং 1.6 সংস্করণে (R80.40 থেকে সমর্থিত) নতুন ম্যানেজমেন্ট API কার্যকারিতাটি ঘনিষ্ঠভাবে দেখব। নিবন্ধটি বুঝতে, আপনার API এবং পাইথনের সাথে কাজ করার প্রাথমিক জ্ঞান প্রয়োজন।

চেক পয়েন্ট সক্রিয়ভাবে API বিকাশ করছে এবং এই মুহূর্তে নিম্নলিখিতগুলি প্রকাশ করা হয়েছে:

• পয়েন্ট ম্যানেজমেন্ট API চেক করুন (বর্তমান সংস্করণ 1.6) — API এর মাধ্যমে কন্ট্রোল সার্ভারের সাথে কাজ করুন (এবং কন্ট্রোল সার্ভার দ্বারা নিয়ন্ত্রিত গেটওয়েতে স্ক্রিপ্ট চালানোর ক্ষমতা)
• চেক পয়েন্ট GAIA API (বর্তমান সংস্করণ 1.4) - নিরাপত্তা গেটওয়ের সাথে কাজ করুন
• হুমকি প্রতিরোধ API 1.0 — চেক পয়েন্ট ক্লাউডে একটি স্যান্ডবক্সের সাথে কাজ করা
• পরিচয় সচেতনতা API — গেটওয়েতে আইডেন্টিটি অ্যাওয়ারনেস ব্লেড দিয়ে কাজ করা
• নিরাপত্তা ব্যবস্থাপনা পোর্টাল API - এসএমবি গেটওয়ে ম্যানেজমেন্ট পোর্টালের সাথে কাজ করুন (SMB গেটওয়ে সম্পর্কে আরও)
• IoT API - আইওটি কন্ট্রোলারের সাথে মিথস্ক্রিয়া
• CloudGuard Connect API - সাথে কাজ করে ক্লাউডগার্ড কানেক্ট (SD-WAN নিরাপত্তা সমাধান)
• Dome9 API - সাথে কাজ করে গম্বুজ9

Python SDK বর্তমানে শুধুমাত্র ম্যানেজমেন্ট এপিআই এবং এর সাথে মিথস্ক্রিয়া সমর্থন করে Gaia API. আমরা এই মডিউলে সবচেয়ে গুরুত্বপূর্ণ ক্লাস, পদ্ধতি এবং ভেরিয়েবল দেখব।

মডিউল ইনস্টল করা হচ্ছে

মডিউল cpapi থেকে দ্রুত এবং সহজে ইনস্টল করে গিথুবে অফিসিয়াল চেক পয়েন্ট সংগ্রহস্থল সাহায্যে বীচি. বিস্তারিত ইনস্টলেশন নির্দেশাবলী পাওয়া যায় README.md. এই মডিউলটি পাইথন সংস্করণ 2.7 এবং 3.7 এর সাথে কাজ করার জন্য অভিযোজিত হয়েছে। এই নিবন্ধে, পাইথন 3.7 ব্যবহার করে উদাহরণ দেওয়া হবে। যাইহোক, Python SDK চেক পয়েন্ট ম্যানেজমেন্ট সার্ভার (স্মার্ট ম্যানেজমেন্ট) থেকে সরাসরি চালানো যেতে পারে, কিন্তু তারা শুধুমাত্র Python 2.7 সমর্থন করে, তাই শেষ বিভাগটি 2.7 সংস্করণের কোড প্রদান করবে। মডিউল ইনস্টল করার অবিলম্বে, আমি ডিরেক্টরির উদাহরণগুলি দেখার পরামর্শ দিই উদাহরণ_পাইথন২ и উদাহরণ_পাইথন২.

গেটিং স্টার্টেড

cpapi মডিউলের উপাদানগুলির সাথে কাজ করতে সক্ষম হওয়ার জন্য, আমাদের মডিউল থেকে আমদানি করতে হবে cpapi কমপক্ষে দুটি প্রয়োজনীয় ক্লাস:

APIClient и APIClientArgs

from cpapi import APIClient, APIClientArgs

Класс APIClientArgs API সার্ভারের সাথে সংযোগ পরামিতি এবং ক্লাসের জন্য দায়ী APIClient API এর সাথে মিথস্ক্রিয়ার জন্য দায়ী।

সংযোগ পরামিতি নির্ধারণ

API এর সাথে সংযোগ করার জন্য বিভিন্ন পরামিতি সংজ্ঞায়িত করতে, আপনাকে ক্লাসের একটি উদাহরণ তৈরি করতে হবে APIClientArgs. নীতিগতভাবে, এর পরামিতিগুলি পূর্বনির্ধারিত এবং নিয়ন্ত্রণ সার্ভারে স্ক্রিপ্ট চালানোর সময়, তাদের নির্দিষ্ট করার প্রয়োজন নেই।

client_args = APIClientArgs()

কিন্তু তৃতীয় পক্ষের হোস্টে চলাকালীন, আপনাকে কমপক্ষে IP ঠিকানা বা API সার্ভারের হোস্ট নাম (পরিচালনা সার্ভার নামেও পরিচিত) উল্লেখ করতে হবে। নীচের উদাহরণে, আমরা সার্ভার সংযোগ পরামিতি সংজ্ঞায়িত করি এবং এটিকে একটি স্ট্রিং হিসাবে ব্যবস্থাপনা সার্ভারের IP ঠিকানা বরাদ্দ করি।

client_args = APIClientArgs(server='192.168.47.241')

এপিআই সার্ভারের সাথে সংযোগ করার সময় ব্যবহার করা যেতে পারে এমন সমস্ত পরামিতি এবং তাদের ডিফল্ট মানগুলি দেখুন:

APIClientArgs ক্লাসের __init__ পদ্ধতির আর্গুমেন্ট

class APIClientArgs:
    """
    This class provides arguments for APIClient configuration.
    All the arguments are configured with their default values.
    """

    # port is set to None by default, but it gets replaced with 443 if not specified
    # context possible values - web_api (default) or gaia_api
    def __init__(self, port=None, fingerprint=None, sid=None, server="127.0.0.1", http_debug_level=0,
                 api_calls=None, debug_file="", proxy_host=None, proxy_port=8080,
                 api_version=None, unsafe=False, unsafe_auto_accept=False, context="web_api"):
        self.port = port
        # management server fingerprint
        self.fingerprint = fingerprint
        # session-id.
        self.sid = sid
        # management server name or IP-address
        self.server = server
        # debug level
        self.http_debug_level = http_debug_level
        # an array with all the api calls (for debug purposes)
        self.api_calls = api_calls if api_calls else []
        # name of debug file. If left empty, debug data will not be saved to disk.
        self.debug_file = debug_file
        # HTTP proxy server address (without "http://")
        self.proxy_host = proxy_host
        # HTTP proxy port
        self.proxy_port = proxy_port
        # Management server's API version
        self.api_version = api_version
        # Indicates that the client should not check the server's certificate
        self.unsafe = unsafe
        # Indicates that the client should automatically accept and save the server's certificate
        self.unsafe_auto_accept = unsafe_auto_accept
        # The context of using the client - defaults to web_api
        self.context = context

আমি বিশ্বাস করি যে APIClientArgs ক্লাসের উদাহরণগুলিতে ব্যবহার করা যেতে পারে এমন যুক্তিগুলি চেক পয়েন্ট অ্যাডমিনিস্ট্রেটরদের জন্য স্বজ্ঞাত এবং অতিরিক্ত মন্তব্যের প্রয়োজন নেই৷

APIClient এবং প্রসঙ্গ পরিচালকের মাধ্যমে সংযোগ করা হচ্ছে

Класс APIClient এটি ব্যবহার করার সবচেয়ে সুবিধাজনক উপায় হল প্রসঙ্গ পরিচালকের মাধ্যমে। APIClient ক্লাসের একটি উদাহরণে যা পাস করতে হবে তা হল সংযোগ পরামিতি যা পূর্ববর্তী ধাপে সংজ্ঞায়িত করা হয়েছিল।

with APIClient(client_args) as client:

কনটেক্সট ম্যানেজার স্বয়ংক্রিয়ভাবে API সার্ভারে একটি লগইন কল করবে না, তবে এটি থেকে প্রস্থান করার সময় এটি একটি লগআউট কল করবে। যদি কোনো কারণে API কলগুলির সাথে কাজ শেষ করার পরে লগআউটের প্রয়োজন না হয়, তাহলে আপনাকে প্রসঙ্গ পরিচালক ব্যবহার না করেই কাজ শুরু করতে হবে:

client = APIClient(clieng_args)

সংযোগ পরীক্ষা করা হচ্ছে

সংযোগটি নির্দিষ্ট পরামিতি পূরণ করে কিনা তা পরীক্ষা করার সবচেয়ে সহজ উপায় হল পদ্ধতিটি ব্যবহার করা চেক_আঙ্গুলের ছাপ. সার্ভার API শংসাপত্রের আঙ্গুলের ছাপের জন্য sha1 হ্যাশ সমষ্টির যাচাইকরণ ব্যর্থ হলে (পদ্ধতিটি ফেরত দেওয়া হয়েছে মিথ্যা), তাহলে এটি সাধারণত সংযোগ সমস্যার কারণে হয় এবং আমরা প্রোগ্রামটির সম্পাদন বন্ধ করতে পারি (বা ব্যবহারকারীকে সংযোগ ডেটা সংশোধন করার সুযোগ দিতে পারি):

    if client.check_fingerprint() is False:
        print("Could not get the server's fingerprint - Check connectivity with the server.")
        exit(1)

দয়া করে নোট করুন যে ভবিষ্যতে ক্লাস APIClient প্রতিটি API কল চেক করবে (পদ্ধতি এপিআই_কল и api_query, আমরা তাদের সম্পর্কে আরও কিছু কথা বলব) API সার্ভারে sha1 ফিঙ্গারপ্রিন্ট শংসাপত্র। কিন্তু যদি, API সার্ভার সার্টিফিকেটের sha1 ফিঙ্গারপ্রিন্ট চেক করার সময়, একটি ত্রুটি সনাক্ত করা হয় (শংসাপত্রটি অজানা বা পরিবর্তন করা হয়েছে), পদ্ধতিটি চেক_আঙ্গুলের ছাপ স্থানীয় মেশিনে স্বয়ংক্রিয়ভাবে এটি সম্পর্কে তথ্য যোগ/পরিবর্তন করার সুযোগ প্রদান করবে। এই চেকটি সম্পূর্ণরূপে নিষ্ক্রিয় করা যেতে পারে (কিন্তু এটি শুধুমাত্র তখনই সুপারিশ করা যেতে পারে যদি স্ক্রিপ্টগুলি API সার্ভারে চালানো হয়, যখন 127.0.0.1-এর সাথে সংযোগ করা হয়), APIClientArgs যুক্তি ব্যবহার করে - unsafe_auto_accept (APIClientArgs সম্বন্ধে আরও দেখুন আগে "সংযোগের পরামিতি সংজ্ঞায়িত করা" এ)।

client_args = APIClientArgs(unsafe_auto_accept=True)

API সার্ভারে লগইন করুন

У APIClient API সার্ভারে লগ ইন করার জন্য 3টির মতো পদ্ধতি রয়েছে এবং তাদের প্রত্যেকটি অর্থ বোঝে সিদ(সেশন-আইডি), যা হেডারে প্রতিটি পরবর্তী API কলে স্বয়ংক্রিয়ভাবে ব্যবহৃত হয় (এই প্যারামিটারের হেডারে নাম X-chkp-sid), তাই এই প্যারামিটারটি আরও প্রক্রিয়া করার দরকার নেই।

লগইন পদ্ধতি

লগইন এবং পাসওয়ার্ড ব্যবহার করে বিকল্প (উদাহরণস্বরূপ, ব্যবহারকারীর নাম অ্যাডমিন এবং পাসওয়ার্ড 1q2w3e অবস্থানগত আর্গুমেন্ট হিসাবে পাস করা হয়েছে):

     login = client.login('admin', '1q2w3e')  

লগইন পদ্ধতিতে অতিরিক্ত ঐচ্ছিক প্যারামিটারগুলিও পাওয়া যায়; এখানে তাদের নাম এবং ডিফল্ট মান রয়েছে:

continue_last_session=False, domain=None, read_only=False, payload=None

মেথড লগইন_with_api_key

একটি api কী ব্যবহার করার বিকল্প (ম্যানেজমেন্ট সংস্করণ R80.40/Management API v1.6 থেকে শুরু করে সমর্থিত, "3TsbPJ8ZKjaJGvFyoFqHFA==" এটি API কী অনুমোদন পদ্ধতি সহ ব্যবস্থাপনা সার্ভারে ব্যবহারকারীদের একজনের জন্য API কী মান:

     login = client.login_with_api_key('3TsbPJ8ZKjaJGvFyoFqHFA==') 

পদ্ধতিতে api_key দিয়ে লগইন করুন একই ঐচ্ছিক পরামিতি পদ্ধতি হিসাবে উপলব্ধ লগইন.

login_as_root পদ্ধতি

একটি API সার্ভার সহ একটি স্থানীয় মেশিনে লগইন করার বিকল্প:

     login = client.login_as_root()

এই পদ্ধতির জন্য শুধুমাত্র দুটি ঐচ্ছিক পরামিতি উপলব্ধ আছে:

domain=None, payload=None

এবং অবশেষে API নিজেদের কল

পদ্ধতির মাধ্যমে API কল করার জন্য আমাদের কাছে দুটি বিকল্প রয়েছে এপিআই_কল и api_query. আসুন তাদের মধ্যে পার্থক্য কি তা খুঁজে বের করা যাক।

এপিআই_কল

এই পদ্ধতি যেকোনো কলের জন্য প্রযোজ্য। আমাদের এপিআই কলের জন্য শেষ অংশটি পাস করতে হবে এবং প্রয়োজনে অনুরোধের বডিতে পেলোড করতে হবে। যদি পেলোড খালি থাকে, তবে এটি মোটেও স্থানান্তর করা যাবে না:

api_versions = client.api_call('show-api-versions') 

কাটা নীচে এই অনুরোধের জন্য আউটপুট:

In [23]: api_versions                                                           
Out[23]: 
APIResponse({
    "data": {
        "current-version": "1.6",
        "supported-versions": [
            "1",
            "1.1",
            "1.2",
            "1.3",
            "1.4",
            "1.5",
            "1.6"
        ]
    },
    "res_obj": {
        "data": {
            "current-version": "1.6",
            "supported-versions": [
                "1",
                "1.1",
                "1.2",
                "1.3",
                "1.4",
                "1.5",
                "1.6"
            ]
        },
        "status_code": 200
    },
    "status_code": 200,
    "success": true
})

show_host = client.api_call('show-host', {'name' : 'h_8.8.8.8'})

কাটা নীচে এই অনুরোধের জন্য আউটপুট:

In [25]: show_host                                                              
Out[25]: 
APIResponse({
    "data": {
        "color": "black",
        "comments": "",
        "domain": {
            "domain-type": "domain",
            "name": "SMC User",
            "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde"
        },
        "groups": [],
        "icon": "Objects/host",
        "interfaces": [],
        "ipv4-address": "8.8.8.8",
        "meta-info": {
            "creation-time": {
                "iso-8601": "2020-05-01T21:49+0300",
                "posix": 1588358973517
            },
            "creator": "admin",
            "last-modifier": "admin",
            "last-modify-time": {
                "iso-8601": "2020-05-01T21:49+0300",
                "posix": 1588358973517
            },
            "lock": "unlocked",
            "validation-state": "ok"
        },
        "name": "h_8.8.8.8",
        "nat-settings": {
            "auto-rule": false
        },
        "read-only": false,
        "tags": [],
        "type": "host",
        "uid": "c210af07-1939-49d3-a351-953a9c471d9e"
    },
    "res_obj": {
        "data": {
            "color": "black",
            "comments": "",
            "domain": {
                "domain-type": "domain",
                "name": "SMC User",
                "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde"
            },
            "groups": [],
            "icon": "Objects/host",
            "interfaces": [],
            "ipv4-address": "8.8.8.8",
            "meta-info": {
                "creation-time": {
                    "iso-8601": "2020-05-01T21:49+0300",
                    "posix": 1588358973517
                },
                "creator": "admin",
                "last-modifier": "admin",
                "last-modify-time": {
                    "iso-8601": "2020-05-01T21:49+0300",
                    "posix": 1588358973517
                },
                "lock": "unlocked",
                "validation-state": "ok"
            },
            "name": "h_8.8.8.8",
            "nat-settings": {
                "auto-rule": false
            },
            "read-only": false,
            "tags": [],
            "type": "host",
            "uid": "c210af07-1939-49d3-a351-953a9c471d9e"
        },
        "status_code": 200
    },
    "status_code": 200,
    "success": true
})

api_query

আমাকে এখনই একটি রিজার্ভেশন করতে দিন যে এই পদ্ধতিটি শুধুমাত্র সেই কলগুলির জন্য প্রযোজ্য যার আউটপুট অফসেট জড়িত। এই ধরনের একটি অনুমান ঘটে যখন এতে প্রচুর পরিমাণে তথ্য থাকে বা থাকতে পারে। উদাহরণস্বরূপ, এটি পরিচালনা সার্ভারে সমস্ত তৈরি হোস্ট অবজেক্টের একটি তালিকার জন্য একটি অনুরোধ হতে পারে। এই ধরনের অনুরোধের জন্য, API ডিফল্টরূপে 50টি অবজেক্টের একটি তালিকা প্রদান করে (আপনি প্রতিক্রিয়াতে 500 অবজেক্টে সীমা বাড়াতে পারেন)। এবং API অনুরোধে অফসেট প্যারামিটার পরিবর্তন করে একাধিকবার তথ্য টান না করার জন্য, একটি api_query পদ্ধতি রয়েছে যা স্বয়ংক্রিয়ভাবে কাজ করে। কলের উদাহরণ যেখানে এই পদ্ধতিটি প্রয়োজন: শো-সেশন, শো-হোস্ট, শো-নেটওয়ার্ক, শো-ওয়াইল্ডকার্ড, শো-গ্রুপ, শো-অ্যাড্রেস-রেঞ্জ, শো-সিম্পল-গেটওয়ে, শো-সিম্পল-ক্লাস্টার, শো-অ্যাক্সেস-রোলস, শো-বিশ্বস্ত-ক্লায়েন্ট, প্রদর্শন-প্যাকেজ. আসলে, আমরা এই API কলগুলির নামে বহুবচন শব্দ দেখতে পাই, তাই এই কলগুলি পরিচালনা করা সহজ হবে api_query

show_hosts = client.api_query('show-hosts') 

কাটা নীচে এই অনুরোধের জন্য আউটপুট:

In [21]: show_hosts                                                             
Out[21]: 
APIResponse({
    "data": [
        {
            "domain": {
                "domain-type": "domain",
                "name": "SMC User",
                "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde"
            },
            "ipv4-address": "192.168.47.1",
            "name": "h_192.168.47.1",
            "type": "host",
            "uid": "5d7d7086-d70b-4995-971a-0583b15a2bfc"
        },
        {
            "domain": {
                "domain-type": "domain",
                "name": "SMC User",
                "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde"
            },
            "ipv4-address": "8.8.8.8",
            "name": "h_8.8.8.8",
            "type": "host",
            "uid": "c210af07-1939-49d3-a351-953a9c471d9e"
        }
    ],
    "res_obj": {
        "data": {
            "from": 1,
            "objects": [
                {
                    "domain": {
                        "domain-type": "domain",
                        "name": "SMC User",
                        "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde"
                    },
                    "ipv4-address": "192.168.47.1",
                    "name": "h_192.168.47.1",
                    "type": "host",
                    "uid": "5d7d7086-d70b-4995-971a-0583b15a2bfc"
                },
                {
                    "domain": {
                        "domain-type": "domain",
                        "name": "SMC User",
                        "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde"
                    },
                    "ipv4-address": "8.8.8.8",
                    "name": "h_8.8.8.8",
                    "type": "host",
                    "uid": "c210af07-1939-49d3-a351-953a9c471d9e"
                }
            ],
            "to": 2,
            "total": 2
        },
        "status_code": 200
    },
    "status_code": 200,
    "success": true
})

API কলের ফলাফল প্রসেস করা হচ্ছে

এর পরে আপনি ক্লাসের ভেরিয়েবল এবং পদ্ধতিগুলি ব্যবহার করতে পারেন API প্রতিক্রিয়া(প্রসঙ্গ পরিচালকের ভিতরে এবং বাইরে উভয়ই)। ক্লাসে API প্রতিক্রিয়া 4টি পদ্ধতি এবং 5টি ভেরিয়েবল পূর্বনির্ধারিত; আমরা আরও বিস্তারিতভাবে সবচেয়ে গুরুত্বপূর্ণগুলির উপর আলোচনা করব।

সাফল্য

শুরুতে, API কলটি সফল হয়েছে এবং একটি ফলাফল ফিরিয়ে দিয়েছে তা নিশ্চিত করা একটি ভাল ধারণা হবে। এই জন্য একটি পদ্ধতি আছে সাফল্য:

In [49]: api_versions.success                                                   
Out[49]: True

API কল সফল হলে সত্য (প্রতিক্রিয়া কোড - 200) এবং সফল না হলে মিথ্যা (অন্য যেকোনো প্রতিক্রিয়া কোড) ফেরত দেয়। প্রতিক্রিয়া কোডের উপর নির্ভর করে বিভিন্ন তথ্য প্রদর্শন করার জন্য একটি API কলের সাথে সাথে ব্যবহার করা সুবিধাজনক।

if api_ver.success: 
    print(api_versions.data) 
else: 
    print(api_versions.err_message) 

স্ট্যাটাসকোড

একটি API কল করার পরে প্রতিক্রিয়া কোড প্রদান করে।

In [62]: api_versions.status_code                                               
Out[62]: 400

সম্ভাব্য প্রতিক্রিয়া কোড: 200,400,401,403,404,409,500,501.

set_success_status

এই ক্ষেত্রে, সাফল্যের স্থিতির মান পরিবর্তন করার প্রয়োজন হতে পারে। প্রযুক্তিগতভাবে, আপনি সেখানে কিছু রাখতে পারেন, এমনকি একটি নিয়মিত স্ট্রিং। কিন্তু একটি বাস্তব উদাহরণ হল এই প্যারামিটারটিকে False-এ রিসেট করা হবে নির্দিষ্ট কিছু শর্তের অধীনে। নীচে, যখন ম্যানেজমেন্ট সার্ভারে কাজগুলি চলমান থাকে তখন উদাহরণের দিকে মনোযোগ দিন, কিন্তু আমরা এই অনুরোধটিকে অসফল বলে বিবেচনা করব (আমরা সফলতার পরিবর্তনশীল সেট করব মিথ্যা, এপিআই কল সফল হওয়া সত্ত্বেও এবং কোড 200 ফেরত দেওয়া হয়েছে)।

for task in task_result.data["tasks"]:
    if task["status"] == "failed" or task["status"] == "partially succeeded":
        task_result.set_success_status(False)
        break

প্রতিক্রিয়া()

প্রতিক্রিয়া পদ্ধতি আপনাকে প্রতিক্রিয়া কোড (স্থিতি_কোড) এবং প্রতিক্রিয়া বডি (বডি) সহ অভিধানটি দেখতে দেয়।

In [94]: api_versions.response()                                                
Out[94]: 
{'status_code': 200,
 'data': {'current-version': '1.6',
  'supported-versions': ['1', '1.1', '1.2', '1.3', '1.4', '1.5', '1.6']}}

উপাত্ত

আপনাকে অপ্রয়োজনীয় তথ্য ছাড়াই শুধুমাত্র প্রতিক্রিয়া (শরীর) দেখতে দেয়।

In [93]: api_versions.data                                                      
Out[93]: 
{'current-version': '1.6',
 'supported-versions': ['1', '1.1', '1.2', '1.3', '1.4', '1.5', '1.6']}

ভুল বার্তা

এই তথ্যটি শুধুমাত্র তখনই পাওয়া যায় যখন API অনুরোধ প্রক্রিয়া করার সময় একটি ত্রুটি ঘটে (প্রতিক্রিয়া কোড না 200)। উদাহরণ আউটপুট

In [107]: api_versions.error_message                                            
Out[107]: 'code: generic_err_invalid_parameter_namenmessage: Unrecognized parameter [1]n'

দরকারী উদাহরণ

ব্যবস্থাপনা API 1.6-এ যোগ করা API কলগুলি ব্যবহার করে এমন উদাহরণ নিচে দেওয়া হল।

প্রথমত, চলুন দেখি কল কিভাবে কাজ করে অ্যাড-হোস্ট и যোগ-ঠিকানা-পরিসীমা. ধরা যাক আমাদের সাবনেট 192.168.0.0/24-এর সমস্ত আইপি অ্যাড্রেস তৈরি করতে হবে, যার শেষ অক্টেট হল 5, হোস্ট টাইপের অবজেক্ট হিসাবে, এবং অন্য সমস্ত আইপি অ্যাড্রেসকে অ্যাড্রেস রেঞ্জ টাইপের অবজেক্ট হিসাবে লিখতে হবে। এই ক্ষেত্রে, সাবনেট ঠিকানা এবং সম্প্রচার ঠিকানা বাদ দিন।

সুতরাং, নীচে একটি স্ক্রিপ্ট রয়েছে যা এই সমস্যার সমাধান করে এবং হোস্ট টাইপের 50টি অবজেক্ট এবং অ্যাড্রেস রেঞ্জ টাইপের 51টি অবজেক্ট তৈরি করে। সমস্যা সমাধানের জন্য, 101টি API কল প্রয়োজন (চূড়ান্ত প্রকাশ কল গণনা না)। এছাড়াও, timeit মডিউল ব্যবহার করে, আমরা পরিবর্তনগুলি প্রকাশ না হওয়া পর্যন্ত স্ক্রিপ্টটি কার্যকর করতে যে সময় লাগে তা গণনা করি।

অ্যাড-হোস্ট এবং অ্যাড-অ্যাড্রেস-রেঞ্জ ব্যবহার করে স্ক্রিপ্ট

import timeit
from cpapi import APIClient, APIClientArgs

start = timeit.default_timer()

first_ip = 1
last_ip = 4

client_args = APIClientArgs(server="192.168.47.240")

with APIClient(client_args) as client: 
     login = client.login_with_api_key('3TsbPJ8ZKjaJGvFyoFqHFA==')
     for ip in range(5,255,5):
         add_host = client.api_call("add-host", {"name" : f"h_192.168.0.{ip}", "ip-address": f'192.168.0.{ip}'})
     while last_ip < 255:
         add_range = client.api_call("add-address-range", {"name": f"r_192.168.0.{first_ip}-{last_ip}", "ip-address-first": f"192.168.0.{first_ip}", "ip-address-last": f"192.168.0.{last_ip}"})
         first_ip+=5
         last_ip+=5
     stop = timeit.default_timer() 
     publish = client.api_call("publish")
     
print(f'Time to execute batch request: {stop - start} seconds')

আমার ল্যাব পরিবেশে, ম্যানেজমেন্ট সার্ভারে লোডের উপর নির্ভর করে এই স্ক্রিপ্টটি কার্যকর করতে 30 থেকে 50 সেকেন্ড সময় নেয়।

এখন দেখা যাক কিভাবে একটি API কল ব্যবহার করে একই সমস্যা সমাধান করা যায় যোগ-অবজেক্ট-ব্যাচ, সমর্থন যার জন্য API সংস্করণ 1.6 এ যোগ করা হয়েছে। এই কলটি আপনাকে একটি API অনুরোধে একসাথে অনেকগুলি বস্তু তৈরি করতে দেয়। তদুপরি, এগুলি বিভিন্ন ধরণের বস্তু হতে পারে (উদাহরণস্বরূপ, হোস্ট, সাবনেট এবং ঠিকানা পরিসীমা)। সুতরাং, আমাদের কাজটি একটি API কলের কাঠামোর মধ্যে সমাধান করা যেতে পারে।

অ্যাড-অবজেক্ট-ব্যাচ ব্যবহার করে স্ক্রিপ্ট

import timeit
from cpapi import APIClient, APIClientArgs

start = timeit.default_timer()

client_args = APIClientArgs(server="192.168.47.240")

objects_list_ip = []
objects_list_range = []

for ip in range(5,255,5):
    data = {"name": f'h_192.168.0.{ip}', "ip-address": f'192.168.0.{ip}'}
    objects_list_ip.append(data)
    
first_ip = 1
last_ip = 4


while last_ip < 255:
    data = {"name": f"r_192.168.0.{first_ip}-{last_ip}", "ip-address-first": f"192.168.0.{first_ip}", "ip-address-last": f"192.168.0.{last_ip}"}
    objects_list_range.append(data)
    first_ip+=5
    last_ip+=5

data_for_batch = {
  "objects" : [ {
    "type" : "host",
    "list" : objects_list_ip
}, {
    "type" : "address-range",
    "list" : objects_list_range
  }]
}


with APIClient(client_args) as client: 
     login = client.login_with_api_key('3TsbPJ8ZKjaJGvFyoFqHFA==')
     add_objects_batch = client.api_call("add-objects-batch", data_for_batch)
     stop = timeit.default_timer() 
     publish = client.api_call("publish")
     
print(f'Time to execute batch request: {stop - start} seconds')

এবং ম্যানেজমেন্ট সার্ভারের লোডের উপর নির্ভর করে আমার ল্যাব পরিবেশে এই স্ক্রিপ্টটি চালাতে 3 থেকে 7 সেকেন্ড সময় লাগে। অর্থাৎ, গড়ে, 101টি API অবজেক্টে, একটি ব্যাচ টাইপ কল 10 গুণ দ্রুত চলে। বৃহত্তর সংখ্যক বস্তুতে পার্থক্যটি আরও বেশি চিত্তাকর্ষক হবে।

এখন দেখা যাক কিভাবে কাজ করতে হয় সেট-অবজেক্ট-ব্যাচ. এই API কল ব্যবহার করে, আমরা যেকোন প্যারামিটার বাল্ক পরিবর্তন করতে পারি। আগের উদাহরণ থেকে অ্যাড্রেসের প্রথম অর্ধেক সেট করা যাক (.124 হোস্ট পর্যন্ত, এবং রেঞ্জও) কালার সিয়েনাতে, এবং অ্যাড্রেসের দ্বিতীয়ার্ধে কালার খাকি বরাদ্দ করি।

আগের উদাহরণে তৈরি করা বস্তুর রঙ পরিবর্তন করা

from cpapi import APIClient, APIClientArgs

client_args = APIClientArgs(server="192.168.47.240")

objects_list_ip_first = []
objects_list_range_first = []
objects_list_ip_second = []
objects_list_range_second = []

for ip in range(5,125,5):
    data = {"name": f'h_192.168.0.{ip}', "color": "sienna"}
    objects_list_ip_first.append(data)
    
for ip in range(125,255,5):
    data = {"name": f'h_192.168.0.{ip}', "color": "khaki"}
    objects_list_ip_second.append(data)
    
first_ip = 1
last_ip = 4
while last_ip < 125:
    data = {"name": f"r_192.168.0.{first_ip}-{last_ip}", "color": "sienna"}
    objects_list_range_first.append(data)
    first_ip+=5
    last_ip+=5
    
while last_ip < 255:
    data = {"name": f"r_192.168.0.{first_ip}-{last_ip}", "color": "khaki"}
    objects_list_range_second.append(data)
    first_ip+=5
    last_ip+=5

data_for_batch_first  = {
  "objects" : [ {
    "type" : "host",
    "list" : objects_list_ip_first
}, {
    "type" : "address-range",
    "list" : objects_list_range_first
  }]
}

data_for_batch_second  = {
  "objects" : [ {
    "type" : "host",
    "list" : objects_list_ip_second
}, {
    "type" : "address-range",
    "list" : objects_list_range_second
  }]
}

with APIClient(client_args) as client: 
     login = client.login_with_api_key('3TsbPJ8ZKjaJGvFyoFqHFA==') 
     set_objects_batch_first = client.api_call("set-objects-batch", data_for_batch_first)
     set_objects_batch_second = client.api_call("set-objects-batch", data_for_batch_second)
     publish = client.api_call("publish")

আপনি একটি API কল ব্যবহার করে একাধিক বস্তু মুছে ফেলতে পারেন ডিলিট-অবজেক্ট-ব্যাচ. এখন আসুন একটি কোড উদাহরণ দেখি যা পূর্বে তৈরি করা সমস্ত হোস্ট মুছে দেয় যোগ-অবজেক্ট-ব্যাচ.

ডিলিট-অবজেক্ট-ব্যাচ ব্যবহার করে বস্তু মুছে ফেলা হচ্ছে

from cpapi import APIClient, APIClientArgs

client_args = APIClientArgs(server="192.168.47.240")

objects_list_ip = []
objects_list_range = []

for ip in range(5,255,5):
    data = {"name": f'h_192.168.0.{ip}'}
    objects_list_ip.append(data)

first_ip = 1
last_ip = 4
while last_ip < 255:
    data = {"name": f"r_192.168.0.{first_ip}-{last_ip}"}
    objects_list_range.append(data)
    first_ip+=5
    last_ip+=5

data_for_batch = {
  "objects" : [ {
    "type" : "host",
    "list" : objects_list_ip
}, {
    "type" : "address-range",
    "list" : objects_list_range
  }]
}

with APIClient(client_args) as client: 
     login = client.login_with_api_key('3TsbPJ8ZKjaJGvFyoFqHFA==')
     delete_objects_batch = client.api_call("delete-objects-batch", data_for_batch)
     publish = client.api_call("publish")

print(delete_objects_batch.data)

চেক পয়েন্ট সফ্টওয়্যারের নতুন রিলিজে উপস্থিত সমস্ত ফাংশন অবিলম্বে API কলগুলি অর্জন করে। এইভাবে, R80.40-এ রিভার্ট টু রিভিশন এবং স্মার্ট টাস্কের মতো "বৈশিষ্ট্যগুলি" উপস্থিত হয়েছিল, এবং সংশ্লিষ্ট API কলগুলি অবিলম্বে তাদের জন্য প্রস্তুত করা হয়েছিল। অধিকন্তু, লিগ্যাসি কনসোল থেকে ইউনিফাইড পলিসি মোডে যাওয়ার সময় সমস্ত কার্যকারিতাও API সমর্থন অর্জন করে। উদাহরণস্বরূপ, সফ্টওয়্যার সংস্করণ R80.40-এর দীর্ঘ-প্রতীক্ষিত আপডেটটি হল লিগ্যাসি মোড থেকে ইউনিফাইড পলিসি মোডে HTTPS পরিদর্শন নীতির স্থানান্তর, এবং এই কার্যকারিতা অবিলম্বে API কলগুলি পেয়েছে৷ এখানে কোডের একটি উদাহরণ রয়েছে যা HTTPS পরিদর্শন নীতির শীর্ষ অবস্থানে একটি নিয়ম যুক্ত করে যা পরিদর্শন থেকে 3টি বিভাগ বাদ দেয় (স্বাস্থ্য, অর্থ, সরকারী পরিষেবা), যা বেশ কয়েকটি দেশে আইন অনুসারে পরিদর্শন থেকে নিষিদ্ধ।

HTTPS পরিদর্শন নীতিতে একটি নিয়ম যোগ করুন

from cpapi import APIClient, APIClientArgs

client_args = APIClientArgs(server="192.168.47.240")

data = {
  "layer" : "Default Layer",
  "position" : "top",
  "name" : "Legal Requirements",
  "action": "bypass",
  "site-category": ["Health", "Government / Military", "Financial Services"]
}

with APIClient(client_args) as client: 
     login = client.login_with_api_key('3TsbPJ8ZKjaJGvFyoFqHFA==')
     add_https_rule = client.api_call("add-https-rule", data)
     publish = client.api_call("publish")

চেক পয়েন্ট ম্যানেজমেন্ট সার্ভারে পাইথন স্ক্রিপ্ট চালানো হচ্ছে

সবই একরকম README.md কন্ট্রোল সার্ভার থেকে সরাসরি পাইথন স্ক্রিপ্ট চালানোর তথ্য রয়েছে। আপনি যখন অন্য মেশিন থেকে API সার্ভারের সাথে সংযোগ করতে অক্ষম হন তখন এটি সুবিধাজনক হতে পারে। আমি একটি ছয় মিনিটের ভিডিও রেকর্ড করেছি যাতে আমি মডিউলটি ইনস্টল করতে দেখি cpapi এবং কন্ট্রোল সার্ভারে পাইথন স্ক্রিপ্ট চালানোর বৈশিষ্ট্য। উদাহরণ হিসেবে, একটি স্ক্রিপ্ট চালানো হয় যা নেটওয়ার্ক অডিটিংয়ের মতো একটি কাজের জন্য একটি নতুন গেটওয়ের কনফিগারেশন স্বয়ংক্রিয় করে। নিরাপত্তা চেকআপ. আমাকে যে বৈশিষ্ট্যগুলি মোকাবেলা করতে হয়েছিল তার মধ্যে: ফাংশনটি এখনও পাইথন 2.7 এ উপস্থিত হয়নি ইনপুট, তাই ব্যবহারকারী প্রবেশ করা তথ্য প্রক্রিয়া করার জন্য, একটি ফাংশন ব্যবহার করা হয় কাঁচা নিবেশ. অন্যথায়, কোডটি অন্যান্য মেশিন থেকে চালু করার মতোই, শুধুমাত্র ফাংশনটি ব্যবহার করা আরও সুবিধাজনক login_as_root, যাতে আপনার নিজের ব্যবহারকারীর নাম, পাসওয়ার্ড এবং ম্যানেজমেন্ট সার্ভারের IP ঠিকানা আবার উল্লেখ না করে।

সিকিউরিটি চেকআপের দ্রুত সেটআপের জন্য স্ক্রিপ্ট

from __future__ import print_function
import getpass
import sys, os
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
from cpapi import APIClient, APIClientArgs

def main():
    with APIClient() as client:
       # if client.check_fingerprint() is False:
       #     print("Could not get the server's fingerprint - Check connectivity with the server.")
       #     exit(1)
        login_res = client.login_as_root()

        if login_res.success is False:
            print("Login failed:n{}".format(login_res.error_message))
            exit(1)

        gw_name = raw_input("Enter the gateway name:")
        gw_ip = raw_input("Enter the gateway IP address:")
        if sys.stdin.isatty():
            sic = getpass.getpass("Enter one-time password for the gateway(SIC): ")
        else:
            print("Attention! Your password will be shown on the screen!")
            sic = raw_input("Enter one-time password for the gateway(SIC): ")
        version = raw_input("Enter the gateway version(like RXX.YY):")
        add_gw = client.api_call("add-simple-gateway", {'name' : gw_name, 'ipv4-address' : gw_ip, 'one-time-password' : sic, 'version': version.capitalize(), 'application-control' : 'true', 'url-filtering' : 'true', 'ips' : 'true', 'anti-bot' : 'true', 'anti-virus' : 'true', 'threat-emulation' : 'true'})
        if add_gw.success and add_gw.data['sic-state'] != "communicating":
            print("Secure connection with the gateway hasn't established!")
            exit(1)
        elif add_gw.success:
            print("The gateway was added successfully.")
            gw_uid = add_gw.data['uid']
            gw_name = add_gw.data['name']
        else:
            print("Failed to add the gateway - {}".format(add_gw.error_message))
            exit(1)

        change_policy = client.api_call("set-access-layer", {"name" : "Network", "applications-and-url-filtering": "true", "content-awareness": "true"})
        if change_policy.success:
            print("The policy has been changed successfully")
        else:
            print("Failed to change the policy- {}".format(change_policy.error_message))
        change_rule = client.api_call("set-access-rule", {"name" : "Cleanup rule", "layer" : "Network", "action": "Accept", "track": {"type": "Detailed Log", "accounting": "true"}})
        if change_rule.success:
            print("The cleanup rule has been changed successfully")
        else:
            print("Failed to change the cleanup rule- {}".format(change_rule.error_message))

        # publish the result
        publish_res = client.api_call("publish", {})
        if publish_res.success:
            print("The changes were published successfully.")
        else:
                print("Failed to publish the changes - {}".format(install_tp_policy.error_message))

        install_access_policy = client.api_call("install-policy", {"policy-package" : "Standard", "access" : 'true',  "threat-prevention" : 'false', "targets" : gw_uid})
        if install_access_policy.success:
            print("The access policy has been installed")
        else:
                print("Failed to install access policy - {}".format(install_tp_policy.error_message))

        install_tp_policy = client.api_call("install-policy", {"policy-package" : "Standard", "access" : 'false',  "threat-prevention" : 'true', "targets" : gw_uid})
        if install_tp_policy.success:
            print("The threat prevention policy has been installed")
        else:
            print("Failed to install threat prevention policy - {}".format(install_tp_policy.error_message))
        
        # add passwords and passphrases to dictionary
        with open('additional_pass.conf') as f:
            line_num = 0
            for line in f:
                line_num += 1
                add_password_dictionary = client.api_call("run-script", {"script-name" : "Add passwords and passphrases", "script" : "printf "{}" >> $FWDIR/conf/additional_pass.conf".format(line), "targets" : gw_name})
                if add_password_dictionary.success:
                    print("The password dictionary line {} was added successfully".format(line_num))
                else:
                    print("Failed to add the dictionary - {}".format(add_password_dictionary.error_message))

main()

একটি পাসওয়ার্ড অভিধান অতিরিক্ত_pass.conf সহ একটি উদাহরণ ফাইল
{
"passwords" : ["malware","malicious","infected","Infected"],
"phrases" : ["password","Password","Pass","pass","codigo","key","pwd","пароль","Пароль","Ключ","ключ","шифр","Шифр"]
}

উপসংহার

এই নিবন্ধটি শুধুমাত্র কাজের মৌলিক সম্ভাবনাগুলি পরীক্ষা করে পাইথন এসডিকে এবং মডিউল cpapi(যেমন আপনি অনুমান করেছেন, এগুলি আসলে প্রতিশব্দ), এবং এই মডিউলের কোড অধ্যয়ন করে আপনি এটির সাথে কাজ করার আরও বেশি সম্ভাবনা খুঁজে পাবেন। এটা সম্ভব যে আপনি এটিকে আপনার নিজস্ব ক্লাস, ফাংশন, পদ্ধতি এবং ভেরিয়েবলের সাথে সম্পূরক করতে চাইবেন। আপনি সবসময় আপনার কাজ শেয়ার করতে পারেন এবং বিভাগে চেক পয়েন্টের জন্য অন্যান্য স্ক্রিপ্ট দেখতে পারেন কোডহাব কমিউনিটি চেকমেটস, যা পণ্য বিকাশকারী এবং ব্যবহারকারী উভয়কে একত্রিত করে।

শুভ কোডিং এবং শেষ পর্যন্ত পড়ার জন্য ধন্যবাদ!

উত্স: www.habr.com