pkce_oauth 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97372c190ea0a108c58d6483b1671335b1825fc6ca1f33d09d9b979599c98498
-  data.tar.gz: 106a46dedb288e854afb0eb3a1a62cb0f4875c5d7799bb4f309e8b4139efa522
+  metadata.gz: 9b199006a114978dddc334598c50e4b9bb70a763a73ad8301cd1267946e06117
+  data.tar.gz: c4dd344fb575d81ef2018be27c3e5a376fdc374dbd9b15b7356c97a0902333bd
 SHA512:
-  metadata.gz: 1ecc650d21e9a5fc2cdcc21725c198e61cc56da30a9e02398b859331430059484414bac55d84e35a5f6db272041ebaef392692c18b5a84ca4899fbb3ad7ee2f2
-  data.tar.gz: dafbd6198bf590d0067f58ba5268b4a12bf0d336b1b35203087ec03e7cf32bf0801e779ac9104ba0bf83e7811b53af4a3ada33e887d7b51bffeb4e2557eff087
+  metadata.gz: 260b21b7fcaf22ad409fff024933419fff064ec9e6b4e4380a90d936a133448cbe3e899734d90caad9f3225470dbba1ae135a71f20ba4aedfe77ddf90aafd092
+  data.tar.gz: 2b53aca98fd4121ba5e740a108923529b42907a296a37e4cccab410a178ccdfee4dfa72856cb5e88ff9e857cadab0e4f141afb99feaa8a1857cd4bb49e0dff80

data/.rubocop.yml

@@ -1,8 +1,70 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
+  Exclude:
+    - 'bin/*'
+    - 'tmp/**/*'
+  NewCops: enable
   TargetRubyVersion: 3.0
 
 Style/StringLiterals:
-  EnforcedStyle: double_quotes
+  Enabled: true
+  EnforcedStyle: single_quotes
 
 Style/StringLiteralsInInterpolation:
+  Enabled: true
   EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/NestedGroups:
+  Max: 6
+
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+    - and
+    - if
+    - in
+    - for
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Metrics/MethodLength:
+  Max: 11

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-## [Unreleased]
+## [0.2.1] - 2025-03-28
+### Modified
+- using rust package pkce
+
+## [0.2.0] - 2024-12-16
+### Added
+- generating random key with charset
+- url escaping for code challenge
+
+### Modified
+- readme
 
 ## [0.1.0] - 2024-12-16
 

data/Cargo.lock

@@ -11,6 +11,12 @@ dependencies = [
  "memchr",
 ]
 
+[[package]]
+name = "base64"
+version = "0.21.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9d297deb1925b89f2ccc13d7635fa0714f12c87adce1c75356b39ca9b7178567"
+
 [[package]]
 name = "bindgen"
 version = "0.69.5"
@@ -37,6 +43,21 @@ version = "2.6.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de"
 
+[[package]]
+name = "block-buffer"
+version = "0.10.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71"
+dependencies = [
+ "generic-array",
+]
+
+[[package]]
+name = "byteorder"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
+
 [[package]]
 name = "cexpr"
 version = "0.6.0"
@@ -63,12 +84,62 @@ dependencies = [
  "libloading",
 ]
 
+[[package]]
+name = "cpufeatures"
+version = "0.2.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "16b80225097f2e5ae4e7179dd2266824648f3e2f49d9134d584b76389d31c4c3"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "crypto-common"
+version = "0.1.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1bfb12502f3fc46cca1bb51ac28df9d618d813cdc3d2f25b9fe775a34af26bb3"
+dependencies = [
+ "generic-array",
+ "typenum",
+]
+
+[[package]]
+name = "digest"
+version = "0.10.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292"
+dependencies = [
+ "block-buffer",
+ "crypto-common",
+]
+
 [[package]]
 name = "either"
 version = "1.13.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "60b1af1c220855b6ceac025d3f6ecdd2b7c4894bfe9cd9bda4fbb4bc7c0d4cf0"
 
+[[package]]
+name = "generic-array"
+version = "0.14.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a"
+dependencies = [
+ "typenum",
+ "version_check",
+]
+
+[[package]]
+name = "getrandom"
+version = "0.2.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c4567c8db10ae91089c99af84c68c38da3ec2f087c3f82960bcdbf3656b6f4d7"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wasi",
+]
+
 [[package]]
 name = "glob"
 version = "0.3.1"
@@ -114,9 +185,9 @@ dependencies = [
 
 [[package]]
 name = "magnus"
-version = "0.6.4"
+version = "0.7.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b1597ef40aa8c36be098249e82c9a20cf7199278ac1c1a1a995eeead6a184479"
+checksum = "3d87ae53030f3a22e83879e666cb94e58a7bdf31706878a0ba48752994146dab"
 dependencies = [
  "magnus-macros",
  "rb-sys",
@@ -157,11 +228,32 @@ dependencies = [
  "minimal-lexical",
 ]
 
+[[package]]
+name = "pkce"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e228dbe2aebd82de09c914fe28d36d3170ed5192e8d52b9c070ee0794519c2d3"
+dependencies = [
+ "base64",
+ "rand",
+ "sha2",
+]
+
 [[package]]
 name = "pkce_oauth"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "magnus",
+ "pkce",
+]
+
+[[package]]
+name = "ppv-lite86"
+version = "0.2.20"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "77957b295656769bb8ad2b6a6b09d897d94f05c41b069aede1fcdaa675eaea04"
+dependencies = [
+ "zerocopy",
 ]
 
 [[package]]
@@ -182,6 +274,36 @@ dependencies = [
  "proc-macro2",
 ]
 
+[[package]]
+name = "rand"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404"
+dependencies = [
+ "libc",
+ "rand_chacha",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_chacha"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88"
+dependencies = [
+ "ppv-lite86",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_core"
+version = "0.6.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
+dependencies = [
+ "getrandom",
+]
+
 [[package]]
 name = "rb-sys"
 version = "0.9.103"
@@ -253,6 +375,17 @@ version = "0.3.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a3f0bf26fd526d2a95683cd0f87bf103b8539e2ca1ef48ce002d67aad59aa0b4"
 
+[[package]]
+name = "sha2"
+version = "0.10.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "793db75ad2bcafc3ffa7c68b215fee268f537982cd901d132f89c6343f3a3dc8"
+dependencies = [
+ "cfg-if",
+ "cpufeatures",
+ "digest",
+]
+
 [[package]]
 name = "shell-words"
 version = "1.1.0"
@@ -276,12 +409,30 @@ dependencies = [
  "unicode-ident",
 ]
 
+[[package]]
+name = "typenum"
+version = "1.17.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825"
+
 [[package]]
 name = "unicode-ident"
 version = "1.0.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "adb9e6ca4f869e1180728b7950e35922a7fc6397f7b641499e8f3ef06e50dc83"
 
+[[package]]
+name = "version_check"
+version = "0.9.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a"
+
+[[package]]
+name = "wasi"
+version = "0.11.0+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"
+
 [[package]]
 name = "windows-targets"
 version = "0.52.6"
@@ -345,3 +496,24 @@ name = "windows_x86_64_msvc"
 version = "0.52.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
+
+[[package]]
+name = "zerocopy"
+version = "0.7.35"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1b9b4fd18abc82b8136838da5d50bae7bdea537c574d8dc1a34ed098d6c166f0"
+dependencies = [
+ "byteorder",
+ "zerocopy-derive",
+]
+
+[[package]]
+name = "zerocopy-derive"
+version = "0.7.35"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]

data/README.md

@@ -1,30 +1,70 @@
 # PkceOauth
 
-
+Proof Key for Code Exchange (PKCE) for ruby built with rust.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Add this line to your application's Gemfile:
 
-```bash
-bundle add pkce_oauth
+```ruby
+gem 'pkce_oauth'
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
 
-```bash
-gem install pkce_oauth
+```ruby
+# @return [Hash] keys: code_verifier, code_challenge
+# code_verifier - random key
+# code_challenge - Base64 url-encoded string of the SHA256 hash of the code verifier
+PkceOauth.challenge
 ```
 
-## Usage
+```ruby
+# @return [Hash] keys: code_verifier, code_challenge
+PkceOauth.challenge(key_length: 64)
+```
+
+```ruby
+# @return [Boolean]
+PkceOauth.challenge_valid?(code_verifier: code_verifier, code_challenge: code_challenge)
+```
+
+### Usage with dry-container
+
+If you use dry-container for class memoization and use `PkceOauth.challenge` with the same options, then you can add initialized objects to container
 
+```ruby
+register('pkce_challenge') { PkceOauth::Challenge.new }
+register('pkce_comparator') { PkceOauth::Comparison.new }
+```
+
+and later call them
+
+```ruby
+pkce_challenge.call
+pkce_comparator.equal?(code_verifier: code_verifier, code_challenge: code_challenge)
+```
+
+### Direct usage
 
+You can directly call generating code verifier and code challenge
+
+```ruby
+PkceOauth.generate_code_verifier
+PkceOauth.generate_limited_code_verifier(64)
+PkceOauth.generate_code_challenge(code_verifier)
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After changing rust code in ext folder you need to compile code and run tests
+
+```bash
+bundle exec rake compile
+rspec
+```
 
 ## Contributing
 

data/Rakefile

@@ -11,7 +11,7 @@ RuboCop::RakeTask.new
 
 require 'rb_sys/extensiontask'
 
-task build: :compile
+task build: :compile # rubocop: disable Rake/Desc
 
 GEMSPEC = Gem::Specification.load('pkce_oauth.gemspec')
 

data/ext/pkce_oauth/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pkce_oauth"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 authors = ["Bogdanov Anton <kortirso@gmail.com>"]
 license = "MIT"
@@ -10,4 +10,5 @@ publish = false
 crate-type = ["cdylib"]
 
 [dependencies]
-magnus = { version = "0.6.2" }
+magnus = { version = "0.7" }
+pkce = { version = "0.2.0" }

data/ext/pkce_oauth/extconf.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "mkmf"
-require "rb_sys/mkmf"
+require 'mkmf'
+require 'rb_sys/mkmf'
 
-create_rust_makefile("pkce_oauth/pkce_oauth")
+create_rust_makefile('pkce_oauth/pkce_oauth')

data/ext/pkce_oauth/src/lib.rs

@@ -1,12 +1,23 @@
 use magnus::{function, prelude::*, Error, Ruby};
+use pkce;
 
-fn hello(subject: String) -> String {
-    format!("Hello from Rust, {subject}!")
+fn generate_limited_code_verifier(length: usize) -> String {
+  String::from_utf8(pkce::code_verifier(length)).expect("REASON")
+}
+
+fn generate_code_verifier() -> String {
+  generate_limited_code_verifier(128)
+}
+
+fn generate_code_challenge(code_verifier: String) -> String {
+  pkce::code_challenge(&code_verifier.as_bytes())
 }
 
 #[magnus::init]
 fn init(ruby: &Ruby) -> Result<(), Error> {
-    let module = ruby.define_module("PkceOauth")?;
-    module.define_singleton_method("hello", function!(hello, 1))?;
-    Ok(())
+  let module = ruby.define_module("PkceOauth")?;
+  module.define_singleton_method("generate_limited_code_verifier", function!(generate_limited_code_verifier, 1))?;
+  module.define_singleton_method("generate_code_verifier", function!(generate_code_verifier, 0))?;
+  module.define_singleton_method("generate_code_challenge", function!(generate_code_challenge, 1))?;
+  Ok(())
 }

data/lib/pkce_oauth/challenge.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PkceOauth
+  class Challenge
+    attr_reader :verifier, :challenger
+
+    def initialize(verifier: CodeVerifier, challenger: CodeChallenger, **options)
+      @verifier = verifier.new(**options.slice(:key_length))
+      @challenger = challenger.new
+    end
+
+    def call
+      code_verifier = verifier.call
+
+      {
+        code_verifier: code_verifier,
+        code_challenge: challenger.call(code_verifier: code_verifier)
+      }
+    end
+  end
+end

data/lib/pkce_oauth/code_challenger.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module PkceOauth
+  class CodeChallenger
+    def call(code_verifier:)
+      PkceOauth.generate_code_challenge(code_verifier)
+    end
+  end
+end

data/lib/pkce_oauth/code_verifier.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module PkceOauth
+  class CodeVerifier
+    class KeyLengthError < StandardError; end
+
+    MINIMUM_KEY_LENGTH = 43
+    DEFAULT_KEY_LENGTH = 128
+
+    attr_reader :key_length
+
+    def initialize(key_length: DEFAULT_KEY_LENGTH)
+      @key_length = validate_key_length(key_length)
+    end
+
+    def call
+      PkceOauth.generate_limited_code_verifier(key_length)
+    end
+
+    private
+
+    def validate_key_length(value)
+      return value if value.is_a?(Integer) && value.between?(MINIMUM_KEY_LENGTH, DEFAULT_KEY_LENGTH)
+
+      raise KeyLengthError, 'Key length should be number between 43 and 128'
+    end
+  end
+end

data/lib/pkce_oauth/comparison.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PkceOauth
+  class Comparison
+    attr_reader :challenger
+
+    def initialize(challenger: CodeChallenger)
+      @challenger = challenger.new
+    end
+
+    def equal?(code_verifier:, code_challenge:)
+      challenger.call(code_verifier: code_verifier) == code_challenge
+    end
+  end
+end

data/lib/pkce_oauth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PkceOauth
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

data/lib/pkce_oauth.rb

@@ -2,8 +2,21 @@
 
 require_relative 'pkce_oauth/version'
 require_relative 'pkce_oauth/pkce_oauth'
+require_relative 'pkce_oauth/code_verifier'
+require_relative 'pkce_oauth/code_challenger'
+require_relative 'pkce_oauth/challenge'
+require_relative 'pkce_oauth/comparison'
 
 module PkceOauth
+  module_function
+
   class Error < StandardError; end
-  # Your code goes here...
+
+  def challenge(...)
+    PkceOauth::Challenge.new(...).call
+  end
+
+  def challenge_valid?(...)
+    PkceOauth::Comparison.new.equal?(...)
+  end
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: pkce_oauth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rb_sys
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.91
+        version: '13.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.91
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: rb_sys
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 0.9.91
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 0.9.91
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.39'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Code verifier and challenge generator for use in PKCE Oauth2.
 email:
 - kortirso@gmail.com
@@ -86,6 +128,10 @@ files:
 - ext/pkce_oauth/extconf.rb
 - ext/pkce_oauth/src/lib.rs
 - lib/pkce_oauth.rb
+- lib/pkce_oauth/challenge.rb
+- lib/pkce_oauth/code_challenger.rb
+- lib/pkce_oauth/code_verifier.rb
+- lib/pkce_oauth/comparison.rb
 - lib/pkce_oauth/version.rb
 - sig/pkce_oauth.rbs
 homepage: https://github.com/kortirso/pkce_oauth