octool 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35ad41804c6a3eb09cde544a272ea3b6e9108355ce0d32799846335e6d3d6345
-  data.tar.gz: 8573306612f8760275735e38e12e4295ccfec60ed731569558d7386063086850
+  metadata.gz: 7421bbf076967b16d0210f813f936c0a75b572694071ad6674cdbd2368bfc5ff
+  data.tar.gz: 849f56075a2a9815fdb225518fb3579c817ed570382f8cd3a3b2f35916d6e9a4
 SHA512:
-  metadata.gz: 70a54c2b4a2224ee8933f2a09dd32d252c0ef18170a0e129fdeab5387eea01e42574ed40107efd80a5ca28648e9c0d52afa0d996d227d0fa28e0bfa3173c96e6
-  data.tar.gz: 352859097909847bf476ad7ab307eed31764ee0a41a388da32d9f112c47bacdacf155636ac7fb5e7eea89b9ba3c61348bf301459f45e81e2dca48b2e447b91b9
+  metadata.gz: 5bb0a131801cc5003fc2102e7efcab828a6f65099b9f0e65e5df4472ff137ba1f52479b7b9f454cfe75f3551d36d6c6cdfe94cccbf9429aeff2a847713afd779
+  data.tar.gz: ee327ac99c2a3036c474ffb7d370c99d23af9afc2e3bc36a6d1fd10573f8f0e7f0e872633797ee25819bafe9f3dd73f0871a4d23741f6ce41f2dc14e69c82bc1

data/bin/octool

@@ -77,12 +77,18 @@ class App
         s.arg_name 'path/to/output/dir'
         s.flag [:d, :dir]
 
+        s.desc 'Set SSP version'
+        s.default_value OCTool::DEFAULT_SSP_VERSION
+        s.long_desc 'Underscores are replaced by spaces'
+        s.arg_name 'VERSION'
+        s.flag :version
+
         s.action do |global_options, options, args|
             export_dir = options[:dir]
             config_file = find_config(args)
             system = OCTool::Parser.new(config_file).load_system
             Dir.chdir File.dirname(config_file) do
-                OCTool::SSP.new(system, export_dir).generate
+                OCTool::SSP.new(system, export_dir).generate(options[:version])
             end
         end
     end

data/lib/octool/constants.rb

@@ -6,4 +6,5 @@ module OCTool
     ERB_DIR = File.join(File.dirname(__FILE__), '..', '..', 'templates').freeze
     DEFAULT_CONFIG_FILENAME = 'config.yaml'
     DEFAULT_OUTPUT_DIR = '/data'
+    DEFAULT_SSP_VERSION = 'unset'
 end

data/lib/octool/ssp.rb

@@ -1,13 +1,24 @@
 # frozen_string_literal: true
 
+require 'date'
 require 'erb'
 
 module OCTool
     # Build DB, CSV, and markdown.
     class SSP
+        attr_reader :build_date
+        attr_reader :version
+
         def initialize(system, output_dir)
             @system = system
             @output_dir = output_dir
+            @version = OCTool::DEFAULT_SSP_VERSION
+            @build_date = DateTime.now
+        end
+
+        def version=(version)
+            # LaTeX fancyheader aborts on underscore in footer.
+            @version = version.to_s.gsub(/_+/, ' ')
         end
 
         def pandoc
@@ -22,7 +33,8 @@ module OCTool
             exit(1)
         end
 
-        def generate
+        def generate(version = nil)
+            self.version = version if version
             unless File.writable?(@output_dir)
                 warn "[FAIL] #{@output_dir} is not writable"
                 exit(1)

data/lib/octool/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OCTool
-    VERSION = '0.0.10'
+    VERSION = '0.0.11'
 end

data/octool.rdoc

@@ -1,6 +1,6 @@
 == octool - Open Compliance Tool
 
-v0.0.10
+v0.0.11
 
 === Global Options
 === --help
@@ -48,6 +48,13 @@ where to store outputs
 [Default Value] /tmp
 Default output directory respects env vars TMPDIR, TMP, TEMP
 
+===== --version VERSION
+
+Set SSP version
+
+[Default Value] unset
+Underscores are replaced by spaces
+
 ==== Command: <tt>validate </tt>
 Check sanity of configuration
 

data/templates/ssp.erb

@@ -8,10 +8,17 @@ title: |
 title: "<%= @system.config['name'] -%>"
 <% end %>
 
-subtitle: "System Security Plan"
+subtitle: |
+    System Security Plan
+
+    <%=build_date.strftime('%Y-%b-%d')%>
+
+<% unless version == OCTool::DEFAULT_SSP_VERSION -%>
+    Version <%=version%>
+<% end -%>
 
 author:
-<% @system.config['maintainers'].each do |maintainer| %>
+<% @system.config['maintainers'].each do |maintainer| -%>
     - <%= maintainer -%>
 <% end %>
 
@@ -48,7 +55,7 @@ pagestyle: headings
 papersize: letter
 geometry:
     - top=2cm
-    - left=2cm
+    - left=3cm
     - right=2cm
     - bottom=2cm
 
@@ -94,6 +101,63 @@ header-includes:
         \usepackage{float}
         \floatplacement{figure}{H}
         ```
+    - |
+        ```{=latex}
+        % https://tex.stackexchange.com/a/32537
+        \usepackage{lastpage}
+
+        % https://ctan.org/pkg/fancyhdr?lang=en
+        \usepackage{fancyhdr}
+
+        \pagestyle{fancy}
+        <% unless version == OCTool::DEFAULT_SSP_VERSION %>
+        \fancyfoot[L]{Version: <%=version-%>}
+        <% end %>
+        \fancyfoot[C]{<%=build_date.strftime('%Y-%b-%d')-%>}
+        \fancyfoot[R]{\thepage\ of\ \pageref{LastPage}}
+        \renewcommand{\footrulewidth}{0.4pt} % thickness
+        \renewcommand{\headrulewidth}{0.4pt} % thickness
+        \fancypagestyle{plain}{\fancyhead{}\renewcommand{\headrule}{}}
+        ```
+    - |
+        ```{=latex}
+        % Which bullet glyphs are avaiable?
+        % http://texdoc.net/texmf-dist/doc/latex/comprehensive/symbols-a4.pdf TABLE 50
+        %
+        % https://learnbyexample.github.io/tutorial/ebook-generation/customizing-pandoc/
+        % https://tex.stackexchange.com/questions/174244/change-the-shape-of-the-bullet-list
+        % https://texblog.org/2008/10/16/lists-enumerate-itemize-description-and-how-to-change-them/
+        % https://tex.stackexchange.com/a/64899
+        % https://ctan.org/pkg/enumitem?lang=en
+        % https://www.latex4technics.com/?note=2vy0
+        %
+        %\usepackage{amsfonts}
+        %
+        % Make bullets small
+        %\renewcommand{\labelitemi}{\tiny $\textbullet$}
+        %\renewcommand{\labelitemii}{\tiny $\textopenbullet$}
+        %\renewcommand{\labelitemiii}{\tiny $\triangleright$}
+        %
+        % Align bullets to left margin and make small
+        % https://tex.stackexchange.com/a/86408
+        %\usepackage{enumitem}
+        %\usepackage{graphicx}
+        %\setlist[itemize,1]{leftmargin=*,label=\scalebox{.8}{$\textbullet$}}
+        %\setlist[itemize,2]{leftmargin=*,label=\scalebox{.8}{$\textopenbullet$}}
+        %\setlist[itemize,3]{leftmargin=*,label=\scalebox{.8}{\triangleright}}
+        %
+        % Align bullets to left margin and use normal font
+        \usepackage{enumitem}
+        \setlist[itemize,1]{leftmargin=*,label=$\textbullet$}
+        \setlist[itemize,2]{leftmargin=*,label=$\textopenbullet$}
+        \setlist[itemize,3]{leftmargin=*,label=\triangleright}
+        %
+        % Align bullets to left margin and use slightly smaller font
+        %\usepackage{MnSymbol}
+        %\setlist[itemize,1]{leftmargin=*,label=$\bullet$}
+        %\setlist[itemize,2]{leftmargin=*,label=$\circ$}
+        %\setlist[itemize,3]{leftmargin=*,label=\blacktriangleright}
+        ```
 ---
 
 # Introduction
@@ -107,13 +171,15 @@ on an information system and their implementation. An SSP provides:
 - Description of components and services
 - System data flows and authorization boundaries
 
+The SSP is also a tool to guide the assessment of the effectiveness
+of controls within the system.
 
 ## Standards
 
 This SSP draws from these standards:
 
 <% @system.standards.each do |s| -%>
-- <%= s['name'] %>
+- <%=s['name']-%> (<%=s['standard_key']-%>)
 <% end %>
 
 The full copy of each standard is included in the appendix.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octool
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Paul Morgan