كيفية إنشاء رمز مصادقة مميز لتفاعلات FMC REST API

المقدمة

يوضح هذا المستند الكيفية التي يمكن بها لمسؤول واجهة برمجة التطبيقات المصادقة على مركز إدارة FirePOWER (FMC)، وإنشاء الرموز المميزة واستعمالها لأي تفاعلات API أخرى.

المتطلبات الأساسية

المتطلبات

توصي Cisco بأن تكون لديك معرفة بالمواضيع التالية:

• الميزات والتهيئة لمركز إدارة Firepower (FMC). (تكوين الدليل)
• فهم العديد من مكالمات REST API. (ما هي واجهات REST API؟)
• مراجعة دليل البدء السريع ل FMC.

المكونات المستخدمة

• مركز إدارة Firepower الذي يدعم واجهات REST API (الإصدار 6.1 أو أعلى) مع تمكين REST API.
• عملاء الراحة مثل PostMan و Python Scripts و Curl وما إلى ذلك.

معلومات أساسية

أصبحت واجهات REST API شائعة بشكل متزايد بسبب النهج خفيف الوزن القابل للبرمجة الذي يمكن لمديري الشبكات إستخدامه لتكوين شبكاتهم وإدارتها. تدعم FMC التكوين والإدارة باستخدام أي عميل REST كما تستخدم مستكشف واجهة برمجة التطبيقات (API) المدمجة.

التكوين

تمكين REST API على FMC

الخطوة 1. انتقل إلى النظام>التكوين>تفضيلات واجهة برمجة تطبيقات REST>تمكين واجهة برمجة تطبيقات REST.

الخطوة 2. حدد خانة الاختيار تمكين REST API.

الخطوة 3. انقر حفظ، يتم عرض شاشة حفظ ناجح عندما يتم تمكين REST API، كما هو موضح في الصورة:

إنشاء مستخدم على FMC

من أفضل الممارسات لاستخدام البنية الأساسية لواجهة برمجة التطبيقات (API) على FMC هو الحفاظ على فصل مستخدمي واجهة المستخدم (UI) ومستخدمي البرامج النصية. ارجع إلى دليل حسابات المستخدمين الخاص ب FMC لفهم مختلف أدوار المستخدمين وإرشادات إنشاء مستخدم جديد.

خطوات طلب رمز مصادقة مميز

الخطوة 1. افتح عميل REST API الخاص بك.

الخطوة 2. قم بتعيين العميل لإنشاء أمر POST، URL: https://<management_center_ip_or_name>/api/fmc_platform/v1/auth/generatetoken.

الخطوة 3. قم بتضمين اسم المستخدم وكلمة المرور كرأس مصادقة أساسي. يجب أن يكون نص POST فارغا.

على سبيل المثال، طلب مصادقة باستخدام Python:

import requests
url = "https://10.10.10.1//api/fmc_platform/v1/auth/generatetoken"

payload = {}
headers = {
'Authorization': 'Basic Y2lzY291c2VyOmNpc2NwYXBpdXNlcg=='
}

response = requests.request("POST", url, headers=headers, data = payload, verify=False)
print(response.headers)

مثال آخر على طلب مصادقة باستخدام CURL:

$ curl --request POST 'https://10.10.10.1/api/fmc_platform/v1/auth/generatetoken' --header 'Authorization: Basic Y2lzY291c2VyOmNpc2NwYXBpdXNlcg==' -k -i
HTTP/1.1 204 204
Date: Tue, 11 Aug 2020 02:54:06 GMT
Server: Apache
Strict-Transport-Security: max-age=31536000; includeSubDomains
Cache-Control: no-store
Accept-Ranges: bytes
Vary: Accept-Charset,Accept-Encoding,Accept-Language,Accept
X-auth-access-token: aa6f8326-0a0c-4f48-9d85-7a920c0fdca5
X-auth-refresh-token: 674e87d1-1572-4cd1-b86d-3abec04ca59d
USER_UUID: fc47b914-8121-11ea-ac18-f0428d0155cd
DOMAIN_ID: 111
DOMAIN_UUID: e276abec-e0f2-11e3-8169-6d9ed49b625f
global: e276abec-e0f2-11e3-8169-6d9ed49b625f
DOMAINS: [{"name":"Global","uuid":"e276abec-e0f2-11e3-8169-6d9ed49b625f"}]
X-Frame-Options: SAMEORIGIN
X-UA-Compatible: IE=edge
X-Permitted-Cross-Domain-Policies: none
X-XSS-Protection: 1; mode=block
Referrer-Policy: same-origin
Content-Security-Policy: base-uri 'self'
X-Content-Type-Options: nosniff

مثال من عميل مستند إلى واجهة المستخدم الرسومية (GUI) مثل Postman، كما هو موضح في الصورة:

إرسال طلبات API التالية

ملاحظة: ما تراه في المخرجات هو رؤوس الردود وليس نص الردود. نص الاستجابة الفعلي فارغ.  معلومات الرأس المهمة التي يلزم إستخراجها هي X-auth-access-token، وX-auth-refresh-token، وDOMAIN_UUID.

بمجرد أن تقوم بالمصادقة بنجاح على FMC واستخراج الرموز المميزة، للحصول على طلبات API إضافية، تحتاج إلى الاستفادة من المعلومات التالية:

• قم بإضافة رأس X-auth-access-token <قيمة رمز المصادقة المميز>كجزء من الطلب.
• إضافة الرؤوس X-auth-access-token <قيمة رمز المصادقة المميز>و X-auth-refresh-token <قيمة رمز التحديث المميز> في طلبات تحديث الرمز المميز.
• أستخدم Domain_UUID من الرمز المميز للمصادقة في كافة طلبات REST إلى الخادم.

باستخدام معلومات الرأس هذه، يمكنك التفاعل بنجاح مع FMC باستخدام واجهات برمجة تطبيقات REST.

أستكشاف المشكلات الشائعة وإصلاحها

• نص الطلب والاستجابة الخاص ب POST الذي تم إرساله للمصادقة فارغ. تحتاج إلى تمرير معلمات المصادقة الأساسية في رأس الطلب. يتم إرجاع جميع معلومات الرمز المميز عبر رؤوس الردود.

• عند إستخدام عميل REST، قد ترى أخطاء متعلقة بمشكلة شهادة SSL بسبب شهادة موقعة ذاتيا. يمكنك إيقاف تشغيل عملية التحقق هذه وفقا للعميل الذي تستخدمه.

• لا يمكن إستخدام بيانات اعتماد المستخدم لكل من واجهات REST API و GUI في وقت واحد، وسيتم تسجيل خروج المستخدم دون سابق إنذار إذا تم إستخدامه لكلا الواجهات.

• تكون رموز مصادقة REST API الخاصة بوحدة التحكم في إدارة الإطارات (FMC) صالحة لمدة 30 دقيقة ويمكن تحديثها ثلاث مرات.