vines 0.4.7 → 0.4.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a283e328bc02906cb090b08bcdc5c5bbc954a93
+  data.tar.gz: 37528ba4506f7a6bf6f57a569696eb80e7eed6d1
+SHA512:
+  metadata.gz: 16915f6f177f20dd6311d6d57df91bf3981382f38d3ab50d94979d8813db203a20d027e6bde673d5086a637b6db4f140c324d2519866dcd2d8476d79e1d86393
+  data.tar.gz: 7cbf9026d98a8d1452af15ffecf2d7544222086fbb0a11ee9ba2e965c0644feefb163dd2e6ea77e0bab881e9b3c724de46eeb3251dbe90d3c3d0b8ed1177e3d6

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2012 Negative Code
+Copyright (c) 2010-2013 Negative Code
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/bin/vines

@@ -1,104 +1,4 @@
 #!/usr/bin/env ruby
-# encoding: UTF-8
 
-require 'optparse'
 require 'vines'
-
-COMMANDS = %w[start stop restart init bcrypt cert ldap schema]
-
-def register_storage
-  %w[couchdb mongodb redis sql].each do |backend|
-    begin
-      require 'vines/storage/%s' % backend
-    rescue LoadError
-      # do nothing
-    end
-  end
-end
-
-def parse(args)
-  options = {}
-  parser = OptionParser.new do |opts|
-    opts.banner = "Usage: vines [options] #{COMMANDS.join('|')}"
-
-    opts.separator ""
-    opts.separator "Daemon options:"
-
-    opts.on('-d', '--daemonize', 'Run daemonized in the background') do |daemonize|
-      options[:daemonize] = daemonize
-    end
-
-    options[:log] = 'log/vines.log'
-    opts.on('-l', '--log FILE', 'File to redirect output (default: log/vines.log)') do |log|
-      options[:log] = log
-    end
-
-    options[:pid] = 'pid/vines.pid'
-    opts.on('-P', '--pid FILE', 'File to store PID (default: pid/vines.pid)') do |pid|
-      options[:pid] = pid
-    end
-
-    opts.separator ""
-    opts.separator "Common options:"
-
-    opts.on('-h', '--help', 'Show this message') do |help|
-      options[:help] = help
-    end
-
-    opts.on('-v', '--version', 'Show version') do |version|
-      options[:version] = version
-    end
-  end
-
-  begin
-    parser.parse!(args)
-  rescue
-    puts parser
-    exit(1)
-  end
-
-  if options[:version]
-    puts Vines::VERSION
-    exit
-  end
-
-  if options[:help]
-    puts parser
-    exit
-  end
-
-  command = args.shift
-  unless COMMANDS.include?(command)
-    puts parser
-    exit(1)
-  end
-
-  options.tap do |opts|
-    opts[:args]    = args
-    opts[:command] = command
-    opts[:config]  = File.expand_path('conf/config.rb')
-    opts[:pid]     = File.expand_path(opts[:pid])
-    opts[:log]     = File.expand_path(opts[:log])
-  end
-end
-
-def check_config(opts)
-  return if %w[bcrypt init].include?(opts[:command])
-  unless File.exists?(opts[:config])
-    puts "No config file found at #{opts[:config]}"
-    exit(1)
-  end
-end
-
-register_storage
-opts = parse(ARGV)
-check_config(opts)
-command = Vines::Command.const_get(opts[:command].capitalize).new
-begin
-  command.run(opts)
-rescue SystemExit
-  # do nothing
-rescue Exception => e
-  puts e.message
-  exit(1)
-end
+Vines::CLI.start

data/lib/vines.rb

@@ -68,11 +68,13 @@ end
   net/ldap
   nokogiri
   openssl
+  optparse
   resolv
   set
   socket
   yaml
 
+  vines/cli
   vines/log
   vines/jid
 

data/lib/vines/cli.rb

@@ -0,0 +1,132 @@
+module Vines
+  # The command line application that's invoked by the `vines` binary included
+  # in the gem. Parses the command line arguments to create a new server
+  # directory, and starts and stops the server.
+  class CLI
+    COMMANDS = %w[start stop restart init bcrypt cert ldap schema]
+
+    def self.start
+      self.new.start
+    end
+
+    # Run the command line application to parse arguments and run sub-commands.
+    # Exits the process with a non-zero return code to indicate failure.
+    #
+    # Returns nothing.
+    def start
+      register_storage
+      opts = parse(ARGV)
+      check_config(opts)
+      command = Command.const_get(opts[:command].capitalize).new
+      begin
+        command.run(opts)
+      rescue SystemExit
+        # do nothing
+      rescue Exception => e
+        puts e.message
+        exit(1)
+      end
+    end
+
+    private
+
+    # Try to load various storage backends provided by vines-* gems and register
+    # them with the storage system for the config file to use.
+    #
+    # Returns nothing.
+    def register_storage
+      %w[couchdb mongodb redis sql].each do |backend|
+        begin
+          require 'vines/storage/%s' % backend
+        rescue LoadError
+          # do nothing
+        end
+      end
+    end
+
+    # Parse the command line arguments and run the matching sub-command
+    # (e.g. init, start, stop, etc).
+    #
+    # args - The ARGV array provided by the command line.
+    #
+    # Returns nothing.
+    def parse(args)
+      options = {}
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: vines [options] #{COMMANDS.join('|')}"
+
+        opts.separator ""
+        opts.separator "Daemon options:"
+
+        opts.on('-d', '--daemonize', 'Run daemonized in the background') do |daemonize|
+          options[:daemonize] = daemonize
+        end
+
+        options[:log] = 'log/vines.log'
+        opts.on('-l', '--log FILE', 'File to redirect output (default: log/vines.log)') do |log|
+          options[:log] = log
+        end
+
+        options[:pid] = 'pid/vines.pid'
+        opts.on('-P', '--pid FILE', 'File to store PID (default: pid/vines.pid)') do |pid|
+          options[:pid] = pid
+        end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on('-h', '--help', 'Show this message') do |help|
+          options[:help] = help
+        end
+
+        opts.on('-v', '--version', 'Show version') do |version|
+          options[:version] = version
+        end
+      end
+
+      begin
+        parser.parse!(args)
+      rescue
+        puts parser
+        exit(1)
+      end
+
+      if options[:version]
+        puts Vines::VERSION
+        exit
+      end
+
+      if options[:help]
+        puts parser
+        exit
+      end
+
+      command = args.shift
+      unless COMMANDS.include?(command)
+        puts parser
+        exit(1)
+      end
+
+      options.tap do |opts|
+        opts[:args]    = args
+        opts[:command] = command
+        opts[:config]  = File.expand_path('conf/config.rb')
+        opts[:pid]     = File.expand_path(opts[:pid])
+        opts[:log]     = File.expand_path(opts[:log])
+      end
+    end
+
+    # Many commands must be run in the context of a vines server directory
+    # created with `vines init`. If the command can't find the server's config
+    # file, print an error message and exit.
+    #
+    # Returns nothing.
+    def check_config(opts)
+      return if %w[bcrypt init].include?(opts[:command])
+      unless File.exists?(opts[:config])
+        puts "No config file found at #{opts[:config]}"
+        exit(1)
+      end
+    end
+  end
+end

data/lib/vines/stream/sasl.rb

@@ -12,11 +12,18 @@ module Vines
         @stream = stream
       end
 
-      # Authenticate s2s streams, comparing their domain to their SSL certificate.
-      # Return +true+ if the base64 encoded domain matches the TLS certificate
-      # presented earlier in stream negotiation. Raise a +SaslError+ if
-      # authentication failed.
-      # http://xmpp.org/extensions/xep-0178.html#s2s
+      # Authenticate server-to-server streams, comparing their domain to their
+      # SSL certificate.
+      #
+      #   http://xmpp.org/extensions/xep-0178.html#s2s
+      #
+      # encoded - The Base64 encoded remote domain name String sent by the
+      #           server stream.
+      #
+      # Returns true if the Base64 encoded domain matches the TLS certificate
+      #   presented earlier in stream negotiation.
+      #
+      # Raises a SaslError if authentication failed.
       def external_auth(encoded)
         unless encoded == EMPTY
           authzid = decode64(encoded)
@@ -27,8 +34,12 @@ module Vines
         matches_from or raise SaslErrors::NotAuthorized
       end
 
-      # Authenticate c2s streams using a username and password. Return the
-      # authenticated +User+ or raise a +SaslError+ if authentication failed.
+      # Authenticate client-to-server streams using a username and password.
+      #
+      # encoded - The Base64 encoded jid and password String sent by the
+      #           client stream.
+      #
+      # Returns the authenticated User or raises SaslError if authentication failed.
       def plain_auth(encoded)
         jid, password = decode_credentials(encoded)
         user = authenticate(jid, password)
@@ -39,7 +50,13 @@ module Vines
 
       # Storage backends should not raise errors, but if an unexpected error
       # occurs during authentication, convert it to a temporary-auth-failure.
-      # Return the authenticated +User+ or +nil+ if authentication failed.
+      #
+      # jid      - The user's jid String.
+      # password - The String password.
+      #
+      # Returns the authenticated User or nil if authentication failed.
+      #
+      # Raises TemoraryAuthFailure if the storage system failed.
       def authenticate(jid, password)
         log.info("Authenticating user: %s" % jid)
         @stream.storage.authenticate(jid, password).tap do |user|
@@ -50,10 +67,15 @@ module Vines
         raise SaslErrors::TemporaryAuthFailure
       end
 
-      # Return the +JID+ and password decoded from the base64 encoded SASL PLAIN
+      # Return the JID and password decoded from the Base64 encoded SASL PLAIN
       # credentials formatted as authzid\0authcid\0password.
-      # http://tools.ietf.org/html/rfc6120#section-6.3.8
-      # http://tools.ietf.org/html/rfc4616
+      #
+      #   http://tools.ietf.org/html/rfc6120#section-6.3.8
+      #   http://tools.ietf.org/html/rfc4616
+      #
+      # encoded - The Base64 encoded String from which to extract jid and password.
+      #
+      # Returns an Array of jid String and password String.
       def decode_credentials(encoded)
         authzid, node, password = decode64(encoded).split("\x00")
         raise SaslErrors::NotAuthorized if node.nil? || node.empty? || password.nil? || password.empty?
@@ -71,7 +93,13 @@ module Vines
       # widely supported. However, Strophe and Blather send a bare JID, in
       # compliance with RFC 6120, but Smack sends just the user name as the
       # authzid. So, take care to handle non-compliant clients here.
-      # http://tools.ietf.org/html/rfc6120#section-6.3.8
+      #
+      #   http://tools.ietf.org/html/rfc6120#section-6.3.8
+      #
+      # authzid - The authzid String (may be nil).
+      # jid     - The username String.
+      #
+      # Returns nothing.
       def validate_authzid!(authzid, jid)
         return if authzid.nil? || authzid.empty?
         authzid.downcase!
@@ -80,10 +108,18 @@ module Vines
         raise SaslErrors::InvalidAuthzid unless compliant || smack
       end
 
-      # Decode the base64 encoded string, raising an error for invalid data.
-      # http://tools.ietf.org/html/rfc6120#section-13.9.1
+      # Decode the Base64 encoded string, raising an error for invalid data.
+      #
+      #   http://tools.ietf.org/html/rfc6120#section-13.9.1
+      #
+      # encoded - The Base64 encoded String.
+      #
+      # Returns a UTF-8 String.
       def decode64(encoded)
-        Base64.strict_decode64(encoded)
+        Base64.strict_decode64(encoded).tap do |decoded|
+          decoded.force_encoding(Encoding::UTF_8)
+          raise SaslErrors::IncorrectEncoding unless decoded.valid_encoding?
+        end
       rescue
         raise SaslErrors::IncorrectEncoding
       end

data/lib/vines/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Vines
-  VERSION = '0.4.7'
+  VERSION = '0.4.8'
 end

data/test/stream/sasl_test.rb

@@ -97,6 +97,18 @@ describe Vines::Stream::SASL do
       storage.verify
     end
 
+    it 'passes with valid password and unicode jid' do
+      user = Vines::User.new(jid: 'piñata@verona.lit')
+      storage.expect :authenticate, user, [user.jid, 'secr3t']
+      stream.expect :storage, storage
+
+      encoded = Base64.strict_encode64("\x00piñata\x00secr3t")
+      subject.plain_auth(encoded).must_equal user
+
+      stream.verify
+      storage.verify
+    end
+
     it 'passes with valid password and authzid provided by strophe and blather' do
       storage.expect :authenticate, romeo, [romeo.jid, 'secr3t']
       stream.expect :storage, storage

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: vines
 version: !ruby/object:Gem::Version
-  version: 0.4.7
-  prerelease: 
+  version: 0.4.8
 platform: ruby
 authors:
 - David Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-23 00:00:00.000000000 Z
+date: 2013-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt-ruby
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: em-hiredis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ldap
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -154,6 +137,7 @@ files:
 - README.md
 - vines.gemspec
 - bin/vines
+- lib/vines/cli.rb
 - lib/vines/cluster/connection.rb
 - lib/vines/cluster/publisher.rb
 - lib/vines/cluster/pubsub.rb
@@ -324,30 +308,26 @@ files:
 homepage: http://www.getvines.org
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1025629835892307549
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Vines is an XMPP chat server that's easy to install and run.
 test_files:
 - test/cluster/publisher_test.rb