doveadm-auth(1)

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

NAME

6       doveadm-auth - Test authentication for a user
7

SYNOPSIS

9       doveadm [-Dv] auth [-a auth_socket_path] [-x auth_info] user [password]
10

DESCRIPTION

12       The  auth  command can be used to test the authentication for the given
13       user.
14

OPTIONS

16       Global doveadm(1) options:
17
18       -D     Enables verbosity and debug messages.
19
20       -v     Enables verbosity, including progress counter.
21
22       Command specific options:
23
24       -a auth_socket_path
25              This option is used to specify an absolute path to  an  alterna‐
26              tive UNIX domain socket.
27
28              By   default  doveadm(1)  will  use  the  socket  /var/run/dove‐
29              cot/auth-client.  The socket may be located  in  another  direc‐
30              tory,  when  the  default  base_dir  setting  was  overridden in
31              /etc/dovecot/dovecot.conf.
32
33       -x auth_info
34              auth_info specifies additional conditions for the auth  command.
35              The  auth_info option string has to be given as name=value pair.
36              For multiple conditions the -x option could be supplied multiple
37              times.
38              Possible names for the auth_info are:
39
40              service
41                     The service for which the authentication lookup should be
42                     tested.  The value may be the name of a service, commonly
43                     used with Dovecot.  For example: imap, pop3 or smtp.
44
45              lip    The local IP address (server) for the test.
46
47              rip    The remote IP address (client) for the test.
48
49              lport  The local port, e.g. 143
50
51              rport  The remote port, e.g. 24567
52

ARGUMENTS

54       user   The  user's  login  name.   Depending  on the configuration, the
55              login name may be for example jane or john@example.com.
56
57       password
58              Optionally the user's password.  doveadm(1) will prompt for  the
59              password, if none was given.
60

EXAMPLE

62       This  example  demonstrates  an imap authentication test for user john,
63       assuming the user is connected  from  the  host  with  the  IP  address
64       192.0.2.143.
65
66       doveadm auth -x service=imap -x rip=192.0.2.143 john johns_password
67       passdb: john auth succeeded
68       extra fields:
69         user=john
70

REPORTING BUGS

72       Report  bugs, including doveconf -n output, to the Dovecot Mailing List
73       <dovecot@dovecot.org>.  Information about reporting bugs  is  available
74       at: http://dovecot.org/bugreport.html
75