Mercurial > hg > nginx-tests
annotate lib/Test/Nginx/Stream.pm @ 1863:dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Relevant infrastructure is provided in Test::Nginx::Stream. This also
ensures that SSL handshake and various read operations are guarded
with timeouts.
The stream_ssl_verify_client.t test uses IO::Socket::SSL::_get_ssl_object()
to access the Net::SSLeay object directly, as it seems to be the only
way to obtain CA list with IO::Socket::SSL. While not exactly correct,
this seems to be good enough for tests.
| author | Maxim Dounin <mdounin@mdounin.ru> |
|---|---|
| date | Thu, 18 May 2023 18:07:12 +0300 |
| parents | 1197c152215b |
| children | 6d3a8f4eb9b2 |
| rev | line source |
|---|---|
| 816 | 1 package Test::Nginx::Stream; |
| 2 | |
| 3 # (C) Andrey Zelenkov | |
| 4 # (C) Nginx, Inc. | |
| 5 | |
| 6 # Module for nginx stream tests. | |
| 7 | |
| 8 ############################################################################### | |
| 9 | |
| 10 use warnings; | |
| 11 use strict; | |
| 12 | |
| 13 use base qw/ Exporter /; | |
|
868
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
14 our @EXPORT_OK = qw/ stream dgram /; |
| 816 | 15 |
| 16 use Test::More qw//; | |
| 17 use IO::Select; | |
| 18 use IO::Socket; | |
| 19 | |
| 20 use Test::Nginx; | |
| 21 | |
| 22 sub stream { | |
| 23 return Test::Nginx::Stream->new(@_); | |
| 24 } | |
| 25 | |
|
868
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
26 sub dgram { |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
27 unshift(@_, "PeerAddr") if @_ == 1; |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
28 |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
29 return Test::Nginx::Stream->new( |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
30 Proto => "udp", |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
31 @_ |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
32 ); |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
33 } |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
34 |
| 816 | 35 sub new { |
| 36 my $self = {}; | |
| 37 bless $self, shift @_; | |
| 38 | |
| 39 unshift(@_, "PeerAddr") if @_ == 1; | |
| 40 | |
|
1863
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
41 eval { |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
42 local $SIG{ALRM} = sub { die "timeout\n" }; |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
43 local $SIG{PIPE} = sub { die "sigpipe\n" }; |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
44 alarm(8); |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
45 |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
46 $self->{_socket} = IO::Socket::INET->new( |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
47 Proto => "tcp", |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
48 PeerAddr => '127.0.0.1', |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
49 @_ |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
50 ) |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
51 or die "Can't connect to nginx: $!\n"; |
| 816 | 52 |
|
1863
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
53 if ({@_}->{'SSL'}) { |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
54 require IO::Socket::SSL; |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
55 IO::Socket::SSL->start_SSL( |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
56 $self->{_socket}, |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
57 SSL_verify_mode => |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
58 IO::Socket::SSL::SSL_VERIFY_NONE(), |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
59 @_ |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
60 ) |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
61 or die $IO::Socket::SSL::SSL_ERROR . "\n"; |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
62 |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
63 my $s = $self->{_socket}; |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
64 log_in("ssl cipher: " . $s->get_cipher()); |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
65 log_in("ssl cert: " . $s->peer_certificate('issuer')); |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
66 } |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
67 |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
68 alarm(0); |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
69 }; |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
70 alarm(0); |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
71 if ($@) { |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
72 log_in("died: $@"); |
| 816 | 73 } |
| 74 | |
| 75 $self->{_socket}->autoflush(1); | |
| 76 | |
| 77 return $self; | |
| 78 } | |
| 79 | |
|
1863
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
80 sub DESTROY { |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
81 my $self = shift; |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
82 $self->{_socket}->close(); |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
83 } |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
84 |
| 816 | 85 sub write { |
|
935
25a4b2fdd3fb
Tests: I/O timeout options introduced in Stream.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
875
diff
changeset
|
86 my ($self, $message, %extra) = @_; |
| 816 | 87 my $s = $self->{_socket}; |
| 88 | |
| 89 local $SIG{PIPE} = 'IGNORE'; | |
| 90 | |
| 91 $s->blocking(0); | |
|
935
25a4b2fdd3fb
Tests: I/O timeout options introduced in Stream.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
875
diff
changeset
|
92 while (IO::Select->new($s)->can_write($extra{write_timeout} || 1.5)) { |
| 816 | 93 my $n = $s->syswrite($message); |
|
1852
1197c152215b
Tests: fixed warning in case of a closed stream.
Eugene Grebenschikov <e.grebenshchikov@nginx.com>
parents:
1825
diff
changeset
|
94 last unless $n; |
| 816 | 95 log_out(substr($message, 0, $n)); |
| 96 | |
| 97 $message = substr($message, $n); | |
| 98 last unless length $message; | |
| 99 } | |
| 100 | |
| 101 if (length $message) { | |
| 102 $s->close(); | |
| 103 } | |
| 104 } | |
| 105 | |
| 106 sub read { | |
|
935
25a4b2fdd3fb
Tests: I/O timeout options introduced in Stream.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
875
diff
changeset
|
107 my ($self, %extra) = @_; |
| 816 | 108 my ($s, $buf); |
| 109 | |
| 110 $s = $self->{_socket}; | |
| 111 | |
| 112 $s->blocking(0); | |
|
1825
3629eda94c1b
Tests: handling of EWOULDBLOCK from sysread() with IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1824
diff
changeset
|
113 while (IO::Select->new($s)->can_read($extra{read_timeout} || 8)) { |
|
3629eda94c1b
Tests: handling of EWOULDBLOCK from sysread() with IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1824
diff
changeset
|
114 my $n = $s->sysread($buf, 1024); |
|
3629eda94c1b
Tests: handling of EWOULDBLOCK from sysread() with IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1824
diff
changeset
|
115 next if !defined $n && $!{EWOULDBLOCK}; |
|
3629eda94c1b
Tests: handling of EWOULDBLOCK from sysread() with IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1824
diff
changeset
|
116 last; |
| 1824 | 117 } |
| 816 | 118 |
| 119 log_in($buf); | |
| 120 return $buf; | |
| 121 } | |
| 122 | |
| 123 sub io { | |
| 124 my $self = shift; | |
| 125 | |
| 126 my ($data, %extra) = @_; | |
| 127 my $length = $extra{length}; | |
|
868
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
128 my $read = $extra{read}; |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
129 |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
130 $read = 1 if !defined $read |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
131 && $self->{_socket}->socktype() == &SOCK_DGRAM; |
| 816 | 132 |
|
935
25a4b2fdd3fb
Tests: I/O timeout options introduced in Stream.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
875
diff
changeset
|
133 $self->write($data, %extra); |
| 816 | 134 |
| 135 $data = ''; | |
| 136 while (1) { | |
|
868
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
137 last if defined $read && --$read < 0; |
|
d2cb9ed7412e
Tests: stream udp tests.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
816
diff
changeset
|
138 |
|
935
25a4b2fdd3fb
Tests: I/O timeout options introduced in Stream.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
875
diff
changeset
|
139 my $buf = $self->read(%extra); |
|
875
c380b4b7e2e4
Tests: compatibility with perl < 5.12 in Stream.pm.
Andrey Zelenkov <zelenkov@nginx.com>
parents:
868
diff
changeset
|
140 last unless defined $buf and length($buf); |
| 816 | 141 |
| 142 $data .= $buf; | |
| 143 last if defined $length && length($data) >= $length; | |
| 144 } | |
| 145 | |
| 146 return $data; | |
| 147 } | |
| 148 | |
|
1024
91e64c1ceec9
Tests: stream access_log tests.
Sergey Kandaurov <pluknet@nginx.com>
parents:
969
diff
changeset
|
149 sub sockaddr { |
|
91e64c1ceec9
Tests: stream access_log tests.
Sergey Kandaurov <pluknet@nginx.com>
parents:
969
diff
changeset
|
150 my $self = shift; |
|
91e64c1ceec9
Tests: stream access_log tests.
Sergey Kandaurov <pluknet@nginx.com>
parents:
969
diff
changeset
|
151 return $self->{_socket}->sockaddr(); |
|
91e64c1ceec9
Tests: stream access_log tests.
Sergey Kandaurov <pluknet@nginx.com>
parents:
969
diff
changeset
|
152 } |
|
91e64c1ceec9
Tests: stream access_log tests.
Sergey Kandaurov <pluknet@nginx.com>
parents:
969
diff
changeset
|
153 |
|
91e64c1ceec9
Tests: stream access_log tests.
Sergey Kandaurov <pluknet@nginx.com>
parents:
969
diff
changeset
|
154 sub sockhost { |
|
91e64c1ceec9
Tests: stream access_log tests.
Sergey Kandaurov <pluknet@nginx.com>
parents:
969
diff
changeset
|
155 my $self = shift; |
|
91e64c1ceec9
Tests: stream access_log tests.
Sergey Kandaurov <pluknet@nginx.com>
parents:
969
diff
changeset
|
156 return $self->{_socket}->sockhost(); |
|
91e64c1ceec9
Tests: stream access_log tests.
Sergey Kandaurov <pluknet@nginx.com>
parents:
969
diff
changeset
|
157 } |
|
91e64c1ceec9
Tests: stream access_log tests.
Sergey Kandaurov <pluknet@nginx.com>
parents:
969
diff
changeset
|
158 |
| 816 | 159 sub sockport { |
| 160 my $self = shift; | |
| 161 return $self->{_socket}->sockport(); | |
| 162 } | |
| 163 | |
|
1863
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
164 sub socket { |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
165 my ($self) = @_; |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
166 $self->{_socket}; |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
167 } |
|
dbb7561a9441
Tests: reworked stream SSL tests to use IO::Socket::SSL.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1852
diff
changeset
|
168 |
| 816 | 169 ############################################################################### |
| 170 | |
| 171 1; | |
| 172 | |
| 173 ############################################################################### |