tsclient 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6648c361899812cae382d7837f53a701fe96ad5c88e65055d6456d9b06e89a9
-  data.tar.gz: 58876bfffa730a35895524b3ddaae3c466f12d7577c2793d3d75b151705170ef
+  metadata.gz: f2a91d5b540777dd21e95c45f79ae5b629f88dfeb5b145a896eff8de50db605e
+  data.tar.gz: c9432bed5af0ec0d1326f95ebf2a3c8867e348ae8ee628a96bd321cd5224640a
 SHA512:
-  metadata.gz: dc32b3da4cc1c722badaae4af2bfab56a22e3d10eff089b7c023a6fd5944b866bc8e7c772e9cfcce0aa380759be50cf3d5769592a7bcc7a3e487492fbd76674b
-  data.tar.gz: 66205c34e15b3d97c3359da0ee87ad571830b0d87e05f1b805b813548bbb3a822625379ed4f3fd6778f18eb156ef0b701bd9e70a20ebea7c45efe4e6fcbe1607
+  metadata.gz: 13782f6c026d88bdf0b56cf983d9cbddd958c44b1536b22bce160f9b3090d024f7cc944b6a9b6792c8ab7366ef71a272afac5789539d57e48ac13247bda32cfd
+  data.tar.gz: 68cf7399a04a5e25a19a9332a9ba5bcde917f9ca1a97d58f8e729f3b78968e91ac0e211a7297aa3aa3b13696a2994c26ee1787697821e03d0e45c7d45495256d

data/CHANGELOG.md

@@ -16,6 +16,12 @@ All notable changes to this project will be documented below. The format is base
 
 ## [Unreleased]
 
+## [0.1.0] - 2022-10-22
+
+- Added: Client can query whois a remote address
+- Added: Client can query current tailscale IPs
+- Added: `Tsclient.default_client` works on macOS
+
 ## [0.0.1] - 2022-10-20
 
 - Added: Initial release

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    tsclient (0.0.1)
+    tsclient (0.1.0)
+      json
+      values (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
@@ -36,9 +38,10 @@ GEM
       rubocop (= 1.35.1)
       rubocop-performance (= 1.14.3)
     unicode-display_width (2.3.0)
+    values (1.8.0)
 
 PLATFORMS
-  arm64-darwin-21
+  ruby
 
 DEPENDENCIES
   minitest

data/README.md

@@ -18,7 +18,15 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO.
+```ruby
+client = Tsclient.default_client
+
+client.tailscale_ips
+# => ["100.100.100.1", "fd7a:115c:a1e0::1"]
+
+client.whois "100.100.100.1"
+# => => #<Tsclient::Profile identifier="bob.bobbity@example.com", name="Bob Bobbity", profile_pic_url="www.google.com/images/errors/robot.png", human=true>
+```
 
 ## Development
 

data/Rakefile

@@ -11,4 +11,4 @@ end
 
 require "standard/rake"
 
-task default: %i[test standard]
+task default: %i[standard spec]

data/lib/tsclient/client.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+require_relative "./result"
+require_relative "./profile"
+
+module Tsclient
+  class Client
+    def initialize(uri:)
+      @api_uri = uri.freeze
+      freeze
+    end
+
+    def tailscale_ips
+      api_get(:status).result.dig("TailscaleIPs")
+    end
+
+    def whois(addr)
+      unless addr.include?(":")
+        addr += ":80"
+      end
+      response = api_get(:whois, addr: addr)
+      if response.error?
+        nil
+      else
+        Profile.from(response.result)
+      end
+    end
+
+    private
+
+    def api_get(endpoint, params = {})
+      case @api_uri.scheme
+      when "http", "https"
+        # All we actually need is the port & password, but expect well formed URI to be passed in
+        Net::HTTP.start(@api_uri.host, @api_uri.port, use_ssl: (@api_uri.scheme == "https")) do |http|
+          req = Net::HTTP::Get.new("/localapi/v0/#{endpoint}?#{params.map { |k, v| "#{k}=#{v}" }.join("&")}")
+          req.basic_auth "", @api_uri.password
+          req.content_type = "application/json"
+          res = http.request(req)
+          case res
+          when Net::HTTPOK
+            Result.with(error: false, result: JSON.parse(res.body))
+          when Net::HTTPNotFound
+            Result.with(error: true, result: res)
+          end
+        end
+      when "unix"
+        raise NotImplemented, "unix socket not implemented"
+      else
+        raise "Can't handle api uri with scheme #{@api_uri.scheme.inspect}"
+      end
+    end
+  end
+end

data/lib/tsclient/profile.rb

@@ -0,0 +1,19 @@
+require "values"
+
+module Tsclient
+  class Profile < Value.new(:identifier, :name, :profile_pic_url, :human)
+    def self.from(data)
+      with(
+        identifier: data.dig("UserProfile", "LoginName"),
+        name: data.dig("UserProfile", "DisplayName"),
+        profile_pic_url: data.dig("UserProfile", "ProfilePicURL"),
+        # We assume anyone with an email address as their SSO identifier is human
+        human: data.dig("UserProfile", "LoginName").include?("@")
+      )
+    end
+
+    def human?
+      human
+    end
+  end
+end

data/lib/tsclient/result.rb

@@ -0,0 +1,9 @@
+require "values"
+
+module Tsclient
+  class Result < Value.new(:error, :result)
+    def error?
+      error
+    end
+  end
+end

data/lib/tsclient/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tsclient
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/tsclient.rb

@@ -1,6 +1,26 @@
 # frozen_string_literal: true
 
-require_relative "tsclient/version"
+require_relative "tsclient/client"
 
 module Tsclient
+  def self.default_client
+    return @default_client if defined?(@default_client)
+
+    # Attempt to setup the default client from various known strategies
+    # Envariables override everything
+    uri = if ENV.key?("TS_LOCALAPI_PORT")
+      URI("http://:#{ENV["TS_LOCALAPI_KEY"]}@localhost:#{ENV["TS_LOCALAPI_PORT"]}")
+
+    # Running on macOS, need to find api deets from filesystem
+    elsif RUBY_PLATFORM["darwin"]
+      tsfile = Pathname.glob("#{ENV["HOME"]}/Library/Group Containers/*.io.tailscale.ipn.macos/sameuserproof-*-*").first
+      _, port, password = tsfile.basename.to_s.split("-", 3)
+      URI("http://:#{password}@localhost:#{port}")
+    # Throw our hands in the air, we just don't ~~care~~ know
+    else
+      raise NotImplemented, "Can't figure out where localapi is"
+    end
+
+    @default_client = Client.new(uri: uri)
+  end
 end

data/tsclient.gemspec

@@ -31,6 +31,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "json"
+  spec.add_dependency "values", "~> 1.8"
+
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "standard", "~> 1.3"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tsclient
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Caius Durling
@@ -10,6 +10,34 @@ bindir: exe
 cert_chain: []
 date: 2022-10-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  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: values
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +96,9 @@ files:
 - README.md
 - Rakefile
 - lib/tsclient.rb
+- lib/tsclient/client.rb
+- lib/tsclient/profile.rb
+- lib/tsclient/result.rb
 - lib/tsclient/version.rb
 - sig/tsclient.rbs
 - tsclient.gemspec