XCA(1) General Commands Manual XCA(1)

xca - مدیریت گواهی‌ها و کلیدها در سامانه X
یک رابط گرافیکی کاربر (GUI) برای مدیریت گواهی‌های X509، کلیدهای RSA/DSA/EC، درخواست‌های PKCS#10 و فهرست‌های ابطال گواهی (CRL) به صورت نرم‌افزاری و بر روی کارت‌های هوشمند.

xca [OPTIONS]

این برنامه به عنوان یک مرجع صدور گواهی (CA) و مخزن گواهی و کلید طراحی شده است. این ابزار برای ذخیره موارد از یک پایگاه‌داده SQL استفاده می‌کند. به طور پیش‌فرض از SQLite3 استفاده می‌شود، اما MySQL و PostgreSQL نیز آزمایش شده و پشتیبانی می‌شوند. انواع شناخته‌شده عبارتند از درخواست‌های امضای گواهی (PKCS#10)، گواهی‌ها (X509v3)، کلیدهای RSA، DSA و EC و فهرست‌های ابطال گواهی (CRL). امضای درخواست‌ها و ایجاد گواهی‌های خودامضا (self-signed) پشتیبانی می‌شود. هر دو می‌توانند برای سادگی بیشتر از الگوها (templates) استفاده کنند. ساختارهای PKI می‌توانند در قالب‌های گوناگونی مانند PKCS#12، PEM، DER، PKCS#8 و PKCS#7 وارد یا صادر شوند.
برنامه XCA به کاربران امکان می‌دهد کارت‌های هوشمند را از طریق رابط PKCS#11 مدیریت کنند.

ایجاد CRL برای <ca>. برای تنظیم نام داخلی CRL جدید از گزینه 'name' استفاده کنید.
نام فایل (*.xdb) پایگاه‌داده SQLite یا یک توصیف‌کننده پایگاه‌داده دوردست: [user@host/TYPE:dbname#prefix].
خروج پس از وارد کردن موارد.
چاپ این راهنما و خروج.
ذخیره سلسله‌مراتب نمایه‌سازی OpenSSL در <dir>.
ذخیره نمایه OpenSSL در <file>.
وارد کردن همه موارد ارائه‌شده به پایگاه‌داده.
فهرستی از نام‌ها که با نقطه-ویرگول (;) از هم جدا شده‌اند و به موارد وارد شده به ترتیبی که در فایل PEM و خط فرمان یافت شده‌اند، اختصاص می‌یابند.
چاپ همه گواهی‌های صادرکننده شناخته‌شده که دارای کلید خصوصی مرتبط هستند و قیدهای اساسی (basic constraints) مربوط به CA در آن‌ها روی 'true' تنظیم شده است.
ایجاد یک کلید جدید و وارد کردن آن به پایگاه‌داده. برای تنظیم نام داخلی کلید جدید از گزینه 'name' استفاده کنید. پارامتر <type> دارای این قالب است: '[RSA|DSA|EC]:[<size>|<curve>].
چاپ تمامی منحنی‌های بیضوی (Elliptic Curves) شناخته‌شده.
فهرست کردن تمام موارد موجود در پایگاه‌داده.
تعیین نام موارد ایجاد شده جدید. در صورت حذف، نامی خودکار تولید خواهد شد.
غیرفعال کردن پنجره‌های گفتگوی بومی سیستم‌عامل برای پیام‌ها و عملیات فایل، و استفاده از پنجره‌های گفتگوی اختصاصی Qt به جای آن.
رابط گرافیکی کاربر اجرا نشود. متناوباً می‌توانید متغیر محیطی XCA_NO_GUI=1 را تنظیم کنید یا xca را از طریق پیوند نمادین 'xca-console' فراخوانی کنید.
گذرواژه پایگاه‌داده برای باز کردن قفل آن. گزینه‌های قالب گذرواژه را در ادامه ببینید.
چاپ نمایش PEM از فایل‌های ارائه‌شده. تنها بخش عمومی کلیدهای خصوصی چاپ می‌شود.
تعیین یک نام فایل برای داده‌های PEM. به طور ضمنی شامل '--pem' نیز می‌شود.
چاپ خلاصه مختصری از فایل‌های ارائه‌شده.
انتخاب تمام موارد در id-list جدا شده با کاما برای نمایش از طریق 'print'، 'text' یا 'pem'.
گذرواژه برای دسترسی به سرور SQL دوردست. گزینه‌های قالب گذرواژه را در ادامه ببینید.
چاپ محتوای فایل‌های ارائه‌شده همانند خروجی OpenSSL.
چاپ گزارش اشکال‌زدایی روی stderr. معادل با تنظیم XCA_DEBUG=all. بخش XCA_DEBUG را ببینید.
چاپ اطلاعات نگارش و خروج.
گزینه‌هایی که با علامت ستاره مشخص شده‌اند نیازمند پایگاه‌داده هستند؛ چه از طریق خط فرمان و چه به عنوان پایگاه‌داده پیش‌فرض.

گزینه‌های گذرواژه نحوی مشابه با openssl را می‌پذیرند:

دریافت گذرواژه از متغیر محیطی var. از آنجا که محیط سایر فرایندها در برخی پلتفرم‌ها (مانند دستور ps در برخی سیستم‌عامل‌های مبتنی بر Unix) قابل مشاهده است، این گزینه باید با احتیاط استفاده شود.
خواندن گذرواژه از توصیف‌گر فایل با شماره number. برای مثال می‌تواند برای ارسال داده‌ها از طریق یک لوله (pipe) استفاده شود.
خط اول pathname به عنوان گذرواژه در نظر گرفته می‌شود. اگر pathname یکسانی برای آرگومان‌های password و sqlpassword داده شود، خط اول برای هر دو گذرواژه استفاده خواهد شد. نیازی نیست pathname حتماً به یک فایل معمولی ارجاع دهد: برای مثال می‌تواند به یک دستگاه یا لوله نام‌گذاری‌شده اشاره داشته باشد.
گذرواژه واقعی همان password است. از آنجا که گذرواژه برای ابزارها (مانند 'ps' در Unix) قابل مشاهده است، این قالب تنها باید در مواردی استفاده شود که امنیت اهمیتی ندارد.
خواندن گذرواژه از ورودی استاندارد (stdin).

برخی متغیرهای محیطی کم‌وبیش کاربردی توسط xca ارزیابی می‌شوند:

عدم اجرای اجباری رابط گرافیکی کاربر. معادل با آرگومان --no-gui. اگر هیچ‌کدام داده نشده باشند، XCA تلاش می‌کند هوشمندانه عمل کرده و با بررسی سایر آرگومان‌ها قضاوت کند که آیا GUI اجرا شود یا خیر.
متغیر محیطی XCA_DEBUG اشکال‌زدایی پویا را کنترل می‌کند. قالب آن فهرستی از الگوها است که با کاما از هم جدا شده‌اند. هر الگو به این صورت است: all|[-]<function>|[-]<filename>:<firstline>[-<lastline>] خط تیره در ابتدا تطابق را نادیده می‌گیرد. firstline و lastline می‌توانند خالی باشند و با خط اول و آخر فایل جایگزین خواهند شد. اگر -<lastline> حذف شود، تنها شماره خط دقیقِ lastline مطابقت داده می‌شود.
مثال: XCA_DEBUG=all,-timerEvent همه موارد را ثبت می‌کند به جز پیام‌های مزاحم timerEvent.
مثال: XCA_DEBUG=pki_base.cpp:100-,-pki_base.cpp:340 پیام‌های pki_base را از خط ۱۰۰ تا آخرین خط، به جز خط ۳۴۰ ثبت می‌کند.
گزینه‌ای برای توسعه‌دهندگان جهت توقف اضطراری و ورود به اشکال‌زدا در صورت دریافت پیام سطح هشدار (warning). صرفاً جهت تکمیل مستندات ذکر شده و برای افراد غیرتوسعه‌دهنده کاربردی ندارد.
اجبار به حالت پرتابل (قابل‌حمل) ویندوز. صرفاً جهت تکمیل مستندات ذکر شده و برای افراد غیرتوسعه‌دهنده کاربردی ندارد.
آرگومان‌های خط فرمان را در قالب nroff صفحه مان، rst ابزار sphinx، یا به صورت فهرستی تک‌خطی برای تکمیل خودکار دستور خروجی می‌دهد تا در صورت اضافه شدن آرگومان‌های جدید، مستندات به طور خودکار به‌روزرسانی شوند.
گزینه‌های اتصال اضافی برای درایورهای پایگاه‌داده SQL همان‌گونه که در https://doc.qt.io/qt-5/qsqldatabase.html#setConnectOptions شرح داده شده است، مانند QPSQL_OPTIONS=requiressl=1

مستندات HTML با جزئیات بیشتر را می‌توان در دایرکتوری doc، در منوی "Help" برنامه یا در نشانی https://hohnstaedt.de/documentation یافت.

این صفحه راهنما توسط Christian Hohnstaedt <christian@hohnstaedt.de> نوشته شده است.