pkce-challenge-ruby's Introduction

PKCE Code challenge generator

PKCE flow code verifier and code challenge generator

Installation

Add this line to your application's Gemfile:

gem 'pkce_challenge'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pkce_challenge

Usage

To generate the code verifier and challenge simply run:

PkceChallenge.challenge

Or with the char length option:

PkceChallenge.challenge(char_length: 128)

Additionally you can run:

pkce_challenge = PkceChallenge.challenge 
pkce_challenge = PkceChallenge.challenge(char_length: 128) # or with char_length option

Returned value is an instance of PkceChallenge::Challenge class which will have the following methods:

pkce_challenge.code_verifier # a dynamically created cryptographically random key
pkce_challenge.code_challenge # a BASE64-URL-encoded string of the SHA256 hash of the 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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/samuelralak/pkce_challenge. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the PkceChallenge project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

pkce-challenge-ruby's People

Contributors

Stargazers

Watchers

pkce-challenge-ruby's Issues

Smaller implementation

Hi, I wanted to really understand how PKCE worked. While doing it I changed the code. I want to submit my proposal here. I don't think you want to change the projectet as it seam "old". Just want to leave it here in case someone want a newer take on it.

Thanks for the initial project. Great inspiration

# https://github.com/samuelralak/pkce-challenge-ruby/
  module PkceChallenge
    # Generate code challenge and verfiier
    #
    # Example:
    #   >> PkceChallenge.challenge
    #   => #<PkceChallenge::Challenge:0x00007f894f810378 @char_length=48, @code_verifier="QbS08cDO9pce~HVCKe9-UDiJoBMG8xwql4FI.Y3CIdpyJtPU", @code_challenge="HT90mmypkXgneRUVK-Ja009VvnoL-flydbEgRcTp5Yw">
    #
    # == Parameters:
    # options::
    #   A Hash containing optional arguments. Supported options
    #   can include `:length`
    #
    # == Returns:
    # An instance of PkceChallenge::Challenge
    #
    def self.challenge(options = {})
      PkceChallenge::Challenge.new(options)
    end

    module Types
      include Dry::Types()
    end

    class Challenge
      attr_reader :verifier, :code_challenge

      Schema = Types::Hash.schema(length?: Dry::Types['integer'].constrained(gteq: 43, lteq: 128).default(48))

      def initialize(options = {})
        @options = Schema.call(options)

        @verifier ||= SecureRandom.alphanumeric(@options[:length]).length
        @code_challenge ||= Digest::SHA256.digest(@verifier).then {Base64.urlsafe_encode64(_1, padding: false)}
      end
    end
  end

Recommend Projects

samuelralak / pkce-challenge-ruby Goto Github PK

pkce-challenge-ruby's Introduction

PKCE Code challenge generator

Installation

Usage

Development

Contributing

License

Code of Conduct

pkce-challenge-ruby's People

Contributors

Stargazers

Watchers

Forkers

pkce-challenge-ruby's Issues

Smaller implementation

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent