חזרה לפיד
articlesמקור: Snyk Blog21.3.2024

תחילת עבודה עם ניתוח סטטי PHP ב-2024

אמ;לק

הפוסט מכסה את יסודות הניתוח הסטטי ומסביר כיצד לאבטח קוד PHP בשנת 2024. הוא דן בכלים ומתודולוגיות לזיהוי פגיעויות ושגיאות קוד לפני שלב הריצה, ומשפר את איכות הקוד ואבטחתו.

סיכום בעברית: מערכת VibeSec · מדיניות המקורות

נוסף ל-VibeSec:

כותרת מקורית: Getting started with PHP static analysis in 2024

תחילת עבודה עם ניתוח סטטי PHP ב-2024

התוכן המלא בעברית

תרגום אוטומטי מהמקור; מונחים טכניים נשארו באנגלית. לנוסח המחייב — הכתבה המקורית.

PHP היא שפת סקריפטים פופולרית בצד השרת המשמשת רבות לפיתוח אתרים. מפתחי PHP יכולים להפיץ ולפרוס מוצרי תוכנה איכותיים יותר על ידי שימוש בכלי ניתוח סטטי (static analysis), המסייעים בהפחתת שגיאות קוד ב-PHP, פרצות אבטחה ובעיות אחרות שעלולות להשפיע על איכות האפליקציה ואבטחתה אם לא יטופלו בשלב מוקדם של מחזור הפיתוח.

מהו ניתוח סטטי?

ניתוח סטטי, הידוע גם כניתוח קוד סטטי או ניתוח קוד מקור, הוא שיטה לניפוי באגים על ידי בחינת קוד מקור לפני הפעלת תוכנית. זה מתבצע על ידי החלת קבוצה של כללי קידוד על קוד המקור של תוכנית. המטרה העיקרית של ניתוח סטטי היא לתפוס ולתקן את השגיאות בשלב המוקדם של פיתוח הקוד.

בהקשר של ⁦PHP⁩, ניתוח סטטי כולל בחינת קוד ⁦PHP⁩ מבלי לבצע אותו, במטרה למצוא בעיות, לאשר תקני קידוד והבנת הארכיטקטורה, בין היתר.

הנה דוגמה לאופן שבו כלי ניתוח סטטי ידגיש בעיה בקוד ⁦PHP⁩:

⁦< ? php function add ( int $left, int $right): int { return $left + $right; } echo add ( "one" , "two" ); ? >⁩

בדוגמה זו, כלי הניתוח הסטטי יזהה שהארגומנטים "אחד" ו-"שניים" אינם מספרים שלמים, ובכך יפר את הצהרת סוג הפרמטר של הפונקציה.

חשיבות הניתוח הסטטי בפיתוח PHP

ניתוח סטטי ממלא תפקיד מכריע בפיתוח ⁦PHP⁩ מכמה סיבות. ראשית, זה עוזר לזהות שגיאות קוד ⁦PHP⁩ ובעיות פוטנציאליות בבסיס הקוד לפני שהקוד נדחף לייצור. זה חשוב במיוחד בשפה כמו ⁦PHP⁩ - המוקלדת באופן דינמי, מה שמקל על הצגת שגיאות הקשורות לסוג.

שנית, ניתוח סטטי ב-⁦PHP⁩ יכול להבטיח שהקוד עומד בסט מוגדר מראש של תקני קידוד. זה חשוב במיוחד בפרויקטים גדולים או בעבודה בצוות, כאשר שמירה על סגנון קידוד עקבי היא קריטית לקריאה ולתחזוקה של הקוד.

לבסוף, ניתוח סטטי יכול לעזור לזהות קוד מורכב או 'מסריח' (code smells) שעשוי להזדקק לרה-פקטורינג (refactoring). על ידי מתן מדדים על מורכבות הקוד, הוא יכול לשמש כמדריך לשיפור האיכות הכוללת של הקוד.

היתרונות של ניתוח סטטי

ניתוח סטטי, במיוחד עבור פיתוח ⁦PHP⁩, עוזר למפתחים וצוותי אבטחה:

• שפר את איכות הקוד: כלי ניתוח סטטי יכולים לעזור למפתחים לשפר את איכות הקוד שלהם על ידי זיהוי שגיאות, פרצות אבטחה והפרות של תקני קידוד. על ידי תיקון בעיות אלה בשלב מוקדם של מחזור הפיתוח, מפתחים יכולים למנוע מהן להפוך לבעיות גדולות יותר בעתיד.

• שפר את האבטחה: מנקודת מבט אבטחתית, כלי ניתוח סטטי יכולים לסייע בזיהוי פרצות אבטחה פוטנציאליות בבסיס הקוד שלך. הם יכולים לזהות בעיות אבטחה נפוצות כגון הזרקת קוד (code injection) ב-PHP,‏ Cross-site scripting (XSS), ופגיעויות של הפניה פתוחה (open redirect).

• זיהוי שגיאות קוד מוקדם: על ידי זיהוי בעיות מוקדם ככל האפשר, ניתוח סטטי יכול לחסוך למפתחים זמן ומשאבים. הוא יכול להפחית באופן משמעותי את הזמן המושקע בניפוי באגים ובביקורות קוד ידניות, ובכך לאפשר למפתחים להתמקד במשימות מורכבות יותר. התחל עם סריקת אבטחה בסטטיקה (static analysis) בחינם באמצעות Snyk.

• עמידה בתקנים: ניתוח סטטי יכול לעזור להבטיח שבסיס הקוד שלך תואם לתקני התעשייה לאיכות קוד, אבטחה ותחזוקה. זה חשוב במיוחד בתעשיות מוסדרות, שבהן עמידה בתקנים מסוימים היא לרוב דרישה.

הבנת ⁦PERCS⁩ 2.0

⁦PERCS⁩ 2.0, המייצג ⁦PHP⁩ ⁦Enhanced Review Coding Standard⁩, הוא שדרוג משמעותי לגרסה הראשונית של ⁦PERCS⁩. זהו כלי מתקדם לניתוח סטטי של קוד ⁦PHP⁩, המאפשר למפתחים לדבוק בסט ספציפי של תקני קידוד, לשפר את איכות הקוד שלהם ולחזק את מוסכמות הקידוד.

גרסה זו של ⁦PERCS⁩ מספקת מערך של תכונות, כולל בדיקת תחביר, בדיקת סגנון קוד וזיהוי פרצות אבטחה פוטנציאליות. זהו כלי רב ערך עבור מפתחים ⁦PHP⁩ שמטרתם לשפר את איכות הקוד שלהם ולהבטיח תאימות עם מוסכמות קידוד סטנדרטיות.

⁦// Sample PHP code < ? php $a = 1 ; $b = 2 ; // PERCS 2.0 can identify if this code adheres to the defined coding standards $result = $a + $b; // PERCS 2.0 will provide feedback on potential issues in this code $result = add ( '1' , 2 ); ? >⁩

עמידה בתקני קידוד היא חיונית בפיתוח תוכנה. הם מבטיחים שהקוד קריא, ניתן לתחזוקה ועקבי, מה שמקל על צוותים לשתף פעולה ועל מפתחים חדשים להבין את בסיס הקוד. תקני קידוד גם מונעים שגיאות קידוד נפוצות ופגיעויות אבטחה אפשריות. על ידי אכיפת סגנון קידוד סטנדרטי, מפתחים יכולים לזהות ולתקן בעיות בצורה יעילה ואפקטיבית יותר.

⁦// A non-standard code < ? php function ADD ($a,$b){ return $a+$b;} ? > // A standard code < ? php function addNumbers ($firstNumber, $secondNumber) { return $firstNumber + $secondNumber; } ? >⁩

⁦PERCS⁩ 2.0 משפר באופן משמעותי הן את איכות הקוד והן את ההקפדה על מוסכמות קידוד. היא עושה זאת על ידי מתן משוב מיידי למפתחים על הקוד שלהם, תוך הדגשת אזורים של אי עמידה בתקני קידוד ופגיעויות אבטחה פוטנציאליות.

על ידי שימוש ב-⁦PERCS⁩ 2.0, מפתחים יכולים לאכוף רמה גבוהה יותר של איכות קוד, ולהבטיח שהיישומים ⁦PHP⁩ שלהם אמינים, ניתנים לתחזוקה ומאובטחים.

3 כלי הניתוח הסטטיים המובילים ל-PHP

בתחום אבטחת קוד ופיתוח תוכנה, ניתוח סטטי הוא גורם מפתח בשמירה על איכות קוד גבוהה וזיהוי פרצות אבטחה פוטנציאליות לפני שהן הופכות לבעייתיות. בואו נחקור שלושה כלי ניתוח סטטיים רבי עוצמה ⁦PHP⁩: ⁦PHPStan⁩, ⁦Psalm⁩ ו-⁦Snyk⁩. כלים אלו מאפשרים למפתחים למצוא באגים ופגמי אבטחה בקוד ⁦PHP⁩, מה שמבטיח את תאימות האבטחה של האפליקציה.

1. ⁦PHPStan⁩

⁦PHPStan⁩ הוא אחד המנתחים הסטטיים הפופולריים ביותר עבור קוד ⁦PHP⁩. הוא מתמקד באיתור באגים בקוד שלך מבלי להפעיל אותו בפועל. היתרון העיקרי של ⁦PHPStan⁩ הוא היכולת שלו לתפוס מחלקות שלמות של באגים עוד לפני שאתה כותב מבחנים לקוד.

כדי להתקין את ⁦PHPStan⁩, אתה יכול להשתמש ב-composer, כלי לניהול תלות ב-⁦PHP⁩. כך:

⁦composer require -- dev phpstan / phpstan⁩

הפעלת ⁦PHPStan⁩ בקוד ⁦PHP⁩ שלך היא פשוטה כמו ביצוע הפקודה למטה:

⁦vendor / bin / phpstan analyse src⁩

כאן, src מייצג את הספרייה המכילה את הקוד ⁦PHP⁩ שלך. לאחר מכן ⁦PHPStan⁩ תוציא רשימה של בעיות פוטנציאליות שהוא מצא בקוד שלך. הפלט כולל בדרך כלל את שם הקובץ, מספר השורה ותיאור הבעיה. לדוגמה, הוא עשוי לזהות ולדווח על הפלט הבא:

⁦------ ---------------------------------------------------------------- Line src / Example . php ------ ---------------------------------------------------------------- 10 Parameter #1 $a of method Example::add() expects int, string given. ------ ----------------------------------------------------------------⁩

2. תהילים

Psalm הוא כלי ניתוח סטטי עוצמתי נוסף עבור PHP. הוא נועד לזהות שגיאות תחביר ושגיאות לוגיות בקוד שלך. אחד היתרונות העיקריים של Psalm הוא היכולת שלו להסיק טיפוסים (types) בקוד ה-PHP שלך, מה שיכול לתפוס באגים הקשורים לטיפוסים לפני שהם מתרחשים.

⁦composer require -- dev vimeo / psalm⁩

כדי להפעיל את ⁦Psalm⁩ בקוד ⁦PHP⁩ שלך, השתמש בפקודה הבאה:

⁦vendor / bin / psalm⁩

הפלט של Psalm יציג לך רשימה של בעיות בקוד, בדומה ל-PHPStan. עם זאת, Psalm מספקת גם רמת חומרה לכל בעיה, מה שיכול לעזור לתעדף תיקונים.

⁦ERROR : InvalidArgument - src / Example . php: 10 : 10 - Argument 1 of Example :: add expects int , string provided⁩

3. Snyk לאבטחת קוד בפיתוח PHP

Snyk הוא כלי אבטחה מוכוון מפתחים המסייע להם למצוא, להבין ולתקן נקודות תורפה ובעיות אבטחה בקוד שלהם, בתלויות (dependencies) של קוד פתוח, בתמונות קונטיינרים (container images) ועוד. הכלי תוכנן כך שיתאים בדיוק לזרימת העבודה הקיימת שלך. הוא משתלב בצורה חלקה עם סביבות פיתוח (IDEs) וכלי בנייה שונים, כך שתוכל להתקין בקלות את הפלאגין ל-PHPStorm או את התוסף ל-VS Code מבית Snyk, בחינם, ולהתחיל לסרוק את הקוד שלך לאיתור פרצות אבטחה.

Snyk מזהה בעיות קוד לא מאובטחות על ידי מינוף מסד הנתונים הנרחב של פגיעות ויכולות ניתוח קוד חכמות. יכולות אלו מאפשרות לכלי לזהות מגוון רחב של איומי אבטחה פוטנציאליים, כולל ביצוע קוד שהשפיע על הפרויקט ⁦SuiteCRM⁩ וגם ביצוע קוד מרחוק ב-dompdf.

בואו נסתכל על דוגמה להזרקה ⁦SQL⁩ ש-⁦Snyk⁩ יכול לזהות:

⁦// Example of SQL Injection Vulnerability < ? php $conn = new mysqli ( "127.0.0.1" , "user" , "MySecretPassword" , "db" ); function doSqlQuery () { $query = " SELECT * FROM users WHERE login = '" . $_POST[ "login" ]; return mysqli_query ($conn, $query); } $target = $_GET[ "target" ]; header ( "Location: " . $target); echo $_GET[ "user" ];⁩

בקטע הקוד ב-PHP שלמעלה, קלט מהמשתמש משורשר ישירות לתוך שאילתת ה-SQL, מה שהופך אותה לרגישה להתקפות הזרקת SQL (SQL injection). ניתוח הקוד הסטטי של Snyk יסמן זאת כסיכון אבטחה חמור. אני ממליץ לך לעבור על השיעור ב-Snyk Learn בנושא הזרקות SQL כדי להבין מדוע הקוד שלעיל אינו מאובטח וכיצד למנוע פגיעות זו.

Snyk גם עוזר לזהות באגים נפוצים בקוד ⁦PHP⁩ שעלולים להוביל לבעיות אבטחה. לדוגמה, שימוש בפונקציה ⁦PHP⁩ שהוצאה משימוש או לא נתמכת יכול להכניס פגיעויות לאפליקציה.

שילוב Snyk ב-PHPStorm וב-VS Code IDE

ניתן לשלב את Snyk בקלות ב-IDEs פופולריים כמו PHPStorm ו-Visual Studio Code, מה שיספק משוב בזמן אמת וסריקת פגיעות תוך כדי כתיבת הקוד.

לאחר התקנת הפלאגין של Snyk עבור PHPStorm, תוכל להריץ סריקות Snyk ישירות מה-IDE שלך. פשוט לחץ לחיצה ימנית על הפרויקט שלך ב-Project Explorer, בחר Snyk Scan, ותוצאות הסריקה יוצגו בלשונית Snyk בחלונית התחתונה.

שילוב Snyk עם VS Code

כדי לשלב את Snyk עם VS Code, תצטרך להתקין את התוסף Snyk Vulnerability Scanner מתוך ה-Marketplace של VS Code. לאחר ההתקנה, Snyk יסרוק אוטומטית את הפרויקט שלך לאיתור דפוסי קוד PHP לא מאובטחים ותלויות פגיעות בקובץ ה-composer שלך. ניתן גם לסרוק מחדש פרויקט על ידי פתיחת ה-Command Palette (צירוף המקשים Ctrl+Shift+P), הקלדת Snyk ובחירה באפשרות Snyk: Rescan. תוצאות הסריקה יוצגו בלשונית Snyk חדשה בסרגל הצד.

שילוב ניתוח סטטי ל-PHP בצינורות CI/CD

עם המורכבות ההולכת וגוברת של פיתוח תוכנה והצורך הגובר ביישומים מאובטחים, חשוב יותר מאי פעם לשלב כלי ניתוח סטטי וסגנון קוד בזרימת העבודה שלך בפיתוח ⁦PHP⁩. צינורות אינטגרציה מתמשכת (⁦CI⁩) ופריסה מתמשכת (⁦CD⁩) מספקים סביבה אידיאלית לאוטומציה של תהליכים אלה, ומבטיחות שאיכות הקוד והאבטחה נשמרות לאורך כל מחזור חיי הפיתוח.

כלים אלה לא רק עוזרים בשמירה על איכות ועקביות קוד, אלא גם משמשים כקו הגנה ראשון מפני איומי אבטחה פוטנציאליים. הם עוזרים בזיהוי ותיקון פגיעויות פוטנציאליות בשלבים המוקדמים של פיתוח תוכנה, ובכך חוסכים זמן, מאמץ ומשאבים בטווח הארוך.

⁦# An example of integrating PHPStan into a CI/CD pipeline using GitHub Actions name : PHPStan on : [ push , pull_request ] jobs : analysis runs - on: ubuntu - latest steps : - uses: actions / checkout @ v2 - uses: shivammathur / setup - php @ v2 with : php - version: '7.4' tools : phpstan - run: composer install -- no - progress - run: phpstan analyse⁩

בדוגמה למעלה, ⁦PHPStan⁩ משולב בצינור ⁦CI/CD⁩ באמצעות ⁦GitHub Actions⁩. זה מבטיח שניתוח סטטי מבוצע אוטומטית בכל בקשת דחיפה או משיכה, תופס בעיות פוטנציאליות מוקדם והופך את סקירת הקוד ליעילה יותר.

היתרונות של שילוב ניתוח סטטי באוטומציית CI

#php#static-analysis#security-tools#code-quality
קרא במקור

קריאה וכלים קשורים

אבטחת PHP / Laravelמונחי אבטחה והסברים בעברית