cinch-identify 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Dominik Honnef
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Last seen plugin
+
+This plugin allows Cinch to automatically identify with services.
+Currently, QuakeNet and all networks using NickServ are supported.
+
+For QuakeNet, both the normal _auth_ and the more secure
+_challengeauth_ commands are supported.
+
+## Installation
+First install the gem by running:
+    [sudo] gem install cinch-identify
+
+Then load it in your bot:
+    require "cinch"
+    require "cinch/plugins/identify"
+
+    bot = Cinch::Bot.new do
+      configure do |c|
+        # add all required options here
+        c.plugins.plugins = [Cinch::Plugins::Identify] # optionally add more plugins
+        c.plugins.options[Cinch::Plugins::Identify] = {
+          :username => "my_username",
+          :password => "my secret password",
+          :type     => :nickserv,
+        }
+      end
+    end
+
+    bot.start
+
+## Commands
+None.
+
+## Options
+### :type
+The type of authentication. `:nickserv` for NickServ, `:quakenet` for
+the insecure _auth_ command on QuakeNet and `:secure_quakenet` or
+`:challengeauth` for the more secure _challengeauth_.
+
+### :username
+The username to use for authentication.
+
+### :password
+The password to use for authentication
+
+### Example configuration
+Check the install instructions for an example configuration.
+
+## Warning
+Be warned that, when using the `:nickserv` or `:quakenet` types, the
+password will show up in the logs.

data/lib/cinch/plugins/identify.rb

@@ -0,0 +1,55 @@
+require "openssl"
+
+module Cinch
+  module Plugins
+    class Identify
+      include Cinch::Plugin
+
+      listen_to :connect, method: :identify
+      def identify(m)
+        case config[:type]
+        when :quakenet
+          @bot.debug "Identifying with Q"
+          identify_quakenet
+        when :secure_quakenet, :challengeauth
+          @bot.debug "Identifying with Q, using CHALLENGEAUTH"
+          identify_secure_quakenet
+        when :nickserv
+          @bot.debug "Identifying with NickServ"
+          identify_nickserv
+        end
+      end
+
+      # TODO as soon as Cinch 1.2.0 is released, use match and
+      # react_on instead
+      listen_to :notice, method: :challengeauth
+      def challengeauth(m)
+        return unless m.user && m.user.nick == "Q"
+        if match = m.message.match(/^CHALLENGE (.+?) (.+)$/)
+          challenge = match[1]
+          @bot.debug "Received challenge '#{challenge}'"
+
+          username = config[:username].irc_downcase(:rfc1459)
+          password = config[:password][0,10]
+
+          key = OpenSSL::Digest::SHA256.hexdigest(username + ":" + OpenSSL::Digest::SHA256.hexdigest(password))
+          response = OpenSSL::HMAC.hexdigest("SHA256", key, challenge)
+          User("Q@CServe.quakenet.org").send("CHALLENGEAUTH #{username} #{response} HMAC-SHA-256")
+        end
+      end
+
+      private
+      def identify_quakenet
+        User("Q@CServe.quakenet.org").send("auth %s %s" % [config[:username], config[:password]])
+      end
+
+      def identify_secure_quakenet
+        User("Q@CServe.quakenet.org").send("CHALLENGE")
+      end
+
+      def identify_nickserv
+        User("nickserv").send("identify %s %s" % [config[:username], config[:password]])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: cinch-identify
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dominik Honnef
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-29 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cinch
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+description: A plugin allowing Cinch bots to automatically identify with services.
+email: 
+- dominikh@fork-bomb.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- lib/cinch/plugins/identify.rb
+has_rdoc: true
+homepage: http://rubydoc.info/github/cinchrb/cinch-identify
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      - 1
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A plugin allowing Cinch bots to automatically identify with services.
+test_files: []
+