syndi 0.0.1 → 0.1.0

data/lib/syndi/irc/protocol.rb

@@ -0,0 +1,164 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'syndi/irc/protocol/numerics'
+
+# namespace Syndi
+module Syndi
+
+  # namespace IRC
+  module IRC
+    syndiload :SASL, 'syndi/irc/sasl/mech'
+
+    # A class for parsing of data per the specifications of the IRC protocol,
+    # v3.1.
+    #
+    # @see http://tools.ietf.org/html/rfc1459
+    # @see http://ircv3.atheme.org/
+    #
+    # @since 4.0.0
+    class Protocol
+
+      # Construct a new IRC data parser.
+      #
+      # @param [Syndi::IRC::Library] lib The IRC library instance.
+      def initialize lib
+        extend Syndi::IRC::Protocol::Numerics
+        lib.events.on :receive, &method(:parse)
+      end
+        
+      # Parse IRC data.
+      #
+      # @param [Syndi::IRC::Server] irc The IRC connection.
+      # @param [String] raw The data received.
+      def parse irc, raw
+          
+        params  = raw.split(/\s+/)
+        command = (raw =~ /^:/ ? params[1] : params[0]).dc
+
+        # Check if we process this command.
+        if respond_to? "on_#{command}"
+          send("on_#{command}", irc, raw, params)
+        end
+
+      end
+
+      # AUTHENTICATE
+      #
+      # @param [Syndi::IRC::Server] irc The IRC connection.
+      # @param [String] raw The data received.
+      # @param [Array<String>] params The data received divided by +\s+ through
+      #   regexp.
+      def on_authenticate irc, raw, params
+        username = $m.conf['irc'][irc.s]['SASL']['username']
+        password = $m.conf['irc'][irc.s]['SASL']['password']
+        
+        if irc.supp.sasl_method    == :dh_blowfish
+          crypt = Syndi::IRC::SASL::Mech::DHBlowfish.encrypt(username, password, params.last)
+        elsif irc.supp.sasl_method == :plain
+          crypt = Syndi::IRC::SASL::Mech::Plain.encrypt(username, password, params.last)
+        end
+
+        while crypt.length >= 400
+          irc.snd "AUTHENTICATE #{crypt.slice!(0, 400)}"
+        end
+
+        if crypt.length > 0
+          irc.snd "AUTHENTICATE #{crypt}"
+        else
+          irc.snd('AUTHENTICATE +')
+        end
+        # And we're done!
+      end
+        
+      # CAP
+      #
+      # @param [Syndi::IRC::Server] irc The IRC connection.
+      # @param [String] raw The data received.
+      # @param [Array<String>] params The data received divided by +\s+ through
+      #   regexp.
+      def on_cap irc, raw, params
+        case params[3]
+
+        when 'LS'
+          params[4].gsub!(/^:/, '')
+          cap_ls(irc, params[4..-1])
+        when 'ACK'
+          params[4].gsub!(/^:/, '')
+          cap_ack(irc, params[4..-1])
+        end
+      end
+
+      # PING
+      #
+      # Return a PONG.
+      #
+      # @param [Syndi::IRC::Server] irc The IRC connection.
+      # @param [String] raw The data received.
+      # @param [Array<String>] params The data received divided by +\s+ through
+      #   regexp.
+      def on_ping irc, raw, params
+        irc.snd("PONG #{params[1]}")
+      end
+
+      #######
+      private
+      #######
+
+      # CAP LS
+      #  
+      # Currently, Syndi's capabilities include the multi-prefix, sasl,
+      # account-notify, away-notify, and extended-join extensions.
+      #
+      # @param [Syndi::IRC::Server] irc The IRC connection.
+      # @param [Array<String>] list List of capabilities.
+      def cap_ls irc, list
+
+        req = []
+          
+        # Every extension possible will be used except SASL, which requires
+        # special configuration.
+        %w[multi-prefix account-notify away-notify extended-join].each do |ext|
+          req.push ext if list.include? ext
+        end
+
+        if $m.conf['irc'][irc.s]['SASL'] and list.include? 'sasl'
+          req.push 'sasl'
+        end
+
+        # Send CAP REQ.
+        irc.snd("CAP REQ :#{req.join(' ')}") unless req.empty?
+
+      end
+      
+      # CAP ACK
+      #
+      # We must save all capabilities into +irc.supp.cap+, and initiate SASL
+      # if possible.
+      #
+      # @param [Syndi::IRC::Server] irc The IRC connection.
+      # @param [Array<String>] list List of capabilities.
+      def cap_ack irc, list
+
+        irc.supp.cap = list
+          
+        if list.include? 'sasl'
+          irc.supp.sasl_id << $m.clock.spawn($m.conf['irc'][irc.s]['SASL']['timeout']||10, :once, irc) do |s|
+            $m.error "SASL authentication on #{s} failed: authentication procedure timed out."
+            s.snd('AUTHENTICATE *')
+            s.cap_end
+          end
+          irc.authenticate :dh_blowfish
+        else
+          irc.snd('CAP END') # end capability negotiation and complete registration
+        end
+
+      end
+
+    end # class Protocol
+
+  end # module IRC
+
+end # module Syndi
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/irc/sasl/diffie_hellman.rb

@@ -0,0 +1,36 @@
+# This code exists in the public domain.
+
+class DiffieHellman
+  
+  attr_reader :p, :g, :q, :x, :e
+
+  # p is the prime, g the generator and q order of the subgroup
+  def initialize p, g, q
+    @p = p
+    @g = g
+    @q = q
+  end
+
+  # generate the [secret] random value and the public key
+  def generate tries=16
+    tries.times do
+      @x = rand(@q)
+      @e = self.g.mod_exp(@x, self.p)
+      return @e if self.valid?
+    end
+    raise ArgumentError, "can't generate valid e"
+  end
+
+  # validate a public key
+  def valid?(_e = self.e)
+    _e and _e.between?(2, self.p-2) and _e.bits_set > 1
+  end
+
+  # compute the shared secret, given the public key
+  def secret f
+    f.mod_exp(self.x, self.p)
+  end
+
+end
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/irc/sasl/mech/dh_blowfish.rb

@@ -0,0 +1,83 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'base64'
+require 'openssl'
+require 'libsyndi'
+require 'syndi/irc/sasl/diffie_hellman'
+
+module Syndi
+
+  module IRC
+  
+    module SASL
+
+      module Mech
+
+        # Module which implements the SASL DH-BLOWFISH mechanism.
+        # @author noxgirl
+        module DHBlowfish
+
+          # Create an SASL-encrypted hash.
+          #
+          # @param [String] username The username.
+          # @param [String] password The password associated with the username.
+          # @param [String] provision The key provided by the server.
+          def self.encrypt username, password, provision
+            # This is a fairly complex process. Duplicate +username+ and
+            # +password+ for safety.
+            user = username.dup
+            pass = password.dup
+
+            # Decode the key from base64.
+            key = Base64.decode64(provision).force_encoding('ASCII-8BIT')
+
+            # Unpack it.
+            p, g, y = unpack_key key
+
+            dh     = DiffieHellman.new(p, g, 23)
+            pkey   = dh.generate
+            secret = OpenSSL::BN.new(dh.secret(y).to_s).to_s(2)
+            pub    = OpenSSL::BN.new(pkey.to_s).to_s(2)
+
+            pass.concat "\0"
+            pass.concat('.' * (8 - (password.size % 8)))
+
+            cipher         = OpenSSL::Cipher::Cipher.new 'BF-ECB'
+            cipher.key_len = 32
+            cipher.encrypt
+            cipher.key     = secret
+
+            enc    = cipher.update(pass).to_s
+            answer = [pub.bytesize, pub, user, enc].pack('na*Z*a*')
+
+            Base64.strict_encode64(answer) # finally, return the hash
+          end
+
+          # @return [Array(Numeric, Numeric, Numeric)] +p+, +g+, and +y+ for
+          #   Diffie-Hellman key exchange
+          def self.unpack_key key
+            key = key.dup
+            pgy = []
+
+            3.times do
+              size = key.unpack('n').first
+              key.slice! 0, 2
+              pgy << key.unpack("a#{size}").first
+              key.slice!(0, size)
+            end
+            
+            pgy.map { |int| OpenSSL::BN.new(int, 2).to_i }
+          end
+
+        end # module DHBlowfish
+
+      end # module Mech
+
+    end # module SASL
+
+  end # module IRC
+
+end # module Syndi
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/irc/sasl/mech/plain.rb

@@ -0,0 +1,39 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'base64'
+
+module Syndi
+
+  module IRC
+  
+    module SASL
+
+      module Mech
+
+        # Module which implements the SASL PLAIN mechanism.
+        module Plain
+
+          # Create an SASL-encrypted hash.
+          #
+          # @author noxgirl
+          #
+          # @param [String] username The username.
+          # @param [String] password The password associated with the username.
+          # @param [String] provision The key provided by the server.
+          def self.encrypt username, password, provision
+            # Easy as this:
+            Base64.encode64([username, username, password].join("\0")).gsub(/\n/, '')
+          end
+
+        end # module Plain
+
+      end # module Mech
+
+    end # module SASL
+
+  end # module IRC
+
+end # module Syndi
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/irc/sasl/mech.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+module Syndi
+  module IRC
+    module SASL
+      module Mech
+        syndiload :DHBlowfish, 'syndi/irc/sasl/mech/dh_blowfish'
+        syndiload :Plain,      'syndi/irc/sasl/mech/plain'
+      end
+    end
+  end
+end
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/irc/server.rb

@@ -0,0 +1,301 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+require 'ostruct'
+require 'socket'
+require 'openssl'
+require 'thread'
+require 'syndi/dsl/base'
+require 'syndi/irc/state/support'
+require 'syndi/irc/std/commands'
+
+# namespace Syndi
+module Syndi
+
+  # Entering namespace: IRC
+  module IRC
+
+    # A class which maintains a connection to an IRC server and provides a highly
+    # usable interface for the IRC server.
+    #
+    # @api IRC
+    # @since 4.0.0
+    # @author noxgirl
+    #
+    # @!attribute [r] socket
+    #   @return [TCPSocket] The TCP socket being used for the connection.
+    #
+    # @!attribute [r] in
+    #   @return [Integer] The number of bytes received from the socket.
+    #
+    # @!attribute [r] out
+    #   @return [Integer] The number of bytes sent to the socket.
+    #
+    # @!attribute [r] type
+    #   @return [Symbol] +:irc+
+    #
+    # @!attribute [r] supp
+    #   @return [Syndi::IRC::State::Support] The IRCd capabilities.
+    #
+    # @!attribute name
+    #   @return [String] The name of the server as specified by configuration.
+    #
+    # @!attribute address
+    #   @return [String] The address used to connect to the server.
+    #
+    # @!attribute port
+    #   @return [Integer] The port used to connect to the server
+    #
+    # @!attribute nick
+    #   @return [String] The nickname of the bot on the server.
+    #
+    # @!attribute user
+    #   @return [String] The username of the bot on the server.
+    #
+    # @!attribute real
+    #   @return [String] The real name or GECOS of the bot on the server.
+    #
+    # @!attribute password
+    #   @return [String] If needed, the password used to connect to the server
+    #   @return [nil] If not needed.
+    #
+    # @!attribute bind
+    #   @return [String] If desired, the address to which to bind for this socket
+    #   @return [nil] If not desired.
+    #   @note This appears to be unused at the moment.
+    #
+    # @!attribute ssl
+    #   @return [true, false] If SSL should [not] be used for the connection.
+    #
+    # @!attribute sasl_id
+    #   @return [String] If SASL is desired, the username with which to authenticate.
+    #   @return [nil] If not used.
+    #   @note This is seemingly deprecated?
+    #
+    # @!attribute connected
+    #   @return [true, false] Whether or not we are connected to the server.
+    #
+    # @!attribute mask
+    #   @return [String] The bot's own hostname or mask on the IRC server.
+    #
+    # @!attribute recvq
+    #   @return [Array<String>] The socket's receive queue, which is comprised of an array
+    #     of strings which are pending processing.
+    #
+    #
+    #  @!attribute prefixes
+    #   @return [Hash{String => String}] The IRC server's supported prefixes, with the key being
+    #     the channel mode which represents the prefix, and the value being the prefix.
+    #
+    # @!attribute channel_modes
+    #   @return [Hash{Symbol => Array<String>}] The IRC server's supported channel modes, divided as thus:
+    #
+    #     - +:list+   = A list of modes which add/remove a nickname or mask from a channel list, such as ops and bans.
+    #     - +:always+ = A llst of modes which change a channel setting, and always have a parameter.
+    #     - +:set+    = A list of modes which change a channel setting, and which have a parameter only when set.
+    #     - +:never+ = A list of modes which change a channel setting, and which never have a parameter.
+    #
+    # @!attribute max_modes
+    #   @return [Integer] The maximum number of mode changes which may be specified in a /MODE query.
+    #
+    # @!attribute await_self_who
+    #   @return [true, false] Whether or not we are awaiting for a response to a /WHO on ourselves.
+    #
+    # @!attribute channels
+    #   @return [Hash{String => IRC::Object::Channel}] A list of channels in which we reside,
+    #     with each key being the channel's name in all-lowercase, and the respective values
+    #     being of {IRC::Object::Channel IRC::Object::Channel}.
+    #
+    # @!attribute users
+    #   @return [Hash{String => IRC::Object::User}] A list of users who are known to us,
+    #     with each key being the user's nickname in all-lowercase, and the respective values
+    #     being of {IRC::Object::User IRC::Object::User}.
+    class Server
+      include Syndi::DSL::Base
+
+      attr_reader   :socket, :in, :out, :type, :supp
+      attr_accessor :name, :address, :port, :nick, :user, :real, :password,
+                    :bind, :ssl, :connected, :chans, :users
+
+      # Produce a new instance of {Syndi::IRC::Server}.
+      #
+      # @param [String] name The name of the server to which we should connect.
+      #
+      # @yieldparam [Syndi::IRC::Server] c This instance, intended for configuration of the
+      #   attributes.
+      #
+      # Configuration attributes are +address+, +port+, +nick+, +user+, +real+,
+      # +password+, +bind+, and +ssl+.
+      #
+      #
+      # @example
+      #   irc = Syndi::IRC::Server.new('Freenode') do |c|
+      #     c.address = 'irc.freenode.net'
+      #     c.port    = 7000
+      #     c.nick    = 'cowmoon'
+      #     c.user    = 'foo1'
+      #     c.real    = "The night is lovely."
+      #     c.bind    = 'localhost'
+      #     c.ssl     = true
+      #   end
+      def initialize(name)
+      
+        # Prepare attributes.
+        @name     = name
+        @address  = nil
+        @port     = nil
+        @nick     = nil
+        @user     = nil
+        @real     = nil
+        @password = nil
+        @bind     = nil
+        @ssl      = false
+
+        # Yield for configuration.
+        yield(self) if block_given? or raise ArgumentError, "Server #{name} unable to initialize because it was not configured."
+
+        # Additional instance attributes.
+        @in         = 0
+        @out        = 0
+        @socket     = nil
+        @connected  = false
+        @type       = :irc
+
+        # Pull in commands.
+        extend   Syndi::IRC::Std::Commands
+        # State managers.
+        @supp  = Syndi::IRC::State::Support.new
+        @chans = nil
+        @users = nil
+
+        # Our receive queue remainder.
+        @recv_rem = nil
+
+        # Mutual exclusion for thread safety.
+        @lock = Mutex.new
+
+      end
+
+      # Establish (or attempt to) a connection with the server.
+      def connect
+
+        # Check for missing attributes.
+        begin
+          attribute_check
+        rescue => e
+          $m.error("Cannot connect to server #@name: #{e}", false, e.backtrace)
+        end
+
+        $m.info("Connecting to #@name @ #@address:#@port...")
+
+        # Create a new socket.
+        begin
+          socket = TCPSocket.new(@address, @port, @bind)
+        rescue => e
+          $m.error("Failed to connect to server #@name: #{e}", false, e.backtrace)
+          raise
+        end
+
+        # Wrap it in SSL if told to.
+        if ssl
+          begin
+            socket = OpenSSL::SSL::SSLSocket.new(socket)
+            socket.connect
+          rescue => e
+            $m.error("Failed to connect to server #@name: #{e}", false, e.backtrace)
+            raise
+          end
+        end
+
+        @socket = socket
+
+        # Register.
+        emit :irc, :preconnect, self
+        pass @password if @password
+        snd 'CAP LS'
+        self.nickname = @nick
+        user @user, Socket.gethostname, @address, @real
+
+      end
+
+      # Send data to the socket.
+      #
+      # @param [String] data The string of data, which should not exceed 512 in length.
+      def snd data
+        $m.foreground("{irc-send} #@name << #{data}")
+        @socket.write("#{data}\r\n")
+        @out += "#{data}\r\n".length
+      end
+
+      # Receive data from the socket, and push it into the recvQ.
+      def recv
+
+        # Thread safety.
+        @lock.synchronize do
+        
+          if @socket.nil? or @socket.eof?
+            return
+          end
+
+          # Read the data.
+          data = @socket.sysread(1024)
+          # Increase in.
+          @in += data.length
+      
+          # Split the data.
+          recv = []
+          until data !~ /\r\n/
+            line, data = data.split(/(?<=\r\n)/, 2)
+            recv.push line.chomp "\r\n"
+          end
+
+          # Check if there's a remainder in the recvQ.
+          if @recv_rem != ''
+            recv[0] = "#@recv_rem#{recv[0]}"
+            @recv_rem = ''
+          end
+          @recv_rem = data if data != ''
+
+          # Lastly, sent the data out
+          recv.each do |dline|
+            $m.foreground("{irc-recv} #@name >> #{dline}")
+            emit :irc, :receive, self, dline # send it out to :receive
+          end
+        
+        end
+
+      end
+
+      def to_s;    @name; end
+      def inspect; "#<Syndi::IRC::Server: name='#@name'>"; end
+      alias_method :s, :to_s
+
+      #######
+      private
+      #######
+
+      # Check the presence of all attributes.
+      def attribute_check
+        raise(ConfigError, "Missing server address")  unless @address
+        raise(ConfigError, "Missing server port")     unless @port
+        raise(ConfigError, "Missing nickname to use") unless @nick
+        raise(ConfigError, "Missing username to use") unless @user
+        raise(ConfigError, "Missing realname to use") unless @real
+      end
+
+      # Check if we are connected.
+      #
+      # @return [true, false]
+      def connected?
+        return false unless @socket
+        return false unless @connected
+        true
+      end
+
+    end # class Server
+
+  end # module IRC
+
+end # module Syndi
+
+# vim: set ts=4 sts=2 sw=2 et:

data/lib/syndi/irc/state/channel_manager.rb

@@ -0,0 +1,6 @@
+# Copyright (c) 2013, Autumn Perrault, et al. All rights reserved.
+# This free software is distributed under the FreeBSD license (see LICENSE).
+
+
+
+# vim: set ts=4 sts=2 sw=2 et: