razorrisk-cassini-utilities-secretserver 0.7.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5653cd591a0033c005a364ab5d99998e81cfffbf45cf20ea5bfade2bf818ce57
+  data.tar.gz: e86f0aa4762c4fd0a61fb2bd06169232004d29792f75f74c5eddf00b096c4201
+SHA512:
+  metadata.gz: 585a28a65144fd1e1332559b70d14533e7ef0d2e4d54f40124a845cdf3b150a1d4f71142f6d7d74d3a52af46ac6a9f4f95c2dd81e03e25e643412edb8b82bcf1
+  data.tar.gz: 2b70508b09af1c534ba72b1ff195de47dc2f4607d1cd349fee323ef0ab6e3cce5d9a1f8c591d34eca89df0cee4433889ee1d3a33a8308b112b466b8eb9f00f00

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change Log
+
+## [0.7.1] (2018-06-20)
+
+**Implemented enhancements:**
+
+none
+
+**Fixed defects:**
+
+none
+
+**Dependencies and packaging:**
+
+- separated into own project/repo/package [WEBAPI-138]
+
+**Merged pull requests:**
+
+none
+
+## END OF CHANGE LOG
+

data/LICENSE

@@ -0,0 +1,5 @@
+Cassini
+
+Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+All rights reserved.
+

data/README.md

@@ -0,0 +1,2 @@
+T.B.C.
+

data/bin/razorrisk-microservice-secretserver

@@ -0,0 +1,295 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         tools/servers/secret-server/ws.rb
+#
+# Purpose:      Main module/entry file for the Secret Server
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+
+# Utility: Secret Server (secret-server)
+#
+# Supported:
+#
+#  - [GET] / {Unsecured}
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/diagnostics/zeroth_include'
+
+require 'razor_risk/cassini/utilities/secret_server'
+
+require 'razor_risk/cassini/applications/unsecured_microservice'
+require 'razor_risk/cassini/cli'
+require 'razor_risk/cassini/diagnostics/util_functions'
+require 'razor_risk/cassini/extensions/libclimate'
+require 'razor_risk/cassini/util/version_util'
+
+require 'razor_risk/extensions/hash/dig'
+
+require 'razor_risk/core/diagnostics/extensions/libclimate'
+require 'razor_risk/core/diagnostics/logger'
+
+require 'libclimate'
+require 'pantheios'
+require 'xqsr3/extensions/hash/deep_transform'
+
+require 'xqsr3/extensions/kernel/integer'
+
+require 'csv'
+require 'json'
+require 'logger'
+require 'yaml'
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Applications
+include ::RazorRisk::Cassini::Util::VersionUtil
+
+include ::RazorRisk::Cassini::Diagnostics
+include ::RazorRisk::Core::Diagnostics::Logger
+
+include ::Pantheios
+
+# ##########################################################################
+# constants
+
+SERVER_ID           =   'secret-server'
+
+DEFAULT_ALGORITHM   =   'sha256'
+
+ACCEPT_TYPES        =   %w{ application/json application/xml text/csv text/plain text/tsv text/tab-separated-values text/xml }
+
+PROGRAM_VERSION =   ::RazorRisk::Cassini::Utilities::SecretServer::VERSION
+
+module Constants
+
+    module Defaults
+
+        LOGGING_THRESHOLD   =   [ :informational, :debug ]
+    end # module Defaults
+end # module Constants
+
+# ##########################################################################
+# compatibility checks
+
+check_version_compatibility ::LibCLImate, '0.10'
+check_version_compatibility ::Pantheios, '0.20'
+
+# ##########################################################################
+# static set-up
+
+# ##########################################################################
+# application
+
+module SecretServer
+
+    include ::Pantheios
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    def included receiver
+
+        receiver.extend self
+    end
+
+    def make_CSV algorithm, secret
+
+        trace ParamNames[ :algorithm, :secret ], algorithm, secret
+
+        CSV.generate do |csv|
+
+            csv << [ algorithm, secret ]
+        end
+    end
+
+    def make_JSON algorithm, secret
+
+        trace ParamNames[ :algorithm, :secret ], algorithm, secret
+
+        r = { algorithm: algorithm, secret: secret }
+
+        r.to_json
+    end
+
+    def make_text algorithm, secret
+
+        trace ParamNames[ :algorithm, :secret ], algorithm, secret
+
+        "#{algorithm}|#{secret}"
+    end
+
+    def make_TSV algorithm, secret
+
+        trace ParamNames[ :algorithm, :secret ], algorithm, secret
+
+        "#{algorithm}\t#{secret}"
+    end
+
+    def make_XML algorithm, secret
+
+        trace ParamNames[ :algorithm, :secret ], algorithm, secret
+
+#<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.we.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+        <<END_OF_xml
+<?xml version="1.0">
+<secrets>
+ <secret algorithm="#{algorithm}" secret="#{secret}" />
+</secrets>
+END_OF_xml
+    end
+end
+
+class SecretServerApp < UnsecuredMicroservice
+
+    include SecretServer
+
+    def self.on_init_service options
+
+        raise ArgumentError, 'missing keyword: secrets' unless options.has_key? :secrets
+
+        secrets             =   options[:secrets]
+
+        settings.set :secrets, (secrets || {}).deep_transform { |k, v| [ k.to_s.downcase, v ] }
+    end
+
+    get '/' do
+
+        trace
+
+        category    =   params[:category] || 'all'
+        algorithm   =   params[:algorithm] || DEFAULT_ALGORITHM
+
+        category    =   category.downcase
+        algorithm   =   algorithm.downcase
+
+        log :info, 'obtaining secret for category \'', category, '\' and algorithm \'', algorithm, '\''
+
+        secret      =   nil
+        secret      ||= settings.secrets.dig(category, algorithm) if 'all' != category
+        secret      ||= settings.secrets.dig('all', algorithm)
+
+        halt *[ 404, {}, "no such algorithm '#{algorithm}' for category '#{category}'" ] unless secret
+
+        ACCEPT_TYPES.each do |accept_type|
+
+            if request.accept? accept_type
+
+                content_type accept_type
+
+                case accept_type
+                when 'application/json'
+
+                    r = make_JSON algorithm, secret
+                when 'text/plain'
+
+                    r = make_text algorithm, secret
+                when 'application/xml', 'text/xml'
+
+                    r = make_XML algorithm, secret
+                when 'text/csv'
+
+                    r = make_CSV algorithm, secret
+                when 'text/tsv', 'text/tab-separated-values'
+
+                    r = make_TSV algorithm, secret
+                else
+
+                    log :violation, 'unrecognised accept type \'', accept_type, '\''
+
+                    halt *[ 500, {}, 'internal server failure' ]
+                end
+
+                return r
+            end
+        end
+
+        halt *[ 406, {}, "supports only the Accept types #{ACCEPT_TYPES.map { |t| %Q<'#{t}'> }.join(', ')}" ]
+    end
+end
+
+TheApp = SecretServerApp
+
+# ##########################################################################
+# command-line parsing
+
+options =   {}
+
+climate = LibCLImate::Climate.new do |cl|
+
+    cl.option_web_server options
+
+    cl.option_host options
+    cl.option_port options
+
+    cl.option_log_threshold options, default_level: Constants::Defaults::LOGGING_THRESHOLD
+
+    cl.usage_values = '<secret-config-path>'
+
+    cl.info_lines = [
+
+        'Secret server',
+        ::RazorRisk::Cassini::CLI.Copyright(2017),
+        :version,
+    ]
+end
+
+log :debug0, 'parsing command line ...'
+
+r = climate.run ARGV
+
+::Pantheios::Core.program_name = options[:program_name] if options[:program_name]
+
+program_name    =   ::Pantheios::Core.program_name
+log_directory   =   options[:log_directory] || './logs'
+log_threshold   =   options[:log_threshold] || :notice
+
+setup_diagnostic_logging program_name, log_directory, log_threshold
+
+
+# amass the arguments that are required
+
+secrets_config_path = r.values[0] or climate.abort 'no secret-config-path specified'
+
+options[:host] ||= nil
+
+secrets_config = YAML.load_file secrets_config_path
+
+secrets = secrets_config['secrets']
+
+secrets.has_key?('all') or climate.abort 'secrets must contain "all" key'
+
+# ##########################################################################
+# main
+
+log :debug0, 'options: ', options
+
+log :informational, 'initialising application ...'
+
+begin
+
+    TheApp.init_service **options, secrets: secrets
+rescue => x
+
+    log :alert, "exception(#{x.class}): #{x.message}"
+
+    climate.abort x.message
+end
+
+log :notice, "starting secret server"
+
+TheApp.run!
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/secret_server/version.rb

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/utilities/secret_server/version.rb
+#
+# Purpose:      Version for RazorRisk.Cassini.Utilities.SecretServer library
+#
+# Created:      8th January 2019
+# Updated:     11th January 2019
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+module Utilities
+
+module SecretServer
+
+    # Current version of the RazorRisk.Cassini.CassiD library
+    VERSION             =   '0.7.9'
+
+    private
+    VERSION_PARTS_      =   VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+    public
+    # Major version of the RazorRisk.Cassini.CassiD library
+    VERSION_MAJOR       =   VERSION_PARTS_[0]       # :nodoc:
+    # Minor version of the RazorRisk.Cassini.CassiD library
+    VERSION_MINOR       =   VERSION_PARTS_[1]       # :nodoc:
+    # Patch version of the RazorRisk.Cassini.CassiD library
+    VERSION_PATCH       =   VERSION_PARTS_[2]       # :nodoc:
+    # Commit version of the RazorRisk.Cassini.CassiD library
+    VERSION_COMMIT      =   VERSION_PARTS_[3] || 0  # :nodoc:
+
+
+    # The description of the framework
+    DESCRIPTION         =   "Razor Risk's Cassini Web-framework's Secret Server utility"
+
+end # module SecretServer
+end # module Utilities
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/utilities/secret_server.rb

@@ -0,0 +1,2 @@
+
+require 'razor_risk/cassini/utilities/secret_server/version'

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: razorrisk-cassini-utilities-secretserver
+version: !ruby/object:Gem::Version
+  version: 0.7.9
+platform: ruby
+authors:
+- Razor Risk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: razorrisk-cassini-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: razorrisk-core-diagnostics-extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: clasp-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: libclimate-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pantheios-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.8
+- !ruby/object:Gem::Dependency
+  name: xqsr3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+description: Razor Risk's Cassini Web-framework's Secret Server utility
+email: operations@razor-risk.com
+executables:
+- razorrisk-microservice-secretserver
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/razorrisk-microservice-secretserver
+- lib/razor_risk/cassini/utilities/secret_server.rb
+- lib/razor_risk/cassini/utilities/secret_server/version.rb
+homepage: https://razor-risk.com/
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Razor Risk Cassini Secret Server utility
+test_files: []