algosec-sdk 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e450cbd6917ee2fd473b32c8bff043daaf1c6787
+  data.tar.gz: b9fc293773ea450cf95a3a353c512838b162e80e
+SHA512:
+  metadata.gz: 90d0a97ec3223bdb70380907ab873a8c1d58e60e7a6bb78069866d08fe04a414b6610aa8863ef179444ed6e9534783f21cd8bb50bf0c362c7c716d71299bb206
+  data.tar.gz: a56dfbe55e022ee3a8a7acfbaac336265dfb1e26634f747fae52be277e90e573483681a2a7cf4a7361ba589313f2895d9ba2aad18ae2afe4c6f29aefb266cfc7

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+Berksfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.sw*
+.idea/

data/.rubocop.yml

@@ -0,0 +1,68 @@
+# See default at https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+AllCops:
+  TargetRubyVersion: 2.1
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ModuleLength:
+  Max: 200
+
+Metrics/ParameterLists:
+  Max: 6
+
+Layout/IndentationWidth:
+  Width: 2
+
+Naming/VariableName:
+  EnforcedStyle: snake_case
+
+Naming/FileName:
+  Exclude:
+    - 'lib/algosec-sdk.rb'
+
+Layout/AlignParameters:
+  Enabled: true
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+#Style/EmptyLines:
+#  Enabled: false
+#
+#Style/RescueModifier:
+#  Enabled: false
+#
+#Style/EmptyLinesAroundBlockBody:
+#  Enabled: false
+#
+#Style/EmptyLinesAroundClassBody:
+#  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+algosecsdk

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+notifications:
+  - false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### New (Unreleased)
+ - (none)
+
+## v1.0.0
+Initial release

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+gemspec
+
+group :test do
+  gem 'coveralls', require: false
+  gem 'pry-byebug'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2018 AlgoSec Systems Ltd.
+All Rights Reserved.
+
+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 and/or sublicense,
+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 NON-INFRINGEMENT. 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,208 @@
+# Ruby SDK for AlgoSec Services
+
+[![Coverage Status](https://coveralls.io/repos/github/algosec/algosec-ruby/badge.svg)](https://coveralls.io/github/algosec/algosec-ruby)
+[![Build Status](https://travis-ci.org/algosec/algosec-ruby.svg)](https://travis-ci.org/algosec/algosec-ruby)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/github/algosec/algosec-ruby)
+[![Gem Version](https://badge.fury.io/rb/algosec-sdk.svg)](https://badge.fury.io/rb/algosec-sdk)
+
+Software Development Kit for interacting with the AlgoSec services API.
+
+## Installation
+
+- Require the gem in your Gemfile:
+
+  ```ruby
+  gem 'algosec-sdk'
+  ```
+
+  Then run `$ bundle install`
+- Or run the command:
+
+  ```bash
+  $ gem install algosec-sdk
+  ```
+
+
+## Client
+
+Everything you do with this API happens through a client object.
+Creating the client object is the first step; then you can perform actions on the client.
+
+```ruby
+require 'algosec-sdk'
+client = ALGOSEC_SDK::Client.new(
+  host: 'https://local.algosec.com',
+  user: 'admin',              # This is the default
+  password: 'algosec',
+  ssl_enabled: false,                  # This is the default and strongly encouraged
+  logger: Logger.new(STDOUT),         # This is the default
+  log_level: :info,                   # This is the default
+  disable_proxy: true                 # Default is false. Set to disable, even if ENV['http_proxy'] is set
+)
+client.login
+```
+
+:lock: Tip: Check the file permissions when storing passwords in clear-text.
+
+#### Environment Variables
+
+You can also set many client options using environment variables. For bash:
+
+```bash
+export ALGOSEC_HOST='https://oneview.example.com'
+export ALGOSEC_USER='admin'
+export ALGOSEC_PASSWORD='secret123'
+export ALGOSEC_SSL_ENABLED=false # NOTE: Disabling SSL is strongly discouraged.
+```
+
+:lock: Tip: Be sure nobody can access to your environment variables
+
+### Custom logging
+
+The default logger is a standard logger to STDOUT, but if you want to specify your own, you can.  However, your logger must implement the following methods:
+
+```ruby
+debug(String)
+info(String)
+warn(String)
+error(String)
+level=(symbol, etc.) # The parameter here will be the log_level attribute
+```
+
+
+## Actions
+
+Actions are performed on the client, and defined in the [helper modules](lib/algosec-sdk/helpers).
+
+#### Business Flow
+
+```ruby
+# Get list of application flows for an application revision id
+client.get_application_flows(app_revision_id)
+
+# Delete a specific flow
+client.delete_flow_by_id(app_revision_id, flow_id)
+
+# Get connectivity status for a flow
+client.get_flow_connectivity(app_revision_id, flow_id)
+
+# Create a flow
+client.create_application_flow(
+      app_revision_id,
+      flow_name,
+      sources,
+      destinations,
+      network_users,
+      network_apps,
+      network_services,
+      comment,
+    )
+
+# Fetch an application flow by it's name
+client.get_application_flow_by_name(app_revision_id, flow_name)
+
+# Get latest application revision id by application name
+client.get_app_revision_id_by_name(app_name)
+
+# Apply application draft
+client.apply_application_draft(app_revision_id)
+
+# Create a new network service
+client.create_network_service(service_name, content)
+
+# Create a new network object
+client.create_network_object(type, content, name)
+
+# defining the complete list of flows for a given app
+flows = client.define_application_flows(
+  'TEST',
+  [
+    'flow1' => {
+      'sources' => ['HR Payroll server', '192.168.0.0/16'],
+      'destinations' => ['16.47.71.62'],
+      'services' => ['HTTPS']
+    },
+    'flow2' => {
+      'sources' => ['10.0.0.1'],
+      'destinations' => ['10.0.0.2'],
+      'services' => ['udp/501']
+    },
+    'flow3' => {
+      'sources' => ['1.2.3.4'],
+      'destinations' => ['3.4.5.6'],
+      'services' => ['SSH']
+    }
+  ]
+)
+
+```
+
+## Custom requests
+
+This gem includes some useful helper methods, but sometimes you need to make your own custom requests to the AlgoSec.
+This project makes it extremely easy to do with some built-in methods for the client object. Here are some examples:
+
+```ruby
+# Get the application object:
+response = client.rest_api(:get, '/BusinessFlow/rest/v1/applications/name/applicationName')
+# or even more simple:
+response = client.rest_get('/BusinessFlow/rest/v1/applications/name/applicationName')
+
+
+# Then we can validate the response and convert the response body into a hash...
+data = client.response_handler(response)
+
+# For creating new BusinessFlow resources, use post:
+options = { some: 'Data' }
+response = client.rest_post('/BusinessFlow/rest/v1/exampleURL', body: options)
+```
+
+These example are about as basic as it gets, but you can make any type of AlgoSec API request.
+If a helper does not do what you need, this will allow you to do it.
+Please refer to the documentation and [code](lib/algosec-sdk/rest.rb) for complete list of methods and information about how to use them.
+
+
+## License
+
+This project is licensed under the MIT license. Please see [LICENSE](LICENSE) for more info.
+
+
+## Contributing and feature requests
+
+**Contributing:** You know the drill. Fork it, branch it, change it, commit it, and pull-request it.
+We are passionate about improving this project, and glad to accept help to make it better. However, keep the following in mind:
+
+ - All pull requests must contain complete test code also. See the testing section below.
+ - We reserve the right to reject changes that we feel do not fit the scope of this project, so for feature additions, please open an issue to discuss your ideas before doing the work.
+
+**Feature Requests:** If you have a need that is not met by the current implementation, please let us know (via a new issue).
+This feedback is crucial for us to deliver a useful product. Do not assume we have already thought of everything, because we assure you that is not the case.
+
+### Building the Gem
+
+First run `$ bundle` (requires the bundler gem), then...
+ - To build only, run `$ rake build`.
+ - To build and install the gem, run `$ rake install`.
+
+#### Pushing the gem to rubygems.org
+
+```bash
+$ rake build
+$ gem push pkg/algosec-sdk-<gem-version>.gem
+```
+
+### Use Gem from sourcecode
+
+Run `pry -Ilib` then follow the README examples above. (don't forget to `require` the Gem)
+
+### Testing
+
+ - RuboCop: `$ rake rubocop`
+ - Unit: `$ rake spec`
+ - All test: `$ rake test`
+
+Note: run `$ rake -T` to get a list of all the available rake tasks.
+
+## Authors
+
+ - AlmogCohen - [@AlmogCohen](https://github.com/AlmogCohen)

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: :test
+
+desc 'Run unit tests only'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  require 'pry-byebug'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--color '
+end
+
+RuboCop::RakeTask.new do |task|
+  task.options << '--display-cop-names'
+end
+
+desc 'Runs rubocop and unit tests'
+task test: %i[rubocop spec]

data/algosec-sdk.gemspec

@@ -0,0 +1,28 @@
+# http://guides.rubygems.org/specification-reference
+require_relative './lib/algosec-sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'algosec-sdk'
+  spec.version       = ALGOSEC_SDK::VERSION
+  spec.authors       = ['Almog Cohen']
+  spec.email         = ['almog.cohen@algosec.com']
+  spec.summary       = 'Gem to interact with AlgoSec API'
+  spec.description   = 'Gem to interact with AlgoSec API'
+  spec.license       = 'MIT'
+  spec.homepage      = 'https://github.com/algosec/algosec-ruby'
+
+  all_files = `git ls-files -z`.split("\x0")
+  spec.files         = all_files.reject { |f| f.match(%r{^(examples\/)|(spec\/)}) }
+  spec.executables   = all_files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'httpclient'
+  spec.add_runtime_dependency 'ipaddress'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop', '> 0.49.0'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/algosec-sdk.rb

@@ -0,0 +1,8 @@
+require_relative 'algosec-sdk/version'
+require_relative 'algosec-sdk/client'
+require_relative 'algosec-sdk/exceptions'
+
+# Module for interracting with the AlgoSec API
+module ALGOSEC_SDK
+  ENV_VARS = %w[ALGOSEC_HOST ALGOSEC_USER ALGOSEC_PASSWORD ALGOSEC_SSL_ENABLED].freeze
+end

data/lib/algosec-sdk/client.rb

@@ -0,0 +1,69 @@
+require 'logger'
+require_relative 'rest'
+# Load all helpers:
+Dir[File.join(File.dirname(__FILE__), '/helpers/*.rb')].each { |file| require file }
+
+module ALGOSEC_SDK
+  # The client defines the connection to the AlgoSec and handles communication with it
+  class Client
+    attr_accessor :http_client, :host, :user, :password, :ssl_enabled, :disable_proxy, :logger, :log_level
+
+    # Create a client object
+    # @param [Hash] options the options to configure the client
+    # @option options [String] :host (ENV['ALGOSEC_HOST']) URL, hostname, or IP address of the AlgoSec server
+    # @option options [String] :user ('admin') Username to use for authentication with the AlgoSec server
+    # @option options [String] :password Password to use for authentication with the AlgoSec server
+    # @option options [Logger] :logger (Logger.new(STDOUT)) Logger object to use.
+    #   Must implement debug(String), info(String), warn(String), error(String), & level=
+    # @option options [Symbol] :log_level (:info) Log level.
+    #   Logger must define a constant with this name. ie Logger::INFO
+    # @option options [Boolean] :ssl_enabled (true) Use ssl for requests?
+    # @option options [Boolean] :disable_proxy (false) Disable usage of a proxy for requests?
+    def initialize(options = {})
+      options = Hash[options.map { |k, v| [k.to_sym, v] }] # Convert string hash keys to symbols
+      @logger = options[:logger] || Logger.new(STDOUT)
+      %i[debug info warn error level=].each do |m|
+        raise "Logger must respond to #{m} method " unless @logger.respond_to?(m)
+      end
+      @log_level = options[:log_level] || :info
+      @logger.level = begin
+                        @logger.class.const_get(@log_level.upcase)
+                      rescue StandardError
+                        @log_level
+                      end
+      @host = options[:host] || ENV['ALGOSEC_HOST']
+      raise InvalidClient, 'Must set the host option' unless @host
+      @host = 'https://' + @host unless @host.start_with?('http://', 'https://')
+      @ssl_enabled = true # Default
+      if ENV.key?('ALGOSEC_SSL_ENABLED')
+        @ssl_enabled = case ENV['ALGOSEC_SSL_ENABLED']
+                       when 'true', '1' then true
+                       when 'false', '0' then false
+                       else ENV['ALGOSEC_SSL_ENABLED']
+                       end
+      end
+      @ssl_enabled = options[:ssl_enabled] unless options[:ssl_enabled].nil?
+      unless [true, false].include?(@ssl_enabled)
+        raise InvalidClient, "ssl_enabled option must be true or false. Got '#{@ssl_enabled}'"
+      end
+      unless @ssl_enabled
+        @logger.warn "SSL is disabled for all requests to #{@host}!"\
+                               ' We recommend you import the necessary certificates instead of disabling SSL.'
+      end
+      @disable_proxy = options[:disable_proxy]
+      unless [true, false, nil].include?(@disable_proxy)
+        raise InvalidClient, 'disable_proxy option must be true, false, or nil'
+      end
+      @logger.warn 'User option not set. Using default (admin)' unless options[:user] || ENV['ALGOSEC_USER']
+      @user = options[:user] || ENV['ALGOSEC_USER'] || 'admin'
+      @password = options[:password] || ENV['ALGOSEC_PASSWORD']
+      raise InvalidClient, 'Must set the password option' unless @password
+      init_http_client
+    end
+
+    include Rest
+
+    # Include helper modules:
+    include BusinessFlowHelper
+  end
+end