j1m-renwick / proxynaut

A simple proxy for Micronaut

Proxynaut - a proxy for Micronaut

A simple proxy for exposing other services through the main Micronaut server. Just add the dependency and put in the configuration into application.yml:

# This will set up two proxied paths...
proxynaut:
  proxies:
    - route-from: /api
      route-to: https://my-backend-api-service.some-cloud.com
      allowed-methods: ["GET"]
      timeout-ms: 30000
      invoke-using-method: "myMethod"
      qualifier: "myProxyClass"
    - route-from: /blobs
      route-to: https://${my.bucket.name}.some-cloud.com
      qualifier: "myProxyClass"
      invoke-using-method: "myOtherMethod"
      allowed-methods: ["POST", "PUT"]
      include-request-headers: [ "X-OUT-HEADER" ]
      include-response-headers: [ "X-RETURN-HEADER" ]
      include-request-cookies: [ "outCookie" ]
      include-response-cookies: [ "returnCookie" ]
      timeout-ms: 60000

Label	Description	Type	Required	Default
route-from	uri path that will be proxied	String	Y	n/a
route-to	url that the proxy will be forwarded to	String	Y	n/a
allowed-methods	HTTP request verbs that will apply to the proxy	Set<String>	N	* (all)
invoke-using-method	proxying method that will be invoked	String	N	n/a
qualifier	proxying class that will be invoked	String	N	n/a
include-request-headers	Headers to be forwarded to the proxy uri	Set<String>	N	n/a
include-response-headers	Headers to be forwarded from the proxy uri	Set<String>	N	n/a
include-request-cookies	Cookies to be forwarded to the proxy uri	Set<String>	N	n/a
include-response-cookies	Cookies to be forwarded from the proxy uri	Set<String>	N	n/a
timeout-ms	Server timeout value for the proxy call (in ms)	Integer	N	30_000

This config will invoke the methods in the below class, including invoking applicable annotations (such as the Security @Secured annotation in the example) :

import com.github.j1mrenwick.proxynaut.core.Proxy;
import com.github.j1mrenwick.proxynaut.core.ProxyFactory;
import com.github.j1mrenwick.proxynaut.core.ProxyProcessor;

@ProxyFactory("myProxyClass")
public class Test implements Proxy {

    @Inject
    protected ProxyProcessor proxy;

    // unsecured proxy
    @Secured(SecurityRule.IS_ANONYMOUS)
    public HttpResponse<?> myMethod(HttpRequest<ByteBuffer<?>> request, String path) {
        return proxy.serve(request, path);
    }

    // secured proxy
    public HttpResponse<?> myOtherMethod(HttpRequest<ByteBuffer<?>> request, String path) {
        return proxy.serve(request, path);
    }
}

If the qualifier is absent, or does not match a @ProxyFactory value on a class implementing Proxy, then the defaultProxyProcessor.serve method will be invoked by default for the proxy.

Usage

See the example project in proxynaut-example.

To dev / run

• In the root directory, run:
  • ./gradlew clean assemble (builds the project)
  • ./gradlew install (publishes the Jars to your local Maven repo)
• Start the proxynaut-example app
• Navigate to http://localhost:8080/proxy/another/page1

Accessing @Secured paths

To access @Secured paths, call POST http://localhost:8080/login with the JSON body:

{
    "username": "letmein",
    "password": "dummy"
}

and then use the returned access_token in future calls as a bearer token via the Authorization header.

To Do

• investigate whether ByteBuffer data needs to be manually released in stream (see TODO)

License: Apache 2.0