machinery-tool 1.22.2 → 1.22.3

data/plugins/patterns/patterns_inspector.rb

@@ -60,11 +60,19 @@ module Machinery
         xml = @system.run_command("zypper", "--non-interactive", "-xq", "--no-refresh", "patterns",
           "-i", stdout: :capture)
       rescue Cheetah::ExecutionFailed => e
-        if e.stdout.include?("locked")
+        # Zypper is locked
+        if e.status.exitstatus == 7 # ZYPPER_EXIT_ZYPP_LOCKED
           Machinery.logger.error(e.stdout)
           raise Machinery::Errors::ZypperFailed.new(
             "Zypper is locked."
           )
+        # Repositories are updated or gpg keys are expiring
+        elsif e.status.exitstatus == 106 # ZYPPER_EXIT_INF_REPOS_SKIPPED
+          Machinery.logger.error(
+            "Zypper returned exit code #{e.status.exitstatus} during patterns inspection with" \
+              " the message:\n#{e.stdout}"
+          )
+          xml = e.stdout
         else
           raise
         end

data/tools/go.rb

@@ -35,9 +35,12 @@ class Go
 
   def build
     if archs.count == 1
-      system("go build -o machinery-helper-#{archs.first}")
+      arch = archs.first
+      puts("Building machinery-helper for architecture #{arch}.")
+      system("go build -o machinery-helper-#{arch}")
     else
       archs.each do |arch|
+        puts("Building machinery-helper for architecture #{arch}.")
         system(
           "env GOOS=linux #{compile_options(arch)} go build -o machinery-helper-#{arch}"
         )

data/tools/helper_builder.rb

@@ -66,7 +66,6 @@ const VERSION = "#{git_revision}"
   def build_machinery_helper
     FileUtils.rm_f(Dir.glob(File.join(@helper_dir, "machinery-helper*")))
     Dir.chdir(@helper_dir) do
-      puts("Building machinery-helper binaries")
       if @go.build
         true
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: machinery-tool
 version: !ruby/object:Gem::Version
-  version: 1.22.2
+  version: 1.22.3
 platform: ruby
 authors:
 - SUSE
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2017-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cheetah
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: abstract_method
   requirement: !ruby/object:Gem::Requirement
@@ -98,14 +84,14 @@ dependencies:
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
@@ -140,14 +126,14 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
@@ -483,7 +469,6 @@ files:
 - manual/docs/wheels.png
 - manual/mkdocs.yml
 - manual/site/CNAME
-- manual/site/base.html
 - manual/site/css/bootstrap.min.css
 - manual/site/css/custom.css
 - manual/site/css/fixed-positioning.css
@@ -542,7 +527,6 @@ files:
 - manual/site/machinery-export-html.1/index.html
 - manual/site/machinery-export-kiwi.1/index.html
 - manual/site/machinery-inspect-container.1/index.html
-- manual/site/machinery-inspect-docker.1/index.html
 - manual/site/machinery-inspect.1/index.html
 - manual/site/machinery-list.1/index.html
 - manual/site/machinery-man.1/index.html
@@ -557,8 +541,7 @@ files:
 - manual/site/machinery_main_scopes.1/index.html
 - manual/site/machinery_main_security_implications.1/index.html
 - manual/site/machinery_main_usecases.1/index.html
-- manual/site/machinery_security_implications.1/index.html
-- manual/site/mkdocs/js/lunr-0.5.7.min.js
+- manual/site/mkdocs/js/lunr.min.js
 - manual/site/mkdocs/js/mustache.min.js
 - manual/site/mkdocs/js/require.js
 - manual/site/mkdocs/js/search-results-template.mustache
@@ -781,7 +764,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Systems management toolkit

data/manual/site/base.html

@@ -1,42 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8"/>
-    <link href="{{ base_url }}/custom.css" rel="stylesheet">
-  </head>
-  <body id="manpage">
-    <div id="back">
-      <a href="{{ base_url }}">
-        <img src="../hand3.png" class="hand3"/>
-        <div class="goback">Go back to the web site</div>
-      </a>
-    </div>
-    <div class="mp">
-      <div class="nav">
-        <ul>
-          {% for nav_item in nav %}
-              {% if nav_item.children %}
-                  <li>{{ nav_item.title }}
-                      <ul>
-                      {% for nav_item in nav_item.children %}
-                          <li class="{% if nav_item.active%}current{%endif%}">
-                              <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
-                          </li>
-                      {% endfor %}
-                      </ul>
-                  </li>
-              {% else %}
-                  <li class="{% if nav_item.active%}current{%endif%}">
-                      <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
-                  </li>
-              {% endif %}
-
-          {% endfor %}
-        </ul>
-      </div>
-      <div class="content">
-        {{ content }}
-      </div>
-    </div>
-  </body>
-</html>

data/manual/site/machinery-inspect-docker.1/index.html

@@ -1,242 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8"/>
-    <link href="../custom.css" rel="stylesheet">
-  </head>
-  <body id="manpage">
-    <div id="back">
-      <a href="..">
-        <img src="../hand3.png" class="hand3"/>
-        <div class="goback">Go back to the web site</div>
-      </a>
-    </div>
-    <div class="mp">
-      <div class="nav">
-        <ul>
-          
-              
-                  <li class="">
-                      <a href="../docs/">Welcome</a>
-                  </li>
-              
-
-          
-              
-                  <li>Home
-                      <ul>
-                      
-                          <li class="">
-                              <a href="../machinery_main_general.1/">General</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery_main_scopes.1/">Scopes</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery_main_usecases.1/">Use cases</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery_security_implications.1/">Security Implications</a>
-                          </li>
-                      
-                      </ul>
-                  </li>
-              
-
-          
-              
-                  <li>Commands
-                      <ul>
-                      
-                          <li class="">
-                              <a href="../machinery-analyze.1/">Analyze</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-build.1/">Build</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-compare.1/">Compare</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-config.1/">Config</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-copy.1/">Copy</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-deploy.1/">Deploy</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-inspect.1/">Inspect</a>
-                          </li>
-                      
-                          <li class="current">
-                              <a href="./">Inspect Docker</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-list.1/">List</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-man.1/">Man</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-move.1/">Move</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-remove.1/">Remove</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-serve.1/">Serve</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-show.1/">Show</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-validate.1/">Validate</a>
-                          </li>
-                      
-                      </ul>
-                  </li>
-              
-
-          
-        </ul>
-      </div>
-      <div class="content">
-        <h1 id="inspect-container-inspect-container">inspect-container — Inspect Container</h1>
-<h2 id="synopsis">SYNOPSIS</h2>
-<p><code>machinery inspect-container</code> [OPTIONS] IMAGENAME</p>
-<p><code>machinery inspect-container</code> [OPTIONS] IMAGEID</p>
-<p><code>machinery</code> help inspect-container</p>
-<h2 id="description">DESCRIPTION</h2>
-<p>The <code>inspect-container</code> command inspects a container image. It creates and starts the container from the provided image before inspection
-and generates a system description from the gathered data. After the inspection the container will be killed and removed again.
-This approach ensures that no containers and images are affected by the inspection.</p>
-<p>Right now the container inspection only supports Docker images.</p>
-<p>The system data is structured into scopes, controlled by the
-<code>--scope</code> option.</p>
-<p><strong>Note</strong>:
-Machinery will always inspect all specified scopes, and skip scopes which
-trigger errors.</p>
-<h2 id="arguments">ARGUMENTS</h2>
-<ul>
-<li><code>IMAGENAME / IMAGEID</code> (required):
-    The name or id of the image to be inspected. The provided name or id will also be
-    used as the name of the stored system description unless another name is
-    provided with the <code>--name</code> option.</li>
-</ul>
-<h2 id="options">OPTIONS</h2>
-<ul>
-<li>
-<p><code>-n NAME</code>, <code>--name=NAME</code> (optional):
-    Store the system description under the specified name.</p>
-</li>
-<li>
-<p><code>-s SCOPE</code>, <code>--scope=SCOPE</code> (optional):
-    Inspect image for specified scope.
-    See the <a href="#Scopes">Scope section</a> for more information.</p>
-</li>
-<li>
-<p><code>-e SCOPE</code>, <code>--ignore-scope=IGNORE-SCOPE</code> (optional):
-    Inspect image for all scopes except the specified scope.
-    See the <a href="#Scopes">Scope section</a> for more information.</p>
-</li>
-<li>
-<p><code>-x</code>, <code>--extract-files</code> (optional):
-    Extract changed configuration and unmanaged files from the inspected container.
-    Shortcut for the combination of <code>--extract-changed-config-files</code>,
-    <code>--extract-unmanaged-files</code>, and <code>--extract-changed-managed-files</code></p>
-</li>
-<li>
-<p><code>--extract-changed-config-files</code> (optional):
-    Extract changed configuration files from the inspected image.</p>
-</li>
-<li>
-<p><code>--extract-unmanaged-files</code> (optional):
-    Extract unmanaged files from the inspected image.</p>
-</li>
-<li>
-<p><code>--extract-changed-managed-files</code> (optional):
-    Extract changed managed files from inspected image.</p>
-</li>
-<li>
-<p><code>--skip-files</code> (optional):
-    Do not consider given files or directories during inspection. Either provide
-    one file or directory name or a list of names separated by commas. You can
-    also point to a file which contains a list of files to filter (one per line)
-    by adding an '@' before the path, e.g.</p>
-<p>$ <code>machinery</code> inspect-container --skip-files=@/path/to/filter_file myimage</p>
-<p>If a filename contains a comma it needs to be escaped, e.g.</p>
-<p>$ <code>machinery</code> inspect-container --skip-files=/file\,with_comma myimage</p>
-<p><strong>Note</strong>: File or directory names are not expanded, e.g. '../path' is taken
-  literally and not expanded.</p>
-</li>
-<li>
-<p><code>--verbose</code> (optional):
-    Display the filters which are used during inspection.</p>
-</li>
-</ul>
-<h2 id="prerequisites">PREREQUISITES</h2>
-<ul>
-<li>
-<p>Inspecting a container requires an image specified by the name or id.</p>
-</li>
-<li>
-<p>The image to be inspected needs to have the following commands:</p>
-<ul>
-<li><code>rpm</code> or <code>dpkg</code></li>
-<li><code>zypper</code>, <code>yum</code> or <code>apt-cache</code></li>
-<li><code>rsync</code></li>
-<li><code>cat</code></li>
-<li><code>sed</code></li>
-<li><code>find</code></li>
-</ul>
-</li>
-</ul>
-<h2 id="examples">EXAMPLES</h2>
-<ul>
-<li>
-<p>Inspect Docker container <code>myimage</code> and save system description under name 'MyContainer':</p>
-<p>$ <code>machinery</code> inspect-container --name=MyContainer myimage</p>
-</li>
-<li>
-<p>Inspect Docker container <code>076f46c1bef1</code> and save system description under name 'MySecondContainer':</p>
-<p>$ <code>machinery</code> inspect-container --name=MySecondContainer 076f46c1bef1</p>
-</li>
-<li>
-<p>Extract changed managed files and save them:</p>
-<p>$ <code>machinery</code> inspect-container --scope=changed-managed-files --extract-files myimage</p>
-</li>
-</ul>
-      </div>
-    </div>
-  </body>
-</html>

data/manual/site/machinery_security_implications.1/index.html

@@ -1,223 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8"/>
-    <link href="../custom.css" rel="stylesheet">
-  </head>
-  <body id="manpage">
-    <div id="back">
-      <a href="..">
-        <img src="../hand3.png" class="hand3"/>
-        <div class="goback">Go back to the web site</div>
-      </a>
-    </div>
-    <div class="mp">
-      <div class="nav">
-        <ul>
-          
-              
-                  <li class="">
-                      <a href="../docs/">Welcome</a>
-                  </li>
-              
-
-          
-              
-                  <li>Home
-                      <ul>
-                      
-                          <li class="">
-                              <a href="../machinery_main_general.1/">General</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery_main_scopes.1/">Scopes</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery_main_usecases.1/">Use cases</a>
-                          </li>
-                      
-                          <li class="current">
-                              <a href="./">Security Implications</a>
-                          </li>
-                      
-                      </ul>
-                  </li>
-              
-
-          
-              
-                  <li>Commands
-                      <ul>
-                      
-                          <li class="">
-                              <a href="../machinery-analyze.1/">Analyze</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-build.1/">Build</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-compare.1/">Compare</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-config.1/">Config</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-copy.1/">Copy</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-deploy.1/">Deploy</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-export-autoyast.1/">Export AutoYaST</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-export-kiwi.1/">Export Kiwi</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-inspect.1/">Inspect</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-inspect-docker.1/">Inspect Docker</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-list.1/">List</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-man.1/">Man</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-move.1/">Move</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-remove.1/">Remove</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-serve.1/">Serve</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-show.1/">Show</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-upgrade-format.1/">Upgrade Format</a>
-                          </li>
-                      
-                          <li class="">
-                              <a href="../machinery-validate.1/">Validate</a>
-                          </li>
-                      
-                      </ul>
-                  </li>
-              
-
-          
-        </ul>
-      </div>
-      <div class="content">
-        <h1 id="security-implications">SECURITY IMPLICATIONS</h1>
-<p>This document describes security related issues administrators need to be aware of when using
-Machinery.</p>
-<h2 id="inspection">Inspection</h2>
-<p>Machinery inspects several parts of a system which are covered by Machinery's scopes. A list
-of the available scopes and information about what they do can be found
-<a href="../machinery_main_scopes.1/index.html">here</a>.</p>
-<p>Users of Machinery who inspect systems need to be aware of the security implications in order
-to take the right decisions on how to protect the retrieved data.</p>
-<h2 id="retrieval-of-data">Retrieval of Data</h2>
-<p>Machinery transfers data from one end point to another via SSH (using public key authentication).</p>
-<p>Depending on the scope, Machinery <a href="../machinery_main_scopes.1/index.html">collects information</a>
-about files on the system. Additionally, when the <code>--extract-files</code> option is given for the
-<code>inspect</code> command, not only the meta data about the files (e.g. permission bits, owner, group etc
-.) but also the file content is extracted. Machinery does not distinguish between sensitive
-data (such as private keys or password files). That means that everyone with access to the system
-description has automatically access to <strong>all</strong> extracted files and contained sensitive data.</p>
-<h4 id="rootsudo-privileges">root/sudo Privileges</h4>
-<p>An inspection can only be done, when the user on the inspected system is either root or has
-sudo privileges. Information about the required sudo configuration can be found
-<a href="../machinery-inspect.1/index.html#prerequisites">here</a>.</p>
-<h2 id="storage-of-data">Storage of Data</h2>
-<h4 id="access-restrictions">Access Restrictions</h4>
-<p>After an inspection has been completed, the directory where the description is stored is made
-readable only for the user. The data is not encrypted by Machinery.</p>
-<h4 id="used-permission-bits">Used Permission Bits</h4>
-<p>When Machinery extracts data, it sets permission bits for files and directories as follows:</p>
-<table>
-<thead>
-<tr>
-<th>Permission Bits</th>
-<th>Used for ...</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>0700</td>
-<td>... directories inside the description directory</td>
-</tr>
-<tr>
-<td>0600</td>
-<td>... for files inside the description directory</td>
-</tr>
-</tbody>
-</table>
-<h4 id="accessing-system-descriptions">Accessing System Descriptions</h4>
-<p>By default, all system descriptions are stored in the directory <code>.machinery</code> in the home directory
-of the user running Machinery. The directory can be redefined by the environment variable
-<code>$MACHINERY_DIR</code>. Each description has its own subdirectory. There is a <code>manifest.json</code> file in
-each description directory which contains the data of the inspection. Extracted files are stored in
-separate subdirectories inside the same description directory.</p>
-<h2 id="presentation-of-data">Presentation of Data</h2>
-<p>There are several ways how data can be presented to one or more users. The user has the option to
-either start a web server and view descriptions or view the descriptions only in the console.</p>
-<p>The following commands are used to present data to users:</p>
-<ul>
-<li>show</li>
-<li>compare</li>
-<li>serve</li>
-<li>list</li>
-</ul>
-<p>All of the commands listed above also have a <code>--html</code> option. When this option is used, Machinery
-starts a web server what will listen on the IP address <code>127.0.0.1</code>. The <code>serve</code> command
-offers also a <code>--public</code> option which makes the server listen on all configured IP addresses.</p>
-<p><strong>WARNING:</strong> When making the server reachable from the outside, users can modify the link to
-access also other descriptions. There is currently no way to restrict the access to only one
-description.</p>
-<p>The <code>serve</code> command also allows the user to specify a port via the <code>--port</code> option. When no port
-is specified, the default port which is configured in the machinery config file in
-<code>~/.machinery/machinery.config</code>) will be taken.</p>
-<h2 id="export-of-data">Export of Data</h2>
-<h4 id="export-autoyast">export-autoyast</h4>
-<p>The <code>export-autoyast</code> command creates an AutoYaST profile for an automated installation. The result
-are also tar balls containing the extracted files from the system description. These files
-potentially contain sensitive data (e.g. passwords). This fact needs to be kept in mind, especially
-if these files are copied to a web server for an AutoYaST installation via HTTP.</p>
-<h4 id="export-kiwi">export-kiwi</h4>
-<p>The program Kiwi allows you to build OS images what you can use for installation. Machinery gives
-you the opportunity to build a complete Kiwi configuration from a system description. This
-configuration can be used to build an image via Kiwi. The <code>export-kiwi</code> command creates a
-directory, where it stores the Kiwi configuration and the files of a system description. These
-files potentially contain sensitive data (e.g. passwords).</p>
-<h4 id="build">build</h4>
-<p>The created image potentially contains sensitive data (e.g. passwords) from extracted files.</p>
-<h4 id="deploy">deploy</h4>
-<p>The uploaded image potentially contains sensitive data (e.g. passwords) from extracted files.</p>
-      </div>
-    </div>
-  </body>
-</html>