
واجهة سطر أوامر (CLI) لتوليد وتحليل ودمج ومقارنة والتحقق من وتوقيع وتحويل ملفات SBOM بصيغة CycloneDX عبر تنسيقات JSON وXML وProtobuf وCSV وSPDX.
______ __ ____ _ __ ________ ____
/ ____/_ _______/ /___ ____ ___ / __ \ |/ / / ____/ / / _/
/ / / / / / ___/ / __ \/ __ \/ _ \/ / / / / / / / / / /
/ /___/ /_/ / /__/ / /_/ / / / / __/ /_/ / | / /___/ /____/ /
\____/\__, /\___/_/\____/_/ /_/\___/_____/_/|_| \____/_____/___/
/____/
Usage:
cyclonedx [command] [options]
Options:
--version Show version information
-?, -h, --help Show help and usage information
Commands:
add Add information to a BOM (currently supports files)
analyze Analyze a BOM file
convert Convert between different BOM formats
diff <from-file> <to-file> Generate a BOM diff
keygen Generates an RSA public/private key pair for BOM signing
merge Merge two or more BOMs
sign Sign a BOM or file
validate Validate a BOM
verify Verify signatures in a BOM
تدعم أداة سطر الأوامر CycloneDX CLI حالياً تحليل ملفات BOM وتعديلها وحساب الفروقات بينها ودمجها وتحويل التنسيقات وتوقيعها والتحقق منها.
يُدعم التحويل بين تنسيقات CycloneDX XML وJSON وProtobuf وCSV وSPDX JSON v2.3.
يمكن تنزيل الملفات التنفيذية من صفحة الإصدارات.
ملاحظة: أُنشئت أداة CycloneDX CLI لحالات الاستخدام المؤتمتة. أي أمر يحتوي على الخيار --input-file يدعم أيضاً إدخال البيانات من stdin. وبالمثل، فإن أي أمر يحتوي على الخيار --output-file يدعم إخراج البيانات إلى stdout. ومع ذلك، ستحتاج إلى تحديد تنسيقات الإدخال والإخراج.
على سبيل المثال:
cat bom.json | cyclonedx-cli convert --input-format json --output-format xml > bom.xml
files
Add files to a BOM
Usage:
cyclonedx add files [options]
Options:
--input-file <input-file> Input BOM filename.
--no-input Use this option to indicate that there is no input BOM.
--output-file <output-file> Output BOM filename, will write to stdout if no value provided.
--input-format <autodetect|json|protobuf|xml> Specify input file format.
--output-format <autodetect|json|protobuf|xml> Specify output file format.
--base-path <base-path> Base path for directory to process (defaults to current working directory if omitted).
--include <include> Apache Ant style path and file patterns to specify what to include (defaults to all files, separate patterns with a space).
--exclude <exclude> Apache Ant style path and file patterns to specify what to exclude (defaults to none, separate patterns with a space).
إنشاء BOM لكود المصدر مع استبعاد دليل مستودع Git:
cyclonedx-cli add files --no-input --output-format json --exclude /.git/**
إضافة ملفات مخرجات البناء من دليل bin إلى BOM موجود:
cyclonedx-cli add files --input-file bom.json --output-format json --base-path bin
analyze
Analyze a BOM file
Usage:
cyclonedx analyze [options]
Options:
--input-file <input-file> Input BOM filename, will read from stdin if no value provided.
--input-format <autodetect|json|protobuf|xml> Specify input file format.
--output-format <json|text> Specify output format (defaults to text).
--multiple-component-versions Report components that have multiple versions in use.
الإبلاغ عن المكونات المضمّنة أكثر من مرة بإصدارات مختلفة:
cyclonedx-cli analyze --input-file sbom.xml --multiple-component-versions
convert
Convert between different BOM formats
Usage:
cyclonedx convert [options]
Options:
--input-file <input-file> Input BOM filename, will read from stdin if no value provided.
--output-file <output-file> Output BOM filename, will write to stdout if no value provided.
--input-format <autodetect|csv|json|protobuf|spdxjson|xml> Specify input file format.
--output-format <autodetect|csv|json|protobuf|spdxjson|xml> Specify output file format.
--output-version <v1_0|v1_1|v1_2|v1_3|v1_4|v1_5|v1_6|v1_7> Specify output BOM specification version. (ignored for CSV and SPDX formats)
التحويل من تنسيق XML إلى تنسيق JSON:
cyclonedx-cli convert --input-file sbom.xml --output-file sbom.json
التحويل من تنسيق XML إلى تنسيق JSON وتوجيه المخرجات إلى أدوات إضافية:
cyclonedx-cli convert --input-file sbom.xml --output-format json | grep "somthing"
تنسيق CSV هو تمثيل محدود لقائمة المكونات في BOM.
الهدف هو توفير طريقة بسيطة للمستخدمين لإنتاج واستهلاك ملفات BOM لحالات الاستخدام البسيطة، بما في ذلك حالات ترحيل البيانات البسيطة.
الحقلان الوحيدان المطلوبان هما حقلا المكوّن name وversion. ويمكن ترك الحقول الأخرى فارغة أو حذف الأعمدة.
يمكن أن يؤدي التحويل بين تنسيقي SPDX وCycloneDX إلى فقدان بعض المعلومات. وظيفة التحويل مُقدَّمة من مكتبة CycloneDX.Spdx.Interop، وهي جزء من مشروع مكتبة CycloneDX .NET.
لمزيد من التفاصيل حول المعلومات المفقودة، راجع صفحة مشروع مكتبة CycloneDX .NET.
diff
Generate a BOM diff
Usage:
cyclonedx diff <from-file> <to-file> [options]
Arguments:
<from-file> From BOM filename.
<to-file> To BOM filename.
Options:
--from-format <autodetect|json|protobuf|xml> Specify from file format.
--to-format <autodetect|json|protobuf|xml> Specify to file format.
--output-format <json|text> Specify output format (defaults to text).
--component-versions Report component versions that have been added, removed or modified.
الإبلاغ عن المكونات التي تغيّرت إصداراتها:
cyclonedx-cli diff sbom-from.xml sbom-to.xml --component-versions
keygen
Generates an RSA public/private key pair for BOM signing
Usage:
cyclonedx keygen [options]
Options:
--private-key-file <private-key-file> Filename for generated private key file (defaults to "private.key")
--public-key-file <public-key-file> Filename for generated public key file (defaults to "public.key")
merge
Merge two or more BOMs
Usage:
cyclonedx merge [options]
Options:
--input-files <input-files> Input BOM filenames (separate filenames with a space).
--output-file <output-file> Output BOM filename, will write to stdout if no value provided.
--input-format <autodetect|json|protobuf|xml> Specify input file format.
--output-format <autodetect|json|protobuf|xml> Specify output file format.
--output-version <v1_0|v1_1|v1_2|v1_3|v1_4|v1_5|v1_6|v1_7> Specify output BOM specification version.
--hierarchical Perform a hierarchical merge.
--group <group> Provide the group of software the merged BOM describes.
--name <name> Provide the name of software the merged BOM describes (required for hierarchical merging).
--version <version> Provide the version of software the merged BOM describes (required for hierarchical merging).
ملاحظة: لإجراء دمج هرمي، يجب أن تحتوي جميع ملفات BOM على موضوع BOM موصوفاً في عنصر المكوّن في البيانات الوصفية (metadata component element).
دمج ملفي BOM بتنسيق XML:
cyclonedx-cli merge --input-files sbom1.xml sbom2.xml --output-file sbom_all.xml
دمج ملفي BOM وتوجيه المخرجات إلى أدوات إضافية:
cyclonedx-cli merge --input-files sbom1.xml sbom2.xml --output-format json | grep "something"
توقيع BOM أو ملف
bom
Sign the entire BOM document
Usage:
cyclonedx sign bom <bom-file> [options]
Arguments:
<bom-file> BOM filename
Options:
--key-file <key-file> Signing key filename (RSA private key in PEM format, defaults to "private.key")
file
Sign arbitrary files and generate a PKCS1 RSA SHA256 signature file
Usage:
cyclonedx sign file <file> [options]
Arguments:
<file> Filename of the file the signature will be created for
Options:
--key-file <key-file> Signing key filename (RSA private key in PEM format, defaults to "private.key")
--signature-file <signature-file> Filename of the generated signature file (defaults to the filename with ".sig" appended)
validate
Validate a BOM
Usage:
cyclonedx validate [options]
Options:
--input-file <input-file> Input BOM filename, will read from stdin if no value provided.
--input-format <autodetect|json|xml> Specify input file format.
--input-version <v1_0|v1_1|v1_2|v1_3|v1_4|v1_5|v1_6|v1_7> Specify input file specification version (defaults to v1.7)
--fail-on-errors Fail on validation errors (return a non-zero exit code)
التحقق من صحة BOM وإرجاع رمز خروج غير صفري (مفيد لكسر البناء تلقائياً، وما إلى ذلك)
cyclonedx-cli validate --input-file sbom.xml --fail-on-errors
التحقق من التوقيعات الخاصة بملفات BOM والملفات
all
Verify all signatures in a BOM
Usage:
cyclonedx verify all <bom-file> [options]
Arguments:
<bom-file> BOM filename
Options:
--key-file <key-file> Public key filename (RSA public key in PEM format, defaults to "public.key")
file
Verifies a PKCS1 RSA SHA256 signature file for an arbitrary file
Usage:
cyclonedx verify file <file> [options]
Arguments:
<file> File the signature file is for
Options:
--key-file <key-file> Public key filename (RSA public key in PEM format, defaults to "public.key")
--signature-file <signature-file> Signature file to be verified (defaults to the filename with ".sig" appended)
يمكن أيضاً تشغيل أداة CycloneDX CLI باستخدام docker: docker run cyclonedx/cyclonedx-cli.
بالنسبة إلى Linux وMacOS، يمكن تثبيت CLI عبر مستودع CycloneDX Homebrew:
brew install cyclonedx/cyclonedx/cyclonedx-cli
تتوفر إصدارات مدعومة رسمياً لهذه المنصات:
تتوفر إصدارات مدعومة من المجتمع لهذه المنصات:
مطلوبة تبعيات وقت تشغيل .NET Core.
بالنسبة إلى Windows، يجب أن تكون هذه التبعيات مثبتة مسبقاً.
بالنسبة إلى Ubuntu، هذه التبعيات هي: libc6 libgcc1 libgssapi-krb5-2 libicu66 libssl1.1 libstdc++6 zlib1g.
يحوّل gron بيانات JSON إلى تعيينات منفصلة لتسهيل استخدام grep للعثور على ما تريده ورؤية «المسار» المطلق إليه.
للتسهيل، تم تضمين gron في صورة Docker الخاصة بـ CycloneDX CLI.
مثال استخدام يعرض جميع أسماء المكونات وإصداراتها
$ gron bom-1.2.json | grep -E "(components\[[[:digit:]]*\].name)|(components\[[[:digit:]]*\].version)"
json.components[0].name = "tomcat-catalina";
json.components[0].version = "9.0.14";
json.components[1].name = "mylibrary";
json.components[1].version = "1.0.0";
أو نفس المثال باستخدام BOM بتنسيق XML
$ cyclonedx convert --input-file bom.xml --output-format json | gron | grep -E "(components\[[[:digit:]]*\].name)|(components\[[[:digit:]]*\].version)"
json.components[0].name = "tomcat-catalina";
json.components[0].version = "9.0.14";
json.components[1].name = "mylibrary";
json.components[1].version = "1.0.0";
لمزيد من التفاصيل حول استخدام gron، راجع صفحة مشروع gron.
لمزيد من التفاصيل حول استخدام grep، راجع صفحة دليل grep.
يُمنح الإذن بالتعديل وإعادة التوزيع بموجب شروط ترخيص Apache 2.0. راجع ملف LICENSE للحصول على الترخيص الكامل.
نرحب بطلبات السحب (Pull requests). لكن يرجى قراءة إرشادات المساهمة في CycloneDX أولاً.
لإنشاء الحل واختباره محلياً، يجب أن يكون .NET 8 مثبتاً لديك. تعمل الأوامر القياسية مثل dotnet build وdotnet test.
من المتوقع عموماً أن تتضمن طلبات السحب اختبارات ذات صلة. تُنفَّذ الاختبارات تلقائياً على Windows وMacOS وLinux لكل طلب سحب. ستؤدي تحذيرات البناء إلى كسر البناء.
يرجى إخبارنا إذا كنت تواجه مشكلة في تصحيح اختبار فاشل على منصة لا يمكنك الوصول إليها.