doveadm-auth(1)

1DOVEADM-AUTH(1)                     Dovecot                    DOVEADM-AUTH(1)
2
3
4

NAME

6       doveadm-auth - Flush/lookup/test authentication data
7

SYNOPSIS

9       doveadm [-Dv] [-f formatter] auth command [OPTIONS] [ARGUMENTS]
10

DESCRIPTION

12       The  doveadm   auth COMMANDS can be used to perform various authentica‐
13       tion related actions.
14

OPTIONS

16       Global doveadm(1) options:
17
18       -D     Enables verbosity and debug messages.
19
20       -f formatter
21              Specifies the formatter for formatting  the  output.   Supported
22              formatters are:
23
24              flow   prints each line with key=value pairs.
25
26              pager  prints each key: value pair on its own line and separates
27                     records with form feed character (^L).
28
29              tab    prints a table header followed  by  tab  separated  value
30                     lines.
31
32              table  prints a table header followed by adjusted value lines.
33
34       -o setting=value
35              Overrides  the  configuration  setting  from  /etc/dovecot/dove‐
36              cot.conf and from the userdb with the given value.  In order  to
37              override  multiple settings, the -o option may be specified mul‐
38              tiple times.
39
40       -v     Enables verbosity, including progress counter.
41
42       Command specific options:
43
44       -x auth_info
45              auth_info specifies additional conditions for  the  auth  lookup
46              and  auth  test commands.  The auth_info option string has to be
47              given as name=value pair.  For multiple conditions the -x option
48              could be supplied multiple times.
49              Possible names for the auth_info are:
50
51              service
52                     The service for which the authentication lookup should be
53                     tested.  The value may be the name of a service, commonly
54                     used with Dovecot.  For example: imap, pop3 or smtp.
55
56              lip    The local IP address (server) for the test.
57
58              rip    The remote IP address (client) for the test.
59
60              lport  The local port, e.g. 143
61
62              rport  The remote port, e.g. 24567
63

ARGUMENTS

65       user   The  user's  login  name.   Depending  on the configuration, the
66              login name may be for example jane or john@example.com.
67
68       password
69              Optionally the user's password.  doveadm(1) will prompt for  the
70              password, if none was given.
71

COMMANDS

73   auth cache flush
74       doveadm auth cache flush [-a master_socket_path] [user ...]
75
76       Flush  the  authentication  cache.  By default the cache is flushed for
77       all the users (which can also be done by sending  SIGHUP  to  the  auth
78       process).   You  can also flush the cache for one or more users by pro‐
79       viding their usernames.
80
81       -a master_socket_path
82              This option is used to specify an absolute path to  an  alterna‐
83              tive UNIX domain socket.
84
85              By   default  doveadm(1)  will  use  the  socket  /var/run/dove‐
86              cot/auth-master.  The socket may be located  in  another  direc‐
87              tory,  when  the  default  base_dir  setting  was  overridden in
88              /etc/dovecot/dovecot.conf.
89
90   auth lookup
91       doveadm  auth  lookup  [-a  userdb_socket_path]  [-x   auth_info]   [-f
92       field] user [...]
93
94       Similar  to doveadm-user(1) command, except it performs a passdb lookup
95       (without authentication) instead of a userdb lookup.
96
97       -a userdb_socket_path
98              This option is used to specify an absolute path to  an  alterna‐
99              tive UNIX domain socket.
100
101              By   default  doveadm(1)  will  use  the  socket  /var/run/dove‐
102              cot/auth-userdb.  The socket may be located  in  another  direc‐
103              tory,  when  the  default  base_dir  setting  was  overridden in
104              /etc/dovecot/dovecot.conf.
105
106       -f field
107              When this option and the  name  of  a  userdb  field  is  given,
108              doveadm(1) will show only the value of the specified field.
109
110   auth test
111       doveadm auth test [-a auth_socket_path] [-x auth_info] user [password]
112
113       Test authentication for the given user.
114
115       -a auth_socket_path
116              This  option  is used to specify an absolute path to an alterna‐
117              tive UNIX domain socket.
118
119              By  default  doveadm(1)  will  use  the  socket   /var/run/dove‐
120              cot/auth-client.   The  socket  may be located in another direc‐
121              tory, when  the  default  base_dir  setting  was  overridden  in
122              /etc/dovecot/dovecot.conf.
123
124

EXAMPLE

126       This  example  demonstrates  an imap authentication test for user john,
127       assuming the user is connected  from  the  host  with  the  IP  address
128       192.0.2.143.
129
130       doveadm auth test -x service=imap -x rip=192.0.2.143 john
131       Password:
132       passdb: john auth succeeded
133       extra fields:
134         user=john
135

REPORTING BUGS

137       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
138       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
139       at: http://dovecot.org/bugreport.html
140