oauth2-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76187c5b942695b8ee0626735c7a762f76dba841
+  data.tar.gz: bf31d9f78aee657bfd091d96c40b81bf8bfa72a0
+SHA512:
+  metadata.gz: 0dcb7367f6597f3311c5e07982e8655f234fc3100a7160193af810cc0e71c050d4b71de2589a14e2935d69fd2035e33115e9d8b6383b8db2c9ba27079603309c
+  data.tar.gz: e7bbd220f94a2e494eada6131b22481d8cef9db51ff7ff7311c229813c3686c8eb73533535a289cfa995fab884f097a4c7091a4ef6acb27311be4ac14746ef68

data/README.md

@@ -0,0 +1,70 @@
+## oauth2-cli
+
+Command line utility to get an OAuth access token for three-legged flows where you authorise an application to access your account. Inspired by [oauth2-cli](https://github.com/dcarley/oauth2-cli) written in Go.
+
+The reason for rewriting this in Ruby was the difficulty to debug the OAuth2 flow when things don't go as expected. Go's OAuth2 library is pretty opaque and trying to figure out why for some services the client_id is not passed when sending the the token request after obtaining the authorisation code has been fruitless - even though sending the request via curl using the produced authorisation code proved successful.
+
+The purpose for this tool is to obtain access and refresh tokens for applications which run as services (i.e daemons) where doing the OAuth2 flow is a bit difficult.
+
+## Install
+
+```bash
+gem install oauth2-cli
+```
+
+## Usage
+
+For services which validate the callback URL, you must use `http://127.0.0.1:8000/oauth/callback` in your OAuth2 application. Bear in mind that `8000` is the default port which may be changed via CLI argument. Adapt as necessary.
+
+The `oauth2-cli` script has a built in help:
+
+```bash
+oauth2-cli -h
+Usage: oauth2-cli --auth AUTHORISATION_URL --token TOKEN_URL --id CLIENT_ID --secret CLIENT_SECRET
+
+    -a, --auth AUTHORISATION_URL     Authorisation URL (required)
+    -t, --token TOKEN_URL            Token URL (required)
+    -i, --id CLIENT_ID               Client ID (required)
+    -s, --secret CLIENT_SECRET       Client secret (required)
+    -o, --scope SCOPE1,SCOPE2,etc    OAuth2 scope to authorise (not used if not specified)
+    -e, --separator                  OAuth2 scope separator character (defaults to space) n.b the scope arg is always passed as array and joined with the separator char for the request
+    -p, --port 8000                  Callback port (defaults to 8000)
+    -d, --debug                      Turn on OAuth2 library debug and WEBrick log
+```
+
+The scope separator character has been implemented for services which interpret the OAuth2 spec a tad different - for example Facebook is using comma separated values for scope.
+
+## Examples
+
+```bash
+# request tokens for accessing Netatmo Weather station
+oauth2-cli -a https://api.netatmo.com/oauth2/authorize -t https://api.netatmo.com/oauth2/token -i CLIENT_ID -s CLIENT_SECRET -o read_station
+
+Go to URL: https://api.netatmo.com/oauth2/authorize?access_type=offline&client_id=CLIENT_ID&redirect_uri=http%3A%2F%2F127.0.0.1%3A8000%2Foauth%2Fcallback&response_type=code&scope=read_station&state=ewcxkqpsfrinhgvyamzbouljtd
+
+Starting server - use Ctrl+C to stop
+
+{"scope"=>["read_station"],
+ "expire_in"=>10800,
+ :access_token=>"ACCESS_TOKEN",
+ :refresh_token=>"REFRESH_TOKEN",
+ :expires_at=>TIMESTAMP}
+
+^C
+
+# request tokens for accessing Awair air-quality monitor
+oauth2-cli -a https://oauth-login.awair.is -t https://oauth2.awair.is/v2/token -i CLIENT_ID -s CLIENT_SECRET
+
+Go to URL: https://oauth-login.awair.is?access_type=offline&client_id=CLIENT_ID&redirect_uri=http%3A%2F%2F127.0.0.1%3A8000%2Foauth%2Fcallback&response_type=code&state=jtiznuypwqfhbvmradlgkeoxcs
+
+Starting server - use Ctrl+C to stop
+
+{"token_type"=>"Bearer",
+ :access_token=>"ACCESS_TOKEN",
+ :refresh_token=>"REFRESH_TOKEN",
+ :expires_at=>nil}
+
+^C
+```
+
+The output hash from the token request may be used by Ruby's [OAuth2](https://github.com/oauth-xx/oauth2) library to recreate an `AccessToken` object using the `from_hash` class method. You have to implement your own token refresh capabilities when the access token expires for the OAuth2 library doesn't provide such functionality.

data/bin/oauth2-cli

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+
+require 'pp'
+require 'oauth2'
+require 'webrick'
+require 'optparse'
+
+options = {}
+required = []
+
+src = File.basename($PROGRAM_NAME)
+state = ('a'..'z').to_a.sample(32).join
+path = '/oauth/callback'
+
+optp = OptionParser.new do |opts|
+  opts.banner = "Usage: #{src} --auth AUTHORISATION_URL --token TOKEN_URL "\
+    "--id CLIENT_ID --secret CLIENT_SECRET\n\n"
+
+  required << :auth
+  desc_auth = 'Authorisation URL (required)'
+  opts.on('-a', '--auth AUTHORISATION_URL', desc_auth) do |opt|
+    options[:auth] = opt
+  end
+
+  required << :token
+  opts.on('-t', '--token TOKEN_URL', 'Token URL (required)') do |opt|
+    options[:token] = opt
+  end
+
+  required << :id
+  opts.on('-i', '--id CLIENT_ID', 'Client ID (required)') do |opt|
+    options[:id] = opt
+  end
+
+  required << :secret
+  opts.on('-s', '--secret CLIENT_SECRET', 'Client secret (required)') do |opt|
+    options[:secret] = opt
+  end
+
+  options[:scope] = []
+  desc_scope = 'OAuth2 scope to authorise (not used if not specified)'
+  opts.on('-o', '--scope SCOPE1,SCOPE2,etc', Array, desc_scope) do |opt|
+    options[:scope] = opt
+  end
+
+  options[:separator] = ' '
+  desc_separator = 'OAuth2 scope separator character (defaults to space) n.b '\
+    'the scope arg is always passed as array and joined with the separator '\
+    'char for the request'
+  opts.on('-e', '--separator', desc_separator) do |opt|
+    options[:separator] = opt
+  end
+
+  options[:port] = 8000
+  desc_port = 'Callback port (defaults to 8000)'
+  opts.on('-p', '--port 8000', Integer, desc_port) do |opt|
+    options[:port] = opt
+  end
+
+  options[:debug] = false
+  opts.on('-d', '--debug', 'Turn on OAuth2 library debug and WEBrick log') do
+    ENV['OAUTH_DEBUG'] = 'true'
+    options[:debug] = true
+  end
+end
+
+optp.parse!
+
+required.each do |arg|
+  next unless options[arg].nil?
+
+  STDERR.puts "Error: missing required argument #{arg}. "\
+    "See #{src} -h for help."
+  exit 1
+end
+
+redirect_uri = "http://127.0.0.1:#{options[:port]}#{path}"
+client = OAuth2::Client.new(
+  options[:id],
+  options[:secret],
+  authorize_url: options[:auth],
+  token_url: options[:token]
+)
+
+code_args = {
+  access_type: 'offline',
+  redirect_uri: redirect_uri,
+  state: state
+}
+
+unless options[:scope].empty?
+  code_args[:scope] = options[:scope].join(options[:separator])
+end
+
+url = client.auth_code.authorize_url(code_args)
+
+puts ''
+puts "Go to URL: #{url}"
+puts ''
+
+puts 'Starting server - use Ctrl+C to stop'
+puts ''
+
+server_options = {
+  Port: options[:port]
+}
+
+unless options[:debug]
+  server_options[:Logger] = WEBrick::Log.new(File.open(File::NULL, 'w'))
+  server_options[:AccessLog] = []
+end
+
+server = WEBrick::HTTPServer.new(server_options)
+
+server.mount_proc('/') do |req, res|
+  unless req.path == path
+    res.status = 403
+    res.body = "Invalid callback path - expecting #{path}"
+    next
+  end
+
+  unless req.query['state'] == state
+    res.status = 400
+    res.body = 'Invalid state in callback'
+    next
+  end
+
+  token = client.auth_code.get_token(
+    req.query['code'],
+    redirect_uri: redirect_uri
+  )
+
+  pp token.to_hash
+  puts ''
+
+  res.status = 200
+  res.body = 'You may now close this tab'
+end
+
+trap('INT') do
+  server.shutdown
+end
+
+server.start

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: oauth2-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ștefan Rusu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.62'
+description: CLI utility to get OAuth token for three-leggged flows
+email: saltwaterc@gmail.com
+executables:
+- oauth2-cli
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- bin/oauth2-cli
+homepage: https://github.com/SaltwaterC/oauth2-cli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: CLI utility to get OAuth token
+test_files: []