soar_idm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c3e1d7bd6ab36b070516c7df38c6aa35c24dee4
+  data.tar.gz: d027699c55c43b626d92af3d813c4a47ea42ed5c
+SHA512:
+  metadata.gz: 6e31cdd4fa2e554a3cb73bf94693b059f5431d78a264e43eec377fb7b21628be0d9fab88e705af809b0ff73797f9a64cf4e0e2d2a2f8ae06e9d759024deef8ea
+  data.tar.gz: 9aaf7a5deba6a3f813a01b5652becf5d6cffc45a24aebc41ef4ff0f48c9a94d4678b9f2beaabe7090f35a024b17bd74dccceb6671ca43c4f3fb43fd9e389f6c6

data/.gitignore

@@ -0,0 +1,11 @@
+.byebug_history
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soar_pl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ernst van Graan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# SoarIDM
+
+SoarIDM is a generic API for Identity Registries to adhere to when playing an active role in accomplishing Identity Management. It was designed for use in the SOAR architecture. Extend the IdmApi class with your own, and provide the needed IDM functionality.
+
+An IDM can be given an entity identifier, and asked to enumerate the roles associated with the entity. When given an entity identifier and a role, the IDM can provide attributes configured for the entity when acting as that role.
+
+# Features
+
+All functionality of the identity registry requires an entity identifier (non-empty string). When requesting attributes for a role, the role is optional (non-empty string).
+
+If an invalid, non-string or empty entity identifier is provided, nil is returned for get_roles().
+If a valid entity identifier is provided, the roles for than entity are returned in a dictionary.
+
+If an invalid, non-string or empty entity identifier is provided, nil is returned for get_attributes().
+If a valid entity identifier is provided, but no role is provided, all attributes for the entity are returned.
+If a valid entity identifier is provided, and a valid role is provided, all attributes associated with that role for the entity are returned, provided the entity has that role. If the entity does not have that role, nil is returned.
+
+If an invalid, non-string or empty entity identifier is provided, nil is returned for get_identifiers().
+If a valid entity identifier is provided, all identifiers known for the entity *by this identity registry* are returned.
+
+For all functions, the entity identifier provided is used to look up the entity identity. The following errors may occur, and result in a SoarIdm::IdentityError being raised:
+
+If a programmatic error results in identities looked up being nil:
+- Error looking up identity for identifier entity_identifier
+
+If more than one identity is found for the entity identifier:
+- Multiple identities found for identifier entity_identifier
+
+If no identities are found for the entity identifier:
+- Identities not found for identifier entity_identifier
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+		gem 'soar_idm'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install soar_idm
+
+## Usage (provider)
+
+When providing your own identity registry, extend the SoarIDM::IdmApi class and implement the inversion of control methods. These methods will receive the identity you provide on lookup of the identifier in calculate_identifiers().
+
+    def calculate_roles(identity)
+      # use your source of truth to match roles to the identity
+      []
+    end
+
+    def calculate_all_attributes(identity)
+      # walk the identity tree for your source of truth and extract all attributes
+      {}
+    end
+
+    def calculate_attributes(identity, role)
+      # extract all attributes for the role from your source of truth, given the identity
+      { role => {} }
+    end 
+
+    def calculate_identifiers(entity_identifier)
+      # walk the identity in your source of truth and extract all identifiers
+      [entity_identifier]
+    end
+
+    def calculate_identities(entity_identifier)
+      # find the UUID in your source of truth for the identity. The base IDM API generates one. For a simplified, shallow registry (not recommended,) simply return the entity identifier. Note though that the SOAR IDMs guarantee global uniqueness for identity UUIDs!
+      [SecureRandom.uuid]
+    end
+
+
+Over-ride the public and private methods at your own risk and at the risk of non-compliance with the SOAR architecture.
+
+## Usage (client)
+	  spec.add_development_dependency 'soar_idm'
+	  bundle exec irb
+
+In the examples that follow, @iut refers to 'implementation under test' a.k.a 'item under test'
+Extend the {SoarIDM::IdmApi IDM API} class to create an identity registry.
+
+Consumers of your identity registry will expect to use it so:
+
+		entity_identifier = "entity identifier"
+		entity_roles = @iut.get_roles(entity_identifier)
+		# [ 'role1', 'role2']
+
+		attributes = @iut.get_attributes(entity_identifier, role)
+		# { 'role1' => {'attribute1' => 'value1', 'attribute2' => 'value2'}, 'role2' => {'attribute3' => 'value3', 'attribute4' => 'value4'}}
+
+        identifiers = @iut.get_identifiers(entity_identifier)
+        # [ 'entity identifier', 'another identifier']
+
+## Deploying
+
+This identity management framework can be deployed in-process in any ruby application or application server. It was intended as a library in support of identity registries as SOA services in the SOAR architecture, to be deployed on soar_sc service components.
+
+## Contributing
+
+Bug reports and feature requests are welcome by email to ernst dot van dot graan at hetzner dot co dot za. This gem is sponsored by Hetzner (Pty) Ltd (http://hetzner.co.za)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/soar_idm/soar_idm.rb

@@ -0,0 +1,86 @@
+require 'securerandom'
+require "soar_idm/version"
+require 'jsender'
+
+module SoarIdm
+  class IdentityError < StandardError
+  end
+
+  class IdmApi
+    def get_roles(entity_identifier)
+      return nil if invalid_entity_identifier?(entity_identifier) or no_entity_identifier?(entity_identifier)
+      identity = get_identity(entity_identifier)
+      calculate_roles(identity)
+    end
+
+    def get_attributes(entity_identifier, role = nil)
+      return nil if invalid_entity_identifier?(entity_identifier) or no_entity_identifier?(entity_identifier)
+      identity = get_identity(entity_identifier)
+      return calculate_all_attributes(identity) if role_missing?(role) or no_role?(role)
+      roles = get_roles(entity_identifier)
+      return nil if roles.nil? or not(roles.include?(role))
+      calculate_attributes(identity, role)
+    end
+
+    def get_identifiers(entity_identifier)
+      return nil if invalid_entity_identifier?(entity_identifier) or no_entity_identifier?(entity_identifier)
+      identity = get_identity(entity_identifier)
+      calculate_identifiers(identity)
+    end
+
+    protected
+
+    def calculate_roles(identity)
+      []
+    end
+
+    def calculate_all_attributes(identity)
+      {}
+    end
+
+    def calculate_attributes(identity, role)
+      { role => {}}
+    end 
+
+    def calculate_identifiers(identity)
+      [entity_identifier]
+    end
+
+    def calculate_identities(entity_identifier)
+      [SecureRandom.uuid]
+    end
+
+    def get_identity(entity_identifier)
+      identities = calculate_identities(entity_identifier)
+      raise IdentityError.new("Error looking up identity for identifier #{entity_identifier}") if identities.nil?
+      raise IdentityError.new("Multiple identities found for identifier #{entity_identifier}") if identities.size > 1
+      raise IdentityError.new("Identities not found for identifier #{entity_identifier}") if identities.size == 0
+      identities.first
+
+    rescue => ex
+      raise IdentityError.new("Failure looking up identity for #{entity_identifier}: #{ex}")
+    end    
+
+    private
+
+    def invalid_entity_identifier?(entity_identifier)
+      entity_identifier.nil? or not(entity_identifier.is_a?(String))
+    end
+
+    def no_entity_identifier?(entity_identifier)
+      entity_identifier.strip == ""
+    end
+
+    def invalid_role?(role)
+      role_missing?(role) or not(role.is_a?(String))
+    end
+    
+    def role_missing?(role)
+      role.nil?
+    end
+
+    def no_role?(role)
+      role.strip == ""
+    end
+  end
+end

data/lib/soar_idm/version.rb

@@ -0,0 +1,3 @@
+module SoarIDM
+  VERSION = "0.0.1"
+end

data/soar_idm.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_idm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_idm"
+  spec.version       = SoarIDM::VERSION
+  spec.authors       = ["Ernst van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{Generic implementation of a SOAR Identity management API}
+  spec.description   = %q{Generic implementation of a SOAR Identity management API}
+#  spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+#  spec.required_ruby_version = ['>=2.0.0']
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+  spec.add_dependency "jsender"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: soar_idm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ernst van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jsender
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generic implementation of a SOAR Identity management API
+email:
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/soar_idm/soar_idm.rb
+- lib/soar_idm/version.rb
+- soar_idm.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Generic implementation of a SOAR Identity management API
+test_files: []
+has_rdoc: