didkit 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04d52ea6bded9fd573e1d4f5794b1b46691159982228b699e32e7b6d83c73573
-  data.tar.gz: e866504833f5abd3cdc6d6225836eb5d6388415a0640439e57ec6a535226ade0
+  metadata.gz: 76dd4f3787cf1cc288015511eb35ea6d41ef4c390f85ca67854617fe7c46d710
+  data.tar.gz: 40ea426b53fa3176dccd4c538cbd40050a3883bb6632af2b45ca1a6f49ac84b7
 SHA512:
-  metadata.gz: 636c2e274e596338aa463971ab1dadac22fb655c67622cce15b65059a99e0bd91ef3ed5a78984c4c48f5ff1731287f8d3efe2d05bc0445871778b9911e3c2977
-  data.tar.gz: 62c9f5ef2238320d598050ff00d696adf572e69c663d85b04424251f4664376193ce40d0dc7bf92daf8d9e315b6d245510ad560759aacb0452955452d3027d2f
+  metadata.gz: a26c81e89e2397bb7690149e143a0de6c9e9635a993e8cd13d572d76b21b38ce37628eb3c3ebc4ea9ffc20b3807f619acb46612a76af9f816b336315a10f7aab
+  data.tar.gz: 89b4d9eb1ec2b7f5207587cde9b0a2b2db8a5912a92dc1ef996f0bac493996aae8b1340fc673838c404ac28d4ab191be6e7ce3a984f35a83402b9ef489feea8b

data/CHANGELOG.md

@@ -1,2 +1,27 @@
-## [Unreleased]
+## [0.0.4] - 2024-03-07
 
+- extracted resolving code from `DID` to a new `Resolver` class (`DID` has helper methods to call the resolver)
+- added `Resolver#get_validated_handle` method to validate handles from the `Document` (+ helpers in `DID` in `Document`)
+- added timeout to `#resolve_handle_by_well_known`
+
+## [0.0.3] - 2024-03-06
+
+- added `Document#handles` with handle info extracted from `alsoKnownAs` field
+- added validation of various fields of the DID document
+- added `DID#resolved_by` (`:dns` or `:http`)
+- added `DID#did` which returns the DID in a string form like `to_s`
+- added `DID#web_domain` which returns the domain part of a `did:web`
+- changed `DID#type` to be stored as a symbol
+
+## [0.0.2] - 2023-11-14
+
+- fixed missing require
+- fixed some connection error handling
+
+## [0.0.1] - 2023-11-14
+
+Initial release:
+
+- resolving handle to DID via DNS or HTTP well-known
+- loading DID document via PLC or did:web well-known
+- extracting PDS endpoint field from the DID doc

data/README.md

@@ -1,31 +1,22 @@
-# Didkit
+# DidKit
 
-TODO: Delete this and the text below, and describe your gem
+A small Ruby gem for handling Distributed Identifiers (DIDs) in Bluesky / AT Protocol
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/didkit`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+## What does it do
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+**TODO** - not much yet :)
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+See the [did.rb](https://github.com/mackuba/didkit/blob/master/lib/didkit/did.rb) file for now.
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
 
-## Usage
-
-TODO: Write usage instructions here
+## Installation
 
-## Development
+    gem install didkit
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Credits
 
-## Contributing
+Copyright © 2023 Kuba Suder ([@mackuba.eu](https://bsky.app/profile/mackuba.eu)).
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/didkit.
+The code is available under the terms of the [zlib license](https://choosealicense.com/licenses/zlib/) (permissive, similar to MIT).

data/lib/didkit/did.rb

@@ -1,94 +1,51 @@
-require 'json'
-require 'net/http'
-require 'open-uri'
-require 'resolv'
-
-require_relative 'document'
 require_relative 'errors'
+require_relative 'resolver'
 
 module DIDKit
   class DID
     def self.resolve_handle(handle)
-      domain = handle.gsub(/^@/, '')
-
-      if dns_did = resolve_handle_by_dns(domain)
-        DID.new(dns_did)
-      elsif http_did = resolve_handle_by_well_known(domain)
-        DID.new(http_did)
-      else
-        nil
-      end
+      Resolver.new.resolve_handle(handle)
     end
 
-    def self.resolve_handle_by_dns(domain)
-      dns_records = Resolv::DNS.open { |d| d.getresources("_atproto.#{domain}", Resolv::DNS::Resource::IN::TXT) }
-
-      if record = dns_records.first
-        if string = record.strings.first
-          if string =~ /^did\=(did\:\w+\:.*)$/
-            return $1
-          end
-        end
-      end
-
-      nil
-    end
-
-    def self.resolve_handle_by_well_known(domain)
-      url = URI("https://#{domain}/.well-known/atproto-did")
-      response = Net::HTTP.get_response(url)
-
-      if response.is_a?(Net::HTTPSuccess)
-        if text = response.body
-          if text.lines.length == 1 && text.start_with?('did:')
-            return text
-          end
-        end
-      end
+    attr_reader :type, :did, :resolved_by
 
-      nil
-    rescue StandardError => e
-      nil
-    end
-
-    attr_reader :type
-
-    def initialize(did)
+    def initialize(did, resolved_by = nil)
       if did =~ /^did\:(\w+)\:/
         @did = did
-        @type = $1
+        @type = $1.to_sym
       else
         raise DIDError.new("Invalid DID format")
       end
 
-      if @type != 'plc' && @type != 'web'
+      if @type != :plc && @type != :web
         raise DIDError.new("Unrecognized DID type: #{@type}")
       end
-    end
 
-    def to_s
-      @did
+      @resolved_by = resolved_by
     end
 
+    alias to_s did
+
     def get_document
-      if @type == 'plc'
-        resolve_did_plc(@did)
-      elsif @type == 'web'
-        resolve_did_web(@did)
-      end
+      Resolver.new.resolve_did(self)
+    end
+
+    def get_validated_handle
+      Resolver.new.get_validated_handle(self)
     end
 
-    def resolve_did_plc(did)
-      url = "https://plc.directory/#{did}"
-      json = JSON.parse(URI.open(url).read)
-      Document.new(json)
+    def web_domain
+      did.gsub(/^did\:web\:/, '') if type == :web
     end
 
-    def resolve_did_web(did)
-      host = did.gsub(/^did\:web\:/, '')
-      url = "https://#{host}/.well-known/did.json"
-      json = JSON.parse(URI.open(url).read)
-      Document.new(json)
+    def ==(other)
+      if other.is_a?(String)
+        self.did == other
+      elsif other.is_a?(DID)
+        self.did == other.did
+      else
+        false
+      end
     end
   end
 end

data/lib/didkit/document.rb

@@ -1,14 +1,45 @@
 module DIDKit
   class Document
-    attr_reader :json
+    class FormatError < StandardError
+    end
+
+    attr_reader :json, :did, :pds_endpoint, :handles
 
-    def initialize(json)
+    def initialize(did, json)
+      raise FormatError, "Missing id field" if json['id'].nil?
+      raise FormatError, "Invalid id field" unless json['id'].is_a?(String)
+      raise FormatError, "id field doesn't match expected DID" unless json['id'] == did.to_s
+
+      @did = did
       @json = json
+
+      service = json['service']
+      raise FormatError, "Missing service key" if service.nil?
+      raise FormatError, "Invalid service data" unless service.is_a?(Array) && service.all? { |x| x.is_a?(Hash) }
+
+      if pds = service.detect { |x| x['id'] == '#atproto_pds' }
+        raise FormatError, "Missing PDS type" unless pds['type']
+        raise FormatError, "Invalid PDS type" unless pds['type'] == 'AtprotoPersonalDataServer'
+        raise FormatError, "Missing PDS endpoint" unless pds['serviceEndpoint']
+        raise FormatError, "Invalid PDS endpoint" unless pds['serviceEndpoint'].is_a?(String)
+        raise FormatError, "Invalid PDS endpoint" unless pds['serviceEndpoint'] =~ %r(://)
+
+        @pds_endpoint = pds['serviceEndpoint']
+      end
+
+      if aka = json['alsoKnownAs']
+        raise FormatError, "Invalid alsoKnownAs" unless aka.is_a?(Array)
+        raise FormatError, "Invalid alsoKnownAs" unless aka.all? { |x| x.is_a?(String) }
+        raise FormatError, "Invalid alsoKnownAs" unless aka.all? { |x| x =~ %r(\Aat://[^/]+\z) }
+
+        @handles = aka.map { |x| x.gsub('at://', '') }
+      else
+        @handles = []
+      end
     end
 
-    def pds_endpoint
-      service = (@json['service'] || []).detect { |s| s['id'] == '#atproto_pds' }
-      service && service['serviceEndpoint']
+    def get_validated_handle
+      Resolver.new.get_validated_handle(self)
     end
   end
 end

data/lib/didkit/resolver.rb

@@ -0,0 +1,82 @@
+require 'json'
+require 'open-uri'
+require 'net/http'
+require 'resolv'
+
+require_relative 'did'
+require_relative 'document'
+
+module DIDKit
+  class Resolver
+    def resolve_handle(handle)
+      domain = handle.gsub(/^@/, '')
+
+      if dns_did = resolve_handle_by_dns(domain)
+        DID.new(dns_did, :dns)
+      elsif http_did = resolve_handle_by_well_known(domain)
+        DID.new(http_did, :http)
+      else
+        nil
+      end
+    end
+
+    def resolve_handle_by_dns(domain)
+      dns_records = Resolv::DNS.open { |d| d.getresources("_atproto.#{domain}", Resolv::DNS::Resource::IN::TXT) }
+
+      if record = dns_records.first
+        if string = record.strings.first
+          if string =~ /^did\=(did\:\w+\:.*)$/
+            return $1
+          end
+        end
+      end
+
+      nil
+    end
+
+    def resolve_handle_by_well_known(domain)
+      url = URI("https://#{domain}/.well-known/atproto-did")
+
+      response = Net::HTTP.start(url.host, url.port, use_ssl: true, open_timeout: 10, read_timeout: 10) do |http|
+        request = Net::HTTP::Get.new(url)
+        http.request(request)
+      end
+
+      if response.is_a?(Net::HTTPSuccess)
+        if text = response.body
+          if text.lines.length == 1 && text.start_with?('did:')
+            return text
+          end
+        end
+      end
+
+      nil
+    rescue StandardError => e
+      nil
+    end
+
+    def resolve_did(did)
+      did = DID.new(did) if did.is_a?(String)
+
+      did.type == :plc ? resolve_did_plc(did) : resolve_did_web(did)
+    end
+
+    def resolve_did_plc(did)
+      url = "https://plc.directory/#{did}"
+      json = JSON.parse(URI.open(url).read)
+      Document.new(did, json)
+    end
+
+    def resolve_did_web(did)
+      url = "https://#{did.web_domain}/.well-known/did.json"
+      json = JSON.parse(URI.open(url).read)
+      Document.new(did, json)
+    end
+
+    def get_validated_handle(did_or_doc)
+      document = did_or_doc.is_a?(Document) ? did_or_doc : resolve_did(did_or_doc)
+
+      document.handles.detect { |h| resolve_handle(h) == document.did }
+    end
+  end
+end

data/lib/didkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DIDKit
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: didkit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-14 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -24,6 +24,7 @@ files:
 - lib/didkit/did.rb
 - lib/didkit/document.rb
 - lib/didkit/errors.rb
+- lib/didkit/resolver.rb
 - lib/didkit/version.rb
 - sig/didkit.rbs
 homepage: https://github.com/mackuba/didkit