0.02
No commit activity in last 3 years
No release in over 3 years
Unofficial ESIA OAuth2 Strategy for OmniAuth.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.16.a
~> 10.0
~> 3.0

Runtime

 Project Readme

OmniAuth Esia (OAuth2)

This is the unofficial OmniAuth strategy for authenticating via OAuth2 to ESIA (GosUslugi). Read more here

Built using omniauth-oauth2.

Installation

Add this line to your application's Gemfile:

gem 'omniauth-esia'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-esia

Usage

OmniAuth::Strategies::Esia is simply a Rack middleware.

In Your Rails application:

# Gemfile
gem 'omniauth-esia'
# config/initializers/omniauth.rb
Rails.application.config.middleware.use OmniAuth::Builder do
  provider :esia, ENV['ESIA_ID'],
    scope:    'fullname email',
    key_passphrase: 'password',
    key_path: "#{Rails.root}/config/keys/private.key",
    crt_path: "#{Rails.root}/config/keys/certificate.crt"
end

or in Your Rails application with Devise. See full instruction here

# config/initializers/devise.rb
Devise.setup do |config|
  config.omniauth :esia, ENV['ESIA_ID'],
    scope:    'fullname email',
    key_passphrase: 'password',
    key_path: "#{Rails.root}/config/keys/private.key",
    crt_path: "#{Rails.root}/config/keys/certificate.crt"
end

Configuring

Read the ESIA docs for more details You can configure several options, which you pass in to the provider method via a Hash:

  • client_id: ESIA identifier
  • scope: a space-separated list of access permissions you want to request from the user. Example 'fullname gender email'
  • key_path: path to private key. Default to config/keys/private.key
  • crt_path: path to certificate. Default to config/keys/certificate.crt
  • client_options: path to certificate. Default to https://esia.gosuslugi.ru. For ESIA's test environment set to https://esia-portal1.test.gosuslugi.ru
client_options: {
        site:          'https://esia-portal1.test.gosuslugi.ru',
        authorize_url: '/aas/oauth2/ac',
        token_url:     '/aas/oauth2/te'
      }

Changes

v 0.2.3 - adds key_passphrase option v 0.2.1 - corrects email fetching v 0.2.0 - corrects namespacing v 0.1.0 - first release

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/elsant/omniauth-esia.

License

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