Vert.x redirect http to https

Question

We have re-written our webservices with Vert.x 4 and we're more than satisfied. Before putting them in production we want to secure them and we're trying to enable https. This is the main verticle:

public class MainVerticle extends AbstractVerticle {

  @Override
  public void start() throws Exception {
    //Deploy the HTTP server
    vertx.deployVerticle(
      "com.albertomiola.equations.http.HttpServerVerticle",
      new DeploymentOptions().setInstances(3)
    );
  }

  // I use this only in IntelliJ Idea because when I hit "Run" the build starts
  public static void main(String[] args) {
    Launcher.executeCommand("run", MainVerticle.class.getName());
  }

}

And this is the most relevant part of the code of the HTTP server verticle:

public class HttpServerVerticle extends AbstractVerticle {

  @Override
  public void start(Promise<Void> startPromise) throws Exception {
    var options = new HttpServerOptions();
    options.setPort(443)
           .setSSl(true)
           .setPemTrustOptions(...)
           .setPemKeyCertOptions(...);

    var server = vertx.createHttpServer(options);
    var router = Router.router(vertx);

    //Start
    server
      .requestHandler(router)
      .listen(portNumber, ar -> {
        if (ar.succeeded()) {
          startPromise.complete();
        } else {
          startPromise.fail(ar.cause());
        }
      });
  }

}

The above code works fine because my website is reachable at https://website.it and https://www.website.it (with letsencrypt certs).

The problem is that when I try to access http://website.it or http://www.website.it it doesn't work (meaning that I can't see the home because the server is unreachable).

How can I redirect http://website.it to https//website.it?

I have googled a lot and what I've managed to find is:

this vertx example that setups HTTPS as I do but it does not mention the redirect
this SO question that seems to tell me what to do but I cannot understand what to do and I am not sure if that setup has to go in the HttpServerOption object

Maybe is my https configuration wrong? I am using Java 11 on IntelliJ IDEA (Maven build) and Vert.x 4 latest version. Thank you

why dont you enable https in nginx/LB which is the recommended way? — injecteer, Sep 17 '19 at 08:14
because I haven't found any resource about that! could you please share a link? — Alberto Miola, Sep 17 '19 at 08:33
2 sec googling https://bjornjohansen.no/redirect-to-https-with-nginx — injecteer, Sep 17 '19 at 08:34
if you use something else instead of nginx, like AWS LB there should be enough info on the internet — injecteer, Sep 17 '19 at 08:34
I thought that vert.x provided a built-in support for this redirect but it seems that it doesnt. I'll go to nginx then, thank you! — Alberto Miola, Sep 17 '19 at 08:36
well you can enable SSL https://vertx.io/docs/vertx-core/groovy/#ssl , but http-https switching is not provided. It's actually a general practice to handle such stuff like proxies, rewrite, protocol switchs before the app-server — injecteer, Sep 17 '19 at 08:50
Regarding pure Vert.x solutions, I am also working on this problem. It is helpful to remember that (by default) HTTP uses port 80, and HTTPS uses port 443. Thus, it would require a "regular" redirect (HTTP status 302) to move a request from port 80 to port 443. For simple redirect, see: `RoutingContext.redirect(String url)` — kevinarpe, Oct 15 '21 at 01:07

Alberto Miola · Accepted Answer · 2019-09-17T09:53:36.740

The final solutions I came up with are shown below and they are equivalent. The idea in both cases is to have an http server (that listens on port 80 of course) that redirects every call to an https server.

So in my case I can do exactly what I want because http://mydomain.it is redirected to https://mydomain.it as expected. For example when I make a call to

http://mydomain.it/api/polynomial/laguerre

There is an http server alive that receives the request but then it throws the ball immediately to

https://mydomain.it/api/polynomial/laguerre

Of course if you directly call the https version this "intermediate" step does not happen.

Using Vert.x

The answer from Hugo in the above post gives a valid solution using Vertx. I have a main verticle that looks like this:

public class MainVerticle extends AbstractVerticle {

  @Override
  public void start() throws Exception {

    //Deploy the HTTPS server
    vertx.deployVerticle(
      "com.albertomiola.equations.http.HttpsServerVerticle",
      new DeploymentOptions().setInstances(n)
    );

    //Deploy the HTTP server
    vertx.deployVerticle(
      "com.albertomiola.equations.http.HttpServerVerticle",
      new DeploymentOptions().setInstances(1)
    );
  }

}

The first verticle is the "real" website because it contains all the logic that I need in my webservice (routers, handlers, models...) and it looks like this:

public class HttpsServerVerticle extends AbstractVerticle {

  @Override
  public void start(Promise<Void> startPromise) throws Exception {
    // Setup the HTTPS
    var httpOptions = new HttpServerOptions()
      .setCompressionSupported(true)
      .setPort(443)
      .setSsl(true)
      .setPemTrustOptions(...)
      .setPemKeyCertOptions(...);

    // Start the server and the routes
    var server = vertx.createHttpServer(httpOptions);
    var router = Router.router(vertx);

    //Start
    server
      .requestHandler(router)
      .listen(ar -> {
        if (ar.succeeded()) {
          startPromise.complete();
        } else {
          startPromise.fail(ar.cause());
        }
      });
  }

}

The other verticle instead is just an http server that permanently redirects (with the 301) to the https version of the webserver. Here's the code:

public class HttpsServerVerticle extends AbstractVerticle {

  @Override
  public void start(Promise<Void> startPromise) throws Exception {
    var server = vertx.createHttpServer(httpOptions);
    var router = Router.router(vertx);

    //Start
    server
      .requestHandler(r -> {
          r.response()
           .setStatusCode(301)
           .putHeader("Location", r.absoluteURI().replace("http", "https"))
           .end();
      });
  }

}

In this way there are 2 servers active but actually it's like if there were only 1 because the http server (port 80) redirects every call to the https server (port 443).

Using Nginx

The other approach that I have tested requires nginx but it does the same things that I've done in the above example. It listens to http requests on port 80 and then it redirects them to the https version.

Install Nginx on my Ubuntu server (or whatever you have)
Go in the configuration file which is in /etc/nginx/nginx.conf in my case

Add the below code

http {
    server {
            listen         80;
            server_name    mydomain.it;
            return         301 https://$server_name$request_uri;
    }

    //other code...
}

Restart with systemctl restart nginx

Now every call to the http version is redirected to the https version. Thanks to the user injecteer which has suggested me this way.

I am using this approach because I prefer not having a single verticle only for the http version. Also this article from the Vertx website says that this approach is valid:

It is common to expose HTTP servers in production through a front HTTP server / proxy like Nginx, and have it use HTTPS for incoming connections. Vert.x can also expose HTTPS by itself, so as to provide end-to-end encryption.

So yeah, setup https with Vertx (I'd recommend letsencrypt certifies) but also redirect calls to https with nginx.

I wrongly thought that I could do something particular with Vertx to handle this redirect but that's not possible. After the suggestions of the people in this answer AND some good googling around I've learned that this approach is common and that's what I should do!

I like how you used HTTP 301 (perm redirect)! For other users, read more here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301 — kevinarpe, Oct 15 '21 at 01:08

score 1 · Answer 2 · answered Sep 17 '19 at 09:03

I think you should create an HTTP server listening to port 80 (along with your HTTPS server) that redirects all requests to their HTTPS equivalent by responding with a 301 HTTP code.

That would be something like:

var server = vertx.createHttpServer();

server.requestHandler(req -> {
  req.response()
    .setStatusCode(301)
    .putHeader("Location", "https://" + req.host() + req.path()) // I completely made this line up and didn't test, but you have the idea
    .end();
})

Hope that helps!

Hugo

ps: using Nginx as it was suggested in the comments, you would do basically the same, but in Nginx: https://serversforhackers.com/c/redirect-http-to-https-nginx

Vert.x redirect http to https

2 Answers2