chore: Format the document

Signed-off-by: Awiteb <a@4rs.nl>

content/ar/protocol/v1.md

@@ -38,11 +38,14 @@ add_toc = true
 مضغوط وهو يتكون من 33 بايت (264 بت) يتم ترميزه بترميز [base58] على سبيل المثال
 العنوان التالي `becZJsZZqGR7qBG8t1Pm4uy62jDTzJsabxnkARhr2syo`.
 
-يتم وضع العنوان العام في رأس (Header) الطلب (Request) بأسم `X-OTMP-PUBLIC` او في بيانات ال [Websocket] في المفتاح `public_key` ويجب
+يتم وضع العنوان العام في رأس (Header) الطلب (Request) بأسم `X-OTMP-PUBLIC` او في
-ان يكون نص [base58] صحيح مكون من 33 بايت (264 بت).
+بيانات ال [Websocket] في المفتاح `public_key` ويجب ان يكون نص [base58] صحيح مكون
+من 33 بايت (264 بت).
 
-> يجب على الخوادم عدم تخزين اسماء خوادم المرسلين الخارجيين، ويتم تحديده في الطلب المرسل من قبلهم فقط، حيث يعتبر المفتاح العام هو المعرف المشترك بين جميع الخوادم.
+> يجب على الخوادم عدم تخزين اسماء خوادم المرسلين الخارجيين، ويتم تحديده في الطلب
-> سوف يوفر هذا سهولة إنتقال الافراد من خادم إلى أخر مع بقاء تعرف الخوادم الاخرى عليهم.
+> المرسل من قبلهم فقط، حيث يعتبر المفتاح العام هو المعرف المشترك بين جميع
+> الخوادم. سوف يوفر هذا سهولة إنتقال الافراد من خادم إلى أخر مع بقاء تعرف
+> الخوادم الاخرى عليهم.
 
 ## أسم الخادم
 أسم الخادم هو نطاق إلكتروني طبيعي، على سبيل المثال `example.com` ويتم جلب عنوان
@@ -61,7 +64,8 @@ add_toc = true
 حيث يتم وضع نقطتان رأسيتان `:` بين عنوان الخادم والمنفذ الذي يستمع إليه. سيسهل
 هذا من جعل أسماء الخوادم سهلة التذكر والكتابة.
 
-يتم وضع اسم خادم المرسل في رأس الطلب بأسم `X-OTMP-SERVER` ويجب ان يكون اسم الخادم فقط، على سبيل المثال `example.com`.
+يتم وضع اسم خادم المرسل في رأس الطلب بأسم `X-OTMP-SERVER` ويجب ان يكون اسم
+الخادم فقط، على سبيل المثال `example.com`.
 
 ## مفتاح التشفير المشترك
 يتم انشاء مفتاح التشفير المشترك عبر خوارزمية [Elliptic Curve Diffie-Hellman] حيث
@@ -71,9 +75,9 @@ add_toc = true
 32 بايت (256 بت).
 
 ### التشفير
-سوف يتم استخدام [مفتاح التشفير المشترك] مفتاحاً للتشفير في خوارزمية
+سوف يتم استخدام [مفتاح التشفير المشترك] مفتاحاً للتشفير في خوارزمية [AES-256
-[AES-256 CBC]، بعد تشفير الرسالة يتم وضع قيمة التهيئة (iv) في أخر الرسالة، ليكون
+CBC]، بعد تشفير الرسالة يتم وضع قيمة التهيئة (iv) في أخر الرسالة، ليكون اخر 16
-اخر 16 بايت (128 بت) هي قيمة التهيئة (iv) التي سوف يستخدمها المستقبِل لفك تشفير
+بايت (128 بت) هي قيمة التهيئة (iv) التي سوف يستخدمها المستقبِل لفك تشفير
 الرسالة. 
 
 مثال لمفتاح تشفير مشترك بترميز [base58]\
@@ -92,40 +96,52 @@ add_toc = true
 > يقومون بتخزينه بالعادة.
 
 ## توقيع الطلب
-هو التوقيع الخاص بالطلب يتم وضعه في رأس الطلب (Header) بأسم `X-OTMP-SIGNATURE` او في بيانات ال [Websocket] في المفتاح `signature`
+هو التوقيع الخاص بالطلب يتم وضعه في رأس الطلب (Header) بأسم `X-OTMP-SIGNATURE`
-بترميز [Hex] ويتم أستخدامه للتأكد من ان مرسل الطلب هو مالك المفتاح العام.
+او في بيانات ال [Websocket] في المفتاح `signature` بترميز [Hex] ويتم أستخدامه
+للتأكد من ان مرسل الطلب هو مالك المفتاح العام.
 
 ### إنشاء التوقيع
 التوقيع يحتاج إلى ثلاث اشياء ليتم إنشائه
 - مفتاح التشفير المشترك.
 - جسم الطلب (body) او بيانات الحدث (data).
-- ثواني الوقت الحالي للمنطقة الزمنية UTC بتنسيق [Unix Time] (8 بايت أي 64 بت **big-endian**).
+- ثواني الوقت الحالي للمنطقة الزمنية UTC بتنسيق [Unix Time] (8 بايت أي 64 بت
+  **big-endian**).
 - 16 بايت عشوائي (128 بت).
 
-يتم إدخال جسم الطلب (body) او بيانات الحدث في الـ[Websocket] إلى دالة [HMAC-SHA256] و إستخدام [مفتاح التشفير المشترك] مضافاً إليه الوقت الحالي (8 بايت) و الـ16 بايت العشوائي، أي المفتاح المستخدم في دالة [HMAC-SHA256] سوف يكون
+يتم إدخال جسم الطلب (body) او بيانات الحدث في الـ[Websocket] إلى دالة
+[HMAC-SHA256] و إستخدام [مفتاح التشفير المشترك] مضافاً إليه الوقت الحالي (8
+بايت) و الـ16 بايت العشوائي، أي المفتاح المستخدم في دالة [HMAC-SHA256] سوف يكون
 
 ```
 مفتاح التشفير المشترك+الوقت الحالي+16 بايت عشوائي
 ```
-بعد ذلك يتم أخذ نتيجة دالة [HMAC-SHA256] و إضافة الوقت المستخدم في الأعلى و الـ16 بايت المستخدمة في الأعلى و جميعهم بترميز [Hex]، مثال
+بعد ذلك يتم أخذ نتيجة دالة [HMAC-SHA256] و إضافة الوقت المستخدم في الأعلى و
+الـ16 بايت المستخدمة في الأعلى و جميعهم بترميز [Hex]، مثال
 
 ```
 bad035084e11bfd266c7b7dfa473d6603be551b3aa215f869776b75bf42ef31900000000665e1a696e6d776f65726e6664757265686a66
 ```
 بعد تحويله إلى بايتات سوف يكون المجموع 56 بايت، وسوف يكون التقسيم كالتالي
-- مخرج دالة [HMAC-SHA256]: من بايت 0 إلى بايت31. (التوقيع الذي سوف يتحقق منه الخادم)
+- مخرج دالة [HMAC-SHA256]: من بايت 0 إلى بايت31. (التوقيع الذي سوف يتحقق منه
-- الوقت: من بايت 32 إلى بايت 39. (الذي سوف يتم إضافته بعد [مفتاح التشفير المشترك]) 
+  الخادم)
+- الوقت: من بايت 32 إلى بايت 39. (الذي سوف يتم إضافته بعد [مفتاح التشفير
+  المشترك]) 
 - ال 16 بايت العشوائي: من بايت 40 إلى بايت 55. (سوف يتم إضافته بعد الوقت)
 
-سوف يتحقق الخادم من أن الوقت الذي في التوقيع لم يتجاوز الـ20 ثانية، وسوف يقوم الخادم بتخزين ال 16 بايت العشوائي في الكاش بمدة حياة 30 ثانية، ليتأكد الخادم من ان ال 16 بايت العشوائي لن يتم إستخدامهم في توقيع أخر، بالتالي ضمان عدم إرسال الطلب مرة أخرى من المهاجمين (ضمان أن التوقيع صالح لمرة واحدة فقط). 
+سوف يتحقق الخادم من أن الوقت الذي في التوقيع لم يتجاوز الـ20 ثانية، وسوف يقوم
+الخادم بتخزين ال 16 بايت العشوائي في الكاش بمدة حياة 30 ثانية، ليتأكد الخادم من
+ان ال 16 بايت العشوائي لن يتم إستخدامهم في توقيع أخر، بالتالي ضمان عدم إرسال
+الطلب مرة أخرى من المهاجمين (ضمان أن التوقيع صالح لمرة واحدة فقط). 
 
 ### شكل البيانات داخل إتصال الـWebsocket
-بعد الإتصال بـ[Websocket] مع الخادم، سوف يكون تنسيق البيانات التي يتم تبادلها بين المرسل والخادم json ويجب عليها توفر المفاتيح التالية
+بعد الإتصال بـ[Websocket] مع الخادم، سوف يكون تنسيق البيانات التي يتم تبادلها
+بين المرسل والخادم json ويجب عليها توفر المفاتيح التالية
 
 - `event`: إسم الحدث، على سبيل المثال إرسال رسالة او تحديث حالة الكتابة.
 - `data`: البيانات الخاصة بالحدث. 
 - `public_key`: وهو العنوان العام الخاص بالمرسل.
--  `signature`: توقيع بيانات الحدث (data)، هذا التوقيع يكون بين المرسل وبين الخادم وليس المُستقبل.
+-  `signature`: توقيع بيانات الحدث (data)، هذا التوقيع يكون بين المرسل وبين
+   الخادم وليس المُستقبل.
 
 ليكون الشكل النهائي كالتالي (مثال)
 
@@ -145,11 +161,13 @@ bad035084e11bfd266c7b7dfa473d6603be551b3aa215f869776b75bf42ef31900000000665e1a69
 
 </div>
 
-> يمكن للخادم طلب أي شكل من البيانات، ويمكنه طلب منك بعض القيم مشفرة بينك وبينه (مثل عنوان المُستقبل) ولكن يجب على المعلومات الحساسة مثل الرسالة او الملف أن يكون مشفر بينك وبين المُستقبل فقط.
+> يمكن للخادم طلب أي شكل من البيانات، ويمكنه طلب منك بعض القيم مشفرة بينك وبينه
+> (مثل عنوان المُستقبل) ولكن يجب على المعلومات الحساسة مثل الرسالة او الملف أن
+> يكون مشفر بينك وبين المُستقبل فقط.
 
 ## طريقة التواصل
-هنا سوف يتم توضيح طريقة التواصل بين طرفين في خادم واحد (تواصل داخلي)، وبين
+هنا سوف يتم توضيح طريقة التواصل بين طرفين في خادم واحد (تواصل داخلي)، وبين طرفين
-طرفين في خوادم مختلفة (تواصل خارجي)
+في خوادم مختلفة (تواصل خارجي)
 
 ### مفاهيم مهمة
 - التواصل الداخلي: هو تواصل طرفين في الخادم نفسه.
@@ -158,57 +176,75 @@ bad035084e11bfd266c7b7dfa473d6603be551b3aa215f869776b75bf42ef31900000000665e1a69
   المسموح لهم بمراسلته.
 - القائمة السوداء: هي قائمة يمتلكها كل مستخدم في الخادم يوجد بها المستخدمين
   الغير مسموح لهم بمراسلته.
-- قائمة الخادم السوداء: هي قائمة يقوم بوضعها مالك الخادم ليمنع خادمه من التواصل مع خوادم محددة او اشخاص محددين.
+- قائمة الخادم السوداء: هي قائمة يقوم بوضعها مالك الخادم ليمنع خادمه من التواصل
+  مع خوادم محددة او اشخاص محددين.
 - جدول الإتصالات الخارجية: هو جدول يتم حفظ به الرسائل الخارجية التي وصلت إلى
   المستخدم عندما لم يكن متصل بالخادم، ويتم مسحها بعد إرسالها له.
-- جدول طلبات الدردشة: هو جدول يتضمن طلبات الدردشة التي قاموا بإرسالها او إستقبالها افراد الخادم إلى/من افراد اخرين في نفس الخادم او في خوادم أخرى، ويتم مسح الطلب بعد وصول قبوله او رفضه. يتم الإستفادة من هذا الجدول لعدم إستقبال إشعارات قبول او رفض مزيفة.
+- جدول طلبات الدردشة: هو جدول يتضمن طلبات الدردشة التي قاموا بإرسالها او
+  إستقبالها افراد الخادم إلى/من افراد اخرين في نفس الخادم او في خوادم أخرى، ويتم
+  مسح الطلب بعد وصول قبوله او رفضه. يتم الإستفادة من هذا الجدول لعدم إستقبال
+  إشعارات قبول او رفض مزيفة.
 
 > سوف يتم استبدال العنوان العام بأسم Alice و Bob لآن العناوين العامة طويلة
 > نسبياً
 
 ### التواصل الداخلي
-اولاً **يجب**[^1] عند فتحك لعميل التواصل أن تقوم بإنشاء تواصل [Websocket] بينك وبين الخادم
+اولاً **يجب**[^1] عند فتحك لعميل التواصل أن تقوم بإنشاء تواصل [Websocket] بينك
-الخاص بك، عبر هذا الإتصال سوف تستقبل الرسائل الجديدة من الخادم الخاص بك، وسوف
+وبين الخادم الخاص بك، عبر هذا الإتصال سوف تستقبل الرسائل الجديدة من الخادم الخاص
-تقوم بالتواصل من خلاله لإرسال الرسائل إلى افراد الخادم.
+بك، وسوف تقوم بالتواصل من خلاله لإرسال الرسائل إلى افراد الخادم.
 
-لدينا الآن المرسل alice والمستقبِل bob و كلاهم في الخادم نفسه، سوف يقوم
+لدينا الآن المرسل alice والمستقبِل bob و كلاهم في الخادم نفسه، سوف يقوم alice
-alice بإرسال طلب Get إلى الخادم يطلب فيه الدردشة مع bob، سوف يرد الخادم بأحد الردود التالية إعتماداً
+بإرسال طلب Get إلى الخادم يطلب فيه الدردشة مع bob، سوف يرد الخادم بأحد الردود
-على حالة alice
+التالية إعتماداً على حالة alice
 
 #### إذا لم يكن هناك مستخدم بأسم bob في الخادم
 سوف يرجع الخادم 404 و يُعلم alice بأنه ليس لديه مستخدم بهذا الأسم.
 
 #### إذا لم يكن alice في قائمة bob البيضاء ولا السوداء
-سوف يقوم الخادم اولاً  بإضافة bob إلى قائمة alice البيضاء، وبعد ذلك إضافة الطلب في جدول طلبات الدردشة **المُستقبلة** بالنسبة لـbob وسوف يضيفه إلى **المُرسلة** بالنسبة إلى alice ويرجع 200 ويقوم بإرسال طلب الدردشة إلى bob وينتظر رد bob، عندما يرد
+سوف يقوم الخادم اولاً  بإضافة bob إلى قائمة alice البيضاء، وبعد ذلك إضافة الطلب
-bob بالموافقة ام الرفض (عبر إتصال ال [Websocket])، سوف يُعلم الخادم alice بأن
+في جدول طلبات الدردشة **المُستقبلة** بالنسبة لـbob وسوف يضيفه إلى **المُرسلة**
-bob وافق او رفض التواصل معه (عبر إتصال الـ [Websocket] او إضافته إلى جدول ليعلمه عند تواصله مع الخادم). إذا لم يوافق bob سوف
+بالنسبة إلى alice ويرجع 200 ويقوم بإرسال طلب الدردشة إلى bob وينتظر رد bob،
-يقوم الخادم بإضافة alice إلى قائمة bob السوداء، و إذا وافق سوف يتم إضافته إلى القائمة البيضاء.
+عندما يرد bob بالموافقة ام الرفض (عبر إتصال ال [Websocket])، سوف يُعلم الخادم
+alice بأن bob وافق او رفض التواصل معه (عبر إتصال الـ [Websocket] او إضافته إلى
+جدول ليعلمه عند تواصله مع الخادم). إذا لم يوافق bob سوف يقوم الخادم بإضافة alice
+إلى قائمة bob السوداء، و إذا وافق سوف يتم إضافته إلى القائمة البيضاء.
 
 #### إذا كان alice في قائمة bob البيضاء
-سوف يرجع الخادم 400 و يُعلم alice بأنه يمكنه مراسلة bob بشكل مباشر عبر إتصال الـ[Websocket].
+سوف يرجع الخادم 400 و يُعلم alice بأنه يمكنه مراسلة bob بشكل مباشر عبر إتصال
+الـ[Websocket].
 
 #### إذا كان alice في قائمة bob السوداء
- سوف يرجع الخادم 403 و يُعلم alice انه في قائمة bob السوداء ولا يمكنه الدردشة معه.
+ سوف يرجع الخادم 403 و يُعلم alice انه في قائمة bob السوداء ولا يمكنه الدردشة
+ معه.
 
 > يتم تخزين رسائل الطرفين مُشفرة في قاعدة البيانات الخاصة بالخادم
 
 ### التواصل الخارجي
-لدينا الآن المرسل alice من `example1.com` والمستقبِل bob من `example2.com` سوف يقوم
+لدينا الآن المرسل alice من `example1.com` والمستقبِل bob من `example2.com` سوف
-alice بإرسال طلب Get إلى `example2.com` يطلب فيه الدردشة مع bob، سوف يرد الخادم
+يقوم alice بإرسال طلب Get إلى `example2.com` يطلب فيه الدردشة مع bob، سوف يرد
-بأحد الردود التالية
+الخادم بأحد الردود التالية
 
 #### إذا لم يكن هناك مستخدم بأسم bob في الخادم
 سوف يرجع الخادم 404 و يُعلم alice بأنه ليس لديه مستخدم بهذا الأسم.
 
 #### إذا لم يكن alice في قائمة bob البيضاء ولا السوداء
-سوف يقوم خادم bob بإرسال طلب الدردشة إلى bob او يقوم بتخزين الطلب في جدول طلبات الدردشة **المٌستقبلة**، ويرد عليه بـ200، بعد ذلك يقوم alice بطلب الخادم الخاص به من إضافة bob إلى قائمته البيضاء ليستقبل منه الرسائل مستقبلاً بدون حاجة bob إرسال طلب دردشة وإنتظار قبولها، سوف يقوم alice ايضاً بطلب الخادم من إضافة bob إلى جدول طلبات الدردشة **المُرسلة** ويتم تضمين خادم bob الحالي الذي تم إرسال طلب الدردشة إليه[^2]
+سوف يقوم خادم bob بإرسال طلب الدردشة إلى bob او يقوم بتخزين الطلب في جدول طلبات
+الدردشة **المٌستقبلة**، ويرد عليه بـ200، بعد ذلك يقوم alice بطلب الخادم الخاص به
+من إضافة bob إلى قائمته البيضاء ليستقبل منه الرسائل مستقبلاً بدون حاجة bob إرسال
+طلب دردشة وإنتظار قبولها، سوف يقوم alice ايضاً بطلب الخادم من إضافة bob إلى جدول
+طلبات الدردشة **المُرسلة** ويتم تضمين خادم bob الحالي الذي تم إرسال طلب الدردشة
+إليه[^2]
 
-إذا قبل/رفض bob الدردشة سوف يُعلم خادم bob خادم alice أن bob قام بقبول/رفض الدردشة، سوف يضع الخادم التوقيع الخاص به في `X-OTMP-SIGNATURE` وسوف يتم جلب المفتاح العام الخاص به من مسار الخادم[^3] (لقد قام alice بإضافة bob والخادم الخاص به في جدول طلبات الدردشة **المُرسلة** لذالك خادم alice يعلم ماهو خادم bob).
+إذا قبل/رفض bob الدردشة سوف يُعلم خادم bob خادم alice أن bob قام بقبول/رفض
+الدردشة، سوف يضع الخادم التوقيع الخاص به في `X-OTMP-SIGNATURE` وسوف يتم جلب
+المفتاح العام الخاص به من مسار الخادم[^3] (لقد قام alice بإضافة bob والخادم
+الخاص به في جدول طلبات الدردشة **المُرسلة** لذالك خادم alice يعلم ماهو خادم
+bob).
 
-بعد ذلك إذا لم يكن لـalice إتصال [Websocket] سابق مع خادم bob، سوف يقوم بإرسال طلب دردشة
+بعد ذلك إذا لم يكن لـalice إتصال [Websocket] سابق مع خادم bob، سوف يقوم بإرسال
-ليتم ترقية الإتصال إلى [Websocket]، ونفس المسئلة مع bob إذا اراد التواصل مع
+طلب دردشة ليتم ترقية الإتصال إلى [Websocket]، ونفس المسئلة مع bob إذا اراد
-alice سوف يقوم بإرسال طلب دردشة ويتم ترقية الإتصال او إعلامه بوجود إتصال
+التواصل مع alice سوف يقوم بإرسال طلب دردشة ويتم ترقية الإتصال او إعلامه بوجود
-[Websocket] مفتوح.
+إتصال [Websocket] مفتوح.
 
 #### إذا كان alice في قائمة bob البيضاء
 سوف يقوم الخادم بترقية الإتصال إلى [Websocket] او إذا كان alice متصل معه من قبل،
@@ -227,7 +263,8 @@ alice سوف يقوم بإرسال طلب دردشة ويتم ترقية الإ
 
 ## شكر و تقدير
 شكراً للأشخاص التاليين على مراجعة و تحسين البروتوكول.
-- أمجد الشرفي <<me@amjad.alsharafi.dev>>: تحسين طريقة عمل التوقيع، و أقتراح الطريقة الحالية.
+- أمجد الشرفي <<me@amjad.alsharafi.dev>>: تحسين طريقة عمل التوقيع، و أقتراح
+  الطريقة الحالية.
 
 {{ hr(data_content="وصلات") }}