microservices-login 0.7.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68861062675878ab005187f8c31ef75fa06b1ae8b245a23582aea8367903f42b
+  data.tar.gz: 1a37dc1abb46923297f8f572f823d84ec791b4f7c00c4ed8a12d8b52b00753fa
+SHA512:
+  metadata.gz: 69629782263e5039bb6c6381262415fe2b63479717cc8c10d91e5f95281498ff70149df73d77becdae83255213f77cf1ed2066ff4a3c85e001b1b38160757b51
+  data.tar.gz: c383cafc45c02693cc1b38f99f19ac5f5ac30d499d22556b887f4179d930da314138d9bb3151f74d0ad06896aebe3dcab374d71a520dccef9cbc8fe2c68fd901

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change Log
+
+## [0.7.1] (2018-06-19)
+
+**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-login

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Main module/entry files for the Login Microservice
+#
+#  Copyright (c) 2017 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/diagnostics/zeroth_include'
+
+require 'razor_risk/cassini/applications/microservices/login'
+require 'razor_risk/cassini/main'
+
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Applications::Microservices
+
+
+# ##########################################################################
+# constants
+
+PROGRAM_VERSION = ::RazorRisk::Cassini::Applications::Microservices::Login::VERSION
+
+
+# ##########################################################################
+# main section
+
+TheApp = Login::LoginApp
+
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/microservices/login/app.rb

@@ -0,0 +1,207 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Login Microservice app.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################################
+
+# Microservices: Login (login)
+#
+# Supported:
+#
+#  - [POST] /do-login {Unsecured}
+#
+# NOTE: this server is able to perform authorisation using the following
+# schemes:
+#
+# - None (:none) - always returns an empty document with 200;
+# - Basic (:basic) - Basic Authentication (as described in
+#   https://tools.ietf.org/html/rfc1945#section-11.1), which requires receipt
+#   of "Authorization" header with the value "Basic <user-pass-64>" where
+#   <user-pass-64> is the Base-64 encoded form of "<username>:<password>".
+#   The client must present this same header (and value) with each request;
+# - Authorisation-only (:authorisation_only) - Razor Risk's proprietary
+#   extension auth scheme, which requires receipt of "Authorization
+#   header with the value "RazorRisk.Razor.AuthorisationOnly <ident-64>",
+#   where <ident-64> is the Base-64 encoded form of "<username>". The client
+#   must present this same header (and value) with each request;
+# - JWT (:jwt) - JWT-based authentication, which requires receipt of
+#   "Authorization" header with the value "Bearer <jwt-64>" where <jwt-64>
+#   is the Base-64 encoded form of a JWT that is obtained from this Login
+#   service via its do-login route with the POST verb and a body containing
+#   username and password name-value pairs (hence the header
+
+
+# ##########################################################################
+# requires
+
+require 'razor_risk/cassini/applications/rest_framework/route_verb_dispatcher'
+require 'razor_risk/cassini/applications/route_verb_adaptors/login'
+
+require 'razor_risk/cassini/applications/securable_microservice'
+require 'razor_risk/cassini/authorisation'
+
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/system_status_connector'
+require 'razor_risk/razor/connectivity/razor_3/entity_connectors/sessions_connector'
+
+require 'razor_risk/razor/connectivity/razor_3/message_map'
+require 'razor_risk/razor/connectivity/razor_3/razor_requester'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+
+# ##########################################################################
+# modules
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+module Login
+
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Applications
+
+
+# ##########################################################################
+# application
+
+# Razor Web Sercies Login Microservice.
+class LoginApp < SecurableMicroservice
+
+    include RouteVerbAdaptors::Login
+    include RESTFramework::RouteVerbDispatch
+
+    include ::RazorRisk::Cassini::Authorisation::SecurityModelHelpers
+
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors
+    include ::RazorRisk::Razor::Connectivity::Razor3
+
+    include ::Pantheios
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # Microservice long name.
+    FULL_DESIGNATION  = 'Login'
+    # Microservice short name.
+    SHORT_DESIGNATION = 'login'
+    # Service type.
+    SERVICE_TYPE      = :microservice
+    # Supported Content Types.
+    HTTP_ACCEPTS      = [
+        'application/xml',
+        'text/xml',
+        'application/json',
+        'text/plain',
+        '*/*'
+    ]
+    # Supported features, used for generating CLI options.
+    PROGRAM_FEATURES  = {
+        has_web_server:         true,
+        has_host_and_port:      true,
+        has_razor_connectivity: true,
+        authentication:         true,
+        copyright_year:         2017,
+    }
+
+    private
+    HTTP_AUTHORIZATION = ::RazorRisk::Cassini::Constants::HTTP_AUTHORIZATION
+
+    public
+
+    # Executed when the mircoservice is initialized.
+    #
+    # @option options [#send_request] :razor_requester The Razor Requester to
+    #   be used to send requests to the Razor application.
+    # @option options [Hash] :message_map The message map used to route razor
+    #   requests.
+    def self.on_init_service options
+
+        trace ParamNames[ :options ], options
+
+        check_option options, :razor_requester
+        check_option options, :message_map, type: MessageMap, allow_nil: true
+
+        set :razor_requester, options[:razor_requester]
+        set :message_map, (options[:message_map] || MessageMap::DefaultInstance)
+    end
+
+    set(:auth_scheme) do |*schemes|
+        condition do
+            schemes.any? { |s| s == settings.authentication_scheme }
+        end
+    end
+
+    post '/*/?', :auth_scheme => :none do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        log :critical, 'You must use a security model'
+        error 500, 'Oops! Something went wrong!'
+    end
+
+    get '/systemstatus/?' do
+        trace ParamNames[ :request, :params ], request, params
+        dispatch BasicLogin
+    end
+
+    post '/do-login/?', :auth_scheme => :basic do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch BasicLogin
+    end
+
+    post '/do-login/?', :auth_scheme => :authorisation_only do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch AuthOnlyLogin
+    end
+
+    post '/do-login/?', :auth_scheme => :jwt do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch JWTLogin
+    end
+
+    post '/do-logout/?', :auth_scheme => [:basic, :authorisation_only] do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        validate_accept request, HTTP_ACCEPTS
+        status 204
+    end
+
+    post '/do-logout/?', :auth_scheme => :jwt do
+
+        trace ParamNames[ :request, :params ], request, params
+
+        dispatch JWTLogout
+    end
+
+    define_catch_all_handlers
+end
+
+# ##########################################################################
+# modules
+
+end # module Login
+end # module Microservices
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/microservices/login/compatability.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Login Microservice compatability checking.
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/util/version_util'
+require 'razor_risk/cassini/common/version'
+require 'razor_risk/razor/connectivity/version'
+require 'libclimate/version'
+require 'pantheios/version'
+
+
+# ##########################################################################
+# modules
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+module Login
+
+# ##########################################################################
+# includes
+
+include ::RazorRisk::Cassini::Util::VersionUtil
+
+
+# ##########################################################################
+# compatibility checks
+
+check_version_compatibility ::RazorRisk::Cassini::Common, [ 0, 21 ], 'RazorRisk.Cassini.Common'
+check_version_compatibility ::RazorRisk::Razor::Connectivity, [ 0, 11, 2 ], 'RazorRisk.Razor.Connectivity'
+check_version_compatibility ::LibCLImate, '0.10'
+check_version_compatibility ::Pantheios, '0.20'
+
+
+# ##########################################################################
+# modules
+
+end # module Login
+end # module Microservices
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/microservices/login/version.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+
+# ##########################################################################
+#
+# Version for RazorRisk.Cassini.Microservices.Login library
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+module RazorRisk
+module Cassini
+module Applications
+module Microservices
+
+module Login
+
+    # Current version of the RazorRisk.Cassini.Microservices.RESTful.Login library
+    VERSION             =   '0.7.11'
+
+    private
+    VERSION_PARTS_      =   VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+    public
+    # Major version of the RazorRisk.Cassini.Microservices.RESTful.Login library
+    VERSION_MAJOR       =   VERSION_PARTS_[0]       # :nodoc:
+    # Minor version of the RazorRisk.Cassini.Microservices.RESTful.Login library
+    VERSION_MINOR       =   VERSION_PARTS_[1]       # :nodoc:
+    # Patch version of the RazorRisk.Cassini.Microservices.RESTful.Login library
+    VERSION_PATCH       =   VERSION_PARTS_[2]       # :nodoc:
+    # Commit version of the RazorRisk.Cassini.Microservices.RESTful.Login library
+    VERSION_COMMIT      =   VERSION_PARTS_[3] || 0  # :nodoc:
+
+
+    # The description of the framework
+    DESCRIPTION         =   "Razor Risk's Cassini Web-framework's Login microservice"
+
+    # @deprecated use {DESCRIPTION} instead.
+    FRAMEWORK_DESCRIPTION = DESCRIPTION
+end # module Login
+
+end # module Microservices
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/microservices/login.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+# ##########################################################################
+#
+# Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ##########################################################################
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/applications/microservices/login/version'
+require 'razor_risk/cassini/applications/microservices/login/app'
+require 'razor_risk/cassini/applications/microservices/login/compatability'
+
+
+# ############################## end of file ############################# #
+
+

data/lib/razor_risk/cassini/applications/route_verb_adaptors/login/auth_only_login.rb

@@ -0,0 +1,165 @@
+# encoding: UTF-8
+
+# ######################################################################## #
+#
+#  Copyright (c) 2019 Razor Risk Technologies Pty Limited. All rights reserved.
+#
+# ######################################################################## #
+
+# ##########################################################
+# requires
+
+require 'razor_risk/cassini/applications/rest_framework/verb_handler'
+require 'razor_risk/cassini/applications/route_verb_adaptors/utils/call_system_status'
+require 'razor_risk/cassini/authorisation'
+require 'razor_risk/cassini/header_functions'
+require 'razor_risk/cassini/util/conversion_util'
+
+require 'razor_risk/razor/connectivity/entity_connectors/exceptions'
+
+require 'razor_risk/core/diagnostics/logger'
+
+require 'pantheios'
+
+
+# ##########################################################
+# module
+
+module RazorRisk
+module Cassini
+module Applications
+module RouteVerbAdaptors
+module Login
+
+
+# ##########################################################
+# AuthOnlyLogin
+
+# Handler for Authorisation Only Login.
+class AuthOnlyLogin < RESTFramework::VerbHandler
+
+    # ##########################################################
+    # includes
+
+    include ::RazorRisk::Cassini::Applications::RouteVerbAdaptors::Utils
+    include ::RazorRisk::Cassini::Authorisation::SecurityModelHelpers
+    include ::RazorRisk::Cassini::Authorisation::HeaderHelpers
+    include ::RazorRisk::Cassini::HeaderFunctions
+    include ::RazorRisk::Cassini::Util::ConversionUtil
+
+    include ::RazorRisk::Razor::Connectivity::EntityConnectors::Exceptions
+    include ::RazorRisk::Razor::Connectivity::Razor3::EntityConnectors
+
+    include ::Pantheios
+    include ::RazorRisk::Core::Diagnostics::Logger
+
+    # ##########################################################
+    # constants
+
+    private
+    HTTP_AUTHORIZATION = ::RazorRisk::Cassini::Constants::HTTP_AUTHORIZATION
+
+    public
+    # Supported Content Types.
+    HTTP_ACCEPTS     = %w{
+        application/xml
+        application/json
+        text/xml
+    }
+    # Supported HTTP Verb .
+    HTTP_VERB        = :post
+    # Supported query parameters.
+    QUERY_PARAMETERS = %w{}
+    # Supported route variables.
+    ROUTE_VARIABLES  = %w{}
+
+
+    # ##########################################################
+    # handler
+
+    # Handles an authorisation only login request.
+    #
+    # @param env [::Hash] The Rack request environment (@see
+    #   Rack::Request#env).
+    # @param params [::Hash] Validated query parameters (@see
+    #   ValidateQueryParametersHelper#validate_query_parameters)
+    # @param request [::Sinatra::Request] The request to be handled.
+    # @param response [::Sinatra::Response] The response object that will be
+    #   used for the HTTP response.
+    def handle env, params, request, response
+
+        trace(
+            ParamNames[ :env, :params, :request, :response ],
+            env, params, request, response
+        )
+
+        auth_scheme = settings.authentication_scheme
+        auth        = env[HTTP_AUTHORIZATION]
+
+        unless auth
+            halt 401, make_WWW_auth_header(auth_scheme), 'Missing or invalid authenticate header'
+        end
+
+        username, _ = credentials_from_AuthorisationOnly auth
+
+        unless username
+            halt 401, make_WWW_auth_header(auth_scheme), 'Missing or invalid authenticate header'
+        end
+
+        # All we do here is issue a Razor Request for system-status -
+        # since it's arbitrary, really - and verify that it worked
+
+        options = {
+            auth_test_mode:  settings.auth_test_mode,
+            auth_scheme:     auth_scheme,
+            razor_requester: settings.razor_requester,
+            message_map:     settings.message_map,
+        }
+
+        cr  = razor_requester_credentials_options(
+            auth_scheme,
+            [ username, nil, nil ],
+            **options
+        )
+        call_system_status(cr, **options)
+
+        status 200
+
+        if request.accept? 'text/plain'
+
+            content_type 'text/plain'
+            ''
+        elsif request.accept?('text/xml')
+
+            content_type 'text/xml'
+            %Q{<?xml version="1.0"?><response result="success"/>}
+        elsif request.accept?('application/xml')
+
+            content_type 'application/xml'
+            %Q{<?xml version="1.0"?><response result="success"/>}
+        elsif request.accept? 'application/json'
+
+            content_type 'application/json'
+            '{}'
+        else
+
+            log :violation, 'Invalid accept type'
+            halt 500, {}, 'Oops! Something went wrong!'
+        end
+    end
+
+end # class AuthOnlyLogin
+
+
+# ##########################################################
+# module
+
+end # module Login
+end # module RouteVerbAdaptors
+end # module Applications
+end # module Cassini
+end # module RazorRisk
+
+# ############################## end of file ############################# #
+
+