.nh
.TH CONTAINERS-SIGSTORE-SIGNING-PARAMS.YAML 5 "ژانویه 2023" "Miloslav Trmač" "راهنمای پارامترهای امضای sigstore"

.SH "نام (NAME)"
containers-sigstore-signing-params.yaml \- ساختار و سینتکس فایل پارامترهای امضای sigstore


.SH "توضیحات (DESCRIPTION)"
فایل‌های پارامتر امضای Sigstore برای ذخیره گزینه‌هایی استفاده می‌شوند که ممکن است برای ایجاد امضاهای sigstore مورد نیاز باشند.
هیچ مسیر پیش‌فرضی برای این فایل‌ها وجود ندارد؛ آن‌ها توسط کاربر مدیریت می‌شوند و به عنوان ورودی برای عملیات امضای تصویر کانتینر استفاده می‌گردند،
مانند \fBskopeo copy --sign-by-sigstore=\fR\fIparam-file\fP\fB\&.yaml\fR یا \fBpodman push --sign-by-sigstore=\fR\fIparam-file\fP\fB\&.yaml\fR .

.SH "قالب (FORMAT)"
فایل‌های پارامتر امضای Sigstore از قالب YAML استفاده می‌کنند.

.PP
بسیاری از پارامترها اختیاری هستند، اما فایل باید اطلاعات کافی را برای ایجاد یک امضا مشخص کند؛
به‌ویژه یک کلید خصوصی یا Fulcio.

.SS "امضا با کلیدهای خصوصی (Signing with Private Keys)"
.IP \(bu 2
\fBprivateKeyFile:\fR \fIpath\fP

.PP
ایجاد یک امضا با استفاده از کلید خصوصی واقع در \fIpath\fP\&.
وجود این فیلد استفاده از کلید خصوصی را فعال می‌کند.
.IP \(bu 2
\fBprivateKeyPassphraseFile:\fR \fIpassphrasePath\fP

.PP
عبارت عبور (passphrase) مورد نیاز برای استفاده از \fBprivateKeyFile\fR را از \fIpassphrasePath\fP می‌خواند.
اختیاری: اگر این مقدار تنظیم نشود، کاربر باید عبارت عبور را به صورت تعاملی وارد کند.

.SS "امضا با گواهی‌های تولید شده توسط Fulcio (Signing with Fulcio-generated Certificates)"
به جای یک کلید خصوصی ثابت، فرایند امضا یک جفت‌کلید کوتاه‌مدت تولید کرده
و از یک سرور Fulcio درخواست می‌کند تا بر اساس احراز هویت کاربر در یک ارائه‌دهنده OpenID Connect، گواهی برای آن جفت‌کلید صادر کند.

.PP
برای مشخص کردن Fulcio، یک زیرشیء \fBfulcio\fR شامل یک یا چند کلید زیر درج کنید.
علاوه بر این، یک سرور Rekor نیز باید مشخص شود.
.IP \(bu 2
\fBfulcioURL:\fR \fIURL\fP

.PP
اجباری. نشانی وب (URL) سرور Fulcio مورد استفاده.
.IP \(bu 2
\fBoidcMode:\fR \fBinteractive\fR | \fBdeviceGrant\fR | \fBstaticToken\fR

.PP
اجباری. نحوه دریافت اعتبارنامه (credential) مورد نیاز OpenID Connect را مشخص می‌کند.

.PP
\fBinteractive\fR یک مرورگر وب را در همان سیستم باز می‌کند، یا اگر این امکان وجود نداشته باشد،
از کاربر می‌خواهد مرورگر را به صورت دستی باز کرده و کد ارائه شده را وارد کند.
این حالت نیازمند آن است که کاربر بتواند مستقیماً با فرایند امضا تعامل داشته باشد.

.PP
\fBdeviceGrant\fR از جریان اعطای مجوز دستگاه (RFC 8628) استفاده می‌کند.
این حالت نیازمند آن است که کاربر بتواند متنی که توسط فرایند امضا چاپ می‌شود را خوانده و در زمان مناسب نسبت به آن اقدام کند.

.PP
\fBstaticToken\fR یک «ID token» از پیش موجود OpenID Connect را ارائه می‌دهد که باید به طور جداگانه دریافت شده باشد.
.IP \(bu 2
\fBoidcIssuerURL:\fR \fIURL\fP

.PP
برای \fBoidcMode:\fR \fBinteractive\fR یا \fBdeviceGrant\fR اجباری است. نشانی وب (URL) سرور صادرکننده OpenID Connect برای احراز هویت.
.IP \(bu 2
\fBoidcClientID:\fR \fIclient ID\fP

.PP
برای \fBoidcMode:\fR \fBinteractive\fR یا \fBdeviceGrant\fR جهت شناسایی کلاینت هنگام ارتباط با صادرکننده استفاده می‌شود.
اختیاری است اما در این موارد احتمالاً ضروری خواهد بود.
.IP \(bu 2
\fBoidcClientSecret:\fR \fIclient secret\fP

.PP
برای \fBoidcMode:\fR \fBinteractive\fR یا \fBdeviceGrant\fR جهت احراز هویت کلاینت هنگام ارتباط با صادرکننده استفاده می‌شود.
اختیاری است.
.IP \(bu 2
\fBoidcIDToken:\fR \fItoken\fP

.PP
برای \fBoidcMode: staticToken\fR اجباری است.
یک توکن شناسایی (ID token) از نوع OpenID Connect که کاربر را شناسایی کرده (و صدور گواهی را مجاز می‌کند).

.SS "ثبت امضا در یک سرور شفافیت Rekor (Recording the Signature to a Rekor Transparency Server)"
این مورد می‌تواند با کلید خصوصی یا Fulcio ترکیب شود.
از نظر عملی، این گزینه برای Fulcio الزامی است؛ هنگام استفاده از یک کلید خصوصی ثابت اختیاری است، اما برای
سازگاری متقابل با پیکربندی پیش‌فرض \fBcosign\fR ضروری می‌باشد.
.IP \(bu 2
\fBrekorURL\fR: \fIURL\fP

.PP
نشانی وب (URL) سرور Rekor مورد استفاده.


.SH "مثال‌ها (EXAMPLES)"
.SS "امضا با استفاده از یک کلید خصوصی از پیش موجود (Sign Using a Pre-existing Private Key)"
از سرور Rekor «زیرساخت جامعه» (community infrastructure) استفاده می‌کند.

.EX
privateKeyFile: "/home/user/sigstore/private-key.key"
privateKeyPassphraseFile: "/mnt/user/sigstore-private-key"
rekorURL: "https://rekor.sigstore.dev"
.EE

.SS "امضا با استفاده از یک گواهی صادر شده توسط Fulcio (Sign Using a Fulcio-Issued Certificate)"
از سرورهای Fulcio و Rekor «زیرساخت جامعه»،
و صادرکننده Dex OIDC که احراز هویت را به صادرکنندگان بزرگ دیگر مانند Google و GitHub واگذار می‌کند، استفاده می‌نماید.

.PP
سایر پیکربندی‌ها به احتمال زیاد نیاز به ارائه یک OIDC client secret نیز خواهند داشت.

.EX
fulcio:
  fulcioURL: "https://fulcio.sigstore.dev"
  oidcMode: "interactive"
  oidcIssuerURL: "https://oauth2.sigstore.dev/auth"
  oidcClientID: "sigstore"
rekorURL: "https://rekor.sigstore.dev"
.EE


.SH "همچنین ببینید (SEE ALSO)"
\fBskopeo\fR(1), \fBpodman\fR(1)