soar-registry-directory 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4505d2bbb4a6b9d47b370ddeaf82d8a9b76231b
-  data.tar.gz: e4de04def83d9751931f30eb49e9fcaad7acd61c
+  metadata.gz: 70a565fb09b0f4af26cfb869c32c41aa5809b27e
+  data.tar.gz: 2fb0d1201fce3c266bf570315b2524005a61776b
 SHA512:
-  metadata.gz: 44514a249b7af19f67f784abe25868d644bfd91a70e777078a0aa613954c196bab77e915b5270be35b2146e29a9ea22fcc31860854c7eb704ef0a7688864e153
-  data.tar.gz: 715d8a78da3f01196c2a67d61fe78bcb059fe86458cd3f6d270f318cfb2de46ba66d57731d8753972d3d1bb7b06ed6bdf32cda651a9e053d87b1102d1607330e
+  metadata.gz: cfbebba8afea49661752f2fe56a23f57c3874c3595af6b23f90fee6a30697258733b83836254df42e9552f1d841de4c8025ee7b7359f7be5871bd428cb72a049
+  data.tar.gz: 12784a7f75d25c92dabdcd1f3fa88ec779bac1dfd5173507f0a29767ffc8ac60ef3e5816e52ac9ddb05b57f92bb92a32e69320dee5a1c0616f4b191c97b66181

data/README.md

@@ -23,7 +23,6 @@ Create an instance of the stub provider by passing in the name, primary key and
 > require 'soar/registry/directory'
 > provider = Soar::Registry::Directory::Provider::Stub.new({
     table: "mytable",
-    primary_key: "uuid",
     index: ["uuid", "email"] 
 })
 ```
@@ -36,7 +35,6 @@ Create an instance of the stub provider by passing in the name, primary key and
     },
     table: "mytable",
     index: ['uuid', 'email'],
-    primary_key: "uuid",
     configuration: {
         region: 'us-west-2'
         endpoint: 'http://localhost:8000'
@@ -45,6 +43,23 @@ Create an instance of the stub provider by passing in the name, primary key and
 
 ```
 
+### LDAP Provider
+```ruby
+> provider = Soar::Registry::Directory::Provider::Ldap.new({
+    base: 'dc=hetzner,dc=co,dc=za',
+    index: ['entryuuid', 'mail'],
+    config: {
+      host: 'localhost',
+      port: 389
+    },
+    attributes: ['entryuuid', 'cn', 'mail', 'sn'],
+    credentials: {
+      username: 'cn=admin,dc=hetzner,dc=co,dc=za'
+      password: 'secret'
+    }
+})
+```
+
 ### The Model
 ```ruby
 > directory = Soar::Registry::Directory.new(provider)
@@ -70,8 +85,8 @@ exit $EXIT_CODE
 
 #### Local
 ```bash
-$ docker-compose --file docker-compose.dynamo_db.yml up
-$ CONFIG_FILE=config.dynamo_db.yml TEST_PROVIDER=DynamoDb cucumber
+$ docker-compose --file docker-compose.dynamo_db.yml up --remove-orphans
+$ CONFIG_FILE=config.dynamo_db.yml TEST_ORCHESTRATION_PROVIDER=DynamoDb cucumber
 ```
 
 #### CI
@@ -80,3 +95,19 @@ docker-compose --file docker-compose.ci.dynamo_db.yml up --abort-on-container-ex
 EXIT_CODE=$(docker ps -a -f "name=soar-registry-directory-test-provider-dynamo_db" -q | xargs docker inspect -f "{{ .State.ExitCode }}")
 exit $EXIT_CODE 
 ```
+
+### LDAP provider
+
+#### Local
+```bash
+$ docker-compose --file docker-compose.ldap.yml up --remove-orphans
+$ CONFIG_FILE=config.ldap.yml TEST_ORCHESTRATION_PROVIDER=Ldap cucumber
+```
+
+#### CI
+```bash
+docker-compose --file docker-compose.ci.ldap.yml up --abort-on-container-exit --remove-orphans --build --force-recreate
+EXIT_CODE=$(docker ps -a -f "name=soar-registry-directory-test-provider-ldap" -q | xargs docker inspect -f "{{ .State.ExitCode }}")
+exit $EXIT_CODE 
+```
+

data/lib/soar/registry/directory/error.rb

@@ -3,6 +3,7 @@ module Soar
       module Directory
         module Error
           class NoEntriesFound < StandardError; end;
+          class MultipleEntriesFound < StandardError; end;
       end
     end
   end

data/lib/soar/registry/directory/model.rb

@@ -1,6 +1,7 @@
 require 'soar/registry/directory/error'
 require 'soar/registry/directory/provider/stub'
 require 'soar/registry/directory/provider/dynamo_db'
+require 'soar/registry/directory/provider/ldap'
 
 module Soar
   module Registry

data/lib/soar/registry/directory/provider/dynamo_db.rb

@@ -14,13 +14,12 @@ module Soar
           ##
           # @param credentials [Hash] { username: 'username', password: 'secret'}
           # @param table [String]
-          # @param primary_key [String]
           # @param index [Array] primary key should be the first item
           # @param configuration [Hash] { region: 'us-west-2', endpoint: 'http://localhost:8000' }
           ##
-          def initialize(credentials: nil, table: nil, primary_key: nil, index: nil, configuration: nil)
+          def initialize(credentials: , table: , index: , configuration: )
             @table_name = table
-            @primary_key = primary_key
+            @primary_key = index[0]
             @index = index
             @credentials = Hashie.symbolize_keys(credentials)
             configuration[:credentials] = Aws::Credentials.new(@credentials[:username], @credentials[:password])
@@ -70,7 +69,7 @@ module Soar
               }
             }
 
-            options.merge!({index_name: "#{key}_index"}) if @index.include?(key)
+            options.merge!({index_name: "#{key}-index"}) if @index.include?(key)
             identity = @client.query(options)
             identity.items.map { |item| 
               Hashie.stringify_keys(item)

data/lib/soar/registry/directory/provider/ldap.rb

@@ -0,0 +1,103 @@
+require 'soar/registry/directory/error'
+require 'net/ldap'
+
+module Soar
+  module Registry
+    module Directory
+      module Provider
+        class Ldap
+
+          ##
+          # @param config [Hash]
+          # @param base [String] ldap tree base eg 'dc=hetzner,dc=co,dc=za'
+          # @param attributes [Array] array of attributes to return for queries
+          # @param credentials [Hash]
+          ##
+          def initialize(config: , base: , attributes: , index: , credentials: )
+            @base = base
+            @index = index
+            @attributes = attributes
+            @config = {
+              host: config[:host],
+              port: config[:port],
+              auth: {
+                method: :simple,
+                username: credentials[:username], 
+                password: credentials[:password]
+              }              
+            }
+            @ldap = Net::LDAP.new(@config)
+            @ldap.bind
+          end
+
+          def put(entry)
+            @ldap.add({
+              dn: entry[:dn],
+              attributes: entry[:attributes]
+            })
+          end
+
+          ##
+          # @param [String] uuid primary key of the identity
+          # @return [Hash] the identity
+          # @raise [Soar::Registry::Directory::Error::NoEntriesFound] if primary key not found
+          # @raise [Soar::Registry::Directory::Error::MultipleEntriesFound] if multiple matches found
+          ##
+          def fetch(uuid)
+            result = @ldap.search({
+              base: @base,
+              attributes: @attributes,
+              filter: Net::LDAP::Filter.eq(@index[0], uuid),
+              return_result: true
+            })
+            raise Soar::Registry::Directory::Error::NoEntriesFound if result.empty?
+            raise Soar::Registry::Directory::Error::MultipleEntriesFound if result.length > 1
+            response = {}
+            @attributes.each { |attribute| 
+              response[attribute.to_sym] = result[0][attribute.to_sym][0]
+            }
+            response
+          end
+
+
+          ##
+          # @param key, named index [String] 
+          # @param value [String]
+          # @return [Array] list of identities
+          # @raise [ArgumentError] if value or named index is not specified
+          ##
+          def search(key, value)
+            result = []
+            entries = @ldap.search({
+              base: @base,
+              filter: Net::LDAP::Filter.eq(key, value),
+              attributes: @attributes,
+              return_result: true
+            })
+
+            entries.each { |entry|
+              response = {}
+              @attributes.each { |attribute| 
+                response[attribute.to_sym] = entry[attribute.to_sym][0]
+              }
+              result << response
+            }
+            return result
+          end
+
+          ##
+          # @return [Array] a list of primary keys and global secondary indexes
+          ##
+          def index
+            @index
+          end
+
+          def delete(dn)
+            @ldap.delete(dn: dn)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/soar/registry/directory/provider/stub.rb

@@ -16,9 +16,9 @@ module Soar
           # @param primary_key [String]
           # @param index [Array] primary key should be the first item 
           ##
-          def initialize(table: nil, primary_key: nil, index: nil)
+          def initialize(table: , index: )
             @table = table
-            @primary_key = primary_key
+            @primary_key = index[0]
             @index = index
             @@interface.clear
           end

data/lib/soar/registry/directory/test/fixtures/entries.json

@@ -1,7 +1,6 @@
 [
     {
         "uuid": "identity-62936e70-1815-439b-bf89-8492855a7e6b",
-        "entity_id": "entity-2d931510-d99f-494a-8c67-87feb05e1594",
         "email": "test+publisher@hetzner.co.za",
         "roles": {
             "staff": {
@@ -14,7 +13,6 @@
     }, 
     {
         "uuid": "identity-43353f18-8afe-11e6-ae22-56b6b6499611",
-        "entity_id": "entity-2d931510-d99f-494a-8c67-87feb05e1594",
         "email": "test+consumer@hetzner.co.za",
         "roles": {
             "staff": {},
@@ -26,7 +24,6 @@
     }, 
     {
         "uuid": "identity-820d5660-2204-4f7d-8c04-746313439b81",
-        "entity_id": "entity-bad85eb9-0713-4da7-8d36-07a8e4b00eab",
         "email": "admin@hetzner.co.za",
         "roles": {
             "staff": {},
@@ -48,7 +45,6 @@
     },
     {
         "uuid": "identity-1ff472a6-8df3-4f13-82c3-89fde26db3cf",
-        "entity_id": "entity-bad85eb9-0713-4da7-8d36-07a8e4b00eab",
         "email": "none@example.com",
         "client_nr": "C123456789",
         "roles": {

data/lib/soar/registry/directory/test/fixtures/table_structure.json

@@ -11,10 +11,6 @@
             "attribute_name": "uuid",
             "attribute_type": "S"
         },
-        {
-            "attribute_name": "entity_id",
-            "attribute_type": "S"
-        },
         {
             "attribute_name": "email",
             "attribute_type": "S"
@@ -22,7 +18,7 @@
     ],
     "global_secondary_indexes": [
         {
-            "index_name": "email_index",
+            "index_name": "email-index",
             "key_schema": [
             {
                 "attribute_name": "email",
@@ -32,23 +28,6 @@
             "projection": {
                 "projection_type": "ALL"
 
-            },
-            "provisioned_throughput": { 
-                "read_capacity_units": 10,
-                "write_capacity_units": 10
-            }
-        },
-        {
-            "index_name": "entity_id_index",
-            "key_schema": [
-            {
-                "attribute_name": "entity_id",
-                "key_type": "HASH"
-            }
-            ],
-            "projection": {
-                "projection_type": "ALL"
-
             },
             "provisioned_throughput": { 
                 "read_capacity_units": 10,

data/lib/soar/registry/directory/test/orchestrator.rb

@@ -1,5 +1,6 @@
 require 'soar/registry/directory/test/provider/stub'
 require 'soar/registry/directory/test/provider/dynamo_db'
+require 'soar/registry/directory/test/provider/ldap'
 
 module Soar
   module Registry

data/lib/soar/registry/directory/test/provider/dynamo_db.rb

@@ -19,7 +19,6 @@ module Soar
                 credentials: @configuration['provider']['credentials'], 
                 table: @table,
                 index: @index,
-                primary_key: @index[0],
                 configuration: @configuration['provider']['config']
               })
               @directory = Soar::Registry::Directory.new(provider)

data/lib/soar/registry/directory/test/provider/ldap.rb

@@ -0,0 +1,132 @@
+require 'soar/registry/directory'
+
+module Soar
+  module Registry
+    module Directory
+      module Test
+        module Provider
+          class Ldap
+
+            def initialize
+              @configuration = YAML.load_file("config/#{ENV['CONFIG_FILE']}")
+              @base = @configuration['provider']['base']
+              @config = {
+                host: @configuration['provider']['config']['host'],
+                port: @configuration['provider']['config']['port']
+              }
+              @credentials = {
+                username: @configuration['provider']['credentials']['username'],
+                password: @configuration['provider']['credentials']['password']
+              }
+              @index = @configuration['provider']['index']
+              @entries = [{
+                dn: "cn=John Smith,#{@base}",
+                attributes: {
+                  cn: "John Smith",
+                  mail: "test@example.com",
+                  objectclass: ["inetOrgPerson", "top"],
+                  sn: "Smith"
+                }
+              }, {
+                dn: "cn=Sarel Cilliers,#{@base}",
+                attributes: {
+                  cn: "Sarel Cilliers",
+                  mail: "sarel@example.com",
+                  objectclass: ["inetOrgPerson", "top"],
+                  sn: "Cilliers"
+                }
+              }]
+            end
+
+            def given_configured_directory
+              provider = Soar::Registry::Directory::Provider::Ldap.new({
+                base: @base,
+                index: @index,
+                config: {
+                  host: @config[:host],
+                  port: @config[:port]
+                },
+                attributes: ['entryuuid', 'cn', 'mail', 'sn'],
+                credentials: {
+                  username: @credentials[:username],
+                  password: @credentials[:password]
+                }
+              })
+              @directory = Soar::Registry::Directory.new(provider)
+              @entries.each { |entry|
+                provider.delete(entry[:dn])
+              }
+            end
+
+            ##
+            # Adds @entries to datastore using ldap protocol
+            # Adds entryuuid to @entries
+            ##
+            def given_existing_data
+              @entries.each{ |entry| 
+                @directory.put(entry)
+                result = @directory.search("mail", entry[:attributes][:mail])
+                entry[:attributes][:entryuuid] = result[0][:entryuuid]
+              }
+            end
+
+            def put_entry
+              @directory.put(@entries[0])
+              result = @directory.search("mail", @entries[0][:attributes][:mail])
+              @entries[0][:attributes][:entryuuid] = result[0][:entryuuid]
+            end
+
+            def search_for_entry
+              @result = @directory.search("mail", @entries[0][:attributes][:mail])
+            end
+
+            def request_index
+              @result = @directory.index
+            end
+
+            def fetch_entry
+              begin
+                @result = @directory.fetch(@entries[0][:attributes][:entryuuid])
+              rescue Soar::Registry::Directory::Error::NoEntriesFound
+                @error = true
+              end
+            end
+
+            def persisted?
+              result = @directory.fetch(@entries[0][:attributes][:entryuuid])
+              entry = @entries[0][:attributes]
+              entry.delete(:objectclass)
+              result == entry
+            end
+
+            def returned?
+              entry = @entries[0][:attributes]
+              entry.delete(:objectclass)
+              @result == [entry]
+            end
+
+            def index?
+              @result == @index
+            end
+
+            def single_entry?
+              entry = @entries[0][:attributes]
+              entry.delete(:objectclass)
+              @result == entry
+            end
+
+            def no_entries_found?
+              @error == true
+            end
+
+            def no_matching_entries?
+              @result == []
+            end
+
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/soar/registry/directory/test/provider/stub.rb

@@ -12,12 +12,11 @@ module Soar
               "identifier" => SecureRandom.hex
             }
 
-            @@index = ["identity_id", "email", "entity_id"]
+            @@index = ["uuid", "identifier"]
 
             def given_configured_directory
               provider = Soar::Registry::Directory::Provider::Stub.new({
                 table: "identities",
-                primary_key: "uuid",
                 index: @@index
               })
               @directory = Soar::Registry::Directory.new(provider)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar-registry-directory
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Charles Mulder
@@ -67,7 +67,7 @@ dependencies:
         version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.28
+        version: 2.6.38
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,7 +77,7 @@ dependencies:
         version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.28
+        version: 2.6.38
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.6
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
 description: Directories for soar registries
 email: charles.mulder@hetzner.co.za
 executables: []
@@ -109,11 +123,14 @@ files:
 - lib/soar/registry/directory/error.rb
 - lib/soar/registry/directory/model.rb
 - lib/soar/registry/directory/provider/dynamo_db.rb
+- lib/soar/registry/directory/provider/ldap.rb
 - lib/soar/registry/directory/provider/stub.rb
 - lib/soar/registry/directory/test/fixtures/entries.json
+- lib/soar/registry/directory/test/fixtures/entries.ldif
 - lib/soar/registry/directory/test/fixtures/table_structure.json
 - lib/soar/registry/directory/test/orchestrator.rb
 - lib/soar/registry/directory/test/provider/dynamo_db.rb
+- lib/soar/registry/directory/test/provider/ldap.rb
 - lib/soar/registry/directory/test/provider/stub.rb
 homepage: https://gitlab.host-h.net/registries/directory
 licenses: