rodauth-oauth 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21325edd12e5fc3ded38294dccf9200497df7bf2ecf72e5e90b5faa0f44c76b6
-  data.tar.gz: 5bd3e791aa77e4702763207fd60640db7c42e3c05d764cff5e56fab17df982b8
+  metadata.gz: ec27cf0fcac2e93b6ba08d76a4fa3e165c55722864d87fb78e4f0fc70a15c759
+  data.tar.gz: 535f0b61b987f38179de2d7011b55d8b9b6e12bdf1293c9da7534c063277c2f3
 SHA512:
-  metadata.gz: 65614673a89008e8a23fd2f3e14617ea6b66eccc5dfad930f6d0205f591077dfb9132ec9927d3a8dce5e313b9310d024aee9761c5a3e9cc0d9cffe4b3e089851
-  data.tar.gz: 97b00f5c89429b79afe5403e2a6ee792611d6f121f6c6ae72582c15c4654daeebeddb3e7348c539e22e7664e886e00feb67df257ed308544bbfe3a4cb53b194e
+  metadata.gz: d1179a1e5db37dbfdc9932a6ec74fb3fba37c7c863c0ec643f9b1c11fee8ef8b8bf71d0705bb9629135f517dbb3d49dd5e7609014ddc3aae28ad4bd0f45981a1
+  data.tar.gz: ebc711bc991746fbfa780f81a91c92508c55eca65e3e316a1fc4b23b6e9141f0d97a8871ce12527fdeaf71234d97ddfa0c712aca870c65f73ab89a11fe40839e

data/CHANGELOG.md

@@ -2,7 +2,39 @@
 
 ## master
 
-## 0.0.2
+## 0.0.3 (5/6/2020)
+
+### Features
+
+#### `:oauth_http_mac`
+
+A new feature builds on top of `:oauth` to allow MAC authorization.
+
+```ruby
+plugin :rodauth do
+  enable :oauth_http_mac
+  # options here...
+end
+```
+
+#### `:oauth_jwt`
+
+Another new feature, this time supporting the generation of JWT access tokens.
+
+```ruby
+plugin :rodauth do
+  enable :oauth_jwt
+  # options here...
+end
+```
+
+### Improvements
+
+* added options for disabling pkce and access type (respectively, `use_oauth_pkce?` and `use_oauth_access_type?`);
+* renamed the existing `use_oauth_implicit_grant_type` to `use_oauth_implicit_grant_type?`;
+* It's now usable as JSON API (small caveat: POST authorize will still redirect on success...);
+
+## 0.0.2 (29/5/2020)
 
 ### Features
 
@@ -18,6 +50,6 @@
 
 * usage of client secret for authorizing the generation of tokens, as the spec mandates (and refraining from them when doing PKCE).
 
-## 0.0.1
+## 0.0.1 (14/5/2020)
 
 Initial implementation of the Oauth 2.0 framework, with an example app done using roda.

data/LICENSE.txt

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2013-2017 Docker, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -13,13 +13,14 @@ This gem implements:
   * [Authorization grant flow](https://tools.ietf.org/html/rfc6749#section-1.3);
   * [Access Token generation](https://tools.ietf.org/html/rfc6749#section-1.4);
   * [Access Token refresh](https://tools.ietf.org/html/rfc6749#section-1.5);
-  * [Token revocation](https://tools.ietf.org/html/rfc7009);
   * [Implicit grant (off by default)[https://tools.ietf.org/html/rfc6749#section-4.2];
-  * [PKCE](https://tools.ietf.org/html/rfc7636);
+* [Token revocation](https://tools.ietf.org/html/rfc7009);
+* [PKCE](https://tools.ietf.org/html/rfc7636);
 * Access Type (Token refresh online and offline);
+* [MAC Authentication Scheme](https://tools.ietf.org/html/draft-hammer-oauth-v2-mac-token-02);
+* [JWT Acess Tokens](https://tools.ietf.org/html/draft-ietf-oauth-access-token-jwt-07);
 * OAuth application and token management dashboards;
 
-
 This gem supports also rails (through [rodauth-rails]((https://github.com/janko/rodauth-rails))).
 
 
@@ -105,7 +106,7 @@ response = HTTPX.post("https://auth_server/oauth-token",json: {
                 })
 response.raise_for_status
 payload = JSON.parse(response.to_s)
-puts payload #=> {"token" => "awr23f3h8f9d2h89...", "refresh_token" => "23fkop3kr290kc..." ....
+puts payload #=> {"access_token" => "awr23f3h8f9d2h89...", "refresh_token" => "23fkop3kr290kc..." ....
 ```
 
 ##### cURL
@@ -130,7 +131,7 @@ response = HTTPX.post("https://auth_server/oauth-token",json: {
                 })
 response.raise_for_status
 payload = JSON.parse(response.to_s)
-puts payload #=> {"token" => "awr23f3h8f9d2h89...", "token_type" => "Bearer" ....
+puts payload #=> {"access_token" => "awr23f3h8f9d2h89...", "token_type" => "Bearer" ....
 ```
 
 ##### cURL
@@ -154,7 +155,7 @@ response = httpx.with(headers: { "X-your-auth-scheme" => ENV["SERVER_KEY"] })
                 })
 response.raise_for_status
 payload = JSON.parse(response.to_s)
-puts payload #=> {"token" => "awr23f3h8f9d2h89...", "token_type" => "Bearer" ....
+puts payload #=> {"access_token" => "awr23f3h8f9d2h89...", "token_type" => "Bearer" ....
 ```
 
 ##### cURL
@@ -337,13 +338,21 @@ This will only work **if there was a previous successful online grant** for the
 
 #### DB schema
 
-the "oauth_grants" table will have to include the "access_type row":
+the "oauth_grants" table will have to include the "access_type" row:
 
 ```ruby
 # in migration
 String :access_type, null: false, default: "offline"
 ```
 
+If you want to disable this flow altogether, you can:
+
+```ruby
+enable :oauth
+use_oauth_access_type? false
+```
+
+
 ### Implicit Grant (default: disabled)
 
 The implicit grant flow is part of the original OAuth 2.0 RFC, however, if you care about security, you are **strongly recommended** not to enable it.
@@ -366,9 +375,7 @@ The "Proof Key for Code Exchange by OAuth Public Clients" (aka PKCE) flow, which
 ```ruby
 # with httpx
 require "httpx"
-httpx = HTTPX.plugin(:authorization)
-response = httpx.with(headers: { "X-your-auth-scheme" => ENV["SERVER_KEY"] })
-                .post("https://auth_server/oauth-token",json: {
+response = HTTPX.post("https://auth_server/oauth-token",json: {
                   client_id: ENV["OAUTH_CLIENT_ID"],
                   grant_type: "authorization_code",
                   code: "oiweicnewdh32fhoi3hf3ihfo2ih3f2o3as",
@@ -376,7 +383,7 @@ response = httpx.with(headers: { "X-your-auth-scheme" => ENV["SERVER_KEY"] })
                 })
 response.raise_for_status
 payload = JSON.parse(response.to_s)
-puts payload #=> {"token" =
+puts payload #=> {"access_token" => ....
 ```
 
 By default, the pkce integration sets "S256" as the default challenge method. If you value security, you **should not use plain**. However, if you really need to, you can set it in the `rodauth` plugin:
@@ -397,13 +404,138 @@ plugin :rodauth do
 end
 ```
 
+If you want, on the other hand. to disable this flow altogether, you can:
+
+```ruby
+enable :oauth
+use_oauth_pkce? false
+```
+
+### HTTP Mac Authentication
+
+You can enable HTTP MAC authentication like this:
+
+```ruby
+plugin :rodauth do
+  enable :oauth_http_mac
+end
+```
+
+Generating an access token will deliver the following fields:
+
+```ruby
+# with httpx
+require "httpx"
+response = httpx.post("https://auth_server/oauth-token",json: {
+                  client_id: ENV["OAUTH_CLIENT_ID"],
+                  client_secret: ENV["OAUTH_CLIENT_SECRET"],
+                  grant_type: "authorization_code",
+                  code: "oiweicnewdh32fhoi3hf3ihfo2ih3f2o3as"
+                })
+response.raise_for_status
+payload = JSON.parse(response.to_s)
+puts payload #=> {
+# "access_token" => ....
+# "mac_key" => ....
+# "mac_algorithm" => 
+```
+
+which you'll be able to use to generate the mac signature to send in the "Authorization" header.
+
+#### DB schema
+
+the "oauth_tokens" table will have to include a column for the mac key:
+
+```ruby
+# in migration
+String :mac_key, token: true
+```
+
+
+### JWT Access Tokens
+
+JWT Acess Tokens are great to avoid DB lookups when validation the authorization token. Quoting the RFC, *The approach is particularly common in topologies where the authorization server and resource server are not co-located, are not run by the same entity, or are otherwise separated by some boundary.*
+
+You can enable JWT Access tokens by doing:
+
+```ruby
+plugin :rodauth do
+  enable :oauth_jwt
+end
+```
+
+This will, by default, use the OAuth application as HMAC signature and "HS256" as the algorithm to sign the resulting JWT access tokens. You can tweak those features by editing the following options:
+
+```ruby
+enable :oauth_jwt
+oauth_jwt_secret "SECRET"
+# or oauth_jwt_secret_path "path/to/file"
+oauth_jwt_algorithm "HS512"
+```
+
+You can look for other options in [the jwt gem documentation](https://github.com/jwt/ruby-jwt), as this is used under the hood.
+
+#### Pub/Priv key
+
+You can decide to keep a private key to encode the JWT token, while other clients hace the public key to decode it. You can then do it like:
+
+```ruby
+rsa_private = OpenSSL::PKey::RSA.generate 2048
+rsa_public = rsa_private.public_key
+
+plugin :rodauth do
+  enable :oauth_jwt
+  oauth_jwt_key rsa_private
+  oauth_jwt_decoding_secret rsa_public
+  oauth_jwt_algorithm "RS256" 
+end
+```
+
+#### JWK
+
+One can further encode the JWT token using JSON Web Keys. Here's how you could enable the feature:
+
+```ruby
+plugin :rodauth do
+  enable :oauth_jwt
+  oauth_jwt_jwk_key 2048 # can be key size or the encoded RSA key, which is the only one supported now.
+  # oauth_jwt_jwk_key "path/to/rsa.pem" if you prefer
+end
+```
+
+#### JWE
+
+You can further instruct the jwt feature to encrypt the encoded token using JSON Web Encryption standard:
+
+```ruby
+jwe_key = OpenSSL::PKey::RSA.new(2048)
+
+plugin :rodauth do
+  oauth_jwt_secret "SECRET"
+  oauth_jwt_algorithm "HS256"
+  oauth_jwt_jwe_key jwe_key
+  oauth_jwt_jwe_encryption_method "A192GCM"
+end
+```
+
+which adds an extra layer of protection.
+
+
+#### DB Schema
+
+You'll still need the "oauth_tokens" table, however you can remove the "token" column.
+
+#### Caveats
+
+Although very handy for the mentioned use case, one can't revoke a JWT token on demand (it must expire first).
+
 ## Ruby support policy
 
-The minimum Ruby version required to run `rodauth-oauth` is 2.3 . Besides that, it should support all rubies that rodauth and roda support.
+The minimum Ruby version required to run `rodauth-oauth` is 2.3 . Besides that, it should support all rubies that rodauth and roda support, including JRuby and (potentially, I don't know yet) truffleruby.
 
 ### JRuby
 
-If you're interested in using this library in rails, be warned that `rodauth-rails` doesn't support it yet (although, this is expected to change at some point).
+If you're interested in using this library in rails, be sure to check `rodauth-rails` policy, as it supports rails 5.2 upwards.
 
 ## Development