zwiebel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ed9636194670d3f271d7617a51d3da0dfaf2b224a8eb3e6046af41eebfdd6ba
-  data.tar.gz: ceccaf9cfe454e4f3cddd6d46698163353337db81ab31d05b61a14ccfd85b5be
+  metadata.gz: d20ac52d5ea64e997b8e609b6a45a695cee8603062060a129dd281e9eec1253c
+  data.tar.gz: 280ec7ab0310cfca61988e163b3b8fbdebb64d00fa216eb5904d6c948283d422
 SHA512:
-  metadata.gz: 8906bafe70a0cf0f1314d0a05e0a5afc7ebf9674b0a0f310ea5c55ac20c34895b0048c0a09b08ca87b9259c44ff79995fa5788bb8e67ca817d04166a980ab327
-  data.tar.gz: 89af7bf58f4f9a03c00666d04b3503d3460fe6657dd895af2b1878c7314ef8916a8b3029c508885f97f8865924a841a632092c8269d81a39467a0aefe5172a08
+  metadata.gz: bfc8f8480cd958c4eef39bab377bfb6ae5019c461cc53285f06075ca618899e4dfbb69cc7bf1576b05b39e7a8995b8ebf33eb7824b2cde37aadb786415abf616
+  data.tar.gz: 04c5f00b8fe9a4725b8030464f34654777d64d44d142aa7e81dc6634bbc44aae67534e755e0fd94885b09e251ebdbef26e58c969f9282a09600a1790ed024579

data/lib/zwiebel/control.rb

@@ -0,0 +1,81 @@
+# Copyright 2023, Kurt Meyerhofer
+# This file is part of zwiebel.
+
+# zwiebel is free software: you can redistribute it and/or modify it under the terms of
+# the GNU Lesser General Public License as published by the Free Software Foundation,
+# either version 3 of the License, or (at your option) any later version.
+
+# zwiebel is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
+# more details.
+
+# You should have received a copy of the GNU Lesser General Public License along with zwiebel.
+# If not, see <https://www.gnu.org/licenses/>.
+
+module Zwiebel
+  class Control
+    attr_accessor :cookie, :host, :port
+
+    def initialize(host: "127.0.0.1", port: 9051, cookie: nil)
+      @host = host
+      @port = port
+      @cookie = cookie
+      connect
+    end
+
+    def connect
+      close
+      @socket = TCPSocket.new(host, port)
+      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+    end
+
+    def connected?
+      !@socket.nil?
+    end
+
+    def close
+      @socket.close unless @socket.nil?
+      @authenticated = false
+      @socket = nil
+    end
+
+    def quit
+      send_line("QUIT")
+      reply = read_reply
+      close
+      reply
+    end
+
+    def authenticate
+      send_line(@cookie ? "AUTHENTICATE #{cookie}" : "AUTHENTICATE")
+      reply = read_reply
+      @authenticated = reply == "250 OK"
+    end
+
+    def authenticated?
+      !!@authenticated
+    end
+
+    def version
+      send_command("GETINFO", "version")
+      reply = read_reply.split("=").last
+      read_reply
+      reply
+    end
+
+    def send_command(command, *args)
+      authenticate unless authenticated?
+      send_line([command, *args].join(" "))
+    end
+
+    def send_line(line)
+      @socket.write("#{line}\r\n")
+      @socket.flush
+    end
+
+    def read_reply
+      @socket.readline.chomp
+    end
+  end
+end

data/lib/zwiebel/version.rb

@@ -1,3 +1,3 @@
 module Zwiebel
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/zwiebel.rb

@@ -1,2 +1,60 @@
+# Copyright 2023, Kurt Meyerhofer
+# This file is part of zwiebel.
+
+# zwiebel is free software: you can redistribute it and/or modify it under the terms of
+# the GNU Lesser General Public License as published by the Free Software Foundation,
+# either version 3 of the License, or (at your option) any later version.
+
+# zwiebel is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
+# more details.
+
+# You should have received a copy of the GNU Lesser General Public License along with zwiebel.
+# If not, see <https://www.gnu.org/licenses/>.
+
+require "base32"
+require_relative "zwiebel/control"
+require_relative "zwiebel/version"
+
 module Zwiebel
+
+  def self.v3_address_valid?(address)
+    # tor address-spec
+    # onion_address = base32(PUBKEY | CHECKSUM | VERSION)
+    #  CHECKSUM = H(".onion checksum" | PUBKEY | VERSION)[:2]
+
+    #  where:
+    #    - PUBKEY is the 32 bytes ed25519 master pubkey of the onion service.
+    #    - VERSION is a one byte version field (default value '\x03')
+    #    - ".onion checksum" is a constant string
+    #    - H is SHA3-256
+    #    - CHECKSUM is truncated to two bytes before inserting it in onion_address
+
+    return false unless address.end_with?(".onion") && address.length == 62
+
+    decoded_address = Base32.decode(address.gsub(".onion", "").upcase)
+    pubkey = decoded_address.byteslice(0, 32)
+    checksum = decoded_address.byteslice(32, 2)
+    version = decoded_address.byteslice(34)
+
+    onion_checksum = ".onion checksum"
+    calculated_checksum = onion_checksum + pubkey + version
+
+    digest = OpenSSL::Digest.digest("SHA3-256", calculated_checksum)
+    checksum_truncated = digest.byteslice(0, 2)
+
+    checksum_truncated == checksum
+  end
+
+  def self.cookie_file_hash(file_path:)
+    if !File.exist?(file_path)
+      raise StandardError "cookie file not present"
+    elsif !File.readable?(file_path)
+      raise StandardError "not permitted to read cookie file"
+    else
+      data = IO.binread(file_path)
+      data.unpack("H*")[0]
+    end
+  end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: zwiebel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kurt Meyerhofer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-04 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
 description: zwiebel is a Tor network hidden service connector for version 3 .onion
   addresses.
 email:
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/zwiebel.rb
+- lib/zwiebel/control.rb
 - lib/zwiebel/version.rb
 homepage: https://github.com/kmeyerhofer/zwiebel
 licenses: