faraday-ntlm_auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dfabd2fb1466348d115b289a904e4a0fe0bd7c4c2e3c7e628efb08dc8e3d9433
+  data.tar.gz: e9e54a8d6688b3c87948c2beefd9757974584a64351ebec6a9ccbb501bfb2a0c
+SHA512:
+  metadata.gz: 4f4da888175f41d61c1ae14a3bde743462aca6e70198d6fcef0190551beab34e3a8650296c4b86688c56a99e8288b0af0da70e5858cc61d7fe72a69b5396a8c7
+  data.tar.gz: '08999da12bad398336a81fdff421e94a4fe0c00db82da1bc89853ddd6ab0e5e0bd4cc99bab0910859e400f29ff4bb80d825e608706e4edbc12e2adf834178344'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+*   Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Lucas Ridge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Faraday NTLM Authentication
+
+A simple Faraday middleware for NTLM authentication
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-ntlm_auth'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install faraday-ntlm_auth
+```
+
+## Usage
+
+```ruby
+require 'faraday/ntlm_auth'
+
+conn = Faraday.new(url: 'http://example.com') do |faraday|
+  faraday.adapter :net_http_persistent, pool_size: 5, idle_timeout: 5 # Net HTTP persistent adapter is required for NTLM authentication
+  faraday.request :ntlm_auth, auth: 'username', 'your_password', 'your_domain'
+end
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `bin/test` to run the tests.
+
+To install this gem onto your local machine, run `rake build`.
+
+To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`.
+See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](<%= github_uri %>).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/ntlm_auth/middleware.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'rubyntlm'
+require 'faraday/net_http_persistent'
+
+module Faraday
+  module NTLMAuth
+    # This class provides the main implementation for your middleware.
+    # Your middleware can implement any of the following methods:
+    # * on_request - called when the request is being prepared
+    # * on_complete - called when the response is being processed
+    #
+    # Optionally, you can also override the following methods from Faraday::Middleware
+    # * initialize(app, options = {}) - the initializer method
+    # * call(env) - the main middleware invocation method.
+    #   This already calls on_request and on_complete, so you normally don't need to override it.
+    #   You may need to in case you need to "wrap" the request or need more control
+    #   (see "retry" middleware: https://github.com/lostisland/faraday-retry/blob/41b7ea27e30d99ebfed958abfa11d12b01f6b6d1/lib/faraday/retry/middleware.rb#L147).
+    #   IMPORTANT: Remember to call `@app.call(env)` or `super` to not interrupt the middleware chain!
+    class Middleware < Faraday::Middleware
+      # This method will be called when the request is being prepared.
+      # You can alter it as you like, accessing things like request_body, request_headers, and more.
+      # Refer to Faraday::Env for a list of accessible fields:
+      # https://github.com/lostisland/faraday/blob/main/lib/faraday/options/env.rb
+      #
+      # @param env [Faraday::Env] the environment of the request being processed
+      def on_request(env)
+        ntlm_message = Net::NTLM::Message
+        env[:request_headers]['Authorization'] = 'NTLM ' + ntlm_message::Type1.new.encode64
+        response = @app.call(env.dup)
+        challenge = response.env[:response_headers]['www-authenticate'][/(?:NTLM|Negotiate) (.*)$/, 1]
+        message = ntlm_message::Type2.decode64(challenge)
+        ntlm_auth = message.response([:user, :password, :domain].zip(@options[:auth]).to_h)
+        env[:request_headers]['Authorization'] = "NTLM #{ntlm_auth.encode64}"
+      end
+
+    end
+  end
+end

data/lib/faraday/ntlm_auth/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module NTLMAuth
+    VERSION = '0.1.0'
+  end
+end

data/lib/faraday/ntlm_auth.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'ntlm_auth/middleware'
+require_relative 'ntlm_auth/version'
+
+module Faraday
+  # This will be your middleware main module, though the actual middleware implementation will go
+  # into <%= middleware_constant %> for the correct namespacing.
+  module NTLMAuth
+    # Faraday allows you to register your middleware for easier configuration.
+    # This step is totally optional, but it basically allows users to use a
+    # custom symbol (in this case, `:<%= middleware_name %>`), to use your middleware in their connections.
+    # After calling this line, the following are both valid ways to set the middleware in a connection:
+    # * conn.use <%= middleware_constant %>
+    # * conn.use :<%= middleware_name %>
+    # Without this line, only the former method is valid.
+    Faraday::Request.register_middleware(ntlm_auth: Faraday::NTLMAuth::Middleware)
+
+    # Alternatively, you can register your middleware under Faraday::Request or Faraday::Response.
+    # This will allow to load your middleware using the `request` or `response` methods respectively.
+    #
+    # Load middleware with conn.request :<%= middleware_name %>
+    # Faraday::Request.register_middleware(<%= middleware_name %>: <%= middleware_constant %>)
+    #
+    # Load middleware with conn.response :<%= middleware_name %>
+    # Faraday::Response.register_middleware(<%= middleware_name %>: <%= middleware_constant %>)
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: faraday-ntlm_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke Ridge
+bindir: bin
+cert_chain: []
+date: 2025-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubyntlm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- lucas.ridge@igs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/faraday/ntlm_auth.rb
+- lib/faraday/ntlm_auth/middleware.rb
+- lib/faraday/ntlm_auth/version.rb
+homepage: https://github.com/igs-opensource/faraday-ntlm_auth
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/igs-opensource/faraday-ntlm_auth/issues
+  changelog_uri: https://github.com/igs-opensource/faraday-ntlm_auth/blob/v0.1.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-ntlm_auth/0.1.0
+  homepage_uri: https://github.com/igs-opensource/faraday-ntlm_auth
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/igs-opensource/faraday-ntlm_auth
+  wiki_uri: https://github.com/igs-opensource/faraday-ntlm_auth/wiki
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A Faraday middleware for NTLM authentication
+test_files: []