Code Monkey home page Code Monkey logo

edhmacclient's Introduction

EDHmacClient

HMAC authentication for iOS applications.

This library makes it easy to add support for HMAC authentication in iOS applications.

It works by adding HTTP headers to an outbound NSMutableURLRequest to encode the request for HMAC authentication.

Getting Started

In your code, import the EDHmacClient class:

import EDHmacClient

if let url = NSURL(string: "http://example.com/api/testMethod") {
	let request = NSMutableURLRequest(URL: url)
	request.HTTPMethod = "DELETE"

	let requestEncoder = EDRequestEncoder(apiKey: 'your_api_key', secretKey: 'your_secret_key', useModifiedBase64ForURL: true)
	requestEncoder.encodeRequest(request)
	
	//...Send out request
}

Before calling encodeRequest, ensure that the NSURL contains any necessary query parameters. However, you should not add the API key as a query parameter because it is added for you in the internal implementation of encodeRequest.

The useModifiedBase64ForURL parameter in the initializer of EDRequestEncoder specifies whether to use modified Base64 for URL encoding in the generated signature. Setting this to true will replace '+' and '/' characters with '-' and '_' respectively in the signature.

If you need to change the names of the query parameter and headers used by HMAC, you can do so after initialization by setting:

  • apiKeyQueryParameter
  • signatureHTTPHeader
  • timestampHTTPHeader
  • versionHTTPHeader

Changes in the client must also be made at the server or authentication will not work.

edhmacclient's People

Contributors

cjtisch avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

relsoul

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.