train-f5 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a19a3cb9829fa7a53cc0df4f22edd11d17ae305df6284773e1cef04db3ec72ee
+  data.tar.gz: ad8d5a49a3b88ed53e8d594404368837242139c7eaf6535ceb98c4a27d5bf527
+SHA512:
+  metadata.gz: 97bed029e2315578316f57c50a68d666f52c4f47691057bfa89afe7124733b8d310de080bb39b67d3dee803bf78fa695972b94eaa2150b3ac13b120f6150648e
+  data.tar.gz: d0b32b7029381ef6efa085c857616e2ba114f1630bfd44077d63b66b663150d24439cffcb44b512b435889e912f34621221a24e6adf9e73ab14bc702888970f6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/FetchEnvVar:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Naming/FileName:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in train-f5.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,238 @@
+PATH
+  remote: .
+  specs:
+    train-f5 (0.1.0)
+      faraday
+      faraday_middleware
+      train
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    azure_graph_rbac (0.17.2)
+      ms_rest_azure (~> 0.12.0)
+    azure_mgmt_key_vault (0.17.7)
+      ms_rest_azure (~> 0.12.0)
+    azure_mgmt_resources (0.18.2)
+      ms_rest_azure (~> 0.12.0)
+    azure_mgmt_security (0.19.0)
+      ms_rest_azure (~> 0.12.0)
+    azure_mgmt_storage (0.23.0)
+      ms_rest_azure (~> 0.12.0)
+    builder (3.2.4)
+    chef-utils (17.10.0)
+      concurrent-ruby
+    concurrent-ruby (1.1.10)
+    declarative (0.0.20)
+    diff-lcs (1.5.0)
+    docker-api (2.2.0)
+      excon (>= 0.47.0)
+      multi_json
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    erubi (1.11.0)
+    excon (0.92.4)
+    faraday (1.10.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-cookie_jar (0.0.7)
+      faraday (>= 0.8.0)
+      http-cookie (~> 1.0.0)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    ffi (1.15.5)
+    google-api-client (0.52.0)
+      addressable (~> 2.5, >= 2.5.1)
+      googleauth (~> 0.9)
+      httpclient (>= 2.8.1, < 3.0)
+      mini_mime (~> 1.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+      rexml
+      signet (~> 0.12)
+    googleauth (0.14.0)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.14)
+    gssapi (1.3.1)
+      ffi (>= 1.0.1)
+    gyoku (1.4.0)
+      builder (>= 2.1.2)
+      rexml (~> 3.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    httpclient (2.8.3)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    inifile (3.0.0)
+    json (2.6.2)
+    jwt (2.5.0)
+    little-plugger (1.1.4)
+    logging (2.3.1)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.14)
+    memoist (0.16.2)
+    mini_mime (1.1.2)
+    minitest (5.16.3)
+    mixlib-shellout (3.2.7)
+      chef-utils
+    ms_rest (0.7.6)
+      concurrent-ruby (~> 1.0)
+      faraday (>= 0.9, < 2.0.0)
+      timeliness (~> 0.3.10)
+    ms_rest_azure (0.12.0)
+      concurrent-ruby (~> 1.0)
+      faraday (>= 0.9, < 2.0.0)
+      faraday-cookie_jar (~> 0.0.6)
+      ms_rest (~> 0.7.6)
+    multi_json (1.15.0)
+    multipart-post (2.2.3)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.1.0)
+    nori (2.6.0)
+    os (1.1.4)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    representable (3.2.0)
+      declarative (< 0.1.0)
+      trailblazer-option (>= 0.1.1, < 0.2.0)
+      uber (< 0.2.0)
+    retriable (3.1.2)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    rubyntlm (0.6.3)
+    rubyzip (2.3.2)
+    signet (0.17.0)
+      addressable (~> 2.8)
+      faraday (>= 0.17.5, < 3.a)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    timeliness (0.3.10)
+    trailblazer-option (0.1.2)
+    train (3.10.1)
+      activesupport (>= 6.0.3.1)
+      azure_graph_rbac (~> 0.16)
+      azure_mgmt_key_vault (~> 0.17)
+      azure_mgmt_resources (~> 0.15)
+      azure_mgmt_security (~> 0.18)
+      azure_mgmt_storage (~> 0.18)
+      docker-api (>= 1.26, < 3.0)
+      google-api-client (>= 0.23.9, <= 0.52.0)
+      googleauth (>= 0.6.6, <= 0.14.0)
+      inifile (~> 3.0)
+      train-core (= 3.10.1)
+      train-winrm (~> 0.2)
+    train-core (3.10.1)
+      addressable (~> 2.5)
+      ffi (!= 1.13.0)
+      json (>= 1.8, < 3.0)
+      mixlib-shellout (>= 2.0, < 4.0)
+      net-scp (>= 1.2, < 4.0)
+      net-ssh (>= 2.9, < 7.0)
+    train-winrm (0.2.13)
+      winrm (>= 2.3.6, < 3.0)
+      winrm-elevated (~> 1.2.2)
+      winrm-fs (~> 1.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    uber (0.1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    unicode-display_width (2.2.0)
+    winrm (2.3.6)
+      builder (>= 2.1.2)
+      erubi (~> 1.8)
+      gssapi (~> 1.2)
+      gyoku (~> 1.0)
+      httpclient (~> 2.2, >= 2.2.0.2)
+      logging (>= 1.6.1, < 3.0)
+      nori (~> 2.0)
+      rubyntlm (~> 0.6.0, >= 0.6.3)
+    winrm-elevated (1.2.3)
+      erubi (~> 1.8)
+      winrm (~> 2.0)
+      winrm-fs (~> 1.0)
+    winrm-fs (1.3.5)
+      erubi (~> 1.8)
+      logging (>= 1.6.1, < 3.0)
+      rubyzip (~> 2.0)
+      winrm (~> 2.0)
+
+PLATFORMS
+  ruby
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  train-f5!
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -0,0 +1,115 @@
+# Train::F5
+
+A simple [Train](https://github.com/inspec/train) plugin that wraps REST calls to F5 BigIP load balancers.
+
+Train is used by Chef infrastructure automation products like Chef Infra and Chef Inspec to connect to
+remote backends.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'train-f5'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or just install it yourself as:
+
+```bash
+$ gem install train-f5
+```
+
+To test the plugin using Inspec you can try:-
+
+```bash
+inspec detect -t f5://admin:secrit_pa55word@f5.myorg.com:8443 --insecure
+```
+
+You should end up with output like this if all went well
+
+```text
+─────── Platform Details ───────
+
+Name:      f5
+Families:  api
+Release:   16.1.3.1
+```
+
+
+## Usage in Inspec profiles
+
+To write an Inspec custom resource, you can use the following methods:-
+
+```ruby
+json_body = inspec.backend.get(f5_rest_endpoint)
+json_body = inspec.backend.put(f5_rest_endpoint, data)
+json_body = inspec.backend.post(f5_rest_endpoint, data)
+json_body = inspec.backend.delete(f5_rest_endpoint)
+```
+
+You can experiment with the API using the Inspec Shell
+
+```bash
+inspec detect -t f5://admin:secrit_pa55word@f5.myorg.com:8443 --insecure
+
+inspec.backend.get '/mgmt/tm/sys/version'
+```
+
+## Example Custom Resource
+
+_The custom resource_
+
+```ruby
+# libraries/f5_software.rb
+class F5Software < Inspec.resource(1)
+  name "f5_software"
+
+  def version
+    body = inspec.backend.get('/mgmt/tm/sys/version')
+    f5_release = body['entries'].values[0]['nestedStats']['entries']['Version']['description']
+  end
+end
+```
+
+_The Control_
+
+```ruby
+# controls/software.rb
+control "Software - 1.1" do
+  impact 0.7
+  title "Version must be correct"
+
+  describe f5_software do
+    its('version') { should eq '16.1.3.0' }
+  end
+end
+```
+
+## Credentials
+
+You can pass credentials at the command line
+
+```bash
+inspec detect -t f5://admin:secrit_pa55word@f5.myorg.com:8443 --insecure
+```
+
+You can also pass credentials in environment variables (useful to avoid creds on the command line)
+
+```bash
+export F5_PORT=8443
+export F5_HOST=f5.myorg.com
+export F5_PASSWORD=secrit_pa55word
+export F5_USER=admin
+
+inspec detect -t f5:// --insecure
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trickyearlobe/train-f5.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "train/f5"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/train-f5/connection.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "train"
+require "train-f5/version"
+require "train-f5/error"
+require "faraday"
+require "faraday_middleware"
+
+module TrainPlugins
+  module F5
+    # F5 Connection
+    class Connection < Train::Plugins::Transport::BaseConnection
+      # Initialise Faraday as the HTTP handler with basic auth
+      # and automatic JSON conversion.
+      def initialize(options)
+        super(options)
+        @baseurl = "https://#{options[:host]}:#{options[:port]}"
+        @httpclient = Faraday.new(
+          url: @baseurl, ssl: { verify: !options[:insecure] },
+          headers: { "Content-Type" => "application/json", "Accept" => "application/json" }
+        ) do |conn|
+          if Faraday::VERSION.split(".")[0] == "1"
+            conn.request :basic_auth, options[:user], options[:password]
+          else
+            conn.request :authorization, :basic, options[:user], options[:password]
+          end
+          conn.request :json
+        end
+      end
+
+      # Allow Train to query the platform we are connected to
+      def platform
+        body = get("/mgmt/tm/sys/version")
+        f5_release = body["entries"].values[0]["nestedStats"]["entries"]["Version"]["description"]
+        # f5_family = body['entries'].values[0]['nestedStats']['entries']['Product']['description']
+        Train::Platforms.name("f5").in_family("api")
+        force_platform!("f5", release: f5_release)
+      end
+
+      # Do GET,PUT,POST, DELETE with the cached Faraday client
+      def get(uri)
+        process_response(@httpclient.get(uri))
+      end
+
+      def put(uri, data = nil)
+        process_response(@httpclient.put(uri, data))
+      end
+
+      def post(uri, data = nil)
+        process_response(@httpclient.post(uri, data))
+      end
+
+      def delete(uri)
+        process_response(@httpclient.delete(uri))
+      end
+
+      def process_response(resp)
+        JSON.parse(resp.body)
+      end
+    end
+  end
+end

data/lib/train-f5/error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "train"
+
+# Allow us to raise F5 specific exceptions
+module TrainPlugins
+  module F5
+    class Error < Train::Error; end
+  end
+end

data/lib/train-f5/transport.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "train-f5/connection"
+
+module TrainPlugins
+  module F5
+    # F5 Transport class for Train
+    class Transport < Train.plugin(1)
+      name "f5"
+      option :host,     default: ENV["F5_HOST"]
+      option :insecure, default: false
+      option :user,     default: ENV["F5_USER"]
+      option :port,     default: ENV["F5_PORT"] || "443"
+      option :password, default: ENV["F5_PASSWORD"]
+
+      # Returns a cached connection to an F5 BigIP appliance
+      def connection(_instance_opts = nil)
+        @connection ||= TrainPlugins::F5::Connection.new(@options)
+      end
+    end
+  end
+end

data/lib/train-f5/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TrainPlugins
+  module F5
+    VERSION = "0.1.1"
+  end
+end

data/lib/train-f5.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Set up the search path for requires
+libdir = __dir__
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+# Pull in the rest of the libraries
+require "train-f5/transport"

data/train-f5.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/train-f5/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "train-f5"
+  spec.version = TrainPlugins::F5::VERSION
+  spec.authors = ["Richard Nixon"]
+  spec.email = ["richard.nixon@btinternet"]
+
+  spec.summary = "A Train plugin for F5 BigIP"
+  spec.description = "A Train plugin that allows Inspec to call the F5 REST API"
+  spec.homepage = "https://github.com/trickyearlobe/train-f5"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "train"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: train-f5
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Richard Nixon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: train
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Train plugin that allows Inspec to call the F5 REST API
+email:
+- richard.nixon@btinternet
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/train-f5.rb
+- lib/train-f5/connection.rb
+- lib/train-f5/error.rb
+- lib/train-f5/transport.rb
+- lib/train-f5/version.rb
+- train-f5.gemspec
+homepage: https://github.com/trickyearlobe/train-f5
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/trickyearlobe/train-f5
+  source_code_uri: https://github.com/trickyearlobe/train-f5
+  changelog_uri: https://github.com/trickyearlobe/train-f5
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: A Train plugin for F5 BigIP
+test_files: []