Contents

# frozen_string_literal: true

module HTTPX
  module Plugins
    #
    # https://gitlab.com/honeyryderchuck/httpx/wikis/Authentication#ntlm-authentication
    #
    module NTLMAuthentication
      NTLMParams = Struct.new(:user, :domain, :password)

      class << self
        def load_dependencies(_klass)
          require "base64"
          require "ntlm"
        end

        def configure(klass)
          klass.plugin(:authentication)
        end

        def extra_options(options)
          Class.new(options.class) do
            def_option(:ntlm, <<-OUT)
              raise Error, ":ntlm must be a #{NTLMParams}" unless value.is_a?(#{NTLMParams})

              value
            OUT
          end.new(options).merge(max_concurrent_requests: 1)
        end
      end

      module InstanceMethods
        def ntlm_authentication(user, password, domain = nil)
          with(ntlm: NTLMParams.new(user, domain, password))
        end

        alias_method :ntlm_auth, :ntlm_authentication

        def request(*args, **options)
          requests = build_requests(*args, options)
          request = requests.first
          ntlm = request.options.ntlm

          return super(*requests, **options) unless ntlm

          request.headers["authorization"] = "NTLM #{NTLM.negotiate(domain: ntlm.domain).to_base64}"
          probe_response = wrap { send_requests(*request, options).first }

          return probe_response unless probe_response.status == 401 && probe_response.headers.key?("www-authenticate") &&
                                       (challenge = probe_response.headers["www-authenticate"][/NTLM (.*)/, 1])

          challenge = Base64.decode64(challenge)
          ntlm_challenge = NTLM.authenticate(challenge, ntlm.user, ntlm.domain, ntlm.password).to_base64

          request.transition(:idle)

          request.headers["authorization"] = "NTLM #{ntlm_challenge}"
          super(request, **options)
        end
      end
    end
    register_plugin :ntlm_authentication, NTLMAuthentication
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
httpx-0.14.5	lib/httpx/plugins/ntlm_authentication.rb