norad_beacon 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14e982822ee749402ff3bd736746133ffb7a4369
+  data.tar.gz: 7a186075cf787bbdf0b8a19fce1f4cac2d08b9a2
+SHA512:
+  metadata.gz: 996a5517ef20c314631e4c4f07e47a5534dd2fab78a7809a41aca682dd5158ff9f58a2acb15306e609fb7e3bf58e700a0dda3ae3a7d97f178b94e579fb29f86e
+  data.tar.gz: a01bb23b25b3293b4670c299f6e6d9d0f65c0c60f6786aa6b971cca1488be8320ca83e6326276ceb33b70b428983b4afd8b582aca366614351c80e92b4566c3f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitlab-ci.yml

@@ -0,0 +1,46 @@
+stages:
+  - static_analysis
+  - security_test
+  - behavior_test
+  - release
+
+image: ruby:2.3.3
+
+cache:
+  key: "$CI_BUILD_NAME"
+  paths:
+    - vendor/bundle
+
+variables:
+ NORAD_ROOT: 'http://127.0.0.1'
+
+before_script:
+  - bundle install --jobs=4
+
+rubocop:
+  stage: static_analysis
+  script: bundle exec rake rubocop
+
+bundle_audit:
+  stage: security_test
+  script: bundle exec bundle-audit check --update
+
+rspec:
+  stage: behavior_test
+  script: bundle exec rspec
+
+publish:
+  stage: release 
+  script:
+    - echo "---" > ~/.gem/credentials
+    - COLON=':' && echo "${COLON}rubygems_api_key${COLON} ${RUBYGEMS_API_KEY}" >> ~/.gem/credentials
+    - git config --global user.email "norad.dev@gmail.com"
+    - git config --global user.name "Norad Release"
+    - git config --global push.default simple
+    - chmod 0600 ~/.gem/credentials
+    - bundle exec rake build
+    - bundle exec rake release:guard_clean
+    - gem push `ls ./pkg/norad_beacon-*.gem` 
+    - rm -fr ~/.gem 
+  only:
+    - master

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.3
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120

data/.ruby-gemset

@@ -0,0 +1 @@
+beacon-gem

data/.ruby-version

@@ -0,0 +1 @@
+2.3.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CONTRIBUTING.md

@@ -0,0 +1,102 @@
+# How to contribute
+
+This guide is meant to provide guidelines for how to contribute to the Norad Beacon project. These
+procedures should work in the majority of cases. At times, it will be necessary to step outside of
+these guidelines and Do What Makes Sense. This is an living document that we can continue to modify
+as we define the process that helps us add code quickly and safely.
+
+## Getting Started
+
+* If you haven't already, you'll want to set up a [development box](https://gitlab.cisco.com/norad/dev-box).
+  This provides a consistent environment for running tests.
+* We use [rubocop](https://github.com/bbatsov/rubocop) to enforce code quality and style guidelines.
+  You can familiarize yourself with the [style guide](https://github.com/bbatsov/ruby-style-guide).
+  You can also install a tool into your editor which will help you follow the style guideline. One
+  for vim can be found [here](https://github.com/scrooloose/syntastic).
+
+## Making Changes
+
+Fundamentally, we follow the Github Flow(1) methodology for branching and committing code. The
+process essentially breaks down as follows:
+
+1. Assign the feature you are beginning to work on to yourself in JIRA.
+2. Create a feature branch off of the master branch. Note that anything in master is always
+   deployable, so this branch will always have the latest code. Branch names should be descriptive.
+3. Your branch is your branch. Feel free to experiment and commit freely. You may wish to make your
+   life easier when it's time to merge into master by learning about [auto-squashing
+   commits](https://robots.thoughtbot.com/autosquashing-git-commits).[^1]
+4. You are free to push the feature branch to the origin as freqently as you wish. This will run the
+   CI suite. You can also run the test suite locally on your dev box. By pushing to the feature
+   branch, you can engage other engineers on the team if you need help. They can checkout your
+   branch and examine the code.
+5. When your feature is done, open a Merge Request in Gitlab.
+
+At this point in process, there is no requirement of any kind for your commit messages. Before
+merging into master, though, you will need a "good commit message" for any commits that aren't being
+squashed. Links to further reading on this topic are available in the Additional Resources section.
+
+## Submitting Changes
+
+When your feature is ready, or is at a state where you'd like to formally begin engaging the rest of
+the team, create a [Merge Request](https://gitlab.cisco.com/norad/beacon/merge_requests)
+in Gitlab. Please write a meaningful title and detailed description that provides an overview of
+What your feature does and Why it does it. You can leave it to the code itself to explain the How,
+but feel free to call anything out here that you would like the reviewer(s) to pay special attention
+to.  If you feel that someone in particular needs to look at your Merge Request, you may assign the
+MR to them. Mentioning someone in the Merge Request description is another way to alert someone in
+particular you'd like for them to look at your MR, e.g. ```cc @bmanifol```.
+
+**ProTips**
+
+* Gitlab will autofill the title and description with your most recent commit when opening the Merge
+Request. So, writing a good commit for your last commit before opening the Merge Request can help
+you kill two birds with one stone.
+
+## Code Review Process
+
+The Code Review Process is meant to be an open-ended discussion about the feature that is being
+committed. It should address whether the changeset meets the requirements of the feature as well as
+the quality of the code itself. The reviewer(s) should also make sure that the feature includes an
+adequate number of meaningful tests.
+
+Please be polite in both giving and receiving feedback. Remember that it's a review of the code, not
+an individual. As a reviewer, do your best to separate your personal opinion of how you would do
+something from what is objectively constructive criticism. Please review the Thoughtbot guide for
+Code Reviews in the Additional Resources section (3).
+
+Make any changes to your feature branch that you and the reviewer agree should be made, and push
+those changes to your feature branch. This will automatically update your Merge Request. Repeat this
+process until the Merge Request is approved.
+
+The merge request must receive at least one **+1** before it can be merged. If individuals are
+called out to look at something during any point of the review process, they will need to provide a
+**+1** as well before it can be merged.
+
+## Merge Process
+
+Your feature got approved! Great! Now it's time to merge into master.
+
+1. Before code can be merged to master, **all tests must be passing**. In other words, you need a
+   green check from Gitlab CI.
+2. In order to keep the master branch's commit history clean, you may be required to rebase your
+   feature branch before it can be merged. This is a loose a requirement, but please consider
+   squashing interim commits into one or more block commits. The goal here is to keep the master
+   branch devoid of commits such as "fixing typo" or "trying out this method." To rebase, run the
+   following on your freature branch: ```git rebase -i origin/master```. See the additional
+   resources for more information on rebasing.
+3. After (force) pushing your rebased feature branch, the Merge Request can be merged **as long as
+   all tests still pass**.
+
+# Additional Resources
+
+1. [Github Flow](https://guides.github.com/introduction/flow/)
+2. [Code Review Guide](https://github.com/thoughtbot/guides/tree/master/code-review)
+3. [Style Guide](https://github.com/bbatsov/ruby-style-guide)
+4. [Git Tips](https://github.com/thoughtbot/guides/blob/master/protocol/git)
+5. [Git Rebase](https://help.github.com/articles/about-git-rebase/)
+6. [Auto-squashing Git Commits](https://robots.thoughtbot.com/autosquashing-git-commits)
+7. [Good Commit Messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
+8. [More Good Commit Messages](http://chris.beams.io/posts/git-commit/)
+9. [Even More Good Commit Messages](http://www.alexkras.com/19-git-tips-for-everyday-use/#good-commit-message)
+
+[^1]: Some background and additional reading on squashing commits. [Squashing Commits with Git](https://davidwalsh.name/squash-commits-git) deals with squashing commits in a feature branch. [git rebase --autosquash](https://coderwall.com/p/hh-4ea/git-rebase-autosquash) picks up where the previous article leaves off and explains how the "git rebase" option "--autosquash" complements squashing commits.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in norad.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "{}"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright 2015 Cisco Systems, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,41 @@
+# Beacon
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/beacon`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'norad_beacon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install norad_beacon
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on our Gitlab server at https://gitlab.cisco.com/norad/beacon.
+
+
+## License
+
+The gem is available as open source under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'norad_beacon'
+
+# 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

data/bin/setup

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

data/lib/norad_beacon.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'norad_beacon/version'
+require 'norad_beacon/runner'
+require 'norad_beacon/multi_runner'
+require 'norad_beacon/result'
+require 'norad_beacon/resultset'
+require 'norad_beacon/exceptions'
+require 'norad_beacon/container_options'
+require 'norad_beacon/api'
+
+module NoradBeacon
+  # Retrieves encrypted credentials stored
+  # locally on the docker container.
+  # @return [Hash]
+  def self.container_options
+    ContainerOptions.new.values
+  rescue NoradBeaconError => e
+    puts "Unable to load local container options: #{e.message}"
+    {}
+  end
+end

data/lib/norad_beacon/api.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'httparty'
+
+module NoradBeacon
+  # Class to post results
+  class NoradAPI
+    include HTTParty
+    @norad_root = ENV.fetch('NORAD_ROOT')
+
+    def self.post_results(results)
+      auth_header = { 'NORAD-SIGNATURE' => results.compute_signature }
+      address = @norad_root + results.url
+      post(
+        address,
+        body: results.payload, headers: { 'Content-Type' => 'application/json' }.merge(auth_header)
+      )
+    end
+  end
+end

data/lib/norad_beacon/container_options.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require 'safe_yaml'
+
+SafeYAML::OPTIONS[:default_mode] = :safe
+
+module NoradBeacon
+  class ContainerOptions
+    CONTAINERS_FILE_URI = '/containers.yml.enc'
+    AES_KEY_SIZE = 128
+    attr_reader :values
+
+    def initialize
+      @values = File.exist?(CONTAINERS_FILE_URI) ? decrypt_and_load : {}
+    end
+
+    private
+
+    # Reads encrypted credentials from disk, decrypts the
+    # credentials, and loads and returns the YAML.
+    # @return [Hash]
+    # rubocop:disable YAMLLoad
+    def decrypt_and_load
+      aes_key = load_key_from_env
+      symbolize YAML.load(decrypt_containers_file(aes_key))
+    rescue Psych::SyntaxError
+      raise NoradBeaconError, e.message
+    end
+    # rubocop:enable YAMLLoad
+
+    # Load the Base64 encoded key from the environment
+    # @return [String] AES Key
+    def load_key_from_env
+      Base64.strict_decode64(ENV.fetch('NORAD_CONTAINERS_FILE_KEY'))
+    rescue ArgumentError => e
+      raise NoradBeaconError, e.message
+    end
+
+    # Decrypt the contents of the containers options file
+    # @param aes_key [String]
+    # @return [String] decrypted contents of the file
+    def decrypt_containers_file(aes_key)
+      decipher = OpenSSL::Cipher::AES.new(AES_KEY_SIZE, :CBC)
+      decipher.decrypt
+      decipher.key = aes_key
+      encrypted_data = File.read(CONTAINERS_FILE_URI, mode: 'rb')
+      decipher.iv = encrypted_data[0..16] # First 16 bytes of this file is the IV
+      decipher.update(encrypted_data[16..-1]) + decipher.final
+    rescue Errno::ENOENT, OpenSSL::Cipher::CipherError => e
+      raise NoradBeaconError, e.message
+    end
+
+    # Symbolize the keys for a deeply nested array
+    # Adapted from ActiveSupport's implementation
+    #
+    # @param object [Object] some value we wish to symbolize
+    # @return [Hash] a hash with symbolized keys
+    def symbolize(object)
+      case object
+      when Hash
+        object.each_with_object({}) do |(k, v), result|
+          result[k.respond_to?(:to_sym) ? k.to_sym : k] = symbolize(v)
+        end
+      when Array
+        object.map { |el| symbolize(el) }
+      else
+        object
+      end
+    end
+  end
+end

data/lib/norad_beacon/exceptions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+class NoradBeaconError < StandardError
+end

data/lib/norad_beacon/multi_runner.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'childprocess'
+
+module NoradBeacon
+  class MultiRunner < Runner
+    attr_reader :result_sets
+
+    # Initialize an instance of the MultiRunner class
+    #
+    # @param prog [String] the program to execute
+    # @param args [Array] list of arguments to pass to the program
+    # @param timeout [Fixnum] optionally specify the timeout for the sub process
+    # @return [NoradBeacon::Runner] an instance of the Runner class
+    def initialize(prog, args, timeout = 600)
+      raise ArgumentError, 'args must be an Array' unless args.is_a?(Array)
+      @prog = prog
+      @timeout = timeout
+      @results_file = "/tmp/#{@prog}.#{Time.now.strftime('%Y%m%d-%H%M%S')}"
+      @result_sets = []
+      @args = format_args(args)
+    end
+  end
+end

data/lib/norad_beacon/result.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require 'json'
+
+module NoradBeacon
+  class Result
+    # rubocop:disable ParameterLists
+    def initialize(nid, status, output, title, description, sir = 'unevaluated')
+      @nid = nid
+      @sir = cvss_to_sir(sir)
+      @status = status
+      @output = output
+      @title = title
+      @description = description
+    end
+    # rubocop:enable ParameterLists
+
+    def to_json(*a)
+      {
+        nid: @nid, sir: @sir, status: @status, output: @output, title: @title, description: @description
+      }.to_json(*a)
+    end
+
+    private
+
+    def cvss_to_sir(sir)
+      return sir if sir !~ /\A\d+\.?\d*\z/
+      case sir.to_f
+      when 0.0..3.9 then return 'low'
+      when 4.0..6.9 then return 'medium'
+      when 7.0..8.9 then return 'high'
+      when 9.0..10.0 then return 'critical'
+      else
+        return 'unevaluated'
+      end
+    end
+  end
+end

data/lib/norad_beacon/resultset.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'json'
+require 'openssl'
+
+module NoradBeacon
+  class ResultSet
+    attr_accessor :url
+
+    def initialize(assessment_url = nil)
+      @results = []
+      @url = assessment_url || JSON.parse(ENV.fetch('ASSESSMENT_PATHS')).first['assessment']
+    end
+
+    def add(result)
+      @results.push(result)
+    end
+
+    def payload
+      @payload ||= { results: @results, timestamp: Time.now.to_i }.to_json
+    end
+
+    def compute_signature
+      OpenSSL::HMAC.hexdigest('sha256', ENV['NORAD_SECRET'], payload)
+    end
+  end
+end

data/lib/norad_beacon/runner.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+require 'childprocess'
+
+module NoradBeacon
+  class Runner
+    attr_reader :result_set, :exit_code
+
+    # Class method to return results file
+    def self.results_file
+      @results_fn ||= "/tmp/norad.results.#{Time.now.strftime('%Y%m%d-%H%M%S')}"
+    end
+
+    # Initialize an instance of the Runner class
+    #
+    # @param prog [String] the program to execute
+    # @param args [Array] list of arguments to pass to the program
+    # @param timeout [Fixnum] optionally specify the timeout for the sub process
+    # @return [NoradBeacon::Runner] an instance of the Runner class
+    def initialize(prog, args, timeout = 600)
+      raise ArgumentError, 'args must be an Array' unless args.is_a?(Array)
+      @prog = prog
+      @timeout = timeout
+      @result_set = NoradBeacon::ResultSet.new
+      @args = format_args(args)
+      @exit_code = nil
+    end
+
+    # Execute the command
+    def execute(stdout_results = false)
+      process = ChildProcess.build(@prog, *@args)
+      set_child_proc_io(process, stdout_results)
+      process.start
+      begin
+        process.poll_for_exit(@timeout)
+      rescue ChildProcess::TimeoutError
+        puts 'Beacon Timeout reached. Stopping the process...'
+        process.stop # tries increasingly harsher methods to kill the process.
+      end
+      @exit_code = process.exit_code
+    end
+
+    # Parse the results stored in the results file
+    def parse_results
+      raw_results = File.open(self.class.results_file, 'r')
+      yield raw_results
+      raw_results.close
+    end
+
+    private
+
+    # Replaces the filename delimeter and any local options we need to override
+    #
+    # @param args [Array] list of arguments to format
+    # @return [Array] formatted list of arguments
+    def format_args(args)
+      local_opts = NoradBeacon.container_options[(ENV['NORAD_SECURITY_CONTAINER_NAME'] || '').to_sym] || {}
+      args.map do |arg|
+        begin
+          next format(arg, local_opts) if arg =~ /\A%\{[a-zA-Z_][a-zA-Z_0-9]*\}\z/
+          arg
+        rescue KeyError, ArgumentError
+          arg
+        end
+      end.compact
+    end
+
+    def set_child_proc_io(process, stdout_results)
+      if stdout_results
+        process.io.stdout = File.open(self.class.results_file, 'w')
+      else
+        process.io.inherit!
+      end
+    end
+  end
+end

data/lib/norad_beacon/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module NoradBeacon
+  VERSION = '0.1.1'
+end

data/norad_beacon.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'norad_beacon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'norad_beacon'
+  spec.version       = NoradBeacon::VERSION
+  spec.authors       = ['Blake Hitchcock', 'Brian Manifold', 'Roger Seagle']
+  spec.email         = ['rbhitchcock@gmail.com', 'bmanifold@gmail.com ', 'roger.seagle@gmail.com']
+
+  spec.summary       = 'Gem to help with posting blackbox results to Norad.'
+  spec.description   = 'Gem to help with posting blackbox results to Norad.'
+  spec.homepage      = 'https://gitlab.com/norad/beacon'
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = '~> 2.3.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'childprocess'
+
+  spec.add_runtime_dependency 'safe_yaml', '~> 1.0.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler-audit', '~> 0.5'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: norad_beacon
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Blake Hitchcock
+- Brian Manifold
+- Roger Seagle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: childprocess
+  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: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Gem to help with posting blackbox results to Norad.
+email:
+- rbhitchcock@gmail.com
+- 'bmanifold@gmail.com '
+- roger.seagle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/norad_beacon.rb
+- lib/norad_beacon/api.rb
+- lib/norad_beacon/container_options.rb
+- lib/norad_beacon/exceptions.rb
+- lib/norad_beacon/multi_runner.rb
+- lib/norad_beacon/result.rb
+- lib/norad_beacon/resultset.rb
+- lib/norad_beacon/runner.rb
+- lib/norad_beacon/version.rb
+- norad_beacon.gemspec
+homepage: https://gitlab.com/norad/beacon
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Gem to help with posting blackbox results to Norad.
+test_files: []