DOVEADM-AUTH(1)                     Dovecot                    DOVEADM-AUTH(1)

نام (NAME)
       doveadm-auth - پاک‌سازی، جستجو و آزمایش داده‌های احراز هویت

خلاصه دستور (SYNOPSIS)
       doveadm [GLOBAL OPTIONS] auth command [OPTIONS] [ARGUMENTS]

توضیحات (DESCRIPTION)
       دستورهای doveadm auth برای انجام عملیات و اقدامات گوناگون مرتبط با
       احراز هویت به کار می‌روند.

گزینه‌های عمومی (GLOBAL OPTIONS)
       گزینه‌های عمومی doveadm(1):

       -D

           پیام‌های اشکال‌زدایی (debug) و پرگویی (verbosity) را فعال می‌کند.



       -O

           هیچ فایل پیکربندی‌ای را نمی‌خواند و صرفاً از مقادیر پیش‌فرض استفاده
           می‌کند. تنظیم dovecot_storage_version به‌طور پیش‌فرض روی جدیدترین نسخه
           قرار دارد، اما می‌توان آن را با -o بازنویسی کرد.



       -k

           تمام محیط را برای doveadm حفظ می‌کند، نه فقط تنظیم
           import_environment را.



       -v

           حالت پرگویی (verbosity)، از جمله شمارنده پیشرفت را فعال می‌کند.



       -i instance-name

           در صورت استفاده از چندین نمونه (instance) از Dovecot، فایل پیکربندی
           را بر اساس این نام نمونه انتخاب می‌کند.

           برای اطلاعات بیشتر به تنظیم instance_name مراجعه کنید.



       -c config-file

           پیکربندی را از config-file داده‌شده می‌خواند. به‌طور پیش‌فرض ابتدا سوکت
           پیکربندی را می‌خواند و در صورت در دسترس نبودن، به
           /etc/dovecot/dovecot.conf بازمی‌گردد. همچنین می‌توانید این مقدار را
           به سوکت پیکربندی نمونه‌ای که نسخه‌ای سازگار را اجرا می‌کند هدایت کنید.



       -o setting=value

           تنظیم پیکربندی setting را از /etc/dovecot/dovecot.conf و از userdb
           با مقدار داده‌شده value بازنویسی می‌کند. جهت بازنویسی چندین تنظیم،
           می‌توان گزینهٔ -o را چندین بار مشخص کرد.



       -f formatter

           قالب‌بندی‌کننده (formatter) را برای قالب‌بندی خروجی مشخص می‌کند.
           قالب‌بندی‌کننده‌های پشتیبانی‌شده عبارتند از:

           flow

               هر سطر را با جفت‌های key=value چاپ می‌کند.


       json

           یک آرایهٔ JSON از اشیاء JSON را چاپ می‌کند.


       pager

           هر جفت key: value را در یک سطر جداگانه چاپ می‌کند و رکوردها را با
           نویسهٔ تغییر صفحه (^L) جدا می‌سازد.


       tab

           یک سربرگ جدول و به دنبال آن سطرهای مقادیر جداشده با تب را چاپ
           می‌کند.


       table

           یک سربرگ جدول و به دنبال آن سطرهای مقادیر تراز شده را چاپ می‌کند.




گزینه‌ها (OPTIONS)
       -x auth_info

           آرگومان auth_info شرایط اضافی را برای دستور user مشخص می‌کند. رشتهٔ
           گزینهٔ auth_info باید به‌صورت یک جفت name = value داده شود. برای
           اعمال چندین شرط می‌توان گزینهٔ -x را چندین بار تکرار کرد.

           نام‌های مجاز برای auth_info عبارتند از:

           service

               سرویسی که جستجوی userdb باید برای آن آزمایش شود. مقدار می‌تواند
               نام سرویسی باشد که معمولاً با Dovecot استفاده می‌شود؛ برای نمونه:
               imap، pop3 یا smtp.


       session

           شناسهٔ نشست.


       lip

           آدرس IP محلی (سرور) برای آزمایش.


       rip

           آدرس IP راه دور (کلاینت) برای آزمایش.


       lport

           درگاه محلی؛ برای نمونه 143.


       rport

           درگاه راه دور؛ برای نمونه 24567.


       real_lip

           آدرس IP محلی روی این میزبان که کلاینت به آن متصل شده است.


       real_rip

           آدرس IP راه دور که کلاینت از آن به این میزبان متصل شده است.


       real_lport

           درگاه محلی روی این میزبان که کلاینت به آن متصل شده است.


       real_rport

           درگاه راه دور که کلاینت از آن به این میزبان متصل شده است.


       forward_<field>

           فیلدی که باید به‌صورت %{forward:field} به فرایند احراز هویت (auth)
           ارسال شود.




آرگومان‌ها (ARGUMENTS)
       user

           نام کاربری ورود user. بسته به نوع پیکربندی، نام کاربری ورود می‌تواند
           برای نمونه jane یا ⟨john@example.com⟩ باشد.



       password

           گذرواژهٔ کاربر به‌صورت اختیاری. در صورتی که گذرواژه‌ای داده نشود،
           doveadm(1) آن را درخواست خواهد کرد.



دستورها (COMMANDS)
   auth cache flush
       doveadm [GLOBAL OPTIONS] auth cache flush [-a master_socket_path]
       [user-mask ...]

       کَش احراز هویت را پاک‌سازی می‌کند. به‌طور پیش‌فرض کَش برای همهٔ کاربران
       پاک‌سازی می‌شود (که می‌توان این کار را با ارسال سیگنال SIGHUP به فرایند
       auth نیز انجام داد). همچنین می‌توانید با مشخص کردن یک ماسک کاربر (user-
       mask) منطبق بر نام‌های کاربری، کَش را برای یک یا چند کاربر پاک‌سازی کنید.

       -a master_socket_path

           این گزینه برای تعیین مسیر مطلق به یک سوکت دامنه یونیکس جایگزین
           استفاده می‌شود.

           به‌طور پیش‌فرض doveadm(1) از سوکت /rundir/auth-master استفاده می‌کند.
           هنگامی که تنظیم پیش‌فرض base_dir در /etc/dovecot/dovecot.conf
           بازنویسی شده باشد، سوکت ممکن است در دایرکتوری دیگری قرار داشته
           باشد.



       -x auth_info

           آرگومان auth_info شرایط اضافی را برای دستور user مشخص می‌کند. رشتهٔ
           گزینهٔ auth_info باید به‌صورت یک جفت name = value داده شود. برای
           اعمال چندین شرط می‌توان گزینهٔ -x را چندین بار تکرار کرد.

           نام‌های مجاز برای auth_info عبارتند از:

           service

               سرویسی که جستجوی userdb باید برای آن آزمایش شود. مقدار می‌تواند
               نام سرویسی باشد که معمولاً با Dovecot استفاده می‌شود؛ برای نمونه:
               imap، pop3 یا smtp.


       session

           شناسهٔ نشست.


       lip

           آدرس IP محلی (سرور) برای آزمایش.


       rip

           آدرس IP راه دور (کلاینت) برای آزمایش.


       lport

           درگاه محلی؛ برای نمونه 143.


       rport

           درگاه راه دور؛ برای نمونه 24567.


       real_lip

           آدرس IP محلی روی این میزبان که کلاینت به آن متصل شده است.


       real_rip

           آدرس IP راه دور که کلاینت از آن به این میزبان متصل شده است.


       real_lport

           درگاه محلی روی این میزبان که کلاینت به آن متصل شده است.


       real_rport

           درگاه راه دور که کلاینت از آن به این میزبان متصل شده است.


       forward_<field>

           فیلدی که باید به‌صورت %{forward:field} به فرایند احراز هویت (auth)
           ارسال شود.




   auth lookup
       doveadm [GLOBAL OPTIONS] auth lookup [-a userdb_socket_path] [-x
       auth_info] [-f field] user [...]

       مشابه دستور doveadm-user(1) است، با این تفاوت که به‌جای جستجو در userdb،
       یک جستجو در passdb (بدون انجام احراز هویت) انجام می‌دهد.

       -a userdb_socket_path

           این گزینه برای تعیین مسیر مطلق به یک سوکت دامنه یونیکس جایگزین
           استفاده می‌شود.

           به‌طور پیش‌فرض doveadm(1) از سوکت /rundir/auth-userdb استفاده می‌کند.
           هنگامی که تنظیم پیش‌فرض base_dir در /etc/dovecot/dovecot.conf
           بازنویسی شده باشد، سوکت ممکن است در دایرکتوری دیگری قرار داشته
           باشد.



       -f field

           هنگامی که این گزینه و نام یک فیلد userdb مشخص شود، doveadm(1) تنها
           مقدار فیلد تعیین‌شده را نمایش خواهد داد.



       -x auth_info

           آرگومان auth_info شرایط اضافی را برای دستور user مشخص می‌کند. رشتهٔ
           گزینهٔ auth_info باید به‌صورت یک جفت name = value داده شود. برای
           اعمال چندین شرط می‌توان گزینهٔ -x را چندین بار تکرار کرد.

           نام‌های مجاز برای auth_info عبارتند از:

           service

               سرویسی که جستجوی userdb باید برای آن آزمایش شود. مقدار می‌تواند
               نام سرویسی باشد که معمولاً با Dovecot استفاده می‌شود؛ برای نمونه:
               imap، pop3 یا smtp.


       session

           شناسهٔ نشست.


       lip

           آدرس IP محلی (سرور) برای آزمایش.


       rip

           آدرس IP راه دور (کلاینت) برای آزمایش.


       lport

           درگاه محلی؛ برای نمونه 143.


       rport

           درگاه راه دور؛ برای نمونه 24567.


       real_lip

           آدرس IP محلی روی این میزبان که کلاینت به آن متصل شده است.


       real_rip

           آدرس IP راه دور که کلاینت از آن به این میزبان متصل شده است.


       real_lport

           درگاه محلی روی این میزبان که کلاینت به آن متصل شده است.


       real_rport

           درگاه راه دور که کلاینت از آن به این میزبان متصل شده است.


       forward_<field>

           فیلدی که باید به‌صورت %{forward:field} به فرایند احراز هویت (auth)
           ارسال شود.




   auth test
       doveadm [GLOBAL OPTIONS] auth test [-a auth_socket_path] [-A sasl_mech]
       [-x auth_info] user [password]

       احراز هویت را برای کاربر مشخص‌شده می‌آزماید.

       -a auth_socket_path

           این گزینه برای تعیین مسیر مطلق به یک سوکت دامنه یونیکس جایگزین
           استفاده می‌شود.

           به‌طور پیش‌فرض doveadm(1) از سوکت /rundir/auth-client استفاده می‌کند.
           هنگامی که تنظیم پیش‌فرض base_dir در /etc/dovecot/dovecot.conf
           بازنویسی شده باشد، سوکت ممکن است در دایرکتوری دیگری قرار داشته
           باشد.



       -A sasl_mech

           سازوکار SASL مورد استفاده برای احراز هویت. به‌طور پیش‌فرض از PLAIN
           استفاده می‌شود.



       -x auth_info

           آرگومان auth_info شرایط اضافی را برای دستور user مشخص می‌کند. رشتهٔ
           گزینهٔ auth_info باید به‌صورت یک جفت name = value داده شود. برای
           اعمال چندین شرط می‌توان گزینهٔ -x را چندین بار تکرار کرد.

           نام‌های مجاز برای auth_info عبارتند از:

           service

               سرویسی که جستجوی userdb باید برای آن آزمایش شود. مقدار می‌تواند
               نام سرویسی باشد که معمولاً با Dovecot استفاده می‌شود؛ برای نمونه:
               imap، pop3 یا smtp.


       session

           شناسهٔ نشست.


       lip

           آدرس IP محلی (سرور) برای آزمایش.


       rip

           آدرس IP راه دور (کلاینت) برای آزمایش.


       lport

           درگاه محلی؛ برای نمونه 143.


       rport

           درگاه راه دور؛ برای نمونه 24567.


       real_lip

           آدرس IP محلی روی این میزبان که کلاینت به آن متصل شده است.


       real_rip

           آدرس IP راه دور که کلاینت از آن به این میزبان متصل شده است.


       real_lport

           درگاه محلی روی این میزبان که کلاینت به آن متصل شده است.


       real_rport

           درگاه راه دور که کلاینت از آن به این میزبان متصل شده است.


       forward_<field>

           فیلدی که باید به‌صورت %{forward:field} به فرایند احراز هویت (auth)
           ارسال شود.




   auth login
       doveadm [GLOBAL OPTIONS] auth login [-a auth_socket_path] [-m
       auth_master_socket_path] [-A sasl_mech] [-x auth_info] user [password]

       ورود کامل کاربر مشخص‌شده را می‌آزماید؛ یعنی هم جستجو در passdb (احراز
       هویت) و هم جستجو در userdb (ورود) را انجام می‌دهد.

       -a auth_socket_path

           این گزینه برای تعیین مسیر مطلق به یک سوکت دامنه یونیکس جایگزین
           استفاده می‌شود.

           به‌طور پیش‌فرض doveadm(1) از سوکت /rundir/auth-client استفاده می‌کند.
           هنگامی که تنظیم پیش‌فرض base_dir در /etc/dovecot/dovecot.conf
           بازنویسی شده باشد، سوکت ممکن است در دایرکتوری دیگری قرار داشته
           باشد.



       -m auth_master_socket_path

           این گزینه برای تعیین مسیر مطلق به یک سوکت دامنه یونیکس جایگزین برای
           سوکت اصلی (master socket) استفاده می‌شود.

           به‌طور پیش‌فرض doveadm(1) از سوکت /rundir/auth-master استفاده می‌کند.
           هنگامی که تنظیم پیش‌فرض base_dir در /etc/dovecot/dovecot.conf
           بازنویسی شده باشد، سوکت ممکن است در دایرکتوری دیگری قرار داشته
           باشد.



       -A sasl_mech

           سازوکار SASL مورد استفاده برای احراز هویت. به‌طور پیش‌فرض از PLAIN
           استفاده می‌شود.



       -x auth_info

           آرگومان auth_info شرایط اضافی را برای دستور user مشخص می‌کند. رشتهٔ
           گزینهٔ auth_info باید به‌صورت یک جفت name = value داده شود. برای
           اعمال چندین شرط می‌توان گزینهٔ -x را چندین بار تکرار کرد.

           نام‌های مجاز برای auth_info عبارتند از:

           service

               سرویسی که جستجوی userdb باید برای آن آزمایش شود. مقدار می‌تواند
               نام سرویسی باشد که معمولاً با Dovecot استفاده می‌شود؛ برای نمونه:
               imap، pop3 یا smtp.


       session

           شناسهٔ نشست.


       lip

           آدرس IP محلی (سرور) برای آزمایش.


       rip

           آدرس IP راه دور (کلاینت) برای آزمایش.


       lport

           درگاه محلی؛ برای نمونه 143.


       rport

           درگاه راه دور؛ برای نمونه 24567.


       real_lip

           آدرس IP محلی روی این میزبان که کلاینت به آن متصل شده است.


       real_rip

           آدرس IP راه دور که کلاینت از آن به این میزبان متصل شده است.


       real_lport

           درگاه محلی روی این میزبان که کلاینت به آن متصل شده است.


       real_rport

           درگاه راه دور که کلاینت از آن به این میزبان متصل شده است.


       forward_<field>

           فیلدی که باید به‌صورت %{forward:field} به فرایند احراز هویت (auth)
           ارسال شود.




مثال‌ها (EXAMPLES)
       این مثال یک آزمایش احراز هویت imap را برای کاربر john نشان می‌دهد، با
       این فرض که کاربر از میزبانی با آدرس IP با مقدار 192.0.2.143 متصل شده
       است.

         doveadm auth test -x service=imap -x rip=192.0.2.143 john

         Password:
         passdb: john auth succeeded
         extra fields:
           user=john

گزارش باگ‌ها (REPORTING BUGS)
       گزارش باگ‌ها، شامل خروجی doveconf -n را به فهرست پستی Dovecot به نشانی
       ⟨dovecot@dovecot.org⟩ ارسال کنید. اطلاعات مربوط به گزارش باگ‌ها در این
       نشانی در دسترس است: ⟨https://dovecot.org/bugreport.html⟩

همچنین ببینید (SEE ALSO)
       doveadm(1)

e5ac02a                            May 2026                    DOVEADM-AUTH(1)