prevoty 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63fa617b429dc2087bbf0917932fc28f49e12b7c
+  data.tar.gz: e1050721f2a1332245c474607adfc086901887fc
+SHA512:
+  metadata.gz: e6f7ac8b2a3b01e3ecfff195e68a553b49f7462a69413a27c13236b39002dcdfa3cf4d3a50d950662f5a8a1b2ba2da42d12811b0a79e3b275c6220f120e42abd
+  data.tar.gz: c05eb8efdf398245f98fcc90daec454f0eb5f3dfdf0b5ce0a75dd70e0b6df76454c4f46f53ad0eb208ad5fcec171fb65769e0bad096b90e936dea8482fad7d1d

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.*swp
+.DS_Store

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Prevoty
+
+MIT License
+
+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,38 @@
+# Prevoty
+
+The Prevoty REST API is the easiest way for individuals and organizations to
+prevent cross-site scripting (XSS) attacks in their web applications. The API
+has been designed to provide simple access to the powerful content analysis
+systems and intelligence tools that Prevoty has developed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'prevoty'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prevoty
+
+## Usage
+
+1) Pull a copy or .zip/.tar of this repository
+
+2) Make sure you have an API key (located in your Prevoty Console http://prevoty.com)
+
+3) Edit `example.rb` - you will want to put in your API and configuration keys
+
+4) Run `ruby example.rb`
+
+## Contributing
+
+1. Fork it ( http://github.com/prevoty/prevoty-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/*_spec.rb'
+end

data/lib/prevoty.rb

@@ -0,0 +1,31 @@
+require 'prevoty/version'
+require 'prevoty/client'
+require 'prevoty/pattern'
+require 'prevoty/hash'
+require 'prevoty/crypto'
+
+# exceptions
+require 'prevoty/exceptions/bad_input_parameter'
+require 'prevoty/exceptions/bad_api_key'
+require 'prevoty/exceptions/internal_error'
+require 'prevoty/exceptions/account_quota_exceeded'
+
+# server responses
+require 'prevoty/responses/api_key_info'
+require 'prevoty/responses/filter_content'
+require 'prevoty/responses/filter_statistics'
+require 'prevoty/responses/generate_token'
+require 'prevoty/responses/validate_token'
+require 'prevoty/responses/delete_token'
+require 'prevoty/responses/query_analysis'
+require 'prevoty/responses/input_validation'
+require 'prevoty/responses/hash_result'
+require 'prevoty/responses/encrypt_result'
+require 'prevoty/responses/decrypt_result'
+require 'prevoty/responses/rsa_public_key'
+require 'prevoty/responses/rsa_private_key'
+require 'prevoty/responses/ecdsa_public_key'
+require 'prevoty/responses/ecdsa_private_key'
+require 'prevoty/responses/rsa_signature'
+require 'prevoty/responses/ecdsa_signature'
+require 'prevoty/responses/signature_verify'

data/lib/prevoty/client.rb

@@ -0,0 +1,341 @@
+require 'httparty'
+require 'json'
+
+module Prevoty
+  class Client
+    attr_accessor :api_key, :base
+
+    def initialize(api_key=nil, base=nil)
+      @api_key = api_key
+      @base = base ||= 'https://api.prevoty.com'
+    end
+
+    def verify_api_key
+      params = {api_key: @api_key}
+
+      response = HTTParty.get("#{@base}/1/key/verify", query: params)
+      case response.code
+      when 200 then return true
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      else false
+      end
+    end
+
+    def api_key_info
+      params = {api_key: @api_key}
+
+      response = HTTParty.get("#{@base}/1/key/info", query: params)
+      case response.code
+      when 200 then APIKeyInfo.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      else raise Exception
+      end
+    end
+
+    def verify_content_configuration(configuration_key)
+      params = {api_key: @api_key, rule_key: configuration_key}
+
+      response = HTTParty.get("#{@base}/1/rule/verify", query: params)
+      case response.code
+      when 200 then return true
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      else raise Exception
+      end
+    end
+
+    def filter_content(input, configuration_key)
+      params = {api_key: @api_key, rule_key: configuration_key, input: input}
+
+      response = HTTParty.post("#{@base}/1/xss/filter", query: params)
+      case response.code
+      when 200 then return FilterContent.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 413 then raise RequestTooLarge
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def bulk_filter(input, configuration_key)
+      params = {api_key: @api_key, rule_key: configuration_key, input: input}
+
+      response = HTTParty.post("#{@base}/1/xss/bulkfilter", query: params)
+      case response.code
+      when 200 then return FilterContent.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 413 then raise RequestTooLarge
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def generate_timed_token(user_identifier, action, ttl)
+      params = {api_key: @api_key, user_identifier: user_identifier, action: action, ttl: ttl}
+
+      response = HTTParty.get("#{@base}/1/token/timed/generate", query: params)
+      case response.code
+      when 200 then return GenerateToken.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def validate_timed_token(user_identifier, action, token)
+      params = {api_key: @api_key, user_identifier: user_identifier, action: action, token: token}
+
+      response = HTTParty.get("#{@base}/1/token/timed/validate", query: params)
+      case response.code
+      when 200 then return ValidateToken.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def delete_timed_token(user_identifier, action, token)
+      params = {api_key: @api_key, user_identifier: user_identifier, action: action, token: token}
+
+      response = HTTParty.get("#{@base}/1/token/timed/delete", query: params)
+      case response.code
+      when 200 then return DeleteToken.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def generate_persisted_token(user_identifier, action)
+      params = {api_key: @api_key, user_identifier: user_identifier, action: action}
+
+      response = HTTParty.get("#{@base}/1/token/persisted/generate", query: params)
+      case response.code
+      when 200 then return GenerateToken.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def validate_persisted_token(user_identifier, action, token)
+      params = {api_key: @api_key, user_identifier: user_identifier, action: action, token: token}
+
+      response = HTTParty.get("#{@base}/1/token/persisted/validate", query: params)
+      case response.code
+      when 200 then return ValidateToken.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def delete_persisted_token(user_identifier, action, token)
+      params = {api_key: @api_key, user_identifier: user_identifier, action: action, token: token}
+
+      response = HTTParty.get("#{@base}/1/token/persisted/delete", query: params)
+      case response.code
+      when 200 then return DeleteToken.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def analyze_query(query, config_key)
+      params = {api_key: @api_key, query: query, config_key: config_key}
+
+      response = HTTParty.post("#{@base}/1/query/parse", query: params)
+      case response.code
+      when 200 then return QueryAnalysis.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def validate_pattern(pattern, input)
+      params = {api_key: @api_key, input: input}
+
+      return call_pattern("#{@base}/1/pattern/#{pattern}", params)
+    end
+
+    def validate_string(input, min, max, length)
+      params = {api_key: @api_key, input: input, min: min, max: max, length: length}
+
+      return call_pattern("#{@base}/1/pattern/string", params)
+    end
+
+    def hash(input, function)
+      params = {api_key: @api_key, payload: input, function: function}
+
+      response = HTTParty.post("#{@base}/1/crypto/hash", query: params)
+      case response.code
+      when 200 then return HashResult.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def encrypt(input, algorithm, mode)
+      params = {api_key: @api_key, payload: input, algorithm: algorithm, mode: mode}
+
+      response = HTTParty.post("#{@base}/1/crypto/encrypt", query: params)
+      case response.code
+      when 200 then return EncryptResult.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def decrypt(result)
+      params = {api_key: @api_key, obj: result.to_json}
+
+      response = HTTParty.post("#{@base}/1/crypto/decrypt", query: params)
+      case response.code
+      when 200 then return DecryptResult.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def generate_rsa_keypair(keysize)
+      params = {api_key: @api_key, algorithm: Prevoty::Crypto::KeyAlgorithms::RSA_PKCS, meta: keysize}
+
+      response = HTTParty.post("#{@base}/1/crypto/genkeypair", query: params)
+      case response.code
+      when 200 then return RSAPrivateKey.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def generate_ecdsa_keypair(curve)
+      params = {api_key: @api_key, algorithm: Prevoty::Crypto::KeyAlgorithms::ECDSA, meta: curve}
+
+      response = HTTParty.post("#{@base}/1/crypto/genkeypair", query: params)
+      case response.code
+      when 200 then return ECDSAPrivateKey.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def rsa_pss_signature(payload, func, private_key, options)
+      params = {api_key: @api_key, algorithm: Prevoty::Crypto::KeyAlgorithms::RSA_PSS, hash: func, key: private_key.to_json, payload: payload, opt: options}
+      return call_rsa_signature(params)
+    end
+
+    def rsa_pkcs_signature(payload, func, private_key)
+      params = {api_key: @api_key, algorithm: Prevoty::Crypto::KeyAlgorithms::RSA_PKCS, hash: func, key: private_key.to_json, payload: payload}
+      return call_rsa_signature(params)
+    end
+
+    def ecdsa_signature(payload, func, private_key)
+      params = {api_key: @api_key, algorithm: Prevoty::Crypto::KeyAlgorithms::ECDSA, hash: func, key: private_key.to_json, payload: payload}
+      return call_ecdsa_signature(params)
+    end
+
+    def verify_rsa_pss_signature(payload, func, public_key, signature, options)
+      params = {api_key: @api_key, algorithm: Prevoty::Crypto::KeyAlgorithms::RSA_PSS, hash: func, key: public_key.to_json, sig: signature.to_json, payload: payload, opt: options}
+      return call_verify_signature(params)
+    end
+
+    def verify_rsa_pkcs_signature(payload, func, public_key, signature)
+      params = {api_key: @api_key, algorithm: Prevoty::Crypto::KeyAlgorithms::RSA_PKCS, hash: func, key: public_key.to_json, sig: signature.to_json, payload: payload}
+      return call_verify_signature(params)
+    end
+
+    def verify_ecdsa_signature(payload, func, public_key, signature)
+      params = {api_key: @api_key, algorithm: Prevoty::Crypto::KeyAlgorithms::ECDSA, hash: func, key: public_key.to_json, sig: signature.to_json, payload: payload}
+      return call_verify_signature(params)
+    end
+
+    private
+    def call_pattern(url, params)
+      response = HTTParty.get(url, query: params)
+      case response.code
+      when 200 then return InputValidation.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def call_rsa_signature(params)
+      response = HTTParty.post("#{@base}/1/crypto/sign", query: params)
+      case response.code
+      when 200 then return RSASignature.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def call_ecdsa_signature(params)
+      response = HTTParty.post("#{@base}/1/crypto/sign", query: params)
+      case response.code
+      when 200 then return ECDSASignature.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+
+    def call_verify_signature(params)
+      response = HTTParty.post("#{@base}/1/crypto/verify", query: params)
+      case response.code
+      when 200 then return SignatureVerify.new(JSON.parse(response.body))
+      when 400 then raise BadInputParameter
+      when 403 then raise BadAPIKey
+      when 500 then raise InternalError
+      when 507 then raise AccountQuotaExceeded
+      else raise Exception
+      end
+    end
+  end
+end