Merge pull request #112 : markdown and links for existing Farsi pages

Author: jgadsden

.github/workflows/ci.yaml

@@ -161,7 +161,16 @@ jobs:
           name: pdf-export-es
           path: site/OWASP_Developer_Guide-ES.pdf
 
-      - name: Build pdf for PT-BR
+      - name: Create FA PDF
+        run: mkdocs build --config-file mkdocs-pdf-fa.yaml
+
+      - name: Upload FA PDF
+        uses: actions/[email protected]
+        with:
+          name: pdf-export-fa
+          path: site/OWASP_Developer_Guide-FA.pdf
+
+      - name: Create PT-BR PDF
         run: mkdocs build --config-file mkdocs-pdf-pt-br.yaml
 
       - name: Upload PT-BR PDF

.github/workflows/pr.yaml

@@ -150,5 +150,8 @@ jobs:
       - name: Build pdf for ES
         run: mkdocs build --config-file mkdocs-pdf-es.yaml
 
+      - name: Build pdf for FA
+        run: mkdocs build --config-file mkdocs-pdf-fa.yaml
+
       - name: Build pdf for PT-BR
         run: mkdocs build --config-file mkdocs-pdf-pt-br.yaml

.gitignore

@@ -37,6 +37,10 @@
 !docs/es/index.md
 !docs/es/**/
 !docs/es/**/*.md
+!docs/fa/
+!docs/fa/index.md
+!docs/fa/**/
+!docs/fa/**/*.md
 !docs/pt-br/
 !docs/pt-br/index.md
 !docs/pt-br/**/

.markdownlint.yaml

@@ -8,7 +8,7 @@ link-fragments: false
 MD013:
   code_block_line_length: 125
   code_blocks: true
-  heading_line_length: 80
+  heading_line_length: 100
   headings: true
   line_length: 125
   stern: true

.wordlist-en.txt

@@ -7,6 +7,7 @@ ARP
 ASVS
 AUTH
 Adoptium
+alirezakkt
 Analyser
 Andra
 Andreas

contributing.md

@@ -87,6 +87,7 @@ and translations help to make is a useful resource for the global AppSec communi
 There are translations in progress:
 
 * [Spanish][es] lead translator Roxana Calderon
+* [Farsi][fa] lead translator alirezakkt
 * [Brazilian Portuguese][pt-br] lead translator Amauri Bizerra
 * [Japanese][ja] lead translator Yuuki Ebihara
 
@@ -206,6 +207,7 @@ OWASP DevGuide: _accessible security for developers_
 [asvs]: https://owasp.org/www-project-application-security-verification-standard/
 [conduct]: code_of_conduct.md
 [es]: https://github.com/OWASP/DevGuide/tree/main/docs/es
+[fa]: https://github.com/OWASP/DevGuide/tree/main/docs/fa
 [ja]: https://github.com/OWASP/DevGuide/tree/main/docs/ja
 [issues]: https://github.com/OWASP/DevGuide/issues/new/choose
 [lychee-install]: https://lychee.cli.rs/

docs/fa/02-foundations/01-security-fundamentals.md

@@ -99,18 +99,20 @@ NIST یک [آسیب‌پذیری][nistvuln] را اینگونه تعریف می
 
 آسیب‌پذیری‌های امنیتی شناخته‌شده عبارتند از:
 
-- [دزدیدن کلیک (Clickjacking)](https://cheatsheetseries.owasp.org/cheatsheets/Clickjacking_Defense_Cheat_Sheet.html)
-- [حمله با اعتبارنامه‌های سرقت‌شده (Credential Stuffing)](https://cheatsheetseries.owasp.org/cheatsheets/Credential_Stuffing_Prevention_Cheat_Sheet.html)
+- [دزدیدن کلیک (Clickjacking)][csclick]
+- [حمله با اعتبارنامه‌های سرقت‌شده (Credential Stuffing)][cscreds]
 - [نشت اطلاعات بین سایتی (Cross-site leaks)][csxsleaks]
-- [حملات نفی سرویس (Denial of Service)](https://cheatsheetseries.owasp.org/cheatsheets/Denial_of_Service_Cheat_Sheet.html) (DoS)
-- حملات [XSS مبتنی بر DOM](https://cheatsheetseries.owasp.org/cheatsheets/DOM_based_XSS_Prevention_Cheat_Sheet.html) شامل [DOM Clobbering](https://cheatsheetseries.owasp.org/cheatsheets/DOM_Clobbering_Prevention_Cheat_Sheet.html)
-- [IDOR](https://cheatsheetseries.owasp.org/cheatsheets/Insecure_Direct_Object_Reference_Prevention_Cheat_Sheet.html)
-- [تزریق (Injection)](https://cheatsheetseries.owasp.org/cheatsheets/Injection_Prevention_Cheat_Sheet.html) شامل [تزریق دستور سیستم‌عامل](https://cheatsheetseries.owasp.org/cheatsheets/OS_Command_Injection_Defense_Cheat_Sheet.html) و [XXE][csxxe]
-- [حملات تزریق مخصوص LDAP](https://cheatsheetseries.owasp.org/cheatsheets/LDAP_Injection_Prevention_Cheat_Sheet.html)
-- [آلودگی پروتوتایپ در جاوا اسکریپت (Prototype pollution)](https://cheatsheetseries.owasp.org/cheatsheets/Prototype_Pollution_Prevention_Cheat_Sheet.html)
+- [حملات نفی سرویس (Denial of Service DoS)][csdos]
+- حملات [XSS مبتنی بر DOM][csdom] شامل
+    [DOM Clobbering][csdomclub]
+- [IDOR][csidor]
+- [تزریق (Injection)][csinjection]
+    شامل [تزریق دستور سیستم‌عامل]][csosinjection] و [XXE][csxxe]
+- [حملات تزریق مخصوص LDAP][csldap]
+- [آلودگی پروتوتایپ در جاوا اسکریپت (Prototype pollution)][csproto]
 - حملات [SSRF][csssrf]
-- [تزریق SQL](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html) و استفاده از [کوئری](https://cheatsheetseries.owasp.org/cheatsheets/Query_Parameterization_Cheat_Sheet.html) های پارامتری
-- [تغییر ریدایرکت و فورواردهای اعتبارسنجی‌نشده](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html)
+- [تزریق SQL][cssql] و استفاده از [کوئری][csquery] های پارامتری
+- [تغییر ریدایرکت و فورواردهای اعتبارسنجی‌نشده][csredirect]
 - حملات [XSS][csxss] و [دور زدن فیلتر XSS][csxssevade]
 
 #### HTTP و HTML
@@ -120,21 +122,23 @@ NIST یک [آسیب‌پذیری][nistvuln] را اینگونه تعریف می
 کنترل‌های امنیتی مختلف آن‌ها داشته باشند.
 
 اکثر تیم‌های توسعه اپلیکیشن با ارتباطات HTTP و استاندارد HTML آشنا هستند، اما در صورت لزوم به
-آموزش‌های [w3consortium] یا [W3 Schools][w3schools] مراجعه کنید. [مجموعه برگه‌های تقلب OWASP](https://cheatsheetseries.owasp.org/)
+آموزش‌های [w3consortium] یا [W3 Schools][w3schools] مراجعه کنید.
+[مجموعه برگه‌های تقلب OWASP](https://cheatsheetseries.owasp.org/)
 اطلاعات مورد نیاز برای تولید نرم‌افزار امن را در اختیار توسعه‌دهندگان اپلیکیشن‌های وب قرار می‌دهد:
 
-- برگه تقلب [امنیت HTML5](https://cheatsheetseries.owasp.org/cheatsheets/HTML5_Security_Cheat_Sheet.html) طیف گسترده‌ای از کنترل‌ها را، مطابق با [استاندارد زنده HTML][htmlliving] فعلی، توصیف می‌کند.
-- برای CSS به برگه تقلب [CSS](https://cheatsheetseries.owasp.org/cheatsheets/Securing_Cascading_Style_Sheets_Cheat_Sheet.html) مراجعه کنید.
-- هدرهای HTTP باید امن باشند، برگه تقلب [هدرهای پاسخ امنیتی HTTP](https://cheatsheetseries.owasp.org/cheatsheets/HTTP_Headers_Cheat_Sheet.html) را ببینید.
+- برگه تقلب [امنیت HTML5][htmlliving] طیف گسترده‌ای از کنترل‌ها را، مطابق با
+[استاندارد زنده HTML][htmlliving] فعلی، توصیف می‌کند.
+- برای CSS به برگه تقلب [CSS][cscss] مراجعه کنید.
+- هدرهای HTTP باید امن باشند، برگه تقلب [هدرهای پاسخ امنیتی HTTP][csheaders] را ببینید.
 - [امنیت انتقال اکید HTTP][csstrict] را قویاً مد نظر قرار دهید.
-- اگر اپلیکیشن قابلیت آپلود فایل دارد، از برگه تقلب [آپلود فایل](https://cheatsheetseries.owasp.org/cheatsheets/File_Upload_Cheat_Sheet.html) پیروی کنید.
-- با استفاده از برگه تقلب [سیاست امنیت محتوا](https://cheatsheetseries.owasp.org/cheatsheets/Content_Security_Policy_Cheat_Sheet.html)، از وجود سیاست امنیت محتوا اطمینان حاصل کنید.
-- از JWT برای یک اپلیکیشن جاوا استفاده می‌کنید؟ به برگه تقلب [توکن وب JSON](https://cheatsheetseries.owasp.org/cheatsheets/JSON_Web_Token_for_Java_Cheat_Sheet.html) مراجعه کنید.
-- اشیاء را ذخیره یا ارسال می‌کنید؟ برگه تقلب [Deserialization (وارسیال‌سازی)](https://cheatsheetseries.owasp.org/cheatsheets/Deserialization_Cheat_Sheet.html) را بررسی کنید.
+- اگر اپلیکیشن قابلیت آپلود فایل دارد، از برگه تقلب [آپلود فایل][csfile] پیروی کنید.
+- با استفاده از برگه تقلب [سیاست امنیت محتوا][cscsp]، از وجود سیاست امنیت محتوا اطمینان حاصل کنید.
+- از JWT برای یک اپلیکیشن جاوا استفاده می‌کنید؟ به برگه تقلب [توکن وب JSON][csjwt] مراجعه کنید.
+- اشیاء را ذخیره یا ارسال می‌کنید؟ برگه تقلب [Deserialization (وارسیال‌سازی)][csserial] را بررسی کنید.
 
 #### منابع
 
-- [استاندارد زنده HTML][htmlliving] [WHATWG]
+- [استاندارد زنده HTML][htmlliving] [WHATWG][whatwg]
 - OWASP [مجموعه برگه‌های تقلب](https://cheatsheetseries.owasp.org/)
 - OWASP [مدل بلوغ تضمین نرم‌افزار][samm] (SAMM)
 
@@ -143,6 +147,25 @@ NIST یک [آسیب‌پذیری][nistvuln] را اینگونه تعریف می
 راهنمای توسعه‌دهنده OWASP یک تلاش اجتماعی است؛ اگر چیزی نیاز به تغییر دارد، لطفاً
 [یک ایشو ثبت کنید][issue0401] یا [در گیت‌هاب ویرایش کنید][edit0401].
 
+[csclick]: https://cheatsheetseries.owasp.org/cheatsheets/Clickjacking_Defense_Cheat_Sheet
+[cscreds]: https://cheatsheetseries.owasp.org/cheatsheets/Credential_Stuffing_Prevention_Cheat_Sheet
+[cscsp]: https://cheatsheetseries.owasp.org/cheatsheets/Content_Security_Policy_Cheat_Sheet.html
+[cscss]: https://cheatsheetseries.owasp.org/cheatsheets/Securing_Cascading_Style_Sheets_Cheat_Sheet.html
+[csdom]: https://cheatsheetseries.owasp.org/cheatsheets/DOM_based_XSS_Prevention_Cheat_Sheet
+[csdomclub]: https://cheatsheetseries.owasp.org/cheatsheets/DOM_Clobbering_Prevention_Cheat_Sheet
+[csdos]: https://cheatsheetseries.owasp.org/cheatsheets/Denial_of_Service_Cheat_Sheet
+[csidor]: https://cheatsheetseries.owasp.org/cheatsheets/Insecure_Direct_Object_Reference_Prevention_Cheat_Sheet
+[csinjection]: https://cheatsheetseries.owasp.org/cheatsheets/Injection_Prevention_Cheat_Sheet
+[csosinjection]: https://cheatsheetseries.owasp.org/cheatsheets/OS_Command_Injection_Defense_Cheat_Sheet
+[csldap]: https://cheatsheetseries.owasp.org/cheatsheets/LDAP_Injection_Prevention_Cheat_Sheet
+[csproto]: https://cheatsheetseries.owasp.org/cheatsheets/Prototype_Pollution_Prevention_Cheat_Sheet
+[csfile]: https://cheatsheetseries.owasp.org/cheatsheets/File_Upload_Cheat_Sheet.html
+[csheaders]: https://cheatsheetseries.owasp.org/cheatsheets/HTTP_Headers_Cheat_Sheet.html
+[csjwt]: https://cheatsheetseries.owasp.org/cheatsheets/JSON_Web_Token_for_Java_Cheat_Sheet.html
+[cssql]: https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet
+[csredirect]: https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet
+[csserial]: https://cheatsheetseries.owasp.org/cheatsheets/Deserialization_Cheat_Sheet.html
+[csquery]: https://cheatsheetseries.owasp.org/cheatsheets/Query_Parameterization_Cheat_Sheet
 [csssrf]: https://cheatsheetseries.owasp.org/cheatsheets/Server_Side_Request_Forgery_Prevention_Cheat_Sheet.html
 [csstrict]: https://cheatsheetseries.owasp.org/cheatsheets/HTTP_Strict_Transport_Security_Cheat_Sheet.html
 [csxss]: https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html
@@ -161,4 +184,4 @@ NIST یک [آسیب‌پذیری][nistvuln] را اینگونه تعریف می
 [sammv]: https://owaspsamm.org/model/verification/
 [w3consortium]: https://www.w3.org/
 [w3schools]: https://www.w3schools.com/html/
-[whatwg]: <https://whatwg.org/>
+[whatwg]: https://whatwg.org/

docs/fa/02-foundations/02-secure-development.md

@@ -209,4 +209,4 @@ DevOps و پایپ‌لاین‌ها با عواقب جدی در مقیاس بز
 [top10]: https://owasp.org/Top10/
 [intstand]: https://owasp.org/www-project-integration-standards/
 [webgoat]: https://owasp.org/www-project-webgoat/
-[wstg]: https://owasp.org/www-project-web-security-testing-guide/
+[wstg]: https://owasp.org/www-project-web-security-testing-guide/

docs/fa/02-foundations/03-security-principles.md

@@ -1,5 +1,6 @@
 این بخش مقدمه‌ای بسیار کوتاه بر برخی مفاهیم مورد استفاده در حوزه امنیت نرم‌افزار است، چرا که این مفاهیم
-ممکن است برای بسیاری از توسعه‌دهندگان اپلیکیشن ناآشنا باشند. [مجموعه برگه‌های تقلب OWASP](https://cheatsheetseries.owasp.org/)
+ممکن است برای بسیاری از توسعه‌دهندگان اپلیکیشن ناآشنا باشند.
+[مجموعه برگه‌های تقلب OWASP](https://cheatsheetseries.owasp.org/)
 توضیحات عمیق‌تری برای این اصول امنیتی ارائه می‌دهد؛ برای مطالعه بیشتر به بخش انتهایی این متن مراجعه کنید.
 
 #### نمای کلی (Overview)
@@ -38,7 +39,7 @@
 
 #### دفاع در عمق (Defense in Depth)
 
-[دفاع در عمق](https://cheatsheetseries.owasp.org/cheatsheets/Secure_Product_Design_Cheat_Sheet.html#2-the-principle-of-defense-in-depth)
+[دفاع در عمق][did]
 که به آن دفاع لایه‌ای نیز گفته می‌شود، یک اصل امنیتی است که در آن، دفاع در برابر حمله توسط چندین کنترل
 امنیتی فراهم می‌شود. هدف این است که نقاط شکست کامل (single points of complete compromise) با گنجاندن
 یک سری یا چندین لایه از پادمان‌های امنیتی و اقدامات متقابل برای کاهش ریسک، حذف یا کاهش یابند.
@@ -83,7 +84,7 @@ Defaults) یا «امنیت به صورت پیش‌فرض» (Secure by Default)
 #### تفکیک وظایف (Separation of Duties)
 
 تفکیک وظایف، که به عنوان
-[تفکیک امتیازات](https://cheatsheetseries.owasp.org/cheatsheets/Secure_Product_Design_Cheat_Sheet.html#1-the-principle-of-least-privilege-and-separation-of-duties)
+[تفکیک امتیازات][sop]
 نیز شناخته می‌شود، یک اصل امنیتی است که نیازمند آن است که تکمیل موفقیت‌آمیز یک وظیفه واحد، به دو یا
 چند شرط وابسته باشد که هر یک به تنهایی برای تکمیل آن وظیفه کافی نیستند.
 
@@ -169,15 +170,19 @@ Defaults) یا «امنیت به صورت پیش‌فرض» (Secure by Default)
 - کنترل‌های پیشگیرانه ۱۰گانه برتر OWASP
   - [C5: Secure by Default Configurations](https://top10proactive.owasp.org/the-top-10/c5-secure-by-default/)
 - سایر موارد
-  - [Compartmentalization (information security)](https://en.wikipedia.org/wiki/Compartmentalization_(information_security)), (Wikipedia)
+  - [Compartmentalization (information security)](https://en.wikipedia.org/wiki/Compartmentalization_(information_security))
   - [Least Functionality](https://csf.tools/reference/nist-sp-800-53/r5/cm/cm-7/), (NIST)
   - [Security by Design](https://pubs.opengroup.org/security/o-esa/#_Toc291061712), (Open Group)
   - [Usability and Manageability](https://pubs.opengroup.org/security/o-esa/#_Toc291061714), (Open Group)
 
 ---
 
-راهنمای توسعه‌دهندگان OWASP یک تلاش جمعی است؛ اگر چیزی نیاز به تغییر دارد، لطفاً
-[یک issue ثبت کنید](https://github.com/OWASP/DevGuide/issues/new?labels=enhancement&template=request.md&title=Update:%2002-foundations/03-security-principles)
-یا [در GitHub ویرایش کنید](https://github.com/OWASP/DevGuide/blob/main/docs/en/02-foundations/03-security-principles.md).
+راهنمای توسعه‌دهنده OWASP یک تلاش اجتماعی است؛ اگر چیزی نیاز به تغییر دارد، لطفاً
+[یک ایشو ثبت کنید][issue0403] یا [در گیت‌هاب ویرایش کنید][edit0403].
 
-[^1]: [Operational Management](https://owaspsamm.org/model/operations/operational-management/), (SAMM)
+[^1]: [Operational Management](https://owaspsamm.org/model/operations/operational-management/), (SAMM)
+
+[did]: https://cheatsheetseries.owasp.org/cheatsheets/Secure_Product_Design_Cheat_Sheet.html#2-the-principle-of-defense-in-depth
+[edit0403]: https://github.com/OWASP/DevGuide/blob/main/docs/en/02-foundations/03-security-principles.md
+[issue0403]: https://github.com/OWASP/DevGuide/issues/new?labels=enhancement&template=request.md&title=Update:%2002-foundations/03-security-principles
+[sop]: https://cheatsheetseries.owasp.org/cheatsheets/Secure_Product_Design_Cheat_Sheet.html#1-the-principle-of-least-privilege-and-separation-of-duties