opensecret 0.0.951 → 0.0.957

data/lib/session/session.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby
+# coding: utf-8
+
+module OpenSession
+
+  # Data and session attributes that span or have relevance across the
+  # entire runtime software instantiation.
+  #
+  # The sessiondata includes information on the user, the home directory,
+  # the session-wide reference time stamp and the session context.
+  class Session
+    include Singleton
+
+    # The session context is derived from the module name of the caller
+    # of the {self.set_context} method.
+    attr_accessor :context
+
+
+    # Read the software context by looking at the name of the module
+    # that is calling this method.
+    #
+    # @example
+    #    If the caller is registered as OpenTools::Hammer the session
+    #    context name is opentools
+    #
+    # The context name derivation simply pulls out the module name from
+    # the stack trace and downcases it.
+############    def set_context
+
+###########      module_name = File.basename caller_locations(1,1).first.absolute_path, ".rb"
+########      @context = module_name.downcase
+
+###########    end
+
+
+    # On non-windows systems the home directory is defined
+    # perfectly by Ruby's Dir object.
+    #
+    # On Windows we sometimes get /AppData/Roaming appended
+    # onto the actual home directory. In these cases this
+    # method removes it.
+    #
+    # @return [String] the path to the machine user's home directory
+    def home_directory
+
+      return Dir.home unless Gem.win_platform?
+
+      extraneous_path = "/AppData/Roaming"
+      if Dir.home.end_with? extraneous_path then
+        return Dir.home.gsub( extraneous_path, "" )
+      end
+
+      return Dir.home
+
+    end
+
+
+    #
+    # Get the username of the logged in user. This name should
+    # not contain spaces (and should be just alphanumeric).
+    #
+    # The current implementation uses environment variables and
+    # crudely states that the username is
+    #
+    # - ENV['USERNAME'] for the Windows platform
+    # - ENV['USER'] for Linux (and everything else)
+    #
+    # @return [String] the username of the machine user
+    def username
+
+      return ENV['USERNAME'] if Gem.win_platform?
+      return ENV['USER']
+
+    end
+
+
+  end
+
+
+end

data/lib/session/time.stamp.rb

@@ -4,40 +4,17 @@ module OpenSession
 
   require 'singleton'
 
-  #
   # This stamp sits at the centre of a fundamental DevOps pattern concerned
   # with infrastructure provisioning and configuraion management.
   #
   # The central idea behind the pattern is to link every infrastructure
-  # object created for an eco-system with an embedded reference that
-  # contains time stamps that are accurate to the nearest
-  #
-  # - month
-  # - day
-  # - hour of day
-  # - minute
-  # - second
-  # - tenth of second
-  # - hundredth of second
-  # - thousandth of second
-  #
-  # Which newly created or updated infrastructure objects are stamped?
-  #
-  # - files and folders
-  # - database user names
-  # - Docker containers
-  # - virtual machines
-  # - s3 buckets and their contents
-  # - aws ec2 machines
-  # - aws acl lists
-  # - hostnames and urls
-  #
+  # object created during a session with a reference accurate to the nearest
+  # centi-second denoting the moment the software runtime (session) began.
   class Stamp
     include Singleton
 
     attr_reader :time_now
 
-    #
     # Return two digit [mo] month index from 01 to 12.
     # @example 02 => in February
     #
@@ -46,7 +23,6 @@ module OpenSession
     end
 
 
-    #
     # Return three character abbreviated month name.
     # @example feb => in February
     #
@@ -96,9 +72,7 @@ module OpenSession
     # The final digit is derived from the 1000 sliced
     # millisecond of second running from 000 to 999.
     #
-    # ---------------------------
-    # Truncation (Not Rounding)
-    # ---------------------------
+    # <tt>Truncation (Not Rounding)</tt>
     #
     # The [final] digit is acquired by TRUNCATING
     # (chopping off) the last 2 of the 3 millisecond
@@ -106,12 +80,11 @@ module OpenSession
     #
     # The 3 returned digits comprise of the
     #
-    #  - second of minute => 2 digits | [00] to [59] (and)
-    #  - tenth of second  => 1 digit from [0] to [9]
+    # - second of minute => 2 digits | [00] to [59] (and)
+    # - tenth of second  => 1 digit from [0] to [9]
+    #
+    # @example
     #
-    # ---------
-    # Example
-    # ---------
     #  => The time at the 562nd millisecond  of the 49th
     #     second of the minute.
     #
@@ -151,7 +124,6 @@ module OpenSession
     end
 
 
-    #
     # [yymo_mmm] returns an amalgam of
     #
     #    => the two-digit year
@@ -159,11 +131,9 @@ module OpenSession
     #    => a period (separator)
     #    => the abbreviated month name
     #
-    # ---------
-    # Example
-    # ---------
-    #  => 1908.aug
-    #  => for August 2019
+    # @example
+    #   => 1908.aug
+    #   => for August 2019
     #
     def self.yymo_mmm
       return "#{yy}#{mo}.#{mmm}"
@@ -237,24 +207,19 @@ module OpenSession
     end
 
 
-    # ---------------------------------------------- -- #
-    # Return 5 digit amalgam of year and julian day. -- #
-    #  eg [19003] for [January 3rd 2019]             -- #
-    # ---------------------------------------------- -- #
+    # Return 5 digit amalgam of year and julian day.
+    #  eg [19003] for [January 3rd 2019]
     def self.yyjjj
       return "#{yy}#{jjj}"
     end
 
 
-    #
     # Return the 4 digit amalgam of the hour and minute
     # using the 24 hour clock.
     #
-    # ---------
-    # Example
-    # ---------
-    #  => 1525
-    #  => 03:25 pm
+    # @example
+    #   => 1525
+    #   => 03:25 pm
     #
     def self.hhmm
       return "#{hh}#{mm}"
@@ -274,32 +239,27 @@ module OpenSession
     #   second of minute => 2 digits | [00] to [59]
     #   tenth of second  => 1 digit from [0] to [9]
     #
-    # ---------
-    # Example
-    # ---------
-    #  => The time at the 562nd millisecond  of the 49th
-    #     second of the 23rd minute of the 17th hour of
-    #     the day ( 17:23:49.562 )
+    # @example
+    #   => The time at the 562nd millisecond  of the 49th
+    #      second of the 23rd minute of the 17th hour of
+    #      the day ( 17:23:49.562 )
     #
-    #  => 8 chars
-    #  => 1723.495
+    #   => 8 chars
+    #   => 1723.495
     #
     def self.hhmm_sst
       return "#{hhmm}.#{sst}"
     end
 
 
+    # Return a string timestampt that is a period separated
+    # amalgam of the 2 digit year, 3 digit julian day, 2 digit
+    # hour, 2 digit minute, 2 digit second and 1 digit rounded
+    # down tenth of second.
     #
-    # Return a period separated amalgam of the
-    #
-    #  => 2 digit year and 3 digit julian day
-    #  => 4 digit hour/minute
-    #
-    # ---------
-    # Example
-    # ---------
-    #  => 19003.1025
-    #  => 10:25 am on January 3rd 2019
+    # @example
+    #   => 19003.1025
+    #   => 10:25 am on January 3rd 2019
     #
     #
     # Return the time of day to a TENTH of a second accuracy.
@@ -311,63 +271,86 @@ module OpenSession
     #
     # The 3 digits of the second segment comprise of
     #
-    #   second of minute => 2 digits | [00] to [59]
-    #   tenth of second  => 1 digit from [0] to [9]
+    # - second of minute => 2 digits | [00] to [59]
+    # - tenth of second  => 1 digit from [0] to [9]
     #
-    # ---------
-    # Example
-    # ---------
-    #  => The time at the 562nd millisecond  of the 49th
-    #     second of the 23rd minute of the 17th hour of
-    #     the day ( 17:23:49.562 )
+    # @example
+    #   => The time at the 562nd millisecond  of the 49th
+    #      second of the 23rd minute of the 17th hour of
+    #      the day ( 17:23:49.562 )
     #
-    #  => 8 chars
-    #  => 1723.495
+    #   => 8 chars
+    #   => 1723.495
     #
     def self.yyjjj_hhmm_sst
       return "#{yyjjj}.#{hhmm}.#{sst}"
     end
 
 
-    # ----------------------------------------- -- #
-    # Return the Rubyfied time zone being used. -- #
-    # ----------------------------------------- -- #
+    # Return a string timestampt that is a period separated
+    # amalgam of the 2 digit year, 3 digit julian day, 2 digit
+    # hour, 2 digit minute, 2 digit second and <b>9 digit</b>
+    # nanosecond.
+    #
+    # @example
+    #   return  => 19003.1725.42.836592034
+    #   4 time  => 17:25:42 am on January 3rd 2019
+    #
+    # As per the above example, the time returned
+    #
+    # - is the 836592034 <b>nanosecond</b>
+    # - of the 42nd <b>second</b>
+    # - of the 25th <b>minute</b>
+    # - of the 17th <b>hour</b>
+    # - of the 3rd <b>day</b>
+    # - of the 20th <b>year</b>
+    # - of the 21st <b>century</b>
+    #
+    # @return [String]
+    #    Return the time of day to nanosecond accuracy.
+    #    23 characters are always returned with three (3) period
+    #    separators at the 6th, 11th and 14th positions.
+    def self.yyjjj_hhmm_ss_nanosec
+      nanosec_str = Stamp.instance.time_now.strftime "%9N"
+      return "#{yyjjj}.#{hhmm}.#{ss}.#{nanosec_str}"
+    end
+
+
+    # Return the Rubyfied time zone being used.
     def self.zone
       return Stamp.instance.time_now.zone
     end
 
 
-    # -------------------------------------------------- -- #
-    # Log segments of time pertaining to the time stamp. -- #
-    # -------------------------------------------------- -- #
+    # Log segments of time pertaining to the time stamp.
+    # @todo
+    #    move method contents into test class
     def self.log_instance_time
 
-      log.info(ere) { "[stamp] -------------- => -------------------------------- #" }
-      log.info(ere) { "[stamp] eco time stamp => [#{Stamp.instance.time_now.ctime}]" }
-      log.info(ere) { "[stamp] -------------- => -------------------------------- #" }
-      log.info(ere) { "[stamp] Univ Time Zone => #{zone}"  }
-      log.info(ere) { "[stamp] Month Index is => #{mo}"    }
-      log.info(ere) { "[stamp] Month Name is  => #{mmm}"   }
-      log.info(ere) { "[stamp] Day Of Week is => #{ddd}"   }
-      log.info(ere) { "[stamp] -------------- => -------------------------------- #" }
-      log.info(ere) { "[stamp] Two Digit Year => #{yy}"    }
-      log.info(ere) { "[stamp] Julian Cal Day => #{jjj}"   }
-      log.info(ere) { "[stamp] Yr and Jul Day => #{yyjjj}" }
-      log.info(ere) { "[stamp] Hour of Theday => #{hh}"    }
-      log.info(ere) { "[stamp] Minute of Hour => #{mm}"    }
-      log.info(ere) { "[stamp] Hour + Minute  => #{hhmm}"  }
-      log.info(ere) { "[stamp] Second of Min  => #{ss}"    }
-      log.info(ere) { "[stamp] 600 Min Slices => #{sst}"   }
-      log.info(ere) { "[stamp] -------------- => -------------------------------- #" }
-      log.info(ere) { "[stamp] The Time Stamp => #{yyjjj_hhmm_sst}" }
-      log.info(ere) { "[stamp] -------------- => -------------------------------- #" }
+      log.info(x) { "[stamp] -------------- => -------------------------------- #" }
+      log.info(x) { "[stamp] eco time stamp => [#{Stamp.instance.time_now.ctime}]" }
+      log.info(x) { "[stamp] -------------- => -------------------------------- #" }
+      log.info(x) { "[stamp] Univ Time Zone => #{zone}"  }
+      log.info(x) { "[stamp] Month Index is => #{mo}"    }
+      log.info(x) { "[stamp] Month Name is  => #{mmm}"   }
+      log.info(x) { "[stamp] Day Of Week is => #{ddd}"   }
+      log.info(x) { "[stamp] -------------- => -------------------------------- #" }
+      log.info(x) { "[stamp] Two Digit Year => #{yy}"    }
+      log.info(x) { "[stamp] Julian Cal Day => #{jjj}"   }
+      log.info(x) { "[stamp] Yr and Jul Day => #{yyjjj}" }
+      log.info(x) { "[stamp] Hour of Theday => #{hh}"    }
+      log.info(x) { "[stamp] Minute of Hour => #{mm}"    }
+      log.info(x) { "[stamp] Hour + Minute  => #{hhmm}"  }
+      log.info(x) { "[stamp] Second of Min  => #{ss}"    }
+      log.info(x) { "[stamp] 600 Min Slices => #{sst}"   }
+      log.info(x) { "[stamp] -------------- => -------------------------------- #" }
+      log.info(x) { "[stamp] The Time Stamp => #{yyjjj_hhmm_sst}" }
+      log.info(x) { "[stamp] -------------- => -------------------------------- #" }
 
     end
 
 
-    # ------------------------------------------------------------ -- #
-    # This singleton (one instance) class sets the time just once. -- #
-    # ------------------------------------------------------------ -- #
+    # This singleton (one instance) class sets the time just once.
     def initialize
 
       @time_now = Time.now;

data/lib/using.txt

@@ -13,6 +13,106 @@ swap disk/password=bettersecret
 lock
 (or push)
 ==============================================================================================
+==============================================================================================
+
+On Curent Workstation
+--------------------------
+os copy config
+
+
+Go to new Workstation
+--------------------------
+enter usb key/phone dir (wherever safe is)
+sudo gem install opensecret
+os safe /path/to/safe
+os store /path/to/store (if different)
+os paste config
+(Now carry on as normal - no need for os init)
+
+
+==============================================================================================
+==============================================================================================
+
+To Decommission from Workstation
+------------------------------------
+os delete config
+
+If necessary you can do
+gem uninstall opensecret
+
+
+==============================================================================================
+==============================================================================================
+
+To Backup
+------------------------------------
+Create single backup reference number
+Create huge symmetric key
+Baseline each file with signature and date / time
+os rekeys and takes direction on where to send crypted + amalgamated keystore and cryptstore
+That goes to one backup location (even tape drive)
+
+Then the machine config and othe sensitive items can be emailed - saved on phone - use os's rest services.
+
+It emails you with a key wealth report.
+If you bring them back together it will rebuild (restore) everything for you.
+
+==============================================================================================
+==============================================================================================
+
+
+
+
+
+You can output in the key EAI data formats - the default is INI.
+
+os read office/laptop                # outputs all groups and key/value pairs (INI format)
+os read office/laptop/login          # outputs the login group and its key/value pairs (INI)
+os read office/laptop/login/username # outputs only the secret value
+
+os peek office/laptop                # (secrets redacted) outputs groups and key/value pairs
+os peek office/laptop/login          # (secrets redacted) outputs login group and its keys
+os peek office/laptop/login/username # exact mirror of full read command
+
+Kiss and Tell
+==================
+os kiss   # taints the secret (and/or secret tree) prepping it for a tell (share)
+os tell   # send secret by sending keys os tell london/safe-houses
+
+os put
+
+os remove
+os wipe
+os open x/y    (when packet exists)
+
+os lock
+
+os unlock (a file)
+os undo
+os zip
+os push (after a zip or file locking operation)
+
+
+
+
+
+==============================================================================================
+==============================================================================================
+
+Input
+======
+
+file
+use bash pipes
+cli string
+sensitive collection
+zip files in folder
+recursive zip with all lower folders
+
+
+
+==============================================================================================
+==============================================================================================
 
 
 open office/laptop --with=asdfasdflkhlkh