مشاركة عبر

AdvancedSecurity-Codeql-Init@1 - مهمة تهيئة الأمان المتقدم ل CodeQL v1

  • مقالة

تهيئة قاعدة بيانات CodeQL استعدادا للبناء.

يجب تمكين GitHub Advanced Security ل Azure DevOps للمستودع الذي يتم مسحه ضوئيا.

بناء الجملة

# Advanced Security Initialize CodeQL v1
# Initializes the CodeQL database in preparation for building.
- task: AdvancedSecurity-Codeql-Init@1
  inputs:
    #languages: # 'csharp' | 'cpp' | 'go' | 'java' | 'javascript' | 'python' | 'ruby' | 'swift'. Languages to analyze. 
    #querysuite: 'Select a query suite...' # 'Select a query suite...' | 'code-scanning' | 'security-extended' | 'security-experimental' | 'security-and-quality'. CodeQL Query Suite to use for analysis. Default: Select a query suite....
  # Advanced
    #ram: # string. Options to control RAM usage in MB. 
    #threads: # string. Use this many threads to evaluate queries. 
    #codeqlpathstoignore: # string. Set a list of paths to exclude in the CodeQL analysis. 
    #codeqlpathstoinclude: # string. Set a list of additional paths to include in the CodeQL analysis. 
    #sourcesfolder: # string. Sets the folder that contains the sources to be analyzed. 
    #loglevel: '_' # '0' | '1' | '2' | '_'. Set the log level for the CodeQL analysis. Default: _.
    #configfilepath: # string. Use this to enable custom query analysis in codeql (path must be absolute). 
    #codeqltoolsdirectory: # string. Set a custom CodeQL tools directory (path must be absolute).

الإدخالات

languages - اللغات المراد تحليلها
string. القيم المسموح بها: csharp، cpp، go، java، javascript، python، ruby. swift

لغة البرمجة المراد تحليلها. يمكن فصل لغات متعددة بفاوصلة.

يمكنك تعيين اللغة هنا في المهمة، أو يمكنك تحديد اللغة في متغير البنية الأساسية لبرنامج ربط العمليات التجارية المسمى advancedsecurity.codeql.language. إذا تم تعيين كليهما، فإن القيمة المحددة في المهمة لها الأسبقية.


querysuite - CodeQL Query Suite لاستخدامه للتحليل.
string. القيم المسموح بها: Select a query suite...، code-scanning، security-extended، security-experimental، security-and-quality. القيمة الافتراضية: Select a query suite....

مجموعة الاستعلام، أي مجموعة القواعد، المستخدمة للتحليل. يمكنك تحديد القيمة هنا في المهمة، أو يمكنك تحديدها في متغير البنية الأساسية لبرنامج ربط العمليات التجارية المسمى advancedsecurity.codeql.querysuite. إذا تم تعيين كليهما، فإن القيمة المحددة في المهمة لها الأسبقية. القيمة الافتراضية هي Select a query suite... التي تشير إلى أنه يجب تحديد مجموعة الاستعلام في advancedsecurity.codeql.querysuite المتغير .


ram - خيارات للتحكم في استخدام ذاكرة الوصول العشوائي بالميغابايت
string.

تعيين إجمالي مقدار ذاكرة الوصول العشوائي التي يجب السماح لمقيم الاستعلام باستخدامها.

يمكنك تحديد ram هنا في المهمة، أو يمكنك تحديدها في متغير البنية الأساسية لبرنامج ربط العمليات التجارية المسمى advancedsecurity.codeql.ram. إذا تم تعيين كليهما، فإن القيمة المحددة في المهمة لها الأسبقية.


threads - استخدم العديد من مؤشرات الترابط هذه لتقييم الاستعلامات
string.

يمكنك تمرير 0 لاستخدام مؤشر ترابط واحد لكل نواة على الجهاز، أو -N لترك نواة N غير مستخدمة (باستثناء الاستمرار في استخدام مؤشر ترابط واحد على الأقل).

يمكنك تحديد threads هنا في المهمة، أو يمكنك تحديدها في متغير البنية الأساسية لبرنامج ربط العمليات التجارية المسمى advancedsecurity.codeql.threads. إذا تم تعيين كليهما، فإن القيمة المحددة في المهمة لها الأسبقية.


codeqlpathstoignore - تعيين قائمة المسارات لاستبعادها في تحليل CodeQL
string.

يمكنك توفير مسارات متعددة مفصولة بفواصل. يجب أن تكون المسارات مرتبطة sourcesfolder بمكان تشغيل CodeQL، والذي يتم تعيينه افتراضيا إلى Build.SourcesDirectory متغير بيئة البنية الأساسية لبرنامج ربط العمليات التجارية. على سبيل المثال، لتجاهل $(Build.SourcesDirectory)/donotscan الدليل، قم بتعيين codeqlpathstoignore: donotscan بدلا من codeqlpathstoignore: $(Build.SourcesDirectory)/donotscan.


codeqlpathstoinclude - تعيين قائمة بالمسارات الإضافية لتضمينها في تحليل CodeQL
string.

يمكنك توفير مسارات متعددة مفصولة بفواصل. يجب أن تكون المسارات مرتبطة sourcesfolder بمكان تشغيل CodeQL، والذي يتم تعيينه افتراضيا إلى Build.SourcesDirectory متغير بيئة البنية الأساسية لبرنامج ربط العمليات التجارية. على سبيل المثال، لتضمين $(Build.SourcesDirectory)/app الدليل، قم بتعيين codeqlpathstoinclude: app بدلا من codeqlpathstoinclude: $(Build.SourcesDirectory)/app.


sourcesfolder - تعيين المجلد الذي يحتوي على المصادر المراد تحليلها
string.

إذا لم توفر هذه القيمة، فسيتم استخدام مجلد المصادر الافتراضي للبنية الأساسية للبنية الأساسية للبنية الأساسية لبرنامج ربط العمليات التجارية (الذي يوفره Build.SourcesDirectory المتغير).


loglevel - تعيين مستوى السجل لتحليل CodeQL
string. القيم المسموح بها: 0 (تحذير)، 1 (مطول)، 2 (تصحيح)، _ (افتراضي (تحذير)). القيمة الافتراضية: _.

حدد مستوى التسجيل.

يمكنك تحديد loglevel هنا في المهمة، أو يمكنك تحديدها في متغير البنية الأساسية لبرنامج ربط العمليات التجارية المسمى advancedsecurity.codeql.loglevel. إذا تم تعيين كليهما، فإن القيمة المحددة في المهمة لها الأسبقية، ما لم يتم تحديد القيمة _ الافتراضية ل loglevel في المهمة. إذا _ تم تحديد، يتم استخدام القيمة من advancedsecurity.codeql.loglevel إذا كانت متوفرة.


configfilepath - استخدم هذا لتمكين تحليل الاستعلام المخصص في codeql (يجب أن يكون المسار مطلقا).
string.

إذا لم يتم توفير المسار، فسيتابع تحليل codeql الاستعلامات الافتراضية.


codeqltoolsdirectory - تعيين دليل أدوات CodeQL مخصص (يجب أن يكون المسار مطلقا)
string.

إذا لم يتم توفير المسار، فسيتم استخدام القيمة الافتراضية.$agent_toolsdirectory


خيارات التحكم بالمهمة

تحتوي جميع المهام على خيارات التحكم بالإضافة إلى مدخلات المهام الخاصة بها. لمزيد من المعلومات، راجع خيارات التحكم وخصائص المهمة الشائعة.

متغيرات الإخراج

لا شيء

الملاحظات

يجب تمكين GitHub Advanced Security ل Azure DevOps للمستودع الذي يتم مسحه ضوئيا.

هام

هذه المهمة مدعومة مع مستودعات Azure Repos Git فقط.

يجب أن يستدعي المسار المهام بالترتيب التالي.

  1. تهيئة CodeQL
  2. AutoBuild (أو مهام الإنشاء المخصصة)
  3. إجراء تحليل CodeQL

مهمة AutoBuild اختيارية ويمكن استبدالها بمهام الإنشاء المخصصة. يجب تشغيل إما AutoBuild أو مهام الإنشاء المخصصة الخاصة بك حتى يتم تحليل مشروعك.

المتطلبات

المتطلبات الوصف
أنواع البنية الأساسية لبرنامج ربط العمليات التجارية YAML، الإصدار الكلاسيكي، الإصدار الكلاسيكي
يعمل على Agent, DeploymentGroup
المطالب بلا
القدرات لا تفي هذه المهمة بأي متطلبات للمهام اللاحقة في الوظيفة.
قيود الأوامر أي
متغيرات Settable أي
إصدار الوكيل جميع إصدارات العامل المدعومة.
فئة المهمة البنية

راجع أيضًا