Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
High Performance HTTP Proxy
PHP HTML Java Other
Failed to load latest commit information.
performance Performance readme update
src Added 500ms delay after HTTP GET to allow HTTP filters to be invoked.
.gitignore Ignore files produced during perf test
.travis.yml Adding travis.yml
COPYRIGHT.txt Initial implementation of LittleShoot proxy based on Netty core
LICENSE.txt Initial implementation of LittleShoot proxy based on Netty core
Netty_4_Upgrade_Notes.md Initial rough pass at Netty 4 upgrade
README.md Some method renaming for consistency.
Yuml_Class_Diagram.md Initial rough pass at Netty 4 upgrade
buildSite.bash Build site script
chain_proxy_keystore_1.jks Refactored connection flow for better composition and readability
deploy.bash Fixed some SSL handshaking and connection reuse issues
littleproxy.properties Removed vestigates of MITM stuff
littleproxy_cert #149 ProxyToServerConnection now removes itself as handler from the o…
littleproxy_keystore.jks Merging in SSL intercept, test port changes
perf.bash Changed path
perfServer.bash Adding performance testing infrastructure
pginstrument-0.1.0-shadow.jar #1109 Added automatic generation of LittleProxy.pro with tests
pom.xml Updated pom to exclude hamcrest 1.x dependencies in favor of hamcrest 2
run.bash Fixed issue with large file uploads
tagRelease.bash Tweaked to check args

README.md

Build Status

LittleProxy is a high performance HTTP proxy written in Java atop Trustin Lee's excellent Netty event-based networking library. It's quite stable, performs well, and is easy to integrate into your projects.

One option is to clone LittleProxy and run it from the command line. This is as simple as:

$ git clone git://github.com/adamfisk/LittleProxy.git
$ cd LittleProxy
$ ./run.bash

You can embed LittleProxy in your own projects through maven with the following:

    <dependency>
        <groupId>org.littleshoot</groupId>
        <artifactId>littleproxy</artifactId>
        <version>1.0.0-beta7</version>
    </dependency>

Once you've included LittleProxy, you can start the server with the following:

HttpProxyServer server =
    DefaultHttpProxyServer.bootstrap()
        .withPort(8080)
        .start();

There are lots of filters and such you can also add to LittleProxy. You can add request and response filters using an HttpFiltersSource(Adapter), for example:

HttpProxyServer server =
    DefaultHttpProxyServer.bootstrap()
        .withPort(8080)
        .withFiltersSource(new HttpFiltersSourceAdapter() {
            public HttpFilters filterRequest(HttpRequest originalRequest, ChannelHandlerContext ctx) {
               return new HttpFiltersAdapter(originalRequest) {
                  @Override
                  public HttpResponse clientToProxyRequest(HttpObject httpObject) {
                      // TODO: implement your filtering here
                      return null;
                  }

                  @Override
                  public HttpResponse proxyToServerRequest(HttpObject httpObject) {
                      // TODO: implement your filtering here
                      return null;
                  }

                  @Override
                  public HttpObject serverToProxyResponse(HttpObject httpObject) {
                      // TODO: implement your filtering here
                      return httpObject;
                  }

                  @Override
                  public HttpObject proxyToClientResponse(HttpObject httpObject) {
                      // TODO: implement your filtering here
                      return httpObject;
                  }   
               };
            }
        })
        .start();

If you want to create additional proxy servers with similar configuration but listening on different ports, you can clone an existing server. The cloned servers will share event loops to reduce resource usage and when one clone is stopped, all are stopped.

existingServer.clone().withPort(8081).start()

For examples of configuring logging, see src/test/resources/log4j.xml.

If you have questions, please visit our Google Group here:

https://groups.google.com/forum/#!forum/littleproxy

Project reports, including the API Documentation, can be found here:

http://littleproxy.org

Benchmarking instructions and results can be found here.

Acknowledgments

Many thanks to The Measurement Factory for the use of Co-Advisor for HTTP standards compliance testing.

Release History

1.0.0-beta4 - Bug fixes

1.0.0-beta3 - Bug fixes

1.0.0-beta2 - Basic Man in the Middle Support

This release added back basic support for Man in the Middle (MITM) proxying. The current MITM support is intended primarily for projects that wish to use LittleProxy to facilitate HTTP related testing. See MitmProxyTest for an example of how to use the updated MITM support.

Certificate impersonation would need to be implemented in order for LittleProxy to work well in an end-user facing capacity. This release includes the hooks for doing so, through the new MitmManager abstraction.

Fixed Issues

1.0.0-beta1 - Netty 4 Upgrade

This release switched LittleProxy from Netty 3 to Netty 4. As part of the upgrade, LittleProxy's public API and internal implementation were significantly refactored for maintainability and API stability.

Support for Man in the Middle proxying was temporarily dropped in this release.

Something went wrong with that request. Please try again.