.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "swtpm_ioctl 8"
.TH swtpm_ioctl 8 2026-03-26 swtpm "دستورات مدیریت سیستم"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "نام (NAME)"
swtpm_ioctl \- ابزاری برای ارسال دستورات کنترلی به swtpm
.SH "خلاصه دستور (SYNOPSIS)"
.IX Header "SYNOPSIS"
\&\fBswtpm_ioctl\fR [\fICOMMAND\fR] [<\fIdevice\fR>]
.SH "توضیحات (DESCRIPTION)"
.IX Header "DESCRIPTION"
دستور
\&\fBswtpm_ioctl\fR
یک ابزار کلاینت برای کنترل شبیه‌سازهای نرم‌افزاری TPM مانند
\&\fIswtpm_cuse\fR
و
\fIswtpm\fR
پیاده‌سازی می‌کند؛ از جمله مقداردهی اولیه و خاموش کردن آن‌ها. پس از انجام مقداردهی اولیه، می‌توان دستورات TPM را به آن ارسال کرد.
.PP
نکته: متغیر محیطی
\fBSWTPM_IOCTL_BUFFERSIZE\fR
می‌تواند برای تعیین اندازه بافر جهت استفاده در انتقال داده‌های وضعیت (state blob) تنظیم شود. اگر این متغیر تنظیم نشود، از رابط
\fBioctl()\fR
برای انتقال وضعیت استفاده می‌شود. این متغیر محیطی در درجه اول برای اهداف آزمایشی کاربرد دارد.
.PP
دستورات زیر پشتیبانی می‌شوند:
.IP "\fB\-\-tpm\-device <device>\fR" 4
.IX Item "--tpm-device <device>"
استفاده از دستگاه مشخص‌شده. مسیر کامل به دستگاه کاراکتری (character device) باید ارائه شود، مانند
.BR /dev/vtpm\-200 .
.Sp
این گزینه می‌تواند به جای ارائه دستگاه به عنوان آخرین پارامتر استفاده شود.
.IP "\fB\-\-tcp <server>:<port>\fR" 4
.IX Item "--tcp <server>:<port>"
اتصال به سرور و پورت مشخص‌شده؛ اگر سروری مشخص نشود، از
\fB127.0.0.1\fR
استفاده می‌شود؛ اگر پورت مشخص نشود، پورت پیش‌فرض
\fB6545\fR
استفاده می‌شود.
.IP "\fB\-\-unix <path>\fR" 4
.IX Item "--unix <path>"
اتصال به مسیر مشخص‌شده در سوکت یونیکس (UnixIO).
.IP \fB\-c\fR 4
.IX Item "-c"
دریافت فلگ‌های قابلیت (capability flags) که نشان‌دهنده دستورات پشتیبانی‌شده هستند.
.IP \fB\-i\fR 4
.IX Item "-i"
ارسال سیگنال مقداردهی اولیه سخت‌افزاری به
\fIswtpm_cuse\fR/\fIswtpm\fR.
وضعیت ناپایدار (volatile state) که قبلاً توسط TPM نوشته شده است خوانده می‌شود و فایل به طور خودکار حذف خواهد شد.
.IP \fB\-s\fR 4
.IX Item "-s"
آغاز فرآیند خاموش‌سازی آرام (graceful shutdown).
.IP \fB\-\-stop\fR 4
.IX Item "--stop"
متوقف کردن
\fIswtpm_cuse\fR/\fIswtpm\fR.
این کار آن را خاموش نمی‌کند. دستور
.I \-i
می‌تواند دوباره به آن ارسال شود. پس از توقف، امکان بارگذاری داده‌های وضعیت TPM (stateblobs) در TPM با استفاده از دستور
.I \-\-load
نیز وجود دارد.
.IP \fB\-e\fR 4
.IX Item "-e"
دریافت بیت
.BR tpmEstablished .
.IP "\fB\-r locality\fR" 4
.IX Item "-r locality"
بازنشانی بیت
.B tpmEstablished
با استفاده از سطح دسترسی محلی (locality) مشخص‌شده. تنها سطوح دسترسی ۳ و ۴ کار می‌کنند. این عملیات سطح دسترسی محلی را که قبلاً با استفاده از گزینه
.I \-l
تنظیم شده بود، به طور دائم تغییر نخواهد داد.
.IP "\fB\-l locality\fR" 4
.IX Item "-l locality"
تنظیم سطح دسترسی محلی (locality) برای دستورات بعدی TPM.
.IP \fB\-v\fR 4
.IX Item "-v"
درخواست از TPM برای نوشتن وضعیت ناپایدار (volatile state) در یک فایل. هنگام اجرای یک
.B TPM_Init
.RI ( \-i )
وضعیت TPM خوانده خواهد شد و TPM می‌تواند بدون نیاز به مقداردهی اولیه بیشتر، عملیات خود را از سر بگیرد.
.IP \fB\-C\fR 4
.IX Item "-C"
لغو دستور در حال اجرای TPM.
.IP "\fB\-h data\fR" 4
.IX Item "-h data"
بازنشانی و گسترش ثبات
.B PCR 17
با هش داده‌های مشخص‌شده. اگر
.I data
تنها شامل تک‌نویسه
\*(Aq\-\*(Aq
باشد، تمام داده‌ها از ورودی استاندارد (stdin) خوانده می‌شوند.
.IP "\fB\-\-save <TPM state blob name> <filename> \fR" 4
.IX Item "--save <TPM state blob name> <filename> "
ذخیره داده وضعیت TPM (state blob) در فایل مشخص‌شده. نام‌های معتبر برای داده وضعیت TPM عبارتند از:
\*(Aqpermanent\*(Aq
(ماندگار)،
\*(Aqvolatile\*(Aq
(ناپایدار)، و
\*(Aqsavestate\*(Aq
(وضعیت ذخیره‌شده).
.Sp
توجه داشته باشید که این دستور در هر زمانی قابل اجرا است. با این حال، برای دریافت آخرین وضعیت ناپایدار، دستور
.I \-v
باید بلافاصله قبل از اجرای این دستور اجرا شده باشد. داده وضعیت
.I savestate
تنها در صورتی بازگردانده می‌شود که دستور
.B TPM_SaveState
در TPM اجرا شده باشد (TPM 1.2).
.IP "\fB\-\-load <TPM state blob name> <filename>\fR" 4
.IX Item "--load <TPM state blob name> <filename>"
بارگذاری داده وضعیت TPM مشخص‌شده از فایل داده‌شده. نام‌های معتبر برای داده وضعیت TPM عبارتند از:
\*(Aqpermanent\*(Aq،
\*(Aqvolatile\*(Aq، و
\*(Aqsavestate\*(Aq.
.Sp
توجه داشته باشید که این دستور تنها می‌تواند روی یک TPM خاموش‌شده اجرا شود. برای راه‌اندازی بعدی TPM با وضعیت بارگذاری‌شده، باید دستور
.I \-i
صادر شود.
.IP \fB\-g\fR 4
.IX Item "-g"
دریافت فلگ‌های پیکربندی که برای مثال مشخص می‌کنند کدام کلیدها (کلید رمزنگاری فایل یا مهاجرت) توسط TPM استفاده می‌شوند.
.IP "\fB\-\-info <flags>\fR" 4
.IX Item "--info <flags>"
دریافت اطلاعات درباره پیاده‌سازی TPM و پیکربندی آن در قالب JSON. مقادیر زیر می‌توانند ارائه شوند. تمام مقادیر را می‌توان با هم OR (یا جمع) کرد تا اطلاعات مربوط به همه آن‌ها در یک پرس‌وجو به دست آید:
.RS 4
.IP \(bu 2
0x1: اطلاعات درباره مشخصاتی که پیاده‌سازی TPM از آن پیروی کرده است
.IP \(bu 2
0x2: اطلاعات درباره سازنده، مدل و نسخه TPM
.IP \(bu 2
0x4: فهرست اندازه‌های کلید پشتیبانی‌شده برای RSA و Camellia
.IP \(bu 2
0x8: توصیف الگوریتم‌های پشتیبانی‌شده و فعال
.IP \(bu 2
0x10: توصیف دستورات پشتیبانی‌شده و فعال
.IP \(bu 2
0x20: توصیف نمایه (پروفایل) فعال
.IP \(bu 2
0x40: فهرست تمامی نمایه‌های (پروفایل‌های) داخلی
.IP \(bu 2
0x80: توصیف ویژگی‌های پشتیبانی‌شده
.RE
.RS 4
.RE
.IP "\fB\-\-lock\-storage <retries>\fR" 4
.IX Item "--lock-storage <retries>"
قفل کردن فضای ذخیره‌سازی و تلاش مجدد به تعداد دفعات مشخص‌شده با تأخیر ۱۰ میلی‌ثانیه‌ای در بین آن‌ها. قفل کردن فضای ذخیره‌سازی ممکن است پس از انتقال وضعیت TPM به بیرون و آزاد شدن قفل فضای ذخیره‌سازی هنگام دریافت داده‌های
\*(Aqsavestate\*(Aq
لازم باشد تا اکنون فضای ذخیره‌سازی دوباره قفل گردد.
.SH "مثال‌ها (EXAMPLES)"
.IX Header "EXAMPLE"
راه‌اندازی swtpm روی پورت ۱۰۰۰۰ برای پورت کنترل و شبیه‌سازی TPM 1.2:
.PP
.Vb 1
\&   #> swtpm socket \-\-tpmstate dir=/tmp/myvtpm1 \-\-log level=4 \-\-ctrl type=tcp,port=10000 \-\-server type=tcp,port=10001 \-\-flags not\-need\-init
.Ve
.PP
دریافت اطلاعات درباره پیاده‌سازی TPM در قالب JSON:
.PP
.Vb 4
\&   #> swtpm_ioctl \-\-tcp :10000 \-\-info 1
\&   {"TPMSpecification":{"family":"1.2","level":2,"revision":116}}
\&   #> swtpm_ioctl \-\-tcp :10000 \-\-info 2
\&   {"TPMAttributes":{"manufacturer":"id:00001014","version":"id:00740001","model":"swtpm"}}
.Ve
.PP
خاموش کردن swtpm:
.PP
.Vb 1
\&   #> swtpm_ioctl \-\-tcp :10000 \-s
.Ve
.SH "همچنین ببینید (SEE ALSO)"
.IX Header "SEE ALSO"
\&\fBswtpm_cuse\fR