https://github.com/erlangpack/erlang-oauth

An Erlang OAuth 1.0 implementation
https://github.com/erlangpack/erlang-oauth

erlang oauth oauth1

Last synced: 3 days ago
JSON representation

An Erlang OAuth 1.0 implementation

• Host: GitHub
• URL: https://github.com/erlangpack/erlang-oauth
• Owner: erlangpack
• License: mit
• Created: 2008-05-16T15:17:32.000Z (over 16 years ago)
• Default Branch: main
• Last Pushed: 2022-06-10T08:05:55.000Z (over 2 years ago)
• Last Synced: 2024-04-26T11:01:03.360Z (9 months ago)
• Topics: erlang, oauth, oauth1
• Language: Erlang
• Homepage:
• Size: 139 KB
• Stars: 297
• Watchers: 20
• Forks: 98
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build Status][gh badge]][gh]

[![Hex.pm version][hexpm version]][hexpm]

[![Hex.pm Downloads][hexpm downloads]][hexpm]

[![Hex.pm Documentation][hexdocs documentation]][hexdocs]

[![Erlang Versions][erlang version badge]][gh]

[![License][license]](LICENSE.txt)

# erlang-oauth

An Erlang implementation of [The OAuth 1.0 Protocol](https://tools.ietf.org/html/rfc5849).

There are functions for 

  - generating signatures (*client* side), 

  - verifying signatures (*server* side),

  - some convenience functions for making OAuth HTTP requests (*client* side).

## Usage

Erlang-oauth is on Hex, you can use the package by adding it into your rebar.config:

    {deps, [

        {oauth, "2.1.0"}

    ]}.

## Erlang/OTP compatibility

Erlang/OTP 21 or greater.

## Quick start (client usage)

    $ erl -make

    Recompile: src/oauth

    $ erl -pa ebin -s crypto -s inets

    ...

    1> Consumer = {"key", "secret", hmac_sha1}.

    ...

    2> RequestTokenURL = "http://term.ie/oauth/example/request_token.php".

    ...

    3> {ok, RequestTokenResponse} = oauth:get(RequestTokenURL, [], Consumer).

    ...

    4> RequestTokenParams = oauth:params_decode(RequestTokenResponse).

    ...

    5> RequestToken = oauth:token(RequestTokenParams).

    ...

    6> RequestTokenSecret = oauth:token_secret(RequestTokenParams).

    ...

    7> AccessTokenURL = "http://term.ie/oauth/example/access_token.php".

    ...

    8> {ok, AccessTokenResponse} = oauth:get(AccessTokenURL, [], Consumer, RequestToken, RequestTokenSecret).

    ...

    9> AccessTokenParams = oauth:params_decode(AccessTokenResponse).

    ...

    10> AccessToken = oauth:token(AccessTokenParams).

    ...

    11> AccessTokenSecret = oauth:token_secret(AccessTokenParams).

    ...

    12> URL = "http://term.ie/oauth/example/echo_api.php".

    ...

    13> {ok, Response} = oauth:get(URL, [{"hello", "world"}], Consumer, AccessToken, AccessTokenSecret).

    ...

    14> oauth:params_decode(Response).

    ...

## OAuth consumer representation

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

```

## Other notes

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/).

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.

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, and then either `oauth:uri_params_encode/1` or `oauth:header_params_encode/1`

to encode the signed parameters.

The percent encoding/decoding implementations are based on [ibrowse](https://github.com/cmullaparthi/ibrowse)

## License

This project is licensed under the terms of the [MIT license](https://opensource.org/licenses/MIT).

[hexpm]: https://hex.pm/packages/oauth

[hexpm version]: https://img.shields.io/hexpm/v/oauth.svg?style=flat-curcle "Hex version"

[hexpm downloads]: https://img.shields.io/hexpm/dt/oauth.svg?style=flat-curcle

[hexdocs documentation]: https://img.shields.io/badge/hex-docs-purple.svg?style=flat-curcle

[hexdocs]: https://hexdocs.pm/oauth

[gh]: https://github.com/erlangpack/erlang-oauth/actions/workflows/test.yaml

[gh badge]: https://github.com/erlangpack/erlang-oauth/workflows/Test/badge.svg

[erlang version badge]: https://img.shields.io/badge/Supported%20Erlang%2FOTP-21%20to%2023-blue.svg?style=flat-curcle

[license]: https://img.shields.io/badge/License-MIT-blue.svg "MIT"