open_graph_fetcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46670fff3dd827c35482bd63b1c246aa876fd85f82b3fdff752144e4f07e537b
+  data.tar.gz: a260be55faeb2038d4aeacfa9d419a1b7301ec023d327eb51fc2d5a1992ff260
+SHA512:
+  metadata.gz: f23ee76f381d04b9fcc1bb60eb2f1baf4a438647009987a072f7a23334008a18614f11bb9a9cf74065e5deb695f65a3d8bed786ea2e6f32137c61a4c14a4ae06
+  data.tar.gz: 005b86f83da1f16ce55998bcefc1bceb93c0e0137bccab08e72ad1da2e749077fe2a0f5e85cd0bbf6abc005181cb16c2abab01adc1e2fa623344146743d198a7

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.2', '3.3']
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+.bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Marco Colli (collimarco.com)
+
+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,33 @@
+# OpenGraphFetcher
+
+Fetch Open Graph metadata in a safer way.
+
+- Includes some mitigations for SSRF attacks
+- Blocks private and local IP ranges
+- Avoids TOC/TOU when connecting to the IP
+- Supports only HTTPS on the standard port (443)
+- Includes request timeouts
+- Avoids redirects
+- Allows only text/html responses
+- Returns only known OG properties and nothing else
+
+## Installation
+
+```ruby
+gem 'open_graph_fetcher'
+```
+
+## Usage
+
+Basic usage:
+
+```ruby
+url = "https://ogp.me"
+fetcher = OpenGraphFetcher::Fetcher.new(url)
+og_data = fetcher.fetch
+puts og_data
+```
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/lib/open_graph_fetcher/errors.rb

@@ -0,0 +1,11 @@
+module OpenGraphFetcher
+  class Error < StandardError; end
+
+  class InvalidSchemeError < Error; end
+  class InvalidPortError < Error; end
+  class IPResolutionError < Error; end
+  class PrivateIPError < Error; end
+  class FetchError < Error; end
+  class ResponseError < Error; end
+  class InvalidContentTypeError < Error; end
+end

data/lib/open_graph_fetcher/fetcher.rb

@@ -0,0 +1,77 @@
+require 'nokogiri'
+require 'net/http'
+require 'resolv'
+require 'ipaddr'
+
+module OpenGraphFetcher
+  class Fetcher
+    OG_PROPERTIES = %w[title type image url description].freeze
+    
+    OPEN_TIMEOUT = 3
+    READ_TIMEOUT = 3
+
+    def self.fetch(url)
+      new(url).fetch
+    end
+
+    def initialize(url)
+      @url = url
+    end
+
+    def fetch
+      uri = URI.parse(@url)
+      raise InvalidSchemeError, "Only HTTPS URLs are allowed" unless uri.scheme == "https"
+      raise InvalidPortError, "Only the default HTTPS port (443) is allowed" if uri.port && uri.port != 443
+
+      ip_address = resolve_ip(uri)
+      raise PrivateIPError, "Resolved IP address is in a private or reserved range" if private_ip?(ip_address)
+
+      response = fetch_data(uri, ip_address)
+      raise ResponseError, "HTTP response is not ok: HTTP #{response.code} #{response.message}" unless response.code == "200"
+      raise InvalidContentTypeError, "Only HTML content is allowed" unless html_content?(response)
+      
+      parse_open_graph_data(response.body)
+    end
+
+    private
+
+    def resolve_ip(uri)
+      Resolv.getaddress(uri.host)
+    rescue Resolv::ResolvError => e
+      raise IPResolutionError, "Could not resolve IP: #{e.message}"
+    end
+
+    def private_ip?(ip)
+      ip_addr = IPAddr.new(ip)
+      ip_addr.private? || ip_addr.link_local? || ip_addr.loopback?
+    end
+
+    def fetch_data(uri, ip)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      Net::HTTP.start(uri.hostname, uri.port, ipaddr: ip, use_ssl: true, open_timeout: OPEN_TIMEOUT, read_timeout: READ_TIMEOUT) do |http|
+        http.request(request)
+      end
+    rescue Net::OpenTimeout, Net::ReadTimeout => e
+      raise FetchError, "Request timed out: #{e.message}"
+    rescue StandardError => e
+      raise FetchError, "Failed to fetch data: #{e.message}"
+    end
+
+    def html_content?(response)
+      content_type = response["Content-Type"]
+      content_type&.start_with?("text/html")
+    end
+
+    def parse_open_graph_data(html)
+      doc = Nokogiri::HTML(html)
+      og_data = {}
+
+      OG_PROPERTIES.each do |property|
+        meta_tag = doc.at_css("meta[property='og:#{property}']")
+        og_data[property] = meta_tag[:content] if meta_tag && meta_tag[:content]
+      end
+
+      og_data
+    end
+  end
+end

data/lib/open_graph_fetcher/version.rb

@@ -0,0 +1,3 @@
+module OpenGraphFetcher
+  VERSION = '0.1.0'.freeze
+end

data/lib/open_graph_fetcher.rb

@@ -0,0 +1,7 @@
+require 'open_graph_fetcher/version'
+require 'open_graph_fetcher/errors'
+require 'open_graph_fetcher/fetcher'
+
+module OpenGraphFetcher
+  
+end

data/open_graph_fetcher.gemspec

@@ -0,0 +1,14 @@
+require_relative 'lib/open_graph_fetcher/version'
+
+Gem::Specification.new do |s|
+  s.name = 'open_graph_fetcher'
+  s.version = OpenGraphFetcher::VERSION
+  s.summary = 'Fetch Open Graph metadata in a safer way.'
+  s.author = 'Marco Colli'
+  s.homepage = 'https://github.com/collimarco/open_graph_fetcher'
+  s.license = 'MIT'
+  s.files = `git ls-files`.split("\n")
+  s.add_dependency 'nokogiri'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+end

data/spec/fetcher_spec.rb

@@ -0,0 +1,101 @@
+require 'open_graph_fetcher'
+require 'webmock/rspec'
+
+RSpec.describe OpenGraphFetcher::Fetcher do
+
+  before do
+    allow(Resolv).to receive(:getaddress).and_return("203.0.113.0")
+  end
+
+  describe ".fetch" do
+    context "when fetching Open Graph data from a valid HTTPS URL" do
+      it "successfully retrieves and parses Open Graph properties" do
+        body = <<-HTML
+          <html>
+            <head>
+              <meta property="og:title" content="Example Title">
+              <meta property="og:type" content="website">
+              <meta property="og:image" content="https://example.com/image.jpg">
+              <meta property="og:url" content="https://example.com/example-page">
+              <meta property="og:description" content="Example description">
+            </head>
+          </html>
+        HTML
+        
+        stub_request(:get, "https://example.com/example-page").to_return(
+          status: 200,
+          body: body,
+          headers: { "Content-Type" => "text/html" }
+        )
+
+        og_data = OpenGraphFetcher::Fetcher.fetch("https://example.com/example-page")
+
+        expect(og_data).to eq({
+          "title" => "Example Title",
+          "type" => "website",
+          "image" => "https://example.com/image.jpg",
+          "url" => "https://example.com/example-page",
+          "description" => "Example description"
+        })
+      end
+    end
+
+    context "when given an HTTP URL" do
+      it "raises an InvalidSchemeError" do
+        expect { OpenGraphFetcher::Fetcher.fetch("http://example.com") }.to raise_error(OpenGraphFetcher::InvalidSchemeError)
+      end
+    end
+
+    context "when given a URL with a non-standard port" do
+      it "raises an InvalidPortError" do
+        expect { OpenGraphFetcher::Fetcher.fetch("https://example.com:8443") }.to raise_error(OpenGraphFetcher::InvalidPortError)
+      end
+    end
+
+    context "when the IP address cannot be resolved" do
+      it "raises an IPResolutionError with an appropriate error message" do
+        allow(Resolv).to receive(:getaddress).and_raise(Resolv::ResolvError, "DNS resolution failed")
+
+        expect { OpenGraphFetcher::Fetcher.fetch("https://nonexistent-domain.com") }.to raise_error(OpenGraphFetcher::IPResolutionError, /Could not resolve IP: DNS resolution failed/)
+      end
+    end
+
+    context "when the resolved IP address is private" do
+      it "raises a PrivateIPError" do
+        allow(Resolv).to receive(:getaddress).with("10.0.0.1").and_return("10.0.0.1")
+
+        expect { OpenGraphFetcher::Fetcher.fetch("https://10.0.0.1") }.to raise_error(OpenGraphFetcher::PrivateIPError)
+      end
+    end
+
+    context "when the HTTP response code is not 200" do
+      it "raises a FetchError with the response code and message" do
+        stub_request(:get, "https://example.com/nonexistent-page").to_return(
+          status: 404,
+          body: "Not Found"
+        )
+
+        expect { OpenGraphFetcher::Fetcher.fetch("https://example.com/nonexistent-page") }.to raise_error(OpenGraphFetcher::ResponseError, /HTTP response is not ok: HTTP 404/)
+      end
+    end
+
+    context "when a network timeout occurs" do
+      it "raises a FetchError with a timeout message" do
+        stub_request(:get, "https://example.com").to_timeout
+
+        expect { OpenGraphFetcher::Fetcher.fetch("https://example.com") }.to raise_error(OpenGraphFetcher::FetchError, /Request timed out/)
+      end
+    end
+
+    context "when the URL returns a non-HTML content type" do
+      it "raises an InvalidContentTypeError" do
+        stub_request(:get, "https://example.com/non-html").to_return(
+          status: 200,
+          headers: { "Content-Type" => "application/json" }
+        )
+
+        expect { OpenGraphFetcher::Fetcher.fetch("https://example.com/non-html") }.to raise_error(OpenGraphFetcher::InvalidContentTypeError)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: open_graph_fetcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marco Colli
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/open_graph_fetcher.rb
+- lib/open_graph_fetcher/errors.rb
+- lib/open_graph_fetcher/fetcher.rb
+- lib/open_graph_fetcher/version.rb
+- open_graph_fetcher.gemspec
+- spec/fetcher_spec.rb
+homepage: https://github.com/collimarco/open_graph_fetcher
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Fetch Open Graph metadata in a safer way.
+test_files: []