.TH "DOVEADM-AUTH" "1" "May 2026" "e5ac02a" "Dovecot" .SH "نام (NAME)" doveadm-auth \- پاک‌سازی، جستجو و آزمایش داده‌های احراز هویت .SH "خلاصه دستور (SYNOPSIS)" .P \fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBauth\fR \fIcommand\fR \[lB]\fIOPTIONS\fR\[rB] \[lB]\fIARGUMENTS\fR\[rB] .SH "توضیحات (DESCRIPTION)" .P دستورهای \fBdoveadm auth\fR برای انجام عملیات و اقدامات گوناگون مرتبط با احراز هویت به کار می‌روند. .SH "گزینه‌های عمومی (GLOBAL OPTIONS)" .P گزینه‌های عمومی doveadm(1): .P \fB-D\fR .RS 0 .RS 4 .P پیام‌های اشکال‌زدایی (debug) و پرگویی (\fIverbosity\fR) را فعال می‌کند. .RE 0 .RE 0 .P \fB-O\fR .RS 0 .RS 4 .P هیچ فایل پیکربندی‌ای را نمی‌خواند و صرفاً از مقادیر پیش‌فرض استفاده می‌کند. تنظیم \fBdovecot_storage_version\fR به‌طور پیش‌فرض روی جدیدترین نسخه قرار دارد، اما می‌توان آن را با \fB-o\fR بازنویسی کرد. .RE 0 .RE 0 .P \fB-k\fR .RS 0 .RS 4 .P تمام محیط را برای doveadm حفظ می‌کند، نه فقط تنظیم \fBimport_environment\fR را. .RE 0 .RE 0 .P \fB-v\fR .RS 0 .RS 4 .P حالت پرگویی (verbosity)، از جمله شمارنده پیشرفت را فعال می‌کند. .RE 0 .RE 0 .P \fB-i\fR \fIinstance-name\fR .RS 0 .RS 4 .P در صورت استفاده از چندین نمونه (instance) از Dovecot، فایل پیکربندی را بر اساس این نام نمونه انتخاب می‌کند. .P برای اطلاعات بیشتر به تنظیم \fBinstance_name\fR مراجعه کنید. .RE 0 .RE 0 .P \fB-c\fR \fIconfig-file\fR .RS 0 .RS 4 .P پیکربندی را از \fIconfig-file\fR داده‌شده می‌خواند. به‌طور پیش‌فرض ابتدا سوکت پیکربندی را می‌خواند و در صورت در دسترس نبودن، به \fI/etc/dovecot/dovecot.conf\fR بازمی‌گردد. همچنین می‌توانید این مقدار را به سوکت پیکربندی نمونه‌ای که نسخه‌ای سازگار را اجرا می‌کند هدایت کنید. .RE 0 .RE 0 .P \fB-o\fR \fIsetting\fR\fB=\fR\fIvalue\fR .RS 0 .RS 4 .P تنظیم پیکربندی \fIsetting\fR را از \fI/etc/dovecot/dovecot.conf\fR و از userdb با مقدار داده‌شده \fIvalue\fR بازنویسی می‌کند. جهت بازنویسی چندین تنظیم، می‌توان گزینهٔ \fB-o\fR را چندین بار مشخص کرد. .RE 0 .RE 0 .P \fB-f\fR \fIformatter\fR .RS 0 .RS 4 .P قالب‌بندی‌کننده (\fIformatter\fR) را برای قالب‌بندی خروجی مشخص می‌کند. قالب‌بندی‌کننده‌های پشتیبانی‌شده عبارتند از: .P \fBflow\fR .RS 4 .P هر سطر را با جفت‌های \fIkey\fR\fB=\fR\fIvalue\fR چاپ می‌کند. .RE 0 .P \fBjson\fR .RS 4 .P یک آرایهٔ JSON از اشیاء JSON را چاپ می‌کند. .RE 0 .P \fBpager\fR .RS 4 .P هر جفت \fIkey\fR: \fIvalue\fR را در یک سطر جداگانه چاپ می‌کند و رکوردها را با نویسهٔ تغییر صفحه (\fB^L\fR) جدا می‌سازد. .RE 0 .P \fBtab\fR .RS 4 .P یک سربرگ جدول و به دنبال آن سطرهای مقادیر جداشده با تب را چاپ می‌کند. .RE 0 .P \fBtable\fR .RS 4 .P یک سربرگ جدول و به دنبال آن سطرهای مقادیر تراز شده را چاپ می‌کند. .RE 0 .RE 0 .RE 0 .SH "گزینه‌ها (OPTIONS)" .P \fB-x\fR \fIauth_info\fR .RS 0 .RS 4 .P آرگومان \fIauth_info\fR شرایط اضافی را برای دستور \fBuser\fR مشخص می‌کند. رشتهٔ گزینهٔ \fIauth_info\fR باید به‌صورت یک جفت \fIname\fR \fB=\fR \fIvalue\fR داده شود. برای اعمال چندین شرط می‌توان گزینهٔ \fB-x\fR را چندین بار تکرار کرد. .P نام‌های مجاز برای \fIauth_info\fR عبارتند از: .P \fBservice\fR .RS 4 .P سرویسی که جستجوی userdb باید برای آن آزمایش شود. مقدار می‌تواند نام سرویسی باشد که معمولاً با Dovecot استفاده می‌شود؛ برای نمونه: \fBimap\fR، \fBpop3\fR یا \fBsmtp\fR. .RE 0 .P \fBsession\fR .RS 4 .P شناسهٔ نشست. .RE 0 .P \fBlip\fR .RS 4 .P آدرس IP محلی (سرور) برای آزمایش. .RE 0 .P \fBrip\fR .RS 4 .P آدرس IP راه دور (کلاینت) برای آزمایش. .RE 0 .P \fBlport\fR .RS 4 .P درگاه محلی؛ برای نمونه 143. .RE 0 .P \fBrport\fR .RS 4 .P درگاه راه دور؛ برای نمونه 24567. .RE 0 .P \fBreal_lip\fR .RS 4 .P آدرس IP محلی روی این میزبان که کلاینت به آن متصل شده است. .RE 0 .P \fBreal_rip\fR .RS 4 .P آدرس IP راه دور که کلاینت از آن به این میزبان متصل شده است. .RE 0 .P \fBreal_lport\fR .RS 4 .P درگاه محلی روی این میزبان که کلاینت به آن متصل شده است. .RE 0 .P \fBreal_rport\fR .RS 4 .P درگاه راه دور که کلاینت از آن به این میزبان متصل شده است. .RE 0 .P \fBforward_\fR .RS 4 .P فیلدی که باید به‌صورت %{forward:field} به فرایند احراز هویت (auth) ارسال شود. .RE 0 .RE 0 .RE 0 .SH "آرگومان‌ها (ARGUMENTS)" .P \fIuser\fR .RS 0 .RS 4 .P نام کاربری ورود \fIuser\fR. بسته به نوع پیکربندی، نام کاربری ورود می‌تواند برای نمونه \fBjane\fR یا \fB\fI\(lajohn@example.com\(ra\fB\fR باشد. .RE 0 .RE 0 .P \fIpassword\fR .RS 0 .RS 4 .P گذرواژهٔ کاربر به‌صورت اختیاری. در صورتی که گذرواژه‌ای داده نشود، doveadm(1) آن را درخواست خواهد کرد. .RE 0 .RE 0 .SH "دستورها (COMMANDS)" .SS "auth cache flush" .P \fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] auth cache flush \[lB]\fB-a\fR \fImaster_socket_path\fR\[rB] \[lB]\fIuser-mask\fR ...\[rB] .P کَش احراز هویت را پاک‌سازی می‌کند. به‌طور پیش‌فرض کَش برای همهٔ کاربران پاک‌سازی می‌شود (که می‌توان این کار را با ارسال سیگنال SIGHUP به فرایند auth نیز انجام داد). همچنین می‌توانید با مشخص کردن یک ماسک کاربر (user-mask) منطبق بر نام‌های کاربری، کَش را برای یک یا چند کاربر پاک‌سازی کنید. .P \fB-a\fR \fImaster_socket_path\fR .RS 0 .RS 4 .P این گزینه برای تعیین مسیر مطلق به یک سوکت دامنه یونیکس جایگزین استفاده می‌شود. .P به‌طور پیش‌فرض doveadm(1) از سوکت \fI/rundir/auth-master\fR استفاده می‌کند. هنگامی که تنظیم پیش‌فرض \fIbase_dir\fR در \fI/etc/dovecot/dovecot.conf\fR بازنویسی شده باشد، سوکت ممکن است در دایرکتوری دیگری قرار داشته باشد. .RE 0 .RE 0 .P \fB-x\fR \fIauth_info\fR .RS 0 .RS 4 .P آرگومان \fIauth_info\fR شرایط اضافی را برای دستور \fBuser\fR مشخص می‌کند. رشتهٔ گزینهٔ \fIauth_info\fR باید به‌صورت یک جفت \fIname\fR \fB=\fR \fIvalue\fR داده شود. برای اعمال چندین شرط می‌توان گزینهٔ \fB-x\fR را چندین بار تکرار کرد. .P نام‌های مجاز برای \fIauth_info\fR عبارتند از: .P \fBservice\fR .RS 4 .P سرویسی که جستجوی userdb باید برای آن آزمایش شود. مقدار می‌تواند نام سرویسی باشد که معمولاً با Dovecot استفاده می‌شود؛ برای نمونه: \fBimap\fR، \fBpop3\fR یا \fBsmtp\fR. .RE 0 .P \fBsession\fR .RS 4 .P شناسهٔ نشست. .RE 0 .P \fBlip\fR .RS 4 .P آدرس IP محلی (سرور) برای آزمایش. .RE 0 .P \fBrip\fR .RS 4 .P آدرس IP راه دور (کلاینت) برای آزمایش. .RE 0 .P \fBlport\fR .RS 4 .P درگاه محلی؛ برای نمونه 143. .RE 0 .P \fBrport\fR .RS 4 .P درگاه راه دور؛ برای نمونه 24567. .RE 0 .P \fBreal_lip\fR .RS 4 .P آدرس IP محلی روی این میزبان که کلاینت به آن متصل شده است. .RE 0 .P \fBreal_rip\fR .RS 4 .P آدرس IP راه دور که کلاینت از آن به این میزبان متصل شده است. .RE 0 .P \fBreal_lport\fR .RS 4 .P درگاه محلی روی این میزبان که کلاینت به آن متصل شده است. .RE 0 .P \fBreal_rport\fR .RS 4 .P درگاه راه دور که کلاینت از آن به این میزبان متصل شده است. .RE 0 .P \fBforward_\fR .RS 4 .P فیلدی که باید به‌صورت %{forward:field} به فرایند احراز هویت (auth) ارسال شود. .RE 0 .RE 0 .RE 0 .SS "auth lookup" .P \fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] auth lookup \[lB]\fB-a\fR \fIuserdb_socket_path\fR\[rB] \[lB]\fB-x\fR \fIauth_info\fR\[rB] \[lB]\fB-f\fR \fIfield\fR\[rB] \fIuser\fR \[lB]...\[rB] .P مشابه دستور doveadm-user(1) است، با این تفاوت که به‌جای جستجو در \fIuserdb\fR، یک جستجو در \fIpassdb\fR (بدون انجام احراز هویت) انجام می‌دهد. .P \fB-a\fR \fIuserdb_socket_path\fR .RS 0 .RS 4 .P این گزینه برای تعیین مسیر مطلق به یک سوکت دامنه یونیکس جایگزین استفاده می‌شود. .P به‌طور پیش‌فرض doveadm(1) از سوکت \fI/rundir/auth-userdb\fR استفاده می‌کند. هنگامی که تنظیم پیش‌فرض \fIbase_dir\fR در \fI/etc/dovecot/dovecot.conf\fR بازنویسی شده باشد، سوکت ممکن است در دایرکتوری دیگری قرار داشته باشد. .RE 0 .RE 0 .P \fB-f\fR \fIfield\fR .RS 0 .RS 4 .P هنگامی که این گزینه و نام یک فیلد userdb مشخص شود، doveadm(1) تنها مقدار فیلد تعیین‌شده را نمایش خواهد داد. .RE 0 .RE 0 .P \fB-x\fR \fIauth_info\fR .RS 0 .RS 4 .P آرگومان \fIauth_info\fR شرایط اضافی را برای دستور \fBuser\fR مشخص می‌کند. رشتهٔ گزینهٔ \fIauth_info\fR باید به‌صورت یک جفت \fIname\fR \fB=\fR \fIvalue\fR داده شود. برای اعمال چندین شرط می‌توان گزینهٔ \fB-x\fR را چندین بار تکرار کرد. .P نام‌های مجاز برای \fIauth_info\fR عبارتند از: .P \fBservice\fR .RS 4 .P سرویسی که جستجوی userdb باید برای آن آزمایش شود. مقدار می‌تواند نام سرویسی باشد که معمولاً با Dovecot استفاده می‌شود؛ برای نمونه: \fBimap\fR، \fBpop3\fR یا \fBsmtp\fR. .RE 0 .P \fBsession\fR .RS 4 .P شناسهٔ نشست. .RE 0 .P \fBlip\fR .RS 4 .P آدرس IP محلی (سرور) برای آزمایش. .RE 0 .P \fBrip\fR .RS 4 .P آدرس IP راه دور (کلاینت) برای آزمایش. .RE 0 .P \fBlport\fR .RS 4 .P درگاه محلی؛ برای نمونه 143. .RE 0 .P \fBrport\fR .RS 4 .P درگاه راه دور؛ برای نمونه 24567. .RE 0 .P \fBreal_lip\fR .RS 4 .P آدرس IP محلی روی این میزبان که کلاینت به آن متصل شده است. .RE 0 .P \fBreal_rip\fR .RS 4 .P آدرس IP راه دور که کلاینت از آن به این میزبان متصل شده است. .RE 0 .P \fBreal_lport\fR .RS 4 .P درگاه محلی روی این میزبان که کلاینت به آن متصل شده است. .RE 0 .P \fBreal_rport\fR .RS 4 .P درگاه راه دور که کلاینت از آن به این میزبان متصل شده است. .RE 0 .P \fBforward_\fR .RS 4 .P فیلدی که باید به‌صورت %{forward:field} به فرایند احراز هویت (auth) ارسال شود. .RE 0 .RE 0 .RE 0 .SS "auth test" .P \fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] auth test \[lB]\fB-a\fR \fIauth_socket_path\fR\[rB] \[lB]\fB-A\fR \fIsasl_mech\fR\[rB] \[lB]\fB-x\fR \fIauth_info\fR\[rB] \fIuser\fR \[lB]\fIpassword\fR\[rB] .P احراز هویت را برای کاربر مشخص‌شده می‌آزماید. .P \fB-a\fR \fIauth_socket_path\fR .RS 0 .RS 4 .P این گزینه برای تعیین مسیر مطلق به یک سوکت دامنه یونیکس جایگزین استفاده می‌شود. .P به‌طور پیش‌فرض doveadm(1) از سوکت \fI/rundir/auth-client\fR استفاده می‌کند. هنگامی که تنظیم پیش‌فرض \fIbase_dir\fR در \fI/etc/dovecot/dovecot.conf\fR بازنویسی شده باشد، سوکت ممکن است در دایرکتوری دیگری قرار داشته باشد. .RE 0 .RE 0 .P \fB-A\fR \fIsasl_mech\fR .RS 0 .RS 4 .P سازوکار SASL مورد استفاده برای احراز هویت. به‌طور پیش‌فرض از PLAIN استفاده می‌شود. .RE 0 .RE 0 .P \fB-x\fR \fIauth_info\fR .RS 0 .RS 4 .P آرگومان \fIauth_info\fR شرایط اضافی را برای دستور \fBuser\fR مشخص می‌کند. رشتهٔ گزینهٔ \fIauth_info\fR باید به‌صورت یک جفت \fIname\fR \fB=\fR \fIvalue\fR داده شود. برای اعمال چندین شرط می‌توان گزینهٔ \fB-x\fR را چندین بار تکرار کرد. .P نام‌های مجاز برای \fIauth_info\fR عبارتند از: .P \fBservice\fR .RS 4 .P سرویسی که جستجوی userdb باید برای آن آزمایش شود. مقدار می‌تواند نام سرویسی باشد که معمولاً با Dovecot استفاده می‌شود؛ برای نمونه: \fBimap\fR، \fBpop3\fR یا \fBsmtp\fR. .RE 0 .P \fBsession\fR .RS 4 .P شناسهٔ نشست. .RE 0 .P \fBlip\fR .RS 4 .P آدرس IP محلی (سرور) برای آزمایش. .RE 0 .P \fBrip\fR .RS 4 .P آدرس IP راه دور (کلاینت) برای آزمایش. .RE 0 .P \fBlport\fR .RS 4 .P درگاه محلی؛ برای نمونه 143. .RE 0 .P \fBrport\fR .RS 4 .P درگاه راه دور؛ برای نمونه 24567. .RE 0 .P \fBreal_lip\fR .RS 4 .P آدرس IP محلی روی این میزبان که کلاینت به آن متصل شده است. .RE 0 .P \fBreal_rip\fR .RS 4 .P آدرس IP راه دور که کلاینت از آن به این میزبان متصل شده است. .RE 0 .P \fBreal_lport\fR .RS 4 .P درگاه محلی روی این میزبان که کلاینت به آن متصل شده است. .RE 0 .P \fBreal_rport\fR .RS 4 .P درگاه راه دور که کلاینت از آن به این میزبان متصل شده است. .RE 0 .P \fBforward_\fR .RS 4 .P فیلدی که باید به‌صورت %{forward:field} به فرایند احراز هویت (auth) ارسال شود. .RE 0 .RE 0 .RE 0 .SS "auth login" .P \fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] auth login \[lB]\fB-a\fR \fIauth_socket_path\fR\[rB] \[lB]\fB-m\fR \fIauth_master_socket_path\fR\[rB] \[lB]\fB-A\fR \fIsasl_mech\fR\[rB] \[lB]\fB-x\fR \fIauth_info\fR\[rB] \fIuser\fR \[lB]\fIpassword\fR\[rB] .P ورود کامل کاربر مشخص‌شده را می‌آزماید؛ یعنی هم جستجو در passdb (احراز هویت) و هم جستجو در userdb (ورود) را انجام می‌دهد. .P \fB-a\fR \fIauth_socket_path\fR .RS 0 .RS 4 .P این گزینه برای تعیین مسیر مطلق به یک سوکت دامنه یونیکس جایگزین استفاده می‌شود. .P به‌طور پیش‌فرض doveadm(1) از سوکت \fI/rundir/auth-client\fR استفاده می‌کند. هنگامی که تنظیم پیش‌فرض \fIbase_dir\fR در \fI/etc/dovecot/dovecot.conf\fR بازنویسی شده باشد، سوکت ممکن است در دایرکتوری دیگری قرار داشته باشد. .RE 0 .RE 0 .P \fB-m\fR \fIauth_master_socket_path\fR .RS 0 .RS 4 .P این گزینه برای تعیین مسیر مطلق به یک سوکت دامنه یونیکس جایگزین برای سوکت اصلی (master socket) استفاده می‌شود. .P به‌طور پیش‌فرض doveadm(1) از سوکت \fI/rundir/auth-master\fR استفاده می‌کند. هنگامی که تنظیم پیش‌فرض \fIbase_dir\fR در \fI/etc/dovecot/dovecot.conf\fR بازنویسی شده باشد، سوکت ممکن است در دایرکتوری دیگری قرار داشته باشد. .RE 0 .RE 0 .P \fB-A\fR \fIsasl_mech\fR .RS 0 .RS 4 .P سازوکار SASL مورد استفاده برای احراز هویت. به‌طور پیش‌فرض از PLAIN استفاده می‌شود. .RE 0 .RE 0 .P \fB-x\fR \fIauth_info\fR .RS 0 .RS 4 .P آرگومان \fIauth_info\fR شرایط اضافی را برای دستور \fBuser\fR مشخص می‌کند. رشتهٔ گزینهٔ \fIauth_info\fR باید به‌صورت یک جفت \fIname\fR \fB=\fR \fIvalue\fR داده شود. برای اعمال چندین شرط می‌توان گزینهٔ \fB-x\fR را چندین بار تکرار کرد. .P نام‌های مجاز برای \fIauth_info\fR عبارتند از: .P \fBservice\fR .RS 4 .P سرویسی که جستجوی userdb باید برای آن آزمایش شود. مقدار می‌تواند نام سرویسی باشد که معمولاً با Dovecot استفاده می‌شود؛ برای نمونه: \fBimap\fR، \fBpop3\fR یا \fBsmtp\fR. .RE 0 .P \fBsession\fR .RS 4 .P شناسهٔ نشست. .RE 0 .P \fBlip\fR .RS 4 .P آدرس IP محلی (سرور) برای آزمایش. .RE 0 .P \fBrip\fR .RS 4 .P آدرس IP راه دور (کلاینت) برای آزمایش. .RE 0 .P \fBlport\fR .RS 4 .P درگاه محلی؛ برای نمونه 143. .RE 0 .P \fBrport\fR .RS 4 .P درگاه راه دور؛ برای نمونه 24567. .RE 0 .P \fBreal_lip\fR .RS 4 .P آدرس IP محلی روی این میزبان که کلاینت به آن متصل شده است. .RE 0 .P \fBreal_rip\fR .RS 4 .P آدرس IP راه دور که کلاینت از آن به این میزبان متصل شده است. .RE 0 .P \fBreal_lport\fR .RS 4 .P درگاه محلی روی این میزبان که کلاینت به آن متصل شده است. .RE 0 .P \fBreal_rport\fR .RS 4 .P درگاه راه دور که کلاینت از آن به این میزبان متصل شده است. .RE 0 .P \fBforward_\fR .RS 4 .P فیلدی که باید به‌صورت %{forward:field} به فرایند احراز هویت (auth) ارسال شود. .RE 0 .RE 0 .RE 0 .SH "مثال‌ها (EXAMPLES)" .P این مثال یک آزمایش احراز هویت imap را برای کاربر john نشان می‌دهد، با این فرض که کاربر از میزبانی با آدرس IP با مقدار 192.0.2.143 متصل شده است. .P .RS 2 .nf doveadm auth test -x service=imap -x rip=192.0.2.143 john .fi .RE .P .RS 2 .nf Password: passdb: john auth succeeded extra fields: user=john .fi .RE .SH "گزارش باگ‌ها (REPORTING BUGS)" .P گزارش باگ‌ها، شامل خروجی \fIdoveconf -n\fR را به فهرست پستی Dovecot به نشانی \fI\(ladovecot@dovecot.org\(ra\fR ارسال کنید. اطلاعات مربوط به گزارش باگ‌ها در این نشانی در دسترس است: \fI\(lahttps://dovecot.org/bugreport.html\(ra\fR .SH "همچنین ببینید (SEE ALSO)" .P \fBdoveadm\fR(1)