razorrisk-cassini-common 0.26.24

data/lib/razor_risk/cassini/authorisation/security_model_helpers.rb

@@ -0,0 +1,93 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/authorisation/security_model_helpers.rb
+#
+# Purpose:      Definition of the
+#               RazorRisk::Cassini::Authorisation::SecurityModelHelpers
+#               module
+#
+# Created:      16th February 2018
+# Updated:      16th February 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+require 'pantheios'
+require 'xqsr3/quality/parameter_checking'
+
+require 'razor_risk/core/diagnostics/logger'
+
+module RazorRisk
+module Cassini
+module Authorisation
+
+module SecurityModelHelpers
+
+    include ::Pantheios
+    include ::Xqsr3::Quality::ParameterChecking
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # Options a RazorRequester-compatible options hash containing
+    # credentials appropriate to the given +authentication_scheme+
+    def razor_requester_credentials_options authentication_scheme, credentials, **options
+
+        check_parameter authentication_scheme, 'authentication_scheme', type: ::Symbol, values: [ :none, :basic, :authorisation_only, :jwt ]
+        check_parameter(credentials, 'credentials', type: ::Array) { |value| value.empty? ? 'no credentials specified' : true }
+
+        r = {}
+
+        credentials = credentials.dup
+
+
+        case authentication_scheme
+        when :none
+
+            ;
+        when :basic
+
+            if options[:auth_test_mode]
+                log :warning, "YOU ARE IN AUTHORIZATION TEST MODE! NO AUTHENTICATION WILL BE PERFORMED! THIS MUST NOT BE USED IN PRODUCTION!"
+                r[:impersonatee] = credentials.shift unless credentials.empty?
+            else
+                r[:username] = credentials.shift unless credentials.empty?
+                r[:password] = credentials.shift unless credentials.empty?
+                r[:domain]   = credentials.shift unless credentials.empty?
+            end
+        when :jwt
+
+            if options[:auth_test_mode]
+                log :warning, "YOU ARE IN AUTHORIZATION TEST MODE! NO AUTHENTICATION WILL BE PERFORMED! THIS MUST NOT BE USED IN PRODUCTION!"
+            end
+            r[:session_id] = credentials.shift unless credentials.empty?
+            r[:user_id]    = credentials.shift unless credentials.empty?
+            r[:user_name]  = credentials.shift unless credentials.empty?
+        when :authorisation_only
+
+            r[:impersonatee] = credentials.shift unless credentials.empty?
+        else
+
+            log :violation, "unexpected authentication_scheme '#{authentication_scheme}' (#{authentication_scheme.class})"
+        end
+
+        r
+    end
+
+end # module SecurityModelHelpers
+
+end # module Authorisation
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+
+

data/lib/razor_risk/cassini/authorisation.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/authorisation.rb
+#
+# Purpose:      Cassini Authorisation common file
+#
+# Created:      26th November 2017
+# Updated:      4th March 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/authorisation/header_helpers'
+require 'razor_risk/cassini/authorisation/security_model_helpers'
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/cli.rb

@@ -0,0 +1,19 @@
+
+module RazorRisk
+module Cassini
+
+module CLI
+
+    def self.Copyright(year)
+
+        "Copyright Razor Risk Technologies Pty Ltd (c) #{year}"
+    end
+
+end # module CLI
+
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/common/version.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Version for RazorRisk.Cassini.Common library
+
+#  Copyright (c) 2017 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+module RazorRisk
+module Cassini
+
+module Common
+
+    # Current version of the RazorRisk.Cassini.Common library
+    VERSION             =   '0.26.24'
+
+    private
+    VERSION_PARTS_      =   VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+    public
+    # Major version of the RazorRisk.Cassini.Common library
+    VERSION_MAJOR       =   VERSION_PARTS_[0]       # :nodoc:
+    # Minor version of the RazorRisk.Cassini.Common library
+    VERSION_MINOR       =   VERSION_PARTS_[1]       # :nodoc:
+    # Patch version of the RazorRisk.Cassini.Common library
+    VERSION_Patch       =   VERSION_PARTS_[2]       # :nodoc:
+    # Commit version of the RazorRisk.Cassini.Common library
+    VERSION_COMMIT      =   VERSION_PARTS_[3] || 0  # :nodoc:
+
+
+    # The description of the framework
+    DESCRIPTION         =   'Cassini Web Service framework for Razor Risk Razor system'
+
+    # [DEPRECATED] Instead use +DESCRIPTION+
+    FRAMEWORK_DESCRIPTION = DESCRIPTION
+
+end # module Common
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/common.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/common.rb
+#
+# Purpose:      Cassini common file
+#
+# Created:      15th January 2018
+# Updated:      4th March 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+=begin
+require 'razor_risk/cassini/authorisation'
+require 'razor_risk/cassini/constants'
+require 'razor_risk/cassini/header_functions'
+require 'razor_risk/cassini/management_plane'
+require 'razor_risk/cassini/util/secrets_util'
+=end
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/constants.rb

@@ -0,0 +1,68 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/constants.rb
+#
+# Purpose:      Cassini constants
+#
+# Created:      14th November 2017
+# Updated:      4th March 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2017-2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+=begin
+=end
+
+module RazorRisk
+module Cassini
+
+module Constants
+
+    # The WWW-Authenticate header scheme for Razor's Authentication-only
+    # authentication scheme
+    SCHEME_AUTH_ONLY                 = 'RazorRisk.Cassini.AuthorisationOnly'
+
+    REFERRED_ENV_PREFIX              = 'razorrisk.cassini.ims'
+
+    SUPPORTED_VERB_NAMES             = %w{ COPY DELETE GET HEAD LINK LOCK OPTIONS PATCH PROPFIND POST PURGE PUT VIEW UNLINK UNLOCK }
+
+    SUPPORTED_VERBS                  = SUPPORTED_VERB_NAMES.map { |name| name.downcase.to_sym }
+
+    HTTP_AUTHORIZATION               = 'HTTP_AUTHORIZATION'
+
+    SUPPORTED_AUTHENTICATION_SCHEMES = %w{ [a]uthorisation-only [b]asic [j]wt }
+
+    # See RFC-2616 Section 13.5.1 @ https://tools.ietf.org/html/rfc2616#section-13.5.1
+    # and its errata 4522 @ https://www.rfc-editor.org/errata/eid4522
+    HOP_BY_HOP_HEADERS               = [
+        'connection',
+        'keep-alive',
+        'proxy-authenticate',
+        'proxy-authorization',
+        'te',
+        'trailer',
+        'transfer-encoding',
+        'upgrade',
+    ]
+
+    # Environment setting to allow exceptions to be propagated for
+    # development and testing purposes.
+    RZ_EXPOSE_MICROSERVICE_EXCEPTIONS = ENV['RZ_EXPOSE_MICROSERVICE_EXCEPTIONS']
+
+end # module Constants
+
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/diagnostics/util_functions.rb

@@ -0,0 +1,248 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/diagnostics/util_functions.rb
+#
+# Purpose:      Centralised diagnostics utility functions
+#
+# Created:      8th February 2018
+# Updated:      26th February 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+require 'pantheios/application_layer/stock_severity_levels'
+require 'pantheios/services/multiplexing_log_service'
+require 'pantheios/services/null_log_service'
+require 'pantheios/services/simple_console_log_service'
+require 'pantheios/services/simple_file_log_service'
+
+require 'xqsr3/quality/parameter_checking'
+
+require 'fileutils'
+
+require 'razor_risk/core/diagnostics/logger'
+
+module RazorRisk
+module Cassini
+
+module Diagnostics
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    module SetupDiagnosticLogging_Constants
+
+        STOCK_SEVERITY_LEVEL_VALUES     =   Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES
+
+        DEFAULT_LOG_THRESHOLD_MAIN      =   :debug4
+        DEFAULT_LOG_THRESHOLD_CONSOLE   =   :informational
+
+        BENCHMARK_SEVERITY_VALUE        =   STOCK_SEVERITY_LEVEL_VALUES[:benchmark]
+
+        DEFAULT_LOG_SIZE_BENCHMARK      =   1024 * 1024 * 10
+        DEFAULT_LOG_SIZE_MAIN           =   1024 * 1024 * 100
+
+        DEFAULT_LOG_DEPTH               =   20
+    end # module SetupDiagnosticLogging_Constants
+
+    # configure diagnostic logging:
+    #
+    # - set program name
+    # - set services:
+    #   * benchmark logger : file, only responding to :benchmark, and only if
+    #     --benchmark is specified
+    #   * main file logger : file, stores all except :benchmark, according to
+    #     :log_threshold
+    #   * main cons logger : stdout/stderr, only :notice and above
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +program_name+:: (::String) The program name. May not be +nil+
+    #   - +log_directory+:: (::String) The directory in which log-files
+    #     will be created. May not be +nil+, unless both +:no_benchmark_log+
+    #     and +:no_main_log+ are truey
+    #   - +log_threshold+:: (::String | ::Symbol |[ ::Symbol, ::Symbol ] )
+    #     Specifies the log-threshold(s). The threshold(s) is specified as a
+    #     string containing comma-separated values, or as a single symbol,
+    #     or as an array of symbols, all of which are treated as a sequence
+    #     of severity thresholds. The severity thresholds apply,
+    #     respectively, to the modifiable-sequence of Console and Main.
+    #
+    # * *Options:*
+    #   - +:no_benchmark_log+:: (boolean) Unless truey, a benchmark log will
+    #     be created
+    #   - +:no_console_log+:: (boolean) Unless truey, a console log will be
+    #     created
+    #   - +:no_main_log+:: (boolean) Unless truey, a main log will be
+    #     created
+    #
+    # NOTE: If all of +:no_benchmark_log+, +:no_console_log+, and
+    # +:no_main_log+ are truey, a null logger will be created, and there will
+    # be no logging
+
+    def setup_diagnostic_logging program_name, log_directory, log_threshold, **options
+
+        ::Xqsr3::Quality::ParameterChecking.check_parameter program_name, 'program_name', type: ::String
+        ::Xqsr3::Quality::ParameterChecking.check_parameter log_directory, 'log_directory', type: ::String
+        ::Xqsr3::Quality::ParameterChecking.check_parameter log_threshold, 'log_threshold', types: [ ::Array, ::Integer, ::Symbol ]
+
+        case log_threshold
+        when ::Array
+
+            log_thresholds  =   log_threshold.dup
+        when ::Symbol
+
+            log_thresholds  =   [ log_threshold ]
+        else
+
+            log_thresholds  =   []
+        end
+
+        console_threshold   =   log_thresholds.shift || options[:console_threshold] || SetupDiagnosticLogging_Constants::DEFAULT_LOG_THRESHOLD_CONSOLE
+        main_threshold      =   log_thresholds.shift || options[:main_threshold] || SetupDiagnosticLogging_Constants::DEFAULT_LOG_THRESHOLD_MAIN
+
+        console_threshold_v =   ::Integer === console_threshold ? console_threshold : SetupDiagnosticLogging_Constants::STOCK_SEVERITY_LEVEL_VALUES[console_threshold]
+        main_threshold_v    =   ::Integer === main_threshold ? main_threshold : SetupDiagnosticLogging_Constants::STOCK_SEVERITY_LEVEL_VALUES[main_threshold]
+
+        unless options[:no_benchmark_log] && options[:no_main_log]
+
+            unless File.directory?(log_directory)
+
+                climate.abort "log directory '#{log_directory}' exists and is not a directory" if File.exist?(log_directory)
+
+                begin
+
+                    FileUtils.mkdir_p log_directory
+                rescue => x
+
+                    log :alert, "exception(#{x.class}): #{x.message}"
+
+                    climate.abort x.message
+                end
+            end
+        end
+
+        services = []
+
+        unless options[:no_benchmark_log]
+
+            bm_log_file_name    =   program_name + '-benchmark.log'
+
+            bm_log_file_path    =   File.join(log_directory, bm_log_file_name)
+
+            bm_logger           =   Pantheios::Services::SimpleFileLogService.new bm_log_file_path, roll_size: SetupDiagnosticLogging_Constants::DEFAULT_LOG_SIZE_BENCHMARK, roll_depth: SetupDiagnosticLogging_Constants::DEFAULT_LOG_DEPTH
+
+            def bm_logger.severity_logged? severity
+
+                case severity
+                when :benchmark, SetupDiagnosticLogging_Constants::BENCHMARK_SEVERITY_VALUE
+
+                    true
+                else
+
+                    false
+                end
+            end
+
+            services            <<  bm_logger
+        end
+
+        unless options[:no_main_log]
+
+            mf_log_file_name    =   program_name + '-main.log'
+
+            mf_log_file_path    =   File.join(log_directory, mf_log_file_name)
+
+            mf_logger           =   Pantheios::Services::SimpleFileLogService.new mf_log_file_path, roll_size: SetupDiagnosticLogging_Constants::DEFAULT_LOG_SIZE_MAIN, roll_depth: SetupDiagnosticLogging_Constants::DEFAULT_LOG_DEPTH
+
+            mf_logger.instance_variable_set :@main_threshold_v_, main_threshold_v
+
+            def mf_logger.severity_logged? severity
+
+                return true unless @main_threshold_v_
+
+                severity = :debug4 if :debug == severity
+
+                severity_v = nil
+
+                case severity
+                when :benchmark, SetupDiagnosticLogging_Constants::BENCHMARK_SEVERITY_VALUE
+
+                    return false
+                when ::Symbol
+
+                    severity_v = SetupDiagnosticLogging_Constants::STOCK_SEVERITY_LEVEL_VALUES[severity]
+                when ::Integer
+
+                    severity_v = severity
+                else
+
+                    ;
+                end
+
+                return true unless severity_v
+
+                severity_v <= @main_threshold_v_
+            end
+
+            services            <<  mf_logger
+        end
+
+        unless options[:no_console_log]
+
+            mc_logger           =   Pantheios::Services::SimpleConsoleLogService.new
+
+            mc_logger.instance_variable_set :@console_threshold_v_, console_threshold_v
+
+            def mc_logger.severity_logged? severity
+
+                return true unless @console_threshold_v_
+
+                severity = :debug4 if :debug == severity
+
+                severity_v = nil
+
+                case severity
+                when :benchmark, SetupDiagnosticLogging_Constants::BENCHMARK_SEVERITY_VALUE
+
+                    return false
+                when ::Symbol
+
+                    severity_v = SetupDiagnosticLogging_Constants::STOCK_SEVERITY_LEVEL_VALUES[severity]
+                when ::Integer
+
+                    severity_v = severity
+                else
+
+                    ;
+                end
+
+                return true unless severity_v
+
+                severity_v <= @console_threshold_v_
+            end
+
+            services            << mc_logger
+        end
+
+        if services.empty?
+
+            mx_logger   =   Pantheios::Services::NullLogService.new
+        else
+
+            mx_logger   =   Pantheios::Services::MultiplexingLogService.new services, level_cache_mode: :thread_fixed
+        end
+
+        ::Pantheios::Core.set_service mx_logger
+    end
+
+end # module Diagnostics
+
+end # module RazorRisk
+end # module Cassini
+

data/lib/razor_risk/cassini/diagnostics/zeroth_include.rb

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+# File:         razor_risk/cassini/diagnostics/zeroth_include.rb
+#
+# Purpose:      When required as the very first file it sets up, for
+#               diagnostics, the main thread name and the process name
+#
+# Created:      5th February 2018
+# Updated:      4th March 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2018, Razor Risk Technologies Pty Ltd
+# All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'pantheios/globals'
+
+# set main thread name
+Pantheios::Globals.MAIN_THREAD_NAME = [ Thread.current, 'main' ]
+
+# set process name
+#
+# If the script name is ws.rb, then the directory name is used
+Pantheios::Globals.PROCESS_NAME = $0 =~ /[\\\/]ws\.rb$/ ? :script_dirname : :script_stem
+
+# ############################## end of file ############################# #
+
+