jersey-hmac-auth

Jersey-based HMAC authentication for the client and server.

This library makes it easy to add HMAC authentication to REST API's that are implemented using the Jersey library. Note that this also works for Jersey-based frameworks, like Dropwizard.

HMAC authentication provides a way for you to ensure the integrity and authenticity of API requests. You grant API access to permitted callers by giving each one an API key and a secret key that they use when generating requests. You can use this library to add support for HMAC authentication on the client and server.

On the client side, e.g. in an SDK library that interfaces with the API, the client must build requests following the authentication contract that jersey-hmac-auth implements. You can do this in any language. However, the jersey-hmac-auth library provides support in Java for client libraries that use the Jersey Client for making HTTP requests.

Getting Started

Server Side

• Jersey 2.x - org.glassfish.jersey
• Jersey 1.x - com.sun.jersey
• Jersey 2.x Sample

Client Side

• Jersey 2.x - org.glassfish.jersey
• Jersey 1.x - com.sun.jersey

HMAC Versions

The HMAC version so far have only been used to distinguished between using POST/PUT data in signature or not.

The server may support any number of versions, however client must supply a version and appropriate include or not include data in signature.

• Version 1 - Has mixed implementations for including content data in signature (deprecated)
• Version 2 - Will not include content data in signature
• Version 3 - Will include content data in signature

User Guide

See the User Guide for more details.

Contributing

To build and run tests locally:

$ git clone git@github.com:bazaarvoice/jersey-hmac-auth.git
$ cd jersey-hmac-auth
$ mvn clean install

To submit a new request or issue, please visit the Issues page.

Pull requests are always welcome.

Continuous Integration