يوضّح هذا المستند كيفية استخدام شهادات البريد الإلكتروني S/MIME مع واجهة برمجة التطبيقات Gmail API.
توفّر واجهة برمجة التطبيقات Gmail API إمكانية الوصول آليًا لإدارة شهادات البريد الإلكتروني S/MIME للمستخدمين في نطاق Google Workspace.
على المشرف تفعيل S/MIME المُستضاف للنطاق لكي تعمل الشهادات.
يوفّر معيار S/MIME مواصفات لتشفير المفتاح العمومي وتوقيع بيانات MIME. عند ضبط شهادات S/MIME لحساب مستخدم، يستخدمها Gmail بالطرق التالية:
توقيع الرسائل الإلكترونية الصادرة باستخدام شهادة المستخدم والمفتاح الخاص
فك تشفير البريد الوارد باستخدام المفتاح الخاص للمستخدم
تشفير البريد الصادر باستخدام شهادة المستلم ومفتاحه العام
التحقّق من البريد الوارد باستخدام شهادة المرسِل والمفتاح العام
يمكنك إنشاء شهادات S/MIME فردية وتحميلها باستخدام واجهة برمجة التطبيقات Gmail API. تكون كل شهادة S/MIME مخصّصة لاسم مستعار معيّن لحساب بريد إلكتروني خاص بمستخدم. تتضمّن العناوين البديلة عنوان البريد الإلكتروني الأساسي وعناوين "الإرسال باسم" المخصّصة. تحدّد واجهة برمجة التطبيقات شهادة S/MIME واحدة كشهادة تلقائية لكل اسم مستعار.
لمزيد من المعلومات حول العناوين البديلة، يُرجى الاطّلاع على إدارة العناوين البديلة والتوقيعات باستخدام Gmail API.
تفويض الوصول إلى واجهة برمجة التطبيقات
للسماح بالوصول إلى واجهة برمجة تطبيقات Gmail، استخدِم إحدى الطرق التالية:
استخدِم حساب خدمة مع تفويض على مستوى النطاق. للحصول على شرح لهذه المصطلحات، يُرجى الاطّلاع على التعرّف على المصادقة والتفويض. لتفعيل هذا الخيار، يُرجى الاطّلاع على إنشاء بيانات اعتماد الوصول.
استخدِم مسار OAuth 2.0 العادي الذي يتطلّب موافقة المستخدم للحصول على رمز مميز للوصول إلى OAuth 2.0. لمزيد من المعلومات، يُرجى الاطّلاع على لمحة عن المصادقة والتفويض.
لاستخدام هذا الخيار، على مشرف النطاق وضع علامة في مربّع الاختيار تفعيل ترميز S/MIME لإرسال الرسائل الإلكترونية واستلامها في وحدة تحكّم المشرف في Google. لمزيد من المعلومات، يُرجى الاطّلاع على تفعيل S/MIME المُستضاف في وحدة تحكّم المشرف.
نطاقات الأذونات
تعتمد واجهة برمجة التطبيقات Gmail API على نطاقات OAuth نفسها التي تستخدمها طرق Gmail sendAs:
gmail.settings.basic: مطلوبة لتعديلSendAsS/MIME الأساسي.gmail.settings.sharing: مطلوبة لتعديل من المخصّصة في S/MIME.
ضبط مفاتيح S/MIME
يتيح المرجع
settings.sendAs.smimeInfo
عدة طرق لإدارة شهادات S/MIME. يرتبط كل شهادة باسم مستعار واحد للمستخدم.
لتحديد الأسماء المستعارة التي يمكن للمستخدم إرسال الرسائل منها، استخدِم طريقة
settings.sendAs.list
في مورد
settings.sendAs.
تحميل مفتاح S/MIME
استخدِم طريقة
settings.sendAs.smimeInfo.insert
في المورد settings.sendAs.smimeInfo لتحميل مفتاح S/MIME جديد
لاسم مستعار يخص مستخدمًا. حدِّد الاسم المستعار المستهدف باستخدام مَعلمات المسار التالية:
userId: عنوان البريد الإلكتروني للمستخدم. استخدِم القيمة الخاصةmeللإشارة إلى المستخدم الذي تمّت مصادقته.sendAsEmail: الاسم المستعار الذي يتم تحميل المفتاح إليه. يظهر عنوان البريد الإلكتروني هذا في رأسFrom:للرسائل الإلكترونية التي يتم إرسالها باستخدام هذا العنوان البديل.
قدِّم شهادة S/MIME والمفتاح الخاص في حقل
pkcs12
بالتنسيق PKCS #12. لا تضبط أي حقول أخرى في الطلب. يحتوي الحقل pkcs12 على مفتاح S/MIME الخاص بالمستخدم وسلسلة شهادات التوقيع. تُجري واجهة برمجة التطبيقات عمليات التحقّق العادية على هذا الحقل قبل قبوله،
وتتحقّق من ما يلي:
- يتطابق الموضوع مع عنوان البريد الإلكتروني المحدّد.
- فترات انتهاء الصلاحية صالحة.
- أن يكون مرجع التصديق (CA) الذي أصدر الشهادة مدرَجًا في قائمة مراجع التصديق الموثوق بها لدى Google
- تتطابق الشهادات مع القيود الفنية في Gmail.
إذا كان المفتاح مشفّرًا، أدخِل كلمة المرور في الحقل
encryptedKeyPassword. يؤدي استدعاء الطريقة settings.sendAs.smimeInfo.insert بنجاح إلى عرض المورد settings.sendAs.smimeInfo id المستخدَم للإشارة إلى المفتاح في المستقبل.
عرض قائمة بمفاتيح S/MIME الخاصة بمستخدم
استخدِم طريقة
settings.sendAs.smimeInfo.list
في مورد settings.sendAs.smimeInfo لعرض قائمة بمفاتيح S/MIME
للمستخدم المحدّد والاسم المستعار المحدّد. حدِّد الاسم المستعار المستهدف باستخدام مَعلمات المسار التالية:
userId: عنوان البريد الإلكتروني للمستخدم. استخدِم القيمة الخاصةmeللإشارة إلى المستخدم الذي تمّت مصادقته.sendAsEmail: الاسم المستعار الذي سيتم عرض المفاتيح الخاصة به. يظهر عنوان البريد الإلكتروني هذا في رأس الرسالةFrom:للرسائل الإلكترونية المُرسَلة باستخدام هذا الاسم المستعار.
استرداد مفاتيح S/MIME لاسم مستعار
استخدِم طريقة
settings.sendAs.smimeInfo.get
في مورد settings.sendAs.smimeInfo لعرض مفاتيح S/MIME المحدّدة لاسم مستعار محدّد للإرسال كعنوان آخر خاص بمستخدم. حدِّد الاسم المستعار المستهدف باستخدام مَعلمات المسار التالية:
userId: عنوان البريد الإلكتروني للمستخدم. استخدِم القيمة الخاصةmeللإشارة إلى المستخدم الذي تمّت مصادقته.sendAsEmail: الاسم المستعار الذي تسترد المفاتيح له. يظهر عنوان البريد الإلكتروني هذا في رأسFrom:للرسائل الإلكترونية التي يتم إرسالها باستخدام هذا العنوان البديل.
حذف مفتاح S/MIME
استخدِم طريقة
settings.sendAs.smimeInfo.delete
في مورد settings.sendAs.smimeInfo لحذف مفتاح S/MIME المحدّد من اسم مستعار. حدِّد الاسم المستعار المستهدف باستخدام مَعلمات المسار التالية:
userId: عنوان البريد الإلكتروني للمستخدم. استخدِم القيمة الخاصةmeللإشارة إلى المستخدم الذي تمّت مصادقته.
sendAsEmail: الاسم المستعار الذي تحذف منه المفتاح. يظهر عنوان البريد الإلكتروني هذا في رأسFrom:للرسائل الإلكترونية التي يتم إرسالها باستخدام هذا العنوان البديل.id: رقم التعريف غير القابل للتغيير الخاص بـsmimeInfo.
لا يمكن رؤية المفتاح المحذوف أو استخدامه بعد الآن. لا يمكنك فك تشفير الرسائل الإلكترونية الواردة المشفّرة باستخدام معيار S/MIME والمفتاح العام المطابق. قبل حذف مفتاح، عليك إبطاله لدى الجهة التي أصدرته (مرجع التصديق).
ضبط مفتاح S/MIME التلقائي لاسم مستعار
استخدِم طريقة
settings.sendAs.smimeInfo.setDefault
في مورد settings.sendAs.smimeInfo لوضع علامة على مفتاح S/MIME المحدّد
كإعداد تلقائي للاسم المستعار المحدّد. حدِّد الاسم المستعار المستهدف باستخدام مَعلمات المسار التالية:
userId: عنوان البريد الإلكتروني للمستخدم. استخدِم القيمة الخاصةmeللإشارة إلى المستخدم الذي تمّت مصادقته.sendAsEmail: العنوان البديل للبريد الإلكتروني الذي تريد ضبط المفتاح التلقائي له. يظهر عنوان البريد الإلكتروني هذا في رأسFrom:للرسائل الإلكترونية التي يتم إرسالها باستخدام هذا العنوان البديل.id: رقم التعريف غير القابل للتغيير الخاص بـsmimeInfo.
مفتاح S/MIME واحد فقط هو الإعداد التلقائي لعنوان بديل "الإرسال باسم" الخاص بالمستخدم. يؤدي استدعاء الطريقة settings.sendAs.smimeInfo.setDefault إلى إلغاء الإعداد التلقائي السابق.
عندما يتلقّى مستخدم رسائل S/MIME موقّعة بمفتاح معيّن، يربط Gmail المفتاح بتاريخ الصلاحية not_beforeالأبعد في المستقبل
كإعداد تلقائي عند تشفير الرسائل الإلكترونية المرسَلة إلى
المستخدم المرتبط. لضمان استخدام مفتاح التشفير التلقائي الجديد من قِبل مستخدمي Gmail الذين سبق للمستخدم التواصل معهم، تأكَّد من أنّ تاريخ not_before للمفتاح التلقائي الجديد يسبق تاريخ المفتاح التلقائي السابق أو ألغِ المفتاح التلقائي السابق.
عيّنات تعليمات برمجية
تعرض عيّنات الرموز البرمجية التالية كيفية استخدام واجهة برمجة التطبيقات Gmail API لإدارة شهادات S/MIME لمؤسسة تضم عدة مستخدمين:
إنشاء مورد smimeInfo لشهادة S/MIME
يوضّح نموذج الرمز البرمجي هذا كيفية قراءة شهادة من ملف، وترميزها إلى سلسلة Base64URL، وتعيينها إلى الحقل pkcs12 في المورد settings.sendAs.smimeInfo:
جافا
Python
تحميل شهادة S/MIME
لتحميل شهادة، استدعِ طريقة
settings.sendAs.smimeInfo.insert
وقدِّم مصدر settings.sendAs.smimeInfo في نص الطلب:
جافا
Python
إدارة شهادات مستخدمين متعدّدين
تعرض عيّنات الرموز البرمجية هذه كيفية إدارة الشهادات لعدة مستخدمين في مؤسسة من خلال طلب مجمّع واحد:
إدراج شهادات من ملف CSV
في ما يلي نموذج لملف CSV يتضمّن معرّفات المستخدمين ومسار شهادة كل مستخدم:
$ cat certificates.csv
user1@example.com,/path/to/user1_cert.p12,cert_password_1
user2@example.com,/path/to/user2_cert.p12,cert_password_2
user3@example.com,/path/to/user3_cert.p12,cert_password_3
جافا
يمكنك استخدام نماذج
CreateSmimeInfo
وInsertSmimeInfo
لتحميل الشهادات للمستخدمين المحدّدين في ملف CSV:
Python
يمكنك استخدام نماذج
create_smime_info
وinsert_smime_info
لتحميل الشهادات للمستخدمين المحدّدين في ملف CSV:
إدارة الشهادة
يجمع هذا النموذج عدة طرق من مرجع settings.sendAs.smimeInfo
لإظهار كيفية إدارة الشهادات لمؤسستك. تعرض هذه السمة قائمة بالشهادات الخاصة بالمستخدم. إذا انتهت صلاحية الشهادة التلقائية أو لم يتم ضبطها، سيتم تحميل الشهادة التي تم العثور عليها في الملف المحدّد. بعد ذلك، يتم ضبط الشهادة التي يكون تاريخ انتهاء صلاحيتها الأبعد في المستقبل كشهادة تلقائية.
تعالج هذه الدالة بعد ذلك ملف CSV، على غرار نموذج إدراج الشهادات من ملف CSV السابق.
جافا
Python
مواضيع ذات صلة
- إدارة الأسماء المستعارة والتوقيعات باستخدام Gmail API
- اختيار نطاقات Gmail API
- تفعيل S/MIME المستضاف لتشفير الرسائل