i2p 0.1.4

data/lib/i2p/sam/client.rb

@@ -0,0 +1,226 @@
+module I2P; module SAM
+  ##
+  # **I2P Simple Anonymous Messaging (SAM) V3 client.**
+  #
+  # @example Connecting to the I2P SAM bridge (1)
+  #   sam = I2P::SAM::Client.new(:port => 7656)
+  #
+  # @example Connecting to the I2P SAM bridge (2)
+  #   I2P::SAM::Client.open(:port => 7656) do |sam|
+  #     ...
+  #   end
+  #
+  # @see http://www.i2p2.de/applications.html
+  # @see http://www.i2p2.de/samv3.html
+  class Client
+    ##
+    # Establishes a connection to the SAM bridge.
+    #
+    # @example Connecting to the default port
+    #   sam = I2P::SAM::Client.open
+    #
+    # @example Connecting to the given port
+    #   sam = I2P::SAM::Client.open(:port => 7656)
+    #
+    # @param  [Hash{Symbol => Object}] options
+    # @option options [String, #to_s]  :host    (DEFAULT_HOST)
+    # @option options [Integer, #to_i] :port    (DEFAULT_PORT)
+    # @option options [Integer, #to_i] :version (PROTOCOL_VERSION)
+    # @yield  [client]
+    # @yieldparam [Client] client
+    # @return [void]
+    def self.open(options = {}, &block)
+      client = self.new(options)
+      client.connect.hello # handshake
+
+      unless block_given?
+        client
+      else
+        begin
+          result = block.call(client)
+        ensure
+          client.disconnect
+        end
+        result
+      end
+    end
+
+    ##
+    # Returns the socket connection to the SAM bridge.
+    #
+    # @return [TCPSocket]
+    attr_reader :socket
+
+    ##
+    # Initializes a new client instance.
+    #
+    # @param  [Hash{Symbol => Object}] options
+    # @option options [String, #to_s]  :host    (DEFAULT_HOST)
+    # @option options [Integer, #to_i] :port    (DEFAULT_PORT)
+    # @option options [Integer, #to_i] :version (PROTOCOL_VERSION)
+    # @yield  [client]
+    # @yieldparam [Client] client
+    def initialize(options = {}, &block)
+      @options = options.dup
+      @host    = (@options.delete(:host)    || DEFAULT_HOST).to_s
+      @port    = (@options.delete(:port)    || DEFAULT_PORT).to_i
+      @version = (@options.delete(:version) || PROTOCOL_VERSION).to_i
+
+      block.call(self) if block_given?
+    end
+
+    ##
+    # Returns `true` if a connection to the SAM bridge has been established
+    # and is active.
+    #
+    # @example
+    #   sam.connected?             #=> true
+    #   sam.disconnect
+    #   sam.connected?             #=> false
+    #
+    # @return [Boolean]
+    def connected?
+      !!@socket
+    end
+
+    ##
+    # Establishes a connection to the SAM bridge.
+    #
+    # If called after the connection has already been established,
+    # disconnects and then reconnects to the bridge.
+    #
+    # @example
+    #   sam.connect
+    #
+    # @return [void]
+    def connect
+      disconnect if connected?
+      @socket = TCPSocket.new(@host, @port)
+      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+      self
+    end
+    alias_method :reconnect, :connect
+
+    ##
+    # Closes the connection to the SAM bridge.
+    #
+    # If called after the connection has already been closed, does nothing.
+    #
+    # @example
+    #   sam.disconnect
+    #
+    # @return [void]
+    def disconnect
+      @socket.close if @socket && !@socket.closed?
+      @socket = nil
+      self
+    end
+    alias_method :close, :disconnect
+
+    ##
+    # Performs the SAM protocol handshake and returns the autonegotiated
+    # protocol version.
+    #
+    # @example
+    #   sam.hello                            #=> 3.0
+    #
+    # @example
+    #   sam.hello(:min => 3.0, :max => 4.0)  #=> 3.0
+    #
+    # @param  [Hash{Symbol => Object}] options
+    # @option options [Float, #to_f]   :min (PROTOCOL_VERSION)
+    # @option options [Float, #to_f]   :max (PROTOCOL_VERSION)
+    # @return [Float]
+    # @raise  [ProtocolNotSupported] if the handshake failed
+    def hello(options = {})
+      send_msg(:hello, :version, {
+        :min => '%.1f' % (options[:min] || @version).to_f,
+        :max => '%.1f' % (options[:max] || @version).to_f,
+      })
+      read_reply[:version].to_f
+    end
+
+    ##
+    # Returns the I2P destination corresponding to `name`.
+    #
+    # @example
+    #   sam.lookup_name("forum.i2p")         #=> #<I2P::Destination:...>
+    #
+    # @param  [String, #to_s] name
+    # @return [Destination]
+    # @raise  [Error::KeyNotFound] if `name` was not found
+    def lookup_name(name)
+      send_msg(:naming, :lookup, :name => name.to_s)
+      Destination.parse(read_reply[:value])
+    end
+
+    ##
+    # Generates a new I2P destination and returns the key pair for it.
+    #
+    # @example
+    #   key_pair = sam.generate_dest
+    #
+    # @return [KeyPair]
+    def generate_dest
+      send_msg(:dest, :generate)
+      KeyPair.parse(read_reply[:priv])
+    end
+    alias_method :generate_destination, :generate_dest
+
+  protected
+
+    ##
+    # Sends a message to the SAM bridge.
+    #
+    # @param  [Symbol, #to_s]          noun
+    # @param  [Symbol, #to_s]          verb
+    # @param  [Hash{Symbol => Object}] options
+    # @return [void]
+    def send_msg(noun, verb, options = {})
+      msg = [noun.to_s.upcase, verb.to_s.upcase]
+      msg += options.map { |k, v| "#{k.to_s.upcase}=#{v}" } unless options.empty?
+      send_line(msg.join(' '))
+      self
+    end
+
+    ##
+    # Sends a text line over the SAM bridge socket.
+    #
+    # @param  [String, #to_s] line
+    # @return [void]
+    def send_line(line)
+      connect unless connected?
+      warn "-> #{line}" if @options[:debug]
+      @socket.write(line.to_s + "\n")
+      @socket.flush
+      self
+    end
+
+    ##
+    # Reads a reply line from the SAM bridge socket.
+    #
+    # @return [String]
+    def read_reply
+      reply = @socket.readline.chomp
+      warn "<- #{reply}" if @options[:debug]
+      case reply
+        when /^HELLO REPLY RESULT=OK VERSION=(\S*)/
+          {:version => $1}
+        when /^HELLO REPLY RESULT=NOVERSION/
+          raise Error::ProtocolNotSupported.new("SAM bridge does not support the requested protocol version")
+        when /^HELLO REPLY RESULT=I2P_ERROR MESSAGE="([^"]+)"/
+          raise Error.new($1.strip)
+        when /^NAMING REPLY RESULT=OK NAME=(\S+) VALUE=(\S+)/
+          {:name => $1, :value => $2}
+        when /^NAMING REPLY RESULT=INVALID_KEY NAME=(\S+)/
+          raise Error::KeyNotValid.new($1)
+        when /^NAMING REPLY RESULT=KEY_NOT_FOUND NAME=(\S+)/
+          raise Error::KeyNotFound.new($1)
+        when /^DEST REPLY PUB=(\S+) PRIV=(\S+)/
+          {:pub => $1, :priv => $2}
+        else
+          raise Error.new(reply)
+      end
+    end
+  end
+end; end

data/lib/i2p/sdk.rb

@@ -0,0 +1,111 @@
+require 'java'
+require 'i2p'
+require 'i2p.jar'
+
+module I2P
+  ##
+  # @since 0.1.3
+  module SDK
+    import 'net.i2p'
+    import 'net.i2p.client'
+    import 'net.i2p.client.datagram'
+    import 'net.i2p.client.naming'
+    import 'net.i2p.crypto'
+    import 'net.i2p.data'
+    import 'net.i2p.data.i2cp'
+    import 'net.i2p.stat'
+    import 'net.i2p.time'
+    import 'net.i2p.util'
+  end
+end
+
+class I2P::Certificate
+  ##
+  # Returns an instance of the Java class `net.i2p.data.Certificate`.
+  #
+  # **This method only works with JRuby, not with MRI or YARV.**
+  #
+  # @return [Object]
+  # @see    http://docs.i2p2.de/core/net/i2p/data/Certificate.html
+  def to_java
+    I2P::SDK::Certificate.new(type.to_i, payload.to_s.to_java_bytes)
+  end
+end
+
+class I2P::PrivateKey
+  ##
+  # Returns an instance of the Java class `net.i2p.data.PrivateKey`.
+  #
+  # **This method only works with JRuby, not with MRI or YARV.**
+  #
+  # @return [Object]
+  # @see    http://docs.i2p2.de/core/net/i2p/data/PrivateKey.html
+  def to_java
+    I2P::SDK::PrivateKey.new(to_s.to_java_bytes)
+  end
+end
+
+class I2P::SigningPrivateKey
+  ##
+  # Returns an instance of the Java class `net.i2p.data.SigningPrivateKey`.
+  #
+  # **This method only works with JRuby, not with MRI or YARV.**
+  #
+  # @return [Object]
+  # @see    http://docs.i2p2.de/core/net/i2p/data/SigningPrivateKey.html
+  def to_java
+    I2P::SDK::SigningPrivateKey.new(to_s.to_java_bytes)
+  end
+end
+
+class I2P::PublicKey
+  ##
+  # Returns an instance of the Java class `net.i2p.data.PublicKey`.
+  #
+  # **This method only works with JRuby, not with MRI or YARV.**
+  #
+  # @return [Object]
+  # @see    http://docs.i2p2.de/core/net/i2p/data/PublicKey.html
+  def to_java
+    I2P::SDK::PublicKey.new(to_s.to_java_bytes)
+  end
+end
+
+class I2P::SigningPublicKey
+  ##
+  # Returns an instance of the Java class `net.i2p.data.SigningPublicKey`.
+  #
+  # **This method only works with JRuby, not with MRI or YARV.**
+  #
+  # @return [Object]
+  # @see    http://docs.i2p2.de/core/net/i2p/data/SigningPublicKey.html
+  def to_java
+    I2P::SDK::SigningPublicKey.new(to_s.to_java_bytes)
+  end
+end
+
+class I2P::Destination
+  ##
+  # Returns an instance of the Java class `net.i2p.data.Destination`.
+  #
+  # **This method only works with JRuby, not with MRI or YARV.**
+  #
+  # @return [Object]
+  # @see    http://docs.i2p2.de/core/net/i2p/data/Destination.html
+  def to_java
+    I2P::SDK::Destination.new(to_base64)
+  end
+end
+
+class I2P::KeyPair
+  ##
+  # Returns an instance of the Java class `net.i2p.data.PrivateKeyFile`.
+  #
+  # **This method only works with JRuby, not with MRI or YARV.**
+  #
+  # @return [Object]
+  # @see    http://docs.i2p2.de/core/net/i2p/data/PrivateKeyFile.html
+  def to_java
+    raise NotImplementedError.new("#{self.class}#to_java") # TODO
+  end
+end

data/lib/i2p/streaming.rb

@@ -0,0 +1,10 @@
+require 'i2p/sdk'
+require 'i2p/streaming.jar'
+
+module I2P
+  ##
+  # @since 0.1.3
+  module Streaming
+    import 'net.i2p.client.streaming'
+  end
+end

data/lib/i2p/version.rb

@@ -0,0 +1,22 @@
+module I2P
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 4
+    EXTRA = nil
+
+    STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')
+
+    ##
+    # @return [String]
+    def self.to_s() STRING end
+
+    ##
+    # @return [String]
+    def self.to_str() STRING end
+
+    ##
+    # @return [Array(Integer, Integer, Integer)]
+    def self.to_a() [MAJOR, MINOR, TINY] end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: i2p
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 4
+  version: 0.1.4
+platform: ruby
+authors: 
+- Arto Bendiken
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-07 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 8
+        version: 0.5.8
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+description: I2P.rb is a Ruby library for interacting with the I2P anonymity network.
+email: i2p@i2p.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- AUTHORS
+- CONTRIBUTORS
+- README
+- UNLICENSE
+- VERSION
+- lib/i2p/bob/client.rb
+- lib/i2p/bob/tunnel.rb
+- lib/i2p/bob.rb
+- lib/i2p/data/certificate.rb
+- lib/i2p/data/destination.rb
+- lib/i2p/data/key.rb
+- lib/i2p/data/key_pair.rb
+- lib/i2p/data/private_key.rb
+- lib/i2p/data/public_key.rb
+- lib/i2p/data/signing_private_key.rb
+- lib/i2p/data/signing_public_key.rb
+- lib/i2p/data/structure.rb
+- lib/i2p/hosts.rb
+- lib/i2p/sam/client.rb
+- lib/i2p/sam.rb
+- lib/i2p/sdk.rb
+- lib/i2p/streaming.rb
+- lib/i2p/version.rb
+- lib/i2p.rb
+- lib/i2p/sdk.jar
+- lib/i2p/streaming.jar
+has_rdoc: false
+homepage: http://cypherpunk.rubyforge.org/i2p/
+licenses: 
+- Public Domain
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 1
+      version: 1.8.1
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- I2P (>= 0.8)
+rubyforge_project: cypherpunk
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Anonymous networking for Ruby.
+test_files: []
+