nginx-ssl-ja3: tests

Author: fooinha

.travis.yml

@@ -22,32 +22,31 @@ before_install:
   - sudo apt-get install -qq -y software-properties-common
   - sudo add-apt-repository "deb http://us.archive.ubuntu.com/ubuntu/ xenial main universe"
   - sudo apt-get update -qq -y --fix-missing
-  - sudo apt-get install -qq -y --fix-missing cpanminus mercurial build-essential make clang valgrind
+  - sudo apt-get install -qq -y --fix-missing cpanminus mercurial build-essential make clang valgrind libio-socket-ssl-perl
 
 install:
   - if [ ! -d /opt ]; then mkdir /opt; fi
-  - git clone https://github.com/openresty/test-nginx.git
+  - git clone https://github.com/nginx/nginx-tests
   - hg clone http://hg.nginx.org/nginx
   - git clone https://github.com/openssl/openssl
 
 script:
-  - ls -la
   - cd openssl
   - ./config -d
   - make -j$JOBS > build.log 2>&1 || (cat build.log && exit 1)
   - sudo make install > build.log 2>&1 || (cat build.log && exit 1)
   - cd ..
-  - cd test-nginx
-  - sudo cpanm .
-  - cd ..
-  - export LD_LIBRARY_PATH=/usr/local/lib/
   - cp -v docker/debian-nginx-ssl-ja3/nginx.ssl.extensions.patch nginx/.
   - cd nginx
   - patch -p1 < nginx.ssl.extensions.patch
-  - auto/configure --with-debug --with-stream --with-ld-opt="-Wl,-E" --prefix=$NGINX_PREFIX  --with-http_ssl_module --with-stream_ssl_module --add-module=$PWD/.. > build.log 2>&1 || (cat build.log && exit 1)
+  - auto/configure --with-debug --with-stream --with-ld-opt="-Wl,-E -L /usr/local/lib" --prefix=$NGINX_PREFIX  --with-http_ssl_module --with-stream_ssl_module --add-module=.. > build.log 2>&1 || (cat build.log && exit 1)
   - make -j$JOBS > build.log 2>&1 || (cat build.log && exit 1)
   - sudo make install > build.log 2>&1 || (cat build.log && exit 1)
-  - cd ..
   - export PATH=$NGINX_PREFIX/sbin:$PATH
+  - export LD_LIBRARY_PATH=/usr/local/lib
   - /opt/nginx/sbin/nginx -V
   - ldd /opt/nginx/sbin/nginx
+  - cd ../t
+  - ln -sf ../nginx-tests/lib/ lib
+  - cd ..
+  - TEST_NGINX_BINARY=/opt/nginx/sbin/nginx prove -v

README.md

@@ -87,7 +87,12 @@ $ make && make install
 ```
 ## Tests
 
-Not available yet.
+Make sure that the lib directory for nginx-tests is available in the 't' directory.
+
+
+```
+$ TEST_NGINX_BINARY=/usr/local/nginx/sbin/nginx prove -v
+```
 
 ## Docker
 

docker/debian-nginx-ssl-ja3/Dockerfile

@@ -62,6 +62,9 @@ RUN cd nginx-ssl-ja3 && git checkout ${GIT_BRANCH}
 
 WORKDIR /build
 
+# Get test framework
+RUN git clone https://github.com/nginx/nginx-tests
+
 # Get openssl master from git
 RUN git clone https://github.com/openssl/openssl
 
@@ -81,12 +84,6 @@ COPY nginx.ssl.extensions.patch /build/nginx
 RUN cat nginx.ssl.extensions.patch
 RUN patch -p1 < nginx.ssl.extensions.patch
 
-# Get test framework
-RUN git clone https://github.com/openresty/test-nginx.git
-
-# Install test framework and dependencies
-RUN cd test-nginx/ && cpanm .
-
 # Configure, make and install
 RUN ./auto/configure --add-module=/build/nginx-ssl-ja3 --with-http_ssl_module --with-stream_ssl_module --with-stream --with-debug --with-ld-opt="-L/usr/local/lib -Wl,-E"
 RUN make install

t/http_ssl_ja3.t

@@ -0,0 +1,132 @@
+#!/usr/bin/perl
+
+# (C) Sergey Kandaurov
+# (C) Nginx, Inc.
+# (C) Paulo Pacheco
+
+# Tests for SSL/TLS ja3 fingerprint
+
+###############################################################################
+
+use warnings;
+use strict;
+
+use Test::More;
+
+BEGIN { use FindBin; chdir($FindBin::Bin); }
+
+use lib 'lib';
+use Test::Nginx;
+use Data::Dumper;
+
+###############################################################################
+
+select STDERR; $| = 1;
+select STDOUT; $| = 1;
+
+eval { require IO::Socket::SSL; };
+plan(skip_all => 'IO::Socket::SSL not installed') if $@;
+eval { IO::Socket::SSL::SSL_VERIFY_NONE(); };
+plan(skip_all => 'IO::Socket::SSL too old') if $@;
+
+my $t = Test::Nginx->new()->has_daemon('openssl')->plan(1);
+
+$t->write_file_expand('nginx.conf', <<'EOF');
+
+%%TEST_GLOBALS%%
+
+daemon off;
+
+events {
+}
+
+http {
+    %%TEST_GLOBALS_HTTP%%
+
+    server {
+        listen       127.0.0.1:8080 ssl;
+        server_name  localhost;
+
+        ssl_certificate_key localhost.key;
+        ssl_certificate localhost.crt;
+
+        location /ja3 {
+            return 200 $http_ssl_ja3_hash;
+        }
+    }
+}
+
+EOF
+
+$t->write_file('openssl.conf', <<EOF);
+[ req ]
+default_bits = 1024
+encrypt_key = no
+distinguished_name = req_distinguished_name
+[ req_distinguished_name ]
+EOF
+
+my $d = $t->testdir();
+
+foreach my $name ('localhost') {
+    system('openssl req -x509 -new '
+        . "-config '$d/openssl.conf' -subj '/CN=$name/' "
+        . "-out '$d/$name.crt' -keyout '$d/$name.key' "
+        . ">>$d/openssl.out 2>&1") == 0
+        or die "Can't create certificate for $name: $!\n";
+}
+
+my $ctx = new IO::Socket::SSL::SSL_Context(
+    SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE(),
+    SSL_session_cache_size => 100);
+
+
+$t->run();
+
+###############################################################################
+
+like(get('/ja3', 8080), qr/.*[0-9a-f]{32}/m, 'http_ssl_ja3 var is returned');
+
+
+###############################################################################
+
+sub get {
+    my ($uri, $port) = @_;
+    my $s = get_ssl_socket($ctx, port($port)) or return;
+    my $r = http_get($uri, socket => $s);
+
+    $s->close();
+    return $r;
+}
+
+sub get_ssl_socket {
+    my ($ctx, $port, %extra) = @_;
+    my $s;
+
+    eval {
+        local $SIG{ALRM} = sub { die "timeout\n" };
+        local $SIG{PIPE} = sub { die "sigpipe\n" };
+        alarm(2);
+        $s = IO::Socket::SSL->new(
+            Proto => 'tcp',
+            PeerAddr => '127.0.0.1',
+            PeerPort => $port,
+            SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE(),
+            SSL_reuse_ctx => $ctx,
+            SSL_error_trap => sub { die $_[1] },
+            %extra
+        );
+        alarm(0);
+    };
+    alarm(0);
+
+    if ($@) {
+        log_in("died: $@");
+        return undef;
+    }
+
+    return $s;
+}
+
+
+###############################################################################