HTTP CLI client with OAuth 2.0 authentication.

You know curl is powerful command line tool and you can make any complex HTTP request to every servers. But the target web server is secured by OAuth 2.0, you must send another HTTP request to the authorization server before making principal request. And more, you should to manage issued access tokens for every resources.

aurl is a command-line tool that process OAuth 2.0 dance and manage access/refresh tokens automatically.

Note: Currently, aurl is not support OAuth 1.0a. Your pull-request is appreciated.

To install, use homebrew or go get:

$ brew tap classmethod-aws/cm
$ brew install aurl

$ go get -d github.com/classmethod-aws/aurl

First, you must create profile setting file ~/.aurl/profiles file which format is described below. Profile setting file format is typically called INI file. Each section name is used as profile name.

Section name is utilized as profile name. In each section following key settings are available:

[default]
auth_server_auth_endpoint = https://api.example.com/oauth/authorize
auth_server_token_endpoint = https://api.example.com/oauth/token
redirect = https://api.example.com/oauth/oob

[foobar]
grant_type = password
client_id = foobar
client_secret = bazqux
auth_server_token_endpoint = https://api.example.com/oauth/token
scopes = read write global
username = john
password = pass1234

[fb]
client_id = your_facebook_App_ID
client_secret = your_facebook_App_Secret
auth_server_auth_endpoint = https://www.facebook.com/dialog/oauth
auth_server_token_endpoint = https://graph.facebook.com/oauth/access_token
redirect = https://www.facebook.com/connect/login_success.html
scopes = public_profile email user_friends

[google]
client_id = xxxxxxxx.apps.googleusercontent.com
client_secret = yyyyyyyy
auth_server_auth_endpoint = https://accounts.google.com/o/oauth2/auth
auth_server_token_endpoint = https://www.googleapis.com/oauth2/v3/token
redirect = urn:ietf:wg:oauth:2.0:oob
scopes = https://www.googleapis.com/auth/plus.login https://www.googleapis.com/auth/userinfo.email

Token store file ~/.aurl/tokens is used by acurl internally. Retrieved access/refresh token is stored in this file. You SHOULD NOT edit this file manually because this file is overwritten every time curl is executed. You may lose comment and another extra data.

Just for information, token sotore file example is following:

[default]
expiry = 1424049169
access_token = xxxx
token_type = bearer
refresh_token = yyyy

[foobar]
expiry = 1424141030
access_token = zzzz
token_type = bearer

[fb]
refresh_token = 
expiry = 1429580553
access_token = blahblah
token_type = 

$ aurl [global options] command [command options] [arguments...]

command is every http method (e.g. get, post, delete) and first argument is target url. You can see all command in the help message. Try, aurl -h.

$ aurl get http://api.example.com/path/to/resource
...http.response.body...
$ aurl post http://api.example.com/path/to/resource --data "foobar"
...http.response.body...

aurl make request with access token in Authorization header of default profile. You can specify profile name with --profile option.

$ aurl --profile fb get https://graph.facebook.com/me
{"id":"...","email": ... }
$ aurl --profile google get https://www.googleapis.com/plus/v1/people/me
{
 "kind": "plus#person",
...
}

By default aurl prints response body in stdout. When an error occured the detail is printed in stderr. You may want not response body but response header, then you can use --no-body and --print-headers option.

$ aurl --no-body --print-headers options http://api.example.com/path/to/resource
{"Content-Type":["application/json;charset=UTF-8"],"Date":["Tue, 17 Feb 2015 08:16:41 GMT"],"Server":["nginx/1.6.2"], ...}

1. Fork (https://github.com/classmethod-aws/aurl/fork)
2. Create a feature branch named like feature/something_awesome_feature from development branch
3. Commit your changes
4. Rebase your local changes against the develop branch
5. Run test suite with the go test ./... command and confirm that it passes
6. Run gofmt -s
7. Create new Pull Request

Daisuke Miyamoto