Sometimes you just need an OAuth token so you can plug it into a tool on the command line for some ad hoc reason. OAuth hates this and will stop at nothing to thwart you.
OAuthX, however, mostly shields you from OAuth's cruelty and makes this process sorta manageable. It manages the OAuth2 authentication flow for CLI tools (with a little help from a proxy) and just gives you an auth token. Finally.
$ oauthx --config file.yaml
Opening the OAuth2 flow in your browser. If your browser doesn't open, visit the link manually:
➤ https://api.service.com/oauth2/authorize?prompt=consent&response_type=code&state=...
Waiting for a response from the service...
Requesting token from:
➤ https://api.service.com/oauth2/access_token
{"access_token":"wagqX59yWq...","expires_in":7200,"refresh_token":"5R3vHUAX...","scopes":"this_one that_one","token_type":"bearer"}
(The additional informational messages are printed to STDERR so that you can pipe the JSON output via STDOUT to another command.)
You provide OAuthX with the basic paramters for your OAuth consumer (which you will need to configure with the service in question) and it:
- Launches your browser with the authorization URL to begin OAuth2 flow,
- Starts a local web server to receive the callback redirect from the service,
- Exchanges the token once it receives that callback, and
- Prints the token as JSON so that a CLI tool can use it (and also displays the token in the browser).
Pretty good, right?
Externally, you will need to:
- Configure an OAuth consumer with your service and get the relevant parameters, and
- Deal with getting some sort of proxy to forward the callback URL from the internet to the OAuthX local service.
So, you know... it is what it is. Good luck!