any_auth 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,141 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AnyAuth
4
+ module Strategies
5
+ class OAuth2 < Base
6
+ class_attribute :authorize_options, default: [], instance_writer: false
7
+ class_attribute :pkce, default: true
8
+
9
+ attr_accessor :client_id, :client_secret
10
+
11
+ def self.authorize_option(*names)
12
+ self.authorize_options += names
13
+ attr_accessor(*names)
14
+ end
15
+
16
+ authorize_option :scope
17
+
18
+ def request_phase(redirect_uri:, **params)
19
+ raise ArgumentError, "#{provider} needs a client_id" if client_id.blank?
20
+
21
+ state = SecureRandom.hex(24)
22
+ session = { 'state' => state, 'redirect_uri' => redirect_uri }
23
+
24
+ if pkce?
25
+ pkce = PKCE.pair
26
+ session['code_verifier'] = pkce.verifier
27
+ params = params.merge(code_challenge: pkce.challenge, code_challenge_method: 'S256')
28
+ end
29
+
30
+ url = client.auth_code.authorize_url(**authorize_params, **params, redirect_uri:, state:)
31
+
32
+ Request.new(url:, session:)
33
+ end
34
+
35
+ def callback_phase(params, session)
36
+ verify(params, session)
37
+ access_token = fetch_access_token(params['code'], session)
38
+ credentials = credentials_from(access_token)
39
+
40
+ Auth.new(provider:, credentials:, **identity(access_token, session))
41
+ end
42
+
43
+ def expired?(credentials)
44
+ expires_at = credentials['expires_at']&.to_time
45
+
46
+ expires_at.present? && expires_at.before?(2.minutes.from_now)
47
+ end
48
+
49
+ def refresh(credentials)
50
+ return credentials unless expired?(credentials)
51
+
52
+ refresh!(credentials)
53
+ end
54
+
55
+ def refresh!(credentials)
56
+ access_token = with_error_handling do
57
+ ::OAuth2::AccessToken.from_hash(client, credentials).refresh
58
+ end
59
+
60
+ credentials.except('expires_at').merge(credentials_from(access_token))
61
+ end
62
+
63
+ private
64
+
65
+ def authorize_params
66
+ authorize_options.index_with { public_send(it) }.compact_blank
67
+ end
68
+
69
+ def verify(params, session)
70
+ raise InvalidCallback, 'No sign-in in progress' if session['redirect_uri'].blank?
71
+ raise InvalidCallback, 'Invalid state' unless valid_state?(params, session)
72
+ raise error_from(nil, params) if error_code(params).present?
73
+ raise InvalidCallback, 'Missing code' if params['code'].blank?
74
+ end
75
+
76
+ def valid_state?(params, session)
77
+ secure_compare(session['state'], params['state'])
78
+ end
79
+
80
+ def fetch_access_token(code, session, **params)
81
+ params = params.merge(
82
+ redirect_uri: session['redirect_uri'],
83
+ code_verifier: session['code_verifier'],
84
+ )
85
+
86
+ with_error_handling { client.auth_code.get_token(code, params.compact) }
87
+ end
88
+
89
+ def identity(_token, _session)
90
+ {}
91
+ end
92
+
93
+ def credentials_from(access_token)
94
+ raise AccessDenied, "#{provider} returned no access token" if access_token.token.blank?
95
+
96
+ {
97
+ 'access_token' => access_token.token,
98
+ 'refresh_token' => access_token.refresh_token,
99
+ 'expires_at' => (Time.at(access_token.expires_at).utc.iso8601 if access_token.expires_at),
100
+ }.compact
101
+ end
102
+
103
+ def client
104
+ ::OAuth2::Client.new(client_id, client_secret, **default_client_options, **client_options)
105
+ end
106
+
107
+ def default_client_options
108
+ { auth_scheme: :request_body }
109
+ end
110
+
111
+ def get(access_token, path)
112
+ parsed { access_token.get(path, snaky: false) }
113
+ end
114
+
115
+ def parsed
116
+ body = with_error_handling { yield.parsed }
117
+ raise Unavailable, "#{provider} returned an unreadable response" unless body.is_a?(Hash)
118
+
119
+ body
120
+ end
121
+
122
+ def with_error_handling
123
+ yield
124
+ rescue ::OAuth2::Error => e
125
+ raise vendor_error(e), cause: nil
126
+ rescue Faraday::Error, JSON::ParserError => e
127
+ raise Unavailable, "#{provider} request failed (#{e.class.name.demodulize})", cause: nil
128
+ end
129
+
130
+ def vendor_error(error)
131
+ response = error.response
132
+ return error_from(nil, {}) unless response.is_a?(::OAuth2::Response)
133
+
134
+ body = response.parsed
135
+ body = {} unless body.is_a?(Hash)
136
+
137
+ error_from(response.status, body, response.headers)
138
+ end
139
+ end
140
+ end
141
+ end
@@ -0,0 +1,77 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AnyAuth
4
+ module Strategies
5
+ class OpenIDConnect < OAuth2
6
+ def request_phase(redirect_uri:, scope: self.scope || 'email profile', **params)
7
+ nonce = SecureRandom.hex(16)
8
+ request = super(redirect_uri:, **params, scope: openid_scope(scope), nonce:)
9
+
10
+ request.with(session: request.session.merge('nonce' => nonce))
11
+ end
12
+
13
+ private
14
+
15
+ def openid_scope(scope)
16
+ ['openid', *scope.split].uniq.join(' ')
17
+ end
18
+
19
+ def identity(access_token, session)
20
+ claims = decode_id_token(access_token)
21
+ raise InvalidCallback, 'Invalid ID token' unless valid_claims?(claims, session)
22
+
23
+ identity_from(claims).merge(raw: claims)
24
+ end
25
+
26
+ def decode_id_token(access_token)
27
+ claims = JWT.decode(access_token.params['id_token'], nil, false).first
28
+ raise InvalidCallback, 'Invalid ID token' unless claims.is_a?(Hash)
29
+
30
+ claims
31
+ rescue JWT::DecodeError
32
+ raise InvalidCallback, 'Invalid ID token'
33
+ end
34
+
35
+ def identity_from(claims)
36
+ { uid: fetch_claim(claims, 'sub'), info: info_from(claims) }
37
+ end
38
+
39
+ def info_from(claims)
40
+ Info.new(name: claims['name'], email: claims['email'], image: claims['picture'])
41
+ end
42
+
43
+ def valid_claims?(claims, session)
44
+ valid_issuer?(claims) && valid_audience?(claims) && unexpired?(claims) &&
45
+ valid_nonce?(claims, session)
46
+ end
47
+
48
+ def valid_issuer?(_claims)
49
+ raise NotImplementedError, "#{self.class.name} must define valid_issuer?(claims)"
50
+ end
51
+
52
+ def valid_audience?(claims)
53
+ audiences = Array(claims['aud'])
54
+ authorized_party = claims['azp']
55
+
56
+ client_id.present? && audiences.include?(client_id) &&
57
+ authorized_party.in?([nil, client_id]) &&
58
+ (audiences.one? || authorized_party == client_id)
59
+ end
60
+
61
+ def unexpired?(claims)
62
+ claims['exp'].is_a?(Numeric) && Time.at(claims['exp']).future?
63
+ end
64
+
65
+ def valid_nonce?(claims, session)
66
+ secure_compare(session['nonce'], claims['nonce'])
67
+ end
68
+
69
+ def fetch_claim(claims, name)
70
+ value = claims[name]
71
+ raise InvalidCallback, "Missing #{name} claim" unless value.is_a?(String) && value.present?
72
+
73
+ value
74
+ end
75
+ end
76
+ end
77
+ end
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AnyAuth
4
+ module Strategies
5
+ class Relatel < OAuth2
6
+ def client_options
7
+ {
8
+ site: 'https://app.relatel.dk',
9
+ authorize_url: '/api/v2/authorize',
10
+ token_url: 'https://app.relatel.dk/api/v2/token',
11
+ }
12
+ end
13
+
14
+ private
15
+
16
+ def identity(access_token, _session)
17
+ employee = get(access_token, '/api/v2/employee')['employee'] || {}
18
+ raise AccessDenied, "#{provider} returned no employee" if employee['id'].blank?
19
+
20
+ {
21
+ uid: employee['id'].to_s,
22
+ info: Info.new(name: employee['name'], email: employee['email']),
23
+ raw: employee,
24
+ }
25
+ end
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,118 @@
1
+ # frozen_string_literal: true
2
+
3
+ begin
4
+ gem 'ruby-saml', '>= 1.18.1'
5
+ require 'onelogin/ruby-saml'
6
+ rescue LoadError => e
7
+ raise LoadError, "AnyAuth::Strategies::Saml needs ruby-saml 1.18.1 or later: #{e.message}"
8
+ end
9
+
10
+ module AnyAuth
11
+ module Strategies
12
+ class Saml < Base
13
+ STATUS = /\Aurn:oasis:names:tc:SAML:2\.0:status:\w+\z/
14
+
15
+ attr_accessor :idp_sso_service_url, :idp_cert, :idp_entity_id, :sp_entity_id,
16
+ :assertion_consumer_service_url, :name_identifier_format
17
+ attr_writer :allow_idp_initiated, :cache
18
+
19
+ def request_phase(redirect_uri:)
20
+ authn_request = OneLogin::RubySaml::Authrequest.new
21
+ url = authn_request.create(settings(redirect_uri))
22
+ session = { 'redirect_uri' => redirect_uri, 'request_id' => authn_request.request_id }
23
+
24
+ Request.new(url:, session:)
25
+ end
26
+
27
+ def callback_phase(params, session)
28
+ raise InvalidCallback, 'Missing SAMLResponse' if params['SAMLResponse'].blank?
29
+ raise InvalidCallback, 'No sign-in in progress' unless requested?(session)
30
+
31
+ response = OneLogin::RubySaml::Response.new(
32
+ params['SAMLResponse'],
33
+ settings: settings(session['redirect_uri']),
34
+ matches_request_id: session['request_id'],
35
+ allowed_clock_drift: 5.seconds,
36
+ )
37
+ raise AccessDenied.new('SAML sign-in refused', code: status_code(response)) unless
38
+ response.success?
39
+ raise InvalidCallback, 'Invalid SAML response' unless response.is_valid?
40
+ raise InvalidCallback, 'SAML assertion never expires' unless response.not_on_or_after
41
+ raise InvalidCallback, 'SAML response already used' unless first_use?(response)
42
+
43
+ Auth.new(
44
+ provider:,
45
+ uid: "#{idp_entity_id}:#{response.name_id}",
46
+ info: info_from(response),
47
+ credentials: {},
48
+ raw: response.attributes.all.to_h,
49
+ )
50
+ end
51
+
52
+ def allow_idp_initiated
53
+ ActiveModel::Type::Boolean.new.cast(@allow_idp_initiated)
54
+ end
55
+
56
+ def metadata
57
+ settings = service_provider
58
+ require_present(settings)
59
+
60
+ OneLogin::RubySaml::Metadata.new.generate(OneLogin::RubySaml::Settings.new(settings))
61
+ end
62
+
63
+ private
64
+
65
+ def settings(redirect_uri = nil)
66
+ settings = identity_provider.merge(service_provider(redirect_uri))
67
+ require_present(settings)
68
+ security = { strict_audience_validation: true, want_name_id: true }
69
+
70
+ OneLogin::RubySaml::Settings.new(settings.merge(name_identifier_format:, security:), true)
71
+ end
72
+
73
+ def identity_provider
74
+ { idp_sso_service_url:, idp_cert:, idp_entity_id: }
75
+ end
76
+
77
+ def service_provider(redirect_uri = nil)
78
+ callback = assertion_consumer_service_url || redirect_uri
79
+
80
+ { sp_entity_id:, assertion_consumer_service_url: callback }
81
+ end
82
+
83
+ def require_present(settings)
84
+ missing = settings.select { |_name, value| value.blank? }.keys
85
+ raise ArgumentError, "#{provider} needs #{missing.to_sentence}" if missing.any?
86
+ end
87
+
88
+ def requested?(session)
89
+ session['request_id'].present? || allow_idp_initiated
90
+ end
91
+
92
+ def status_code(response)
93
+ codes = response.status_code.to_s.split(' | ')
94
+
95
+ response.status_code if codes.all? { it.match?(STATUS) }
96
+ end
97
+
98
+ def first_use?(response)
99
+ key = "any_auth:saml:#{idp_entity_id}:#{response.assertion_id}"
100
+
101
+ cache.write(key, true, unless_exist: true, expires_at: response.not_on_or_after + 1.minute)
102
+ end
103
+
104
+ def cache
105
+ store = @cache || (Rails.cache if defined?(Rails))
106
+ return store unless store.nil? || store.is_a?(ActiveSupport::Cache::NullStore)
107
+
108
+ raise ArgumentError, "#{provider} needs a cache shared by every process to refuse replays"
109
+ end
110
+
111
+ def info_from(response)
112
+ attributes = response.attributes
113
+
114
+ Info.new(name: attributes['name'], email: attributes['email'] || attributes['mail'])
115
+ end
116
+ end
117
+ end
118
+ end
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AnyAuth
4
+ module Strategies
5
+ class Shopify < OAuth2
6
+ attribute :shop, :string
7
+
8
+ validates :shop, format: { with: /\A[a-z0-9][a-z0-9-]*\.myshopify\.com\z/, message: :invalid }
9
+
10
+ def shop=(value)
11
+ super(normalize_shop(value))
12
+ end
13
+
14
+ def client_options
15
+ raise ArgumentError, "#{shop.inspect} is not a Shopify shop" unless valid?
16
+
17
+ {
18
+ site: URI::HTTPS.build(host: shop).to_s,
19
+ authorize_url: '/admin/oauth/authorize',
20
+ token_url: '/admin/oauth/access_token',
21
+ }
22
+ end
23
+
24
+ private
25
+
26
+ def normalize_shop(value)
27
+ address = value.to_s.strip.downcase.delete_prefix('https://').delete_prefix('http://')
28
+ name = address[%r{\Aadmin\.shopify\.com/store/([^/]+)}, 1] || address.split('/').first
29
+ return if name.blank?
30
+ return name if name.include?('.')
31
+
32
+ "#{name}.myshopify.com"
33
+ end
34
+
35
+ def verify(params, session)
36
+ super
37
+ raise InvalidCallback, 'Invalid shop' unless shop.present? && params['shop'] == shop
38
+ raise InvalidCallback, 'Invalid HMAC' unless valid_hmac?(params)
39
+ end
40
+
41
+ def valid_hmac?(params)
42
+ return false unless client_secret.present? && params.values.all?(String)
43
+
44
+ secure_compare(hmac(params), params['hmac'])
45
+ end
46
+
47
+ def hmac(params)
48
+ message = params.except('hmac').sort.map { it.join('=') }.join('&')
49
+
50
+ OpenSSL::HMAC.hexdigest('SHA256', client_secret, message)
51
+ end
52
+
53
+ def fetch_access_token(code, session)
54
+ super(code, session, expiring: 1)
55
+ end
56
+
57
+ def identity(access_token, _session)
58
+ { uid: shop, raw: access_token.params }
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,73 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AnyAuth
4
+ module Strategies
5
+ class Signicat < OpenIDConnect
6
+ LEVELS = %w[unspecified low substantial high].freeze
7
+
8
+ authorize_option :prompt, :login_hint, :ui_locales
9
+
10
+ attr_accessor :domain, :idp, :loa
11
+
12
+ def request_phase(redirect_uri:, scope: self.scope || 'profile', **params)
13
+ raise ArgumentError, "#{provider} needs a domain" if domain.blank?
14
+ raise ArgumentError, "#{loa.inspect} is not a level: #{LEVELS.join(', ')}" unless valid_loa?
15
+
16
+ super
17
+ end
18
+
19
+ def client_options
20
+ {
21
+ site: issuer,
22
+ authorize_url: '/auth/open/connect/authorize',
23
+ token_url: '/auth/open/connect/token',
24
+ }
25
+ end
26
+
27
+ private
28
+
29
+ def authorize_params
30
+ super.merge(acr_values:).compact_blank
31
+ end
32
+
33
+ def acr_values
34
+ values = []
35
+ values << "idp:#{idps.join(',')}" if idps.any?
36
+ values << "loa:#{loa}" if loa.present?
37
+
38
+ values.join(' ')
39
+ end
40
+
41
+ def idps
42
+ Array(idp)
43
+ end
44
+
45
+ def valid_loa?
46
+ loa.blank? || loa.in?(LEVELS)
47
+ end
48
+
49
+ def valid_claims?(claims, session)
50
+ super && requested_eid?(claims) && requested_level?(claims)
51
+ end
52
+
53
+ def issuer
54
+ URI::HTTPS.build(host: domain, path: '/auth/open').to_s
55
+ end
56
+
57
+ def valid_issuer?(claims)
58
+ claims['iss'] == issuer
59
+ end
60
+
61
+ def requested_eid?(claims)
62
+ idps.empty? || claims['idp'].in?(idps)
63
+ end
64
+
65
+ def requested_level?(claims)
66
+ return true if loa.blank?
67
+
68
+ achieved = LEVELS.index(claims['acr'])
69
+ achieved.present? && achieved >= LEVELS.index(loa)
70
+ end
71
+ end
72
+ end
73
+ end
@@ -0,0 +1,32 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AnyAuth
4
+ module Strategies
5
+ class Tavle < OAuth2
6
+ def client_options
7
+ {
8
+ site: 'https://tavle.co',
9
+ authorize_url: '/oauth/authorize',
10
+ token_url: '/oauth/token',
11
+ }
12
+ end
13
+
14
+ private
15
+
16
+ def identity(access_token, _session)
17
+ userinfo = get(access_token, '/oauth/userinfo')
18
+ raise AccessDenied, "#{provider} returned no subject" if userinfo['sub'].blank?
19
+
20
+ { uid: userinfo['sub'].to_s, info: info_from(userinfo), raw: userinfo }
21
+ end
22
+
23
+ def info_from(userinfo)
24
+ Info.new(
25
+ name: userinfo['name'],
26
+ email: userinfo['email'],
27
+ email_verified: userinfo['email_verified'] == true,
28
+ )
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module AnyAuth
4
+ VERSION = '0.1.0'
5
+ end
data/lib/any_auth.rb ADDED
@@ -0,0 +1,81 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'base64'
4
+ require 'digest'
5
+ require 'json'
6
+ require 'openssl'
7
+ require 'securerandom'
8
+ require 'time'
9
+ require 'uri'
10
+
11
+ require 'active_model'
12
+ require 'active_support'
13
+ require 'active_support/core_ext'
14
+ require 'active_support/security_utils'
15
+ require 'faraday'
16
+ require 'jwt'
17
+ require 'oauth2'
18
+
19
+ module AnyAuth
20
+ class Error < StandardError
21
+ attr_reader :code, :description, :retry_after
22
+
23
+ def initialize(message = nil, code: nil, description: nil, retry_after: nil)
24
+ @code = code
25
+ @description = description
26
+ @retry_after = retry_after
27
+ super(message)
28
+ end
29
+
30
+ def reason
31
+ code || self.class.name.demodulize.underscore
32
+ end
33
+ end
34
+
35
+ class AuthenticationError < Error; end
36
+ class InvalidCallback < AuthenticationError; end
37
+ class AccessDenied < AuthenticationError; end
38
+ class Unavailable < AuthenticationError; end
39
+ class ConfigurationError < Error; end
40
+
41
+ def self.configuration
42
+ @configuration ||= Configuration.new
43
+ end
44
+
45
+ def self.configure
46
+ yield configuration
47
+ end
48
+
49
+ def self.providers
50
+ configuration.providers
51
+ end
52
+
53
+ def self.strategy_class(name)
54
+ configuration.strategy_class(name)
55
+ end
56
+
57
+ def self.strategy(...)
58
+ configuration.strategy(...)
59
+ end
60
+ end
61
+
62
+ require_relative 'any_auth/version'
63
+ require_relative 'any_auth/auth'
64
+ require_relative 'any_auth/configuration'
65
+ require_relative 'any_auth/info'
66
+ require_relative 'any_auth/pkce'
67
+ require_relative 'any_auth/request'
68
+ require_relative 'any_auth/controller_helpers'
69
+ require_relative 'any_auth/strategies/base'
70
+ require_relative 'any_auth/strategies/oauth2'
71
+ require_relative 'any_auth/strategies/open_id_connect'
72
+ require_relative 'any_auth/strategies/adversus'
73
+ require_relative 'any_auth/strategies/apple'
74
+ require_relative 'any_auth/strategies/economic'
75
+ require_relative 'any_auth/strategies/google'
76
+ require_relative 'any_auth/strategies/hubspot'
77
+ require_relative 'any_auth/strategies/microsoft'
78
+ require_relative 'any_auth/strategies/relatel'
79
+ require_relative 'any_auth/strategies/shopify'
80
+ require_relative 'any_auth/strategies/signicat'
81
+ require_relative 'any_auth/strategies/tavle'