https://github.com/rnd-soft/warden_cookie_session

[MIRROR] Warden Cookie Session is a warden strategy to store auth in custom encrypted cookie(instead of rack:session).
https://github.com/rnd-soft/warden_cookie_session

gem rails ruby ruby-on-rails warden

Last synced: about 1 month ago
JSON representation

[MIRROR] Warden Cookie Session is a warden strategy to store auth in custom encrypted cookie(instead of rack:session).

• Host: GitHub
• URL: https://github.com/rnd-soft/warden_cookie_session
• Owner: RND-SOFT
• License: mit
• Created: 2019-11-08T06:26:02.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-04T07:21:14.000Z (over 1 year ago)
• Last Synced: 2024-03-15T05:06:18.807Z (8 months ago)
• Topics: gem, rails, ruby, ruby-on-rails, warden
• Language: Ruby
• Homepage: https://br.rnds.pro/ruby/warden_cookie_session
• Size: 26.4 KB
• Stars: 2
• Watchers: 6
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Warden Cookie Session

[![Gem Version](https://badge.fury.io/rb/warden_cookie_session.svg)](https://rubygems.org/gems/warden_cookie_session)

[![Gem](https://img.shields.io/gem/dt/warden_cookie_session.svg)](https://rubygems.org/gems/warden_cookie_session/versions)

[![YARD](https://badgen.net/badge/YARD/doc/blue)](http://www.rubydoc.info/gems/warden_cookie_session)

[![Coverage](https://lysander.rnds.pro/api/v1/badges/cs_coverage.svg)](https://lysander.rnds.pro/api/v1/badges/cs_coverage.html)

[![Quality](https://lysander.rnds.pro/api/v1/badges/cs_quality.svg)](https://lysander.rnds.pro/api/v1/badges/cs_quality.html)

[![Outdated](https://lysander.rnds.pro/api/v1/badges/cs_outdated.svg)](https://lysander.rnds.pro/api/v1/badges/cs_outdated.html)

[![Vulnerabilities](https://lysander.rnds.pro/api/v1/badges/cs_vulnerable.svg)](https://lysander.rnds.pro/api/v1/badges/cs_vulnerable.html)

Warden Cookie Session is a warden strategy to store auth in custom encrypted cookie(instead of rack:session).

The main puprpose to allow store authorization between multiple rails applications, without sharing `secret_key_base`.  

# Usage

Setup `Warden::CookieSession` in initializer and provide wrapper.

```ruby

Warden::CookieSession.configure do |config|

  config.cookie = Rails.application.secrets['shared_cookie']

  config.secret = Rails.application.secrets['shared_secret']

  config.wrapper = Warden::CookieSession::DefaultWrapper.new(User)

end

```

Default wrapper just fetch user from model:

```ruby

module Warden

  module CookieSession

    class DefaultWrapper

      def initialize(klass = nil)

        @klass = klass

      end

      def serialize_record(record)

        # like in https://github.com/plataformatec/devise/blob/master/lib/devise/models/authenticatable.rb

        [record.to_key, record.authenticatable_salt]

      end

      def fetch_record(key)

        @klass.find(key.first)

      end

      def validate_record(record, salt)

        # like in https://github.com/plataformatec/devise/blob/master/lib/devise/models/authenticatable.rb

        record if record && record.authenticatable_salt == salt

      end

    end

  end

end

```

# Advansed Usage

With `Warden::CookieSession` we can fetch user data remotly ex. from API:

```ruby

Warden::CookieSession.configure do |config|

  config.cookie = Rails.application.secrets['shared_cookie']

  config.secret = Rails.application.secrets['shared_secret']

    class RemoteWrapper

      def serialize_record(record)

        [record.to_key, record.authenticatable_salt]

      end

      def fetch_record(key)

        FetchRemoteUserAndSalt.run!(key)

      end

      def validate_record(record, salt)

        record if record && record.authenticatable_salt == salt

      end

    end

  config.wrapper = Warden::CookieSession::DefaultWrapper.new(User)

end

```

# Installation

It's a gem:

```bash

  gem install warden_cookie_session

```

There's also the wonders of [the Gemfile](http://bundler.io):

```ruby

  gem 'warden_cookie_session'

```