1 # Copyright (C) 2020 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
6 use Socket qw(IPPROTO_TCP SOL_SOCKET);
7 use PublicInbox::TestCommon;
8 # IO::Poll is part of the standard library, but distros may split it off...
9 require_mods(qw(DBD::SQLite IO::Socket::SSL Mail::IMAPClient IO::Poll));
10 my $imap_client = 'Mail::IMAPClient';
11 $imap_client->can('starttls') or
12 plan skip_all => 'Mail::IMAPClient does not support TLS';
13 my $can_compress = $imap_client->can('compress');
14 if ($can_compress) { # hope this gets fixed upstream, soon
15 require PublicInbox::IMAPClient;
16 $imap_client = 'PublicInbox::IMAPClient';
19 my $cert = 'certs/server-cert.pem';
20 my $key = 'certs/server-key.pem';
21 unless (-r $key && -r $cert) {
23 "certs/ missing for $0, run $^X ./create-certs.perl in certs/";
25 use_ok 'PublicInbox::TLS';
26 use_ok 'IO::Socket::SSL';
27 use PublicInbox::InboxWritable;
28 require PublicInbox::SearchIdx;
29 my $version = 1; # v2 needs newer git
30 require_git('2.6') if $version >= 2;
31 my ($tmpdir, $for_destroy) = tmpdir();
32 my $err = "$tmpdir/stderr.log";
33 my $out = "$tmpdir/stdout.log";
34 my $inboxdir = "$tmpdir";
35 my $pi_config = "$tmpdir/pi_config";
36 my $group = 'test-imapd-tls';
37 my $addr = $group . '@example.com';
38 my $starttls = tcp_server();
39 my $imaps = tcp_server();
40 my $ibx = PublicInbox::Inbox->new({
41 inboxdir => $inboxdir,
44 -primary_address => $addr,
45 indexlevel => 'basic',
47 $ibx = PublicInbox::InboxWritable->new($ibx, {nproc=>1});
50 open my $fh, '>', $pi_config or BAIL_OUT "open: $!";
52 [publicinbox "imapd-tls"]
59 close $fh or BAIL_OUT "close: $!\n";
63 my $im = $ibx->importer(0);
64 ok($im->add(eml_load('t/data/0001.patch')), 'message added');
67 my $s = PublicInbox::SearchIdx->new($ibx, 1);
72 my $imaps_addr = $imaps->sockhost . ':' . $imaps->sockport;
73 my $starttls_addr = $starttls->sockhost . ':' . $starttls->sockport;
74 my $env = { PI_CONFIG => $pi_config };
78 [ "--cert=$cert", "--key=$key",
79 "-limaps://$imaps_addr",
80 "-limap://$starttls_addr" ],
83 open my $fh, '>', $_ or BAIL_OUT "truncate: $!";
85 my $cmd = [ '-imapd', '-W0', @$args, "--stdout=$out", "--stderr=$err" ];
86 $td = start_script($cmd, $env, { 3 => $starttls, 4 => $imaps });
88 SSL_hostname => 'server.local',
89 SSL_verifycn_name => 'server.local',
90 SSL_verify_mode => SSL_VERIFY_PEER(),
91 SSL_ca_file => 'certs/test-ca.pem',
93 # start negotiating a slow TLS connection
94 my $slow = tcp_connect($imaps, Blocking => 0);
95 $slow = IO::Socket::SSL->start_SSL($slow, SSL_startHandshake => 0, %o);
96 my $slow_done = $slow->connect_SSL;
99 diag('W: connect_SSL early OK, slow client test invalid');
100 use PublicInbox::Syscall qw(EPOLLIN EPOLLOUT);
101 @poll = (fileno($slow), EPOLLIN | EPOLLOUT);
103 @poll = (fileno($slow), PublicInbox::TLS::epollbit());
105 # we should call connect_SSL much later...
106 my %imaps_opt = (User => 'a', Password => 'b',
107 Server => $imaps->sockhost,
108 Port => $imaps->sockport);
110 my $c = $imap_client->new(%imaps_opt, Ssl => [ %o ]);
111 ok($c && $c->IsAuthenticated, 'authenticated');
112 ok($c->select($group), 'SELECT works');
113 ok(!(scalar $c->has_capability('STARTTLS')),
114 'starttls not advertised with IMAPS');
115 ok(!$c->starttls, "starttls fails");
116 ok($c->has_capability('COMPRESS'), 'compress advertised');
117 ok($c->compress, 'compression enabled with IMAPS');
118 ok(!$c->starttls, 'starttls still fails');
119 ok($c->noop, 'noop succeeds');
120 ok($c->logout, 'logout succeeds');
123 my %imap_opt = (Server => $starttls->sockhost,
124 Port => $starttls->sockport);
125 $c = $imap_client->new(%imap_opt);
126 ok(scalar $c->has_capability('STARTTLS'),
127 'starttls advertised');
128 ok($c->Starttls([ %o ]), 'set starttls options');
129 ok($c->starttls, '->starttls works');
130 ok(!(scalar($c->has_capability('STARTTLS'))),
131 'starttls not advertised');
132 ok(!$c->starttls, '->starttls again fails');
133 ok(!(scalar($c->has_capability('STARTTLS'))),
134 'starttls still not advertised');
135 ok($c->examine($group), 'EXAMINE works');
136 ok($c->noop, 'NOOP works');
137 ok($c->compress, 'compression enabled with IMAPS');
138 ok($c->noop, 'NOOP works after compress');
139 ok($c->logout, 'logout succeeds after compress');
141 # STARTTLS with bad hostname
142 $o{SSL_hostname} = $o{SSL_verifycn_name} = 'server.invalid';
143 $c = $imap_client->new(%imap_opt);
144 ok(scalar $c->has_capability('STARTTLS'), 'starttls advertised');
145 ok($c->Starttls([ %o ]), 'set starttls options');
146 ok(!$c->starttls, '->starttls fails with bad hostname');
148 $c = $imap_client->new(%imap_opt);
149 ok($c->noop, 'NOOP still works from plain IMAP');
151 # IMAPS with bad hostname
152 $c = $imap_client->new(%imaps_opt, Ssl => [ %o ]);
153 is($c, undef, 'IMAPS fails with bad hostname');
155 # make hostname valid
156 $o{SSL_hostname} = $o{SSL_verifycn_name} = 'server.local';
157 $c = $imap_client->new(%imaps_opt, Ssl => [ %o ]);
158 ok($c, 'IMAPS succeeds again with valid hostname');
160 # slow TLS connection did not block the other fast clients while
161 # connecting, finish it off:
163 IO::Poll::_poll(-1, @poll);
164 $slow_done = $slow->connect_SSL and last;
165 @poll = (fileno($slow), PublicInbox::TLS::epollbit());
168 ok(sysread($slow, my $greet, 4096) > 0, 'slow got a greeting');
169 like($greet, qr/\A\* OK \[CAPABILITY IMAP4rev1 /, 'got greeting');
170 is(syswrite($slow, "1 LOGOUT\r\n"), 10, 'slow wrote LOGOUT');
171 ok(sysread($slow, my $end, 4096) > 0, 'got end');
172 is(sysread($slow, my $eof, 4096), 0, 'got EOF');
175 skip 'TCP_DEFER_ACCEPT is Linux-only', 2 if $^O ne 'linux';
176 my $var = eval { Socket::TCP_DEFER_ACCEPT() } // 9;
177 defined(my $x = getsockopt($imaps, IPPROTO_TCP, $var)) or die;
178 ok(unpack('i', $x) > 0, 'TCP_DEFER_ACCEPT set on IMAPS');
179 defined($x = getsockopt($starttls, IPPROTO_TCP, $var)) or die;
180 is(unpack('i', $x), 0, 'TCP_DEFER_ACCEPT is 0 on plain IMAP');
183 skip 'SO_ACCEPTFILTER is FreeBSD-only', 2 if $^O ne 'freebsd';
184 if (system('kldstat -m accf_data >/dev/null')) {
185 skip 'accf_data not loaded? kldload accf_data', 2;
187 require PublicInbox::Daemon;
188 my $var = PublicInbox::Daemon::SO_ACCEPTFILTER();
189 my $x = getsockopt($imaps, SOL_SOCKET, $var);
190 like($x, qr/\Adataready\0+\z/, 'got dataready accf for IMAPS');
191 $x = getsockopt($starttls, IPPROTO_TCP, $var);
192 is($x, undef, 'no BSD accept filter for plain IMAP');
198 is($?, 0, 'no error in exited process');
199 open my $fh, '<', $err or BAIL_OUT "open $err failed: $!";
200 my $eout = do { local $/; <$fh> };
201 unlike($eout, qr/wide/i, 'no Wide character warnings');