grinch-identify 1.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af84c50edd0bda9b174b3439184668c2b93d12c1013aaed0d7284c9cbf42ca04
+  data.tar.gz: dc508374a5dddc19f2536088efc434aa2b3308542b368da7798b4d71fd536522
+SHA512:
+  metadata.gz: b9131dda43dc450aa0328d026c4a1fde9b0e6596d0cae21bc62ee2593e71d3920a71fa0705a80528693541732cb0e5791109ee9f6203fbc5ab5ca7542a3e71da
+  data.tar.gz: 7926476e05c31352006b43c1a0585194face6cf5309ac8440628365e8beaa89ea089f1eb90c003d2bd7b32599541fe781e9e2689a7a31065f2938366a9b64f1c

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2011 by Dominik Honnef
+Copyright (C) 2019 by William Woodruff
+
+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,61 @@
+# Identify plugin
+
+This plugin allows Grinch to automatically identify with services.
+Currently, DALnet, QuakeNet, KreyNet 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, `:userserv` for
+UserServ, `:dalnet` for DALnet, `:quakenet` for the insecure _auth_ command on QuakeNet and
+`:secure_quakenet` or `:challengeauth` for the more secure
+_challengeauth_. `:kreynet` for KreyNet.
+
+### :username
+The username to use for authentication. Do not set this when using
+NickServ on a network that only supports identifying as the current
+nick (e.g. dancer-ircd.)
+
+### :password
+The password to use for authentication
+
+### :service_name
+The nick name of the service to send the identification message to.
+This option is currently only being used for `:userserv` and defaults
+to `"UserServ"`.
+
+### Example configuration
+Check the install instructions for an example configuration.
+
+## Warning
+Be warned that, when using the `:nickserv`, `:dalnet`, `:userserv`, `:quakenet`
+or `:kreynet` types, the password will show up in the logs.

data/lib/cinch/plugins/identify.rb

@@ -0,0 +1,117 @@
+# -*- coding: utf-8 -*-
+require "openssl"
+
+module Cinch
+  module Plugins
+    class Identify
+      include Cinch::Plugin
+
+      listen_to :connect, method: :identify
+      def identify(m)
+        case config[:type]
+        when :quakenet
+          debug "Identifying with Q"
+          identify_quakenet
+        when :dalnet
+          debug "Identifying with Nickserv on DALnet"
+          identify_dalnet
+        when :secure_quakenet, :challengeauth
+          debug "Identifying with Q, using CHALLENGEAUTH"
+          identify_secure_quakenet
+        when :nickserv
+          debug "Identifying with NickServ"
+          identify_nickserv
+        when :kreynet
+          debug "Identifying with K on KreyNet"
+          identify_kreynet
+        when :userserv
+          debug "Identifying with UserServ"
+          identify_userserv
+        else
+          debug "Not going to identify with unknown type #{config[:type].inspect}"
+        end
+      end
+
+      match(/^You are successfully identified as/,           use_prefix: false, use_suffix: false, react_on: :private, method: :identified_nickserv)
+      match(/^You are now identified for/,                   use_prefix: false, use_suffix: false, react_on: :private, method: :identified_nickserv)
+      match(/^Password accepted - you are now recognized\./, use_prefix: false, use_suffix: false, react_on: :private, method: :identified_nickserv)
+      match(/^Hasło przyjęte - jesteś zidentyfikowany/,      use_prefix: false, use_suffix: false, react_on: :private, method: :identified_nickserv)
+      def identified_nickserv(m)
+        service_name = config[:service_name] || "nickserv"
+        if m.user == User(service_name) && config[:type] == :nickserv
+          debug "Identified with NickServ"
+          @bot.handlers.dispatch :identified, m
+        end
+      end
+
+      match(/^CHALLENGE (.+?) (.+)$/, use_prefix: false, use_suffix: false, react_on: :notice, method: :challengeauth)
+      def challengeauth(m)
+        return unless m.user && m.user.nick == "Q"
+        return unless [:secure_quakenet, :challengeauth].include?(config[:type])
+
+        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
+
+      match(/^You are now logged in as/, use_prefix: false, use_suffix: false, react_on: :notice, method: :identified_quakenet)
+      def identified_quakenet(m)
+        if m.user == User("q") && [:quakenet, :secure_quakenet, :challengeauth].include?(config[:type])
+          debug "Identified with Q"
+          @bot.handlers.dispatch(:identified, m)
+        end
+      end
+
+      match(/^You are now logged in as/, use_prefix: false, use_suffix: false, react_on: :notice, method: :identified_userserv)
+      def identified_userserv(m)
+        service_name = config[:service_name] || "UserServ"
+        service_name = service_name.split("@").first
+        if m.user == User(service_name) && config[:type] == :userserv
+          debug "Identified with UserServ"
+          @bot.handlers.dispatch :identified, m
+        end
+      end
+
+      private
+      def identify_dalnet
+        User("Nickserv@services.dal.net").send("identify %s" % [config[:password]])
+      end
+
+      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
+        service_name = config[:service_name] || "nickserv"
+        service_name = service_name.split("@").first
+        if config[:username]
+          cmd = "identify %s %s" % [config[:username], config[:password]]
+        else
+          cmd = "identify %s" % [config[:password]]
+        end
+        User(service_name).send(cmd)
+      end
+
+      def identify_kreynet
+        User("K!k@krey.net").send("LOGIN %s %s" % [config[:username], config[:password]])
+      end
+
+      def identify_userserv
+        service_name = config[:service_name] || "UserServ"
+        User(service_name).send("LOGIN %s %s" % [config[:username], config[:password]])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: grinch-identify
+version: !ruby/object:Gem::Version
+  version: 1.7.0
+platform: ruby
+authors:
+- William Woodruff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grinch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+description: |
+  A plugin allowing Grinch bots to automatically identify with services.
+  NickServ, QuakeNet and KreyNet are supported.
+email:
+- william@yossarian.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/cinch/plugins/identify.rb
+homepage: http://rubydoc.info/github/cinchrb/cinch-identify
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A plugin allowing Grinch bots to automatically identify with services.
+test_files: []