wg-metasploit_data_models 4.1.4.01 → 4.1.4.02

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7199bab840b316e061e6e20f906f49e8a4a1f772422acf1e0a0f649f664020ce
-  data.tar.gz: 1fdd62d6abf2ffee91b232c71a362a81bacda817dc03dbc5b638351f51ea85c4
+  metadata.gz: ceacf05a960fa9c22ddd6cc450672f0685a72c1c700c1adf01a1810f56e224f3
+  data.tar.gz: 7e7a93370a505fa7cc4fe475cc7b5df8843a2a4689c5ba0e7cf1be023c5acae3
 SHA512:
-  metadata.gz: 6e05b8c06291528ad6f9a1903ace01261ad47b3398027f6db8526db0def6fb08cfe07bf19fda38c5cf92623e7106488cc67d6f87fd181fd24bc332ca2bd5d6a4
-  data.tar.gz: a9f8441f80a0fd7d7151c3914fdae23df484d823b24361314e769dd084ea373ba13ffbcdb75232fdaaf0b820d9f168ccd0d100433dba76a2fdca953c98c329a5
+  metadata.gz: 75eb272be274177281aa56b1d771bb02d8959ae589b9b8cc35fb98ede3fc08f2387785950b423410e6c9160463e74ddb6a280ac236213111f88d9e2c36238cd8
+  data.tar.gz: 69b8579d774dba31bbf04b6d47a91141816c814c5d725ace4a3f8fbe9a79594d9006ad8df7e5707d35041d2b699beb81d9a923c49767c5954e6e4fbcfe247f74

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.github/workflows/verify.yml

@@ -0,0 +1,68 @@
+name: Verify
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  test:
+    runs-on: ubuntu-16.04
+    timeout-minutes: 40
+
+    services:
+      postgres:
+        image: postgres:9.6
+        ports: ["5432:5432"]
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    strategy:
+      fail-fast: true
+      matrix:
+        ruby:
+          - 2.7
+
+    env:
+      RAILS_ENV: test
+
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - name: Install system dependencies
+        run: sudo apt-get install libpcap-dev graphviz
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Setup bundler
+        run: |
+          gem install bundler
+
+      - name: Bundle install
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Test
+        run: |
+          cp spec/dummy/config/database.yml.github_actions spec/dummy/config/database.yml
+          bundle exec rake --version
+          bundle exec rake db:create db:migrate
+
+          # Disabling this check because it is proving unreliable
+          # git diff --exit-code spec/dummy/db/structure.sql
+          bundle exec rake spec
+          bundle exec rake yard

data/.gitignore

@@ -0,0 +1,29 @@
+# bundler configuration
+.bundle
+# Mac OS X folder attributes
+.DS_Store
+# built gems
+*.gem
+# Rubymine project configuration
+.idea
+# logs
+*.log
+# Don't check in new rvm version and gemset files
+.ruby-gemset
+.ruby-version
+# Don't check in rvmrc since this is a gem
+.rvmrc
+# YARD database
+.yardoc
+# coverage report directory for simplecov/Rubymine
+coverage
+# generated yardocs
+doc
+# Installed gem versions.  Not stored for the same reasons as .rvmrc
+Gemfile.lock
+# Packaging directory for builds
+pkg/*
+# Database configuration (with passwords) for specs
+spec/dummy/config/database.yml
+# Secrets
+spec/dummy/tmp/*

data/.rspec

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

data/.simplecov

@@ -0,0 +1,38 @@
+# RM_INFO is set when using Rubymine.  In Rubymine, starting SimpleCov is
+# controlled by running with coverage, so don't explicitly start coverage (and
+# therefore generate a report) when in Rubymine.  This _will_ generate a report
+# whenever `rake spec` is run.
+unless ENV['RM_INFO']
+	SimpleCov.start
+end
+
+SimpleCov.configure do
+  load_profile('rails')
+
+  # ignore this file
+	add_filter '.simplecov'
+
+	#
+	# Changed Files in Git Group
+	# @see http://fredwu.me/post/35625566267/simplecov-test-coverage-for-changed-files-only
+	#
+
+	untracked = `git ls-files --exclude-standard --others`
+	unstaged = `git diff --name-only`
+	staged = `git diff --name-only --cached`
+	all = untracked + unstaged + staged
+	changed_filenames = all.split("\n")
+
+	add_group 'Changed' do |source_file|
+		changed_filenames.detect { |changed_filename|
+			source_file.filename.end_with?(changed_filename)
+		}
+	end
+
+	#
+	# Specs are reported on to ensure that all examples are being run and all
+	# lets, befores, afters, etc are being used.
+	#
+
+	add_group 'Specs', 'spec'
+end

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+--plugin yard-metasploit-erd
+--protected
+{app,lib}/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Next Release
+
+* Enhancements
+* Bug Fixes
+* Deprecations
+* Incompatible Changes

data/CONTRIBUTING.md

@@ -0,0 +1,133 @@
+# Contributing
+
+## Forking
+
+[Fork this repository](https://github.com/rapid7/metasploit_data_models/fork)
+
+## Branching
+
+Branch names follow the format `TYPE/ISSUE/SUMMARY`.  You can create it with `git checkout -b TYPE/ISSUE/SUMMARY`.
+
+### `TYPE`
+
+`TYPE` can be `bug`, `chore`, or `feature`.
+
+### `ISSUE`
+
+`ISSUE` is either a [Github issue](https://github.com/rapid7/metasploit_data_models/issues) or an issue from some other
+issue tracking software.
+
+### `SUMMARY`
+
+`SUMMARY` is is short summary of the purpose of the branch composed of lower case words separated by '-' so that it is a valid `PRERELEASE` for the Gem version.
+
+## Changes
+
+### `PRERELEASE`
+
+1. Update `PRERELEASE` to match the `SUMMARY` in the branch name.  If you branched from `master`, and [version.rb](lib/metasploit_data_models/version.rb) does not have `PRERELEASE` defined, then adding the following lines after `PATCH`:
+```
+# The prerelease version, scoped to the {MAJOR}, {MINOR}, and {PATCH} version number.
+PRERELEASE = '<SUMMARY>'
+```
+2. `rake spec`
+3.  Verify the specs pass, which indicates that `PRERELEASE` was updated correctly.
+4. Commit the change `git commit -a`
+
+### Your changes
+
+Make your changes or however many commits you like, committing each with `git commit`.
+
+### Pre-Pull Request Testing
+
+#### Specs
+1. Run specs one last time before opening the Pull Request: `rake spec`
+2. Verify there was no failures.
+
+#### Documentation
+1. Generate yard documentation to ensure all new code is documented: `rake yard`
+2. Verify there were no `[warn]`ings.
+3. Verify there were no undocumented objects.
+
+### Push
+
+Push your branch to your fork on github: `git push TYPE/ISSUE/SUMMARY`
+
+### Pull Request
+
+* [Create new Pull Request](https://github.com/rapid7/metasploit_data_models/compare/)
+* Add a Verification Steps to the description comment
+
+```
+# Verification Steps
+
+- [ ] `bundle install`
+
+## `rake spec`
+- [ ] `rake spec`
+- [ ] VERIFY no failures
+
+## `rake yard`
+- [ ] `rake yard`
+- [ ] VERIFY no `[warn]`ings
+- [ ] VERIFY no undocumented objects
+```
+
+You should also include at least one scenario to manually check the changes outside of specs.
+
+* Add a Post-merge Steps comment
+
+The 'Post-merge Steps' are a reminder to the reviewer of the Pull Request of how to update the [`PRERELEASE`](lib/metasploit_data_models/version.rb) so that [version_spec.rb](spec/lib/metasploit_data_models/version.rb_spec.rb) passes on the target branch after the merge.
+
+DESTINATION is the name of the destination branch into which the merge is being made.  SOURCE_SUMMARY is the SUMMARY from TYPE/ISSUE/SUMMARY branch name for the SOURCE branch that is being made.
+
+When merging to `master`:
+
+```
+# Post-merge Steps
+
+Perform these steps prior to pushing to master or the build will be broke on master.
+
+## Version
+- [ ] Edit `lib/metasploit_data_models/version.rb`
+- [ ] Remove `PRERELEASE` and its comment as `PRERELEASE` is not defined on master.
+
+## Gem build
+- [ ] gem build *.gemspec
+- [ ] VERIFY the gem has no '.pre' version suffix.
+
+## RSpec
+- [ ] `rake spec`
+- [ ] VERIFY version examples pass without failures
+
+## Commit & Push
+- [ ] `git commit -a`
+- [ ] `git push origin master`
+```
+
+When merging to DESTINATION other than `master`:
+
+```
+# Post-merge Steps
+
+Perform these steps prior to pushing to DESTINATION or the build will be broke on DESTINATION.
+
+## Version
+- [ ] Edit `lib/metasploit_data_models/version.rb`
+- [ ] Change `PRERELEASE` from `SOURCE_SUMMARY` to `DESTINATION_SUMMARY` to match the branch (DESTINATION) summary (DESTINATION_SUMMARY)
+
+## Gem build
+- [ ] gem build metasploit_data_models.gemspec
+- [ ] VERIFY the prerelease suffix has change on the gem.
+
+## RSpec
+- [ ] `rake spec`
+- [ ] VERIFY version examples pass without failures
+
+## Commit & Push
+- [ ] `git commit -a`
+- [ ] `git push origin DESTINATION`
+```
+
+To update the [CHANGELOG.md](CHANGELOG.md) with the merged changes or release the merged code see
+[RELEASING.md](RELEASING.md)

data/Gemfile

@@ -0,0 +1,46 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in metasploit_data_models.gemspec
+gemspec
+
+
+group :development do
+  #gem 'metasploit-erd'
+  # embed ERDs on index, namespace Module and Class<ApplicationRecord> pages
+  #gem 'yard-metasploit-erd'
+end
+
+# used by dummy application
+group :development, :test do
+  # Upload coverage reports to coveralls.io
+  gem 'coveralls', require: false  
+  # supplies factories for producing model instance for specs
+  # Version 4.1.0 or newer is needed to support generate calls without the 'FactoryBot.' in factory definitions syntax.
+  gem 'factory_bot'
+  # auto-load factories from spec/factories
+  gem 'factory_bot_rails'
+
+  gem 'rails'
+  # Used to create fake data
+  gem "faker"
+
+  # bound to 0.20 for Activerecord 4.2.8 deprecation warnings:
+  # https://github.com/ged/ruby-pg/commit/c90ac644e861857ae75638eb6954b1cb49617090
+  gem 'pg'
+
+  gem 'pry'
+end
+
+group :test do
+  # In a full rails project, factory_girl_rails would be in both the :development, and :test group, but since we only
+  # want rails in :test, factory_girl_rails must also only be in :test.
+  # add matchers from shoulda, such as validates_presence_of, which are useful for testing validations
+  gem 'shoulda-matchers'
+  # code coverage of tests
+  gem 'simplecov', :require => false
+  # need rspec-rails >= 2.12.0 as 2.12.0 adds support for redefining named subject in nested context that uses the
+  # named subject from the outer context without causing a stack overflow.
+  gem 'rspec-rails'
+  # used for building markup for webpage factories
+  gem 'builder'
+end

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (C) 2012, Rapid7, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+	  this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+	  this list of conditions and the following disclaimer in the documentation
+	  and/or other materials provided with the distribution.
+
+    * Neither the name of Rapid7 LLC nor the names of its contributors
+	  may be used to endorse or promote products derived from this software
+	  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,65 @@
+#MetasploitDataModels [![Build Status](https://travis-ci.org/rapid7/metasploit_data_models.png)](https://travis-ci.org/rapid7/metasploit_data_models)[![Code Climate](https://codeclimate.com/github/rapid7/metasploit_data_models.png)](https://codeclimate.com/github/rapid7/metasploit_data_models)[![Coverage Status](https://coveralls.io/repos/rapid7/metasploit_data_models/badge.png)](https://coveralls.io/r/rapid7/metasploit_data_models)[![Dependency Status](https://gemnasium.com/rapid7/metasploit_data_models.png)](https://gemnasium.com/rapid7/metasploit_data_models)[![Gem Version](https://badge.fury.io/rb/metasploit_data_models.png)](http://badge.fury.io/rb/metasploit_data_models)
+
+Part of Metasploit's database layer
+
+## Purpose
+__MetasploitDataModels__ exists to do several key things:
+
+1. Allow code sharing between Metasploit Framework (MSF) and the commercial versions of Metasploit (Community, Express, Pro -- usually referred to collectively as "Pro")
+
+2. Give developers a lightweight entry point to MSF's backend for use in developing tools that gather data intended for later use with Metasploit (e.g. specialized scanners).
+
+3. Make it easy to keep commercial stuff private while increasing the functionality of the open-source tools we provide to the community.
+
+
+## Usage
+
+### Rails
+
+In a Rails application, MetasploitDataModels acts a
+[Rails Engine](http://edgeapi.rubyonrails.org/classes/Rails/Engine.html) and the models are available to application
+just as if they were defined under `app/models`.  If your Rails appliation needs to modify the models, this can be done
+using `ActiveSupport.on_load` hooks in initializers.  The block passed to on_load hook is evaluated in the context of the
+model class, so defining method and including modules will work just like reopeninng the class, but
+`ActiveSupport.on_load` ensures that the monkey patches will work after reloading in development mode.  Each class has a
+different `on_load` name, which is just the class name converted to an underscored symbol, so `Mdm::ApiKey` runs the
+`:mdm_api_key` load hooks, etc.
+
+    # Gemfile
+    gem :metasploiit_data_models, :git => git://github.com/rapid7/metasploit_data_models.git, :tag => 'v0.3.0'
+
+    # config/initializers/metasploit_data_models.rb
+    ActiveSupport.on_load(:mdm_api_key) do
+      # Returns the String obfuscated token for display. Meant to avoid CSRF
+      # api-key stealing attackes.
+      def obfuscated_token
+        token[0..3] + "****************************"
+      end
+    end
+
+**This gem's `Rails::Engine` is not required automatically.** You'll need to also add the following to your `config/application.rb`:
+
+    require 'metasploit_data_models/engine'
+
+### Metasploit Framework
+
+In Metasploit Framework, `MetasploitDataModels::Engine` is loaded, but the data models are only if the user wants to use
+the database.
+
+### Elsewhere
+
+In Metasploit Pro, MDM is loaded via the metasploit_data_models gem: https://rubygems.org/gems/metasploit_data_models
+
+## Developer Info
+
+### Console
+The gem includes a console based on [Pry](https://github.com/pry/pry/)
+
+Give it a path to a working MSF database.yml file for full
+ActiveRecord-based access to your data.
+
+__Note:__ "development" mode is hardcoded into the console currently.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)

data/RELEASING.md

@@ -0,0 +1,82 @@
+# Releasing
+
+These steps can be added to the Pull Request description's task list to remind the reviewer of how to release the
+gem.
+
+```
+# Release
+
+Complete these steps on DESTINATION
+
+## [CHANGELOG.md](CHANGELOG.md)
+
+### Terminology
+
+* "Enhancements" are widdening the API, such as by adding new classes or methods.
+* "Bug Fixes" are fixes to the implementation that do not affect the public API.  If the public API is affected then
+  the change should be listed as both a "Bug Fix" and either an "Enhancement" or "Incompatible Change" depending on how
+  the bug was fixed.
+* "Deprecations" are changes to the implementation that cause deprecation warnings to be issued for APIs which will be
+  removed in a future major release.  "Deprecations" are usually accompanied by an Enhancement that creates a new API
+  that is meant to be used in favor of the deprecated API.
+* "Incompatbile Changes" are the removal of classes or methods or new required arguments or setup that shrink the API.
+  It is best practice to make a "Deprecation" for the API prior to its removal.
+
+### Task List
+
+- [ ] Generate the list of changes since the last release: `git log v<LAST_MAJOR>.<LAST_MINOR>.<LAST_PATCH>..HEAD`
+- [ ] For each commit in the release, find the corresponding PR by search for the commit on Github.
+- [ ] For each PR, determine whether it is an Enhancement, Bug Fix, Deprecation, and/or Incompatible Change.  A PR can
+      be in more than one category, in which case it should be listed in each category it belongs, but with a category
+      specific description of the change.
+- [ ] Add an item to each category's list in the following format: `[#<PR>](https://github.com/rapid7/metasploit_data_models/pull/<PR>) <consumer summary> - [@<github_user>](https://github.com/<github_user>)`
+      `consumer_summary` should be a summary of the Enhancement, Bug Fix, Deprecation, or Incompatible Change from a
+      downstream consumer's of the library's perspective.  `github_user` should be Github handle of the author of the
+      PR.
+- [ ] If you added any Deprecations or Incompatible Changes, then adding upgrading information to
+      [UPGRADING.md](UPGRADING.md)
+
+## `VERSION`
+
+The entries in the [CHANGELOG.md](CHANGELOG.md) can be used to help determine how the `VERSION` should be bumped.
+
+### Bug fixes
+
+If the [CHANGELOG.md](CHANGELOG.md) contains only Bug Fixes for the Next Release, then increment
+[`PATCH`](lib/metasploit_data_models/version.rb).
+
+### Compatible API changes
+
+If the [CHANGELOG.md](CHANGELOG.md) contains any Enhancements or Deprecations, then increment
+[`MINOR`](lib/metasploit_data_models/version.rb) and reset [`PATCH`](lib/metasploit_data_models/version.rb) to `0`.
+
+### Incompatible API changes
+
+If the [CHANGELOG.md](CHANGELOG.md) contains any Incompatible Change, then increment [`MAJOR`](lib/metasploit_data_models/version.rb) and
+reset [`MINOR`](lib/metasploit_data_models/version.rb and [`PATCH`](lib/metasploit_data_models/version.rb) to `0`.
+
+## Setup [CHANGELOG.md](CHANGELOG.md) for next release
+
+- [ ] Change `Next Release` section name at the top of [CHANGELOG.md](CHANGELOG.md) to match the current `VERSION`.
+- [ ] Add a new `Next Release` section above the `VERSION`'s section you just renamed:
+<pre>
+# Next Release
+
+* Enhancements
+* Bug Fixes
+* Deprecations
+* Incompatible Changes
+</pre>
+
+## Release to rubygems.org
+
+## ruby-2.1
+- [ ] `rvm use ruby-2.1@metasploit_data_models`
+- [ ] `rm Gemfile.lock`
+- [ ] `bundle install`
+- [ ] `rake release`
+```
+
+### Downstream dependencies
+
+There are currently no known downstream dependencies

data/Rakefile

@@ -0,0 +1,72 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+
+print_without = false
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+
+begin
+  load 'rails/tasks/engine.rake'
+rescue LoadError
+  puts "railties not in bundle, so can't load engine tasks."
+  print_without = true
+end
+
+Bundler::GemHelper.install_tasks
+
+#
+# load rake files like a normal rails app
+# @see http://viget.com/extend/rails-engine-testing-with-rspec-capybara-and-factorygirl
+#
+
+pathname = Pathname.new(__FILE__)
+root = pathname.parent
+rakefile_glob = root.join('lib', 'tasks', '**', '*.rake').to_path
+
+Dir.glob(rakefile_glob) do |rakefile|
+  load rakefile
+end
+
+begin
+  require 'rspec/core'
+rescue LoadError
+  puts "rspec not in bundle, so can't set up spec tasks.  " \
+       "To run specs ensure to install the development and test groups."
+  print_without = true
+else
+  require 'rspec/core/rake_task'
+
+  # Depend on app:db:test:prepare so that test database is recreated just like in a full rails app
+  # @see http://viget.com/extend/rails-engine-testing-with-rspec-capybara-and-factorygirl
+  RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+  task :default => :spec
+end
+
+# Use find_all_by_name instead of find_by_name as find_all_by_name will return pre-release versions
+gem_specification = Gem::Specification.find_all_by_name('metasploit-yard').first
+
+if gem_specification
+  Dir[File.join(gem_specification.gem_dir, 'lib', 'tasks', '**', '*.rake')].each do |rake|
+    load rake
+  end
+
+  #
+  # Eager load before yard docs so that ApplicationRecord subclasses are loaded for yard-metasploit-erd
+  #
+
+  task 'yard:doc' => :eager_load
+
+  task eager_load: :environment do
+    Rails.application.eager_load!
+  end
+else
+  puts "metasploit-yard not in bundle, so can't setup yard tasks. " \
+       "To run yard ensure to install the development group."
+  print_without = true
+end
+
+if print_without
+  puts "Bundle currently installed '--without #{Bundler.settings.without.join(' ')}'."
+  puts "To clear the without option do `bundle install --without ''` (the --without flag with an empty string) or " \
+       "`rm -rf .bundle` to remove the .bundle/config manually and then `bundle install`"
+end

data/UPGRADING.md

@@ -0,0 +1 @@
+No Deprecations or Incompatible Changes have been introduced at this time

data/app/models/mdm/api_key.rb

@@ -0,0 +1,61 @@
+# API key to access the RPC.
+class Mdm::ApiKey < ApplicationRecord
+  
+  #
+  # Attributes
+  #
+
+  # @!attribute [rw] created_at
+  #   When this API Key was created.
+  #
+  #   @return [DateTime]
+
+  # @!attribute [rw] token
+  #   The API Key to authenicate to the RPC.
+  #
+  #   @return [String]
+
+  # @!attribute [rw] updated_at
+  #   The last time this API Key was updated.
+  #
+  #   @return [DateTime]
+
+  #
+  #
+  # Validations
+  #
+  #
+
+  #
+  # Method Validations
+  #
+
+  validate :supports_api
+
+  #
+  # Attribute Validations
+  #
+
+  validates :token, :presence => true, :length => { :minimum => 8 }
+
+  #
+  # Instance Methods
+  #
+
+  protected
+
+
+  # Validates whether License supports API.
+  #
+  # @return [void]
+  # @todo MSP-2724
+  def supports_api
+    license = License.get
+
+    if license and not license.supports_api?
+      errors.add :license, " - this product does not support API access"
+    end
+  end
+
+  Metasploit::Concern.run(self)
+end