shodan 0.1.0

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2010 John Matherly <jmath@surtri.com>
+
+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.
+
+Except as contained in this notice, the name(s) of the above
+copyright holders shall not be used in advertising or otherwise
+to promote the sale, use or other dealings in this Software
+without prior written authorization.
+
+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,36 @@
+## Installation
+
+To install the library use rubygems:
+
+	gem install shodan
+
+## Usage
+
+Before you can use the API, you need to have an API key.
+
+[Get your API key here](http://www.shodanhq.com/api_doc)
+
+Setup the SHODAN WebAPI:
+
+	require 'shodan'
+	
+	api = Shodan::WebAPI.new(MY_API_KEY)
+
+Print a list of cisco-ios devices:
+
+	result = api.search("cisco-ios")
+	result['matches'].each{ |host|
+		puts host['ip']
+	}
+
+Get all the information SHODAN has on the IP 217.140.75.46:
+
+	host = api.host('217.140.75.46')
+	puts host.to_s
+
+To properly handle potential errors, you should wrap all requests in a try/except block:
+
+	begin
+		api.search("cisco-ios")
+	rescue Exception => e
+		puts "Error: #{e.to_s}"

data/lib/shodan.rb

@@ -0,0 +1,3 @@
+# Import all the SHODAN classes
+require 'shodan/api'
+require 'shodan/version'

data/lib/shodan/api.rb

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'cgi'
+require 'json'
+require 'net/http'
+
+module Shodan
+  
+  # The WebAPI class interfaces with the shodanhq.com/api
+  # It currently supports 2 methods:
+  # 1. search (query)
+  # 2. host (ip)
+  #
+  # Author:: achillean (mailto:jmath at surtri.com)
+  #
+  # :title:Shodan::WebAPI
+  class WebAPI
+    attr_accessor :api_key
+    attr_accessor :base_url
+    
+    def initialize(api_key)
+      @api_key = api_key
+      @base_url = "http://www.shodanhq.com/api/"
+    end
+    
+    # Internal method that sends out the HTTP request.
+    # Expects a webservice function (ex. 'search') name and a hash of arguments.
+    def request(func, args)
+      # Convert the argument hash into a string
+      args_string = args.map{|k, v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v)}"}.join("&")
+        
+      # Craft the final request URL
+      url = "#{@base_url}#{func}?key=#{@api_key}&#{args_string}"
+      
+      # Send the request
+      response = Net::HTTP.get_response(URI.parse(url))
+      
+      # Convert the JSON data into a native Ruby hash
+      data = JSON.parse(response.body)
+      
+      # Raise an error if something went wrong
+      if data.has_key? 'error'
+        raise data['error']
+      end
+      
+      return data
+    end
+    private :request
+    
+    # Get all available information on an IP.
+    #
+    # Arguments:
+    # ip  - host IP (string)
+    #
+    # Returns a hash containing the host information
+    def host(ip)
+      return request('host', {:ip => ip})
+    end
+    
+    # Perform a search on Shodan.
+    #
+    # Arguments:
+    # query - search query; same format as the website (string)
+    #
+    # Returns a hash containing the search results
+    def search(query)
+      return request('search', {:q => query})
+    end
+  end
+  
+end

data/lib/shodan/version.rb

@@ -0,0 +1,3 @@
+module Shodan
+  Version = VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: shodan
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Matherly
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.4.6
+    version: 
+description: "  A Ruby library to interact with the SHODAN API.\n"
+email: jmath@surtri.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- README.md
+- LICENSE
+- HISTORY.md
+- lib/shodan.rb
+- lib/shodan/version.rb
+- lib/shodan/api.rb
+has_rdoc: true
+homepage: http://github.com/achillean/shodan-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby library to interact with the SHODAN API.
+test_files: []
+