Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add more notes to README

  • Loading branch information...
commit 16f7b21d6ddd50e54c55a4eec8b2adba7fbc31bc 1 parent 15b56b2
@tim authored
Showing with 45 additions and 14 deletions.
  1. +45 −14 README.md
View
59 README.md
@@ -1,4 +1,8 @@
-# An Erlang OAuth implementation
+# erlang-oauth
+
+An Erlang OAuth 1.0 implementation. Includes functions for generating signatures
+(client side), verifying signatures (server side), and some convenience functions
+for making OAuth HTTP requests (client side).
## Quick start (client usage)
@@ -36,31 +40,58 @@
...
-## Dependency management with [rebar](https://github.com/basho/rebar)
+## OAuth consumer representation
-You can add erlang-oauth as a dependency to your rebar.config file like this:
+Consumers are represented using tuples:
+
+```erlang
+{Key::string(), Secret::string(), plaintext}
+
+{Key::string(), Secret::string(), hmac_sha1}
+
+{Key::string(), RSAPrivateKeyPath::string(), rsa_sha1} % client side
+
+{Key::string(), RSACertificatePath::string(), rsa_sha1} % server side
+```
- {deps, [
- {oauth, ".*", {git, "https://github.com/tim/erlang-oauth.git"}}
- ]}.
-Please consult the [relevant rebar wiki page](https://github.com/basho/rebar/wiki/Dependency-management) for more information.
+## OAuth compatibility
+This implementation should be compatible with the signature algorithms
+presented in [RFC5849 - The OAuth 1.0 Protocol](http://tools.ietf.org/html/rfc5849),
+and [OAuth Core 1.0 Revision A](http://oauth.net/core/1.0a/). It is *not* intended
+to cover [OAuth 2.0](http://oauth.net/2/).
-## Notes
-Consumer credentials are represented as follows:
+## Erlang/OTP compatibility
- {Key::string(), Secret::string(), plaintext}
+Erlang/OTP R14B or greater.
+
+
+## [Rebar](https://github.com/basho/rebar) compatibility
+
+This implementation should be fully compatible with rebar. You can add
+erlang-oauth as a dependency to your rebar.config file like this:
+
+ {deps, [
+ {oauth, ".*", {git, "https://github.com/tim/erlang-oauth.git"}}
+ ]}.
- {Key::string(), Secret::string(), hmac_sha1}
+Please consult the [relevant rebar wiki page](https://github.com/basho/rebar/wiki/Dependency-management)
+for more information.
- {Key::string(), RSAPrivateKeyPath::string(), rsa_sha1} % client side
- {Key::string(), RSACertificatePath::string(), rsa_sha1} % server side
+## Other notes
+This is *not* a "plug and play" server implementation. In order to implement OAuth
+correctly as a provider you have more work to do: token storage, nonce and timestamp
+verification etc.
-Erlang/OTP R14B or greater is required for RSA-SHA1
+This is *not* a "bells and whistles" HTTP client. If you need fine grained control
+over your HTTP requests or you prefer to use something other than inets/httpc then you
+will need to assemble the requests yourself. Use `oauth:sign/6` to generate a list of
+signed OAuth parameters, `oauth:uri_params_encode/1` or `oauth:header_params_encode/1` to
+encode the parameters, and then assemble the request using your HTTP client of choice.
The percent encoding/decoding implementations are based on [ibrowse](https://github.com/cmullaparthi/ibrowse)
Please sign in to comment.
Something went wrong with that request. Please try again.