okta-jwt 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c95b336fb7297f4ebb61661e9be2f297120140df657acb290b04b7568313bb33
-  data.tar.gz: 8d9397202b711994674e159f7b8e4c95cddefe06e47aacbd72feffd8d9782bdf
+  metadata.gz: 13e5d691d2e52857e02e2dba1a078dd9e2919b878f3426437c23c55b169d99ce
+  data.tar.gz: a7be07dee7976a82fb89cd181ca1f40d7f822bba7c16281dfc5c1010d8269ecf
 SHA512:
-  metadata.gz: e86570f91963ca59a3e140069e4e7eb50885d31935d633651935593303deccb230abc7d1707b115ab4236b90603d6adaa312c1e15837a21f7edfe2276492de9b
-  data.tar.gz: 2be63b2da3ec1632fb2337417c51f6d2a8531fda8e016be897ba2ed4557c13d9bd21c8accca341fed0c440d61bd5bd254ccab60fcfdae2e25ca25e57fe43bbb3
+  metadata.gz: 01553fbc8f947fdb6ef574d279a0b4f480c65e1a0cbe9a359b5eac042a87c6ceb56a04c7fbeb20c6aa34fbe147a49053a28e67b1082a92b981321b462b16b4de
+  data.tar.gz: 12234fb7cc1f169f392f5faf17c2abc491510fa4534c6e0ac22a5ee9eda6032cdfdfed56fd002a1d390f76b20777f60280c30d872234d712429e87acb180c7cf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    okta-jwt (0.5.0)
+    okta-jwt (0.6.0)
       faraday
       json-jwt
 

data/README.md

@@ -19,34 +19,59 @@ Or install it yourself as:
     $ gem install okta-jwt
 
 ## Usage
+Require the library:
 
-Configure the client to sign in user (optional):
+```ruby
+require 'okta/jwt'
+```
+
+### Getting the tokens
+
+Configuration:
 
 ```ruby
-# client for resource owner password flow
-Okta::Jwt.configure_client!(
-  issuer: 'https://<org>.oktapreview.com/oauth2<auth_server_id>',
-  client_id: 'client_id',
-  client_secret: 'client_secret')
+Okta::Jwt.configure!(
+  issuer: 'https://<org>.oktapreview.com/oauth2<auth_server_id>'
+)
 ```
+NOTE: this step is optional, you don't need it for token verification.
+
+#### Resource owner password flow
 
 Sign in user to get access token (default scope is openid):
 
 ```ruby
-auth_response = Okta::Jwt.sign_in(
+auth_response = Okta::Jwt.sign_in_user(
   username: 'user@example.org',
   password: 'password',
+  client_id: 'client_id',
+  client_secret: 'client_secret',
   scope: 'openid my_scope'
 )
-parsed_auth_response = JSON.parse(auth_response.body)
-access_token = parsed_auth_response['access_token']
+access_token = JSON.parse(auth_response.body)['access_token']
+```
+
+#### Client credentials flow
+
+Sign in client to get access token (provide at least one custom scope):
+
+```ruby
+auth_response = Okta::Jwt.sign_in_client(
+  client_id: 'client_id',
+  client_secret: 'client_secret',
+  scope: 'my_scope'
+)
+access_token = JSON.parse(auth_response.body)['access_token']
 ```
 
+### Verify the token
+  
 Verify access token (signature + claims):
 
 ```ruby
 Okta::Jwt.logger = Logger.new(STDOUT) # set optional logger
-verified_access_token = Okta::Jwt.verify_token(access_token,
+verified_access_token = Okta::Jwt.verify_token(
+  access_token,
   issuer: 'https://<org>.oktapreview.com/oauth2<auth_server_id>',
   audience: 'development',
   client_id: 'client_id'

data/lib/okta/jwt.rb

@@ -14,19 +14,17 @@ module Okta
     JWKS_CACHE  = {}
   
     class << self
-      attr_accessor :issuer, :auth_server_id, :client_id, :client_secret, :logger
+      attr_accessor :issuer, :auth_server_id, :logger
     end
   
     # configure the client for signing in
-    def configure_client!(issuer:, client_id:, client_secret:)
+    def configure!(issuer:, logger: nil)
       @issuer         = issuer
-      @client_id      = client_id
-      @client_secret  = client_secret
       @auth_server_id = issuer.split('/').last
     end
   
     # sign in user to get tokens
-    def sign_in(username:, password:, scope: 'openid')
+    def sign_in_user(username:, password:, client_id:, client_secret:, scope: 'openid')
       client(issuer).post do |req|
         req.url "/oauth2/#{auth_server_id}/v1/token"
         req.headers['Content-Type']   = 'application/x-www-form-urlencoded'
@@ -34,6 +32,16 @@ module Okta
         req.body = URI.encode_www_form username: username, password: password, scope: scope, grant_type: 'password'
       end
     end
+
+    # sign in client to get access_token
+    def sign_in_client(client_id:, client_secret:, scope:)
+      client(issuer).post do |req|
+        req.url "/oauth2/#{auth_server_id}/v1/token"
+        req.headers['Content-Type']   = 'application/x-www-form-urlencoded'
+        req.headers['Authorization']  = 'Basic: ' + Base64.strict_encode64("#{client_id}:#{client_secret}")
+        req.body = URI.encode_www_form scope: scope, grant_type: 'client_credentials'
+      end
+    end
   
     # validate the token
     def verify_token(token, issuer:, audience:, client_id:)

data/lib/okta/jwt/version.rb

@@ -1,5 +1,5 @@
 module Okta
   module Jwt
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okta-jwt
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Damir Roso
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler