ldap-ber 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d62933a4b34660baba5b9ece1311ec054c8fc68e1384e845bc7d99bc3199b61c
+  data.tar.gz: e9c58a69cbd8a77abd5e9d2532a618a797c5a6caa2c75948299f76ac7f93e4fa
+SHA512:
+  metadata.gz: d83da22ad3a51c98800f5e6ca9c7f8e10a4a25b8dbbb96f35c7c99ca2024cdc516d9954503a4c1e0b32c8da67dc8df4a475a140ec62f478465650745bf059cb8
+  data.tar.gz: 1e2f827f2952026dfc2b608bf4c5e2a607c2e70b2a70eb40aa6158a2a5cd7db64b98d3e03f668e77eaadd924823ca263d9a1c7ebf97d70f3cd06cd9358e69a0a

data/.gitignore

@@ -0,0 +1,14 @@
+*.a
+*.bundle
+*.gem
+*.html
+*.o
+*.so
+.ruby-version
+.bundle/
+.yardoc
+coverage/
+doc/
+Gemfile.lock
+pkg
+tags

data/.rspec

@@ -0,0 +1,6 @@
+--require spec_helper
+--order random
+--format documentation
+--color
+--profile
+--fail-fast

data/.rubocop.yml

@@ -0,0 +1,20 @@
+inherit_from: .rubocop_todo.yml
+require: rubocop-performance
+
+AllCops:
+  Include:
+    - Rakefile
+    - lib/ber/**/*.rb
+  Exclude:
+    - '**/.*'
+    - doc/**/*
+    - spec/**/*
+  TargetRubyVersion: 2.4
+
+
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/.rubocop_todo.yml

@@ -0,0 +1,44 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-02-15 16:05:18 +0000 using RuboCop version 0.80.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowComments.
+Lint/SuppressedException:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 39
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 16
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 47
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# Offense count: 4
+Style/Documentation:
+  Exclude:
+    - 'lib/ber/identified/null.rb'
+    - 'lib/ber/identified/oid.rb'
+
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 104

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+end
+
+group :test do
+  gem 'pry', platforms: %i[jruby rbx]
+  gem 'pry-byebug', platforms: :mri
+  gem 'rspec', require: false
+  gem 'simplecov', require: false
+end

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2017-2021 Peter Hamilton
+
+Copyright 2006–2011 by Francis Cianfrocca and other contributors.
+
+
+MIT License
+
+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,9 @@
+# Basic Encoding Rules for LDAP
+
+The Basic Encoding Rules ([BER](https://ldapwiki.com/wiki/Basic%20Encoding%20Rules)) are a set of [Abstract Syntax Notation One](https://ldapwiki.com/wiki/Abstract%20Syntax%20Notation%20One) 
+encoding rules that define a specific way in which information may be encoded in a binary form. 
+
+This gem contains the _BER_ core extensions from [ruby-net-ldap](https://github.com/ruby-ldap/ruby-net-ldap/tree/master/lib/net/ber/core_ext) 
+refactored into refinements for use in the [rom-ldap](https://gitlab.com/peterdavidhamilton/rom-ldap) gem and the accompanying TestUnit tests have been rewritten in Rspec.
+
+I would like to thank the authors of `NET::LDAP` for their continued work.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+if ENV['PRY']
+  begin
+    require 'pry-byebug'
+  rescue LoadError
+  end
+end
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ber'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/ldap-ber.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'ber/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ldap-ber'
+  spec.version       = BER::VERSION.dup
+  spec.authors       = ['Peter Hamilton']
+  spec.email         = ['pete@peterdavidhamilton.com']
+  spec.summary       = 'LDAP Basic Encoding Rules: used by rom-ldap'
+  spec.description   = 'Refactored from Net:LDAP gem.'
+  spec.homepage      = 'https://gitlab.com/peterdavidhamilton/ldap-ber'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.metadata['yard.run']  = 'yri'
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.add_runtime_dependency 'dry-core', '~> 0.4'
+  spec.add_runtime_dependency 'dry-initializer', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+end

data/lib/ber.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'dry/core/constants'
+require 'yaml'
+require 'pathname'
+require 'ber/version'
+require 'ber/function'
+require 'ber/refinements'
+
+# Basic Encoding Rules
+#
+module BER
+  include Dry::Core::Constants
+
+  def self.function
+    @function ||= Function.new
+  end
+
+  # Path to gem root
+  #
+  # @return [Pathname]
+  #
+  # @api private
+  def self.root
+    Pathname(File.dirname(__FILE__))
+  end
+
+  #
+  #
+  # @return [Hash]
+  #
+  # @api private
+  def self.config
+    @config ||= YAML.load_file(root.join('ber.yaml')).freeze
+  end
+
+  #
+  #
+  # @param type [Symbol] (:response)
+  #
+  # @param val [Integer, Symbol]
+  #
+  # @return [Symbol, Integer]
+  #
+  # @api private
+  def self.fetch(type, val)
+    case val
+    when Integer then config[type][val]
+    when Symbol  then config[type].key(val)
+    end
+  end
+
+  def self.compile_syntax(syntax)
+    out = [nil] * 256
+
+    syntax.each do |tag_class_id, encodings|
+      tag_class = config[:tag_class][tag_class_id]
+      encodings.each do |encoding_id, classes|
+        encoding     = config[:encoding_type][encoding_id]
+        object_class = tag_class + encoding
+        classes.each do |number, object_type|
+          out[object_class + number] = object_type
+        end
+      end
+    end
+
+    out
+  end
+
+  Error = Class.new(RuntimeError)
+
+  ASN_SYNTAX       = compile_syntax(config[:syntax]).freeze
+  IDENTIFIED       = compile_syntax(config[:identified_type]).freeze
+  MAX_FIXNUM_SIZE  = 0.size
+  WILDCARD         = '*'
+end

data/lib/ber.yaml

@@ -0,0 +1,199 @@
+---
+:tag_class:
+  :universal:         0b00000000  # 0
+  :application:       0b01000000  # 64
+  :context_specific:  0b10000000  # 128
+  :private:           0b11000000  # 192
+
+:encoding_type:
+  :primitive:         0b00000000  # 0
+  :constructed:       0b00100000  # 32
+
+:identified_type:
+  :universal:
+    :primitive:
+      1:    :boolean
+      2:    :integer
+      4:    :string
+      5:    :null
+      6:    :oid
+      10:   :integer
+      13:   :string             # (relative OID)
+
+    :constructed:
+      16:   :array
+      17:   :array
+
+  :context_specific:
+    :primitive:
+      10:   :integer
+
+#
+# Abstract Syntax Notation One - ASN.1
+#
+:syntax:
+  :application:
+    :primitive:
+      2:                        # UnbindRequest body # nil!
+    :constructed:
+      0:  :array                # BindRequest
+      1:  :array                # BindResponse
+      2:  :array                # UnbindRequest
+      3:  :array                # SearchRequest
+      4:  :array                # SearchData
+      5:  :array                # SearchResult
+      6:  :array                # ModifyRequest
+      7:  :array                # ModifyResponse
+      8:  :array                # AddRequest
+      9:  :array                # AddResponse
+      10: :array                # DelRequest
+      11: :array                # DelResponse
+      12: :array                # ModifyRdnRequest
+      13: :array                # ModifyRdnResponse
+      14: :array                # CompareRequest
+      15: :array                # CompareResponse
+      16: :array                # AbandonRequest
+      19: :array                # SearchResultReferral
+      24: :array                # Unsolicited Notification
+
+  :universal:
+    :constructed:
+      107: :array               # ExtendedResponse (PasswdModifyResponseValue)
+
+  :context_specific:
+    :primitive:
+      0: :string                # password
+      1: :string                # Kerberos v4
+      2: :string                # Kerberos v5
+      3: :string                # SearchFilter-extensible
+      4: :string                # SearchFilter-extensible
+      7: :string                # serverSaslCreds
+    :constructed:
+      0: :array                 # RFC-2251 Control and Filter-AND
+      1: :array                 # SearchFilter-OR
+      2: :array                 # SearchFilter-NOT
+      3: :array                 # Search referral
+      4: :array                 # unknown use in Microsoft Outlook
+      5: :array                 # SearchFilter-GE
+      6: :array                 # SearchFilter-LE
+      7: :array                 # serverSaslCreds
+      9: :array                 # SearchFilter-extensible
+
+
+:request:
+  :con_and:             0xa0   # constructed  0, "and"
+  :con_or:              0xa1   # constructed  1, "or"
+  :con_not:             0xa2   # constructed  2, "not"
+  :equality_match:      0xa3   # constructed  3, "equalityMatch"
+  :substring:           0xa4   # constructed  4, "substring"
+  :op_gte:              0xa5   # constructed  5, "greaterOrEqual"
+  :op_lte:              0xa6   # constructed  6, "lessOrEqual"
+  :substr_initial:      0x80   # primitive    0, SubstringFilter "initial"
+  :substr_any:          0x81   # primitive    0, SubstringFilter "any"
+  :substr_final:        0x82   # primitive    0, SubstringFilter "final"
+  :is_present:          0x87   # primitive    7, "present"
+  :op_ext:              0xa9   # constructed  9, "extensible comparison"
+
+
+:response:
+  0:  :bind_request
+  1:  :bind_result
+  2:  :unbind_request
+  3:  :search_request
+  4:  :search_returned_data
+  5:  :search_result
+  6:  :modify_request
+  7:  :modify_response
+  8:  :add_request
+  9:  :add_response
+  10: :delete_request
+  11: :delete_response
+  12: :modify_rdn_request
+  13: :modify_rdn_response
+  14: :compare_request
+  15: :compare_response
+  16: :abandon_request
+  17: :unknown
+  18: :unknown
+  19: :search_result_referral
+  20: :unknown
+  21: :unknown
+  22: :unknown
+  23: :extended_request
+  24: :extended_response
+  25: :intermediate_response
+
+:result:
+  0:  :success
+  1:  :operations_error
+  2:  :protocol_error
+  3:  :time_limit_exceeded
+  4:  :size_limit_exceeded
+  5:  :compare_false
+  6:  :compare_true
+  7:  :auth_method_not_supported
+  8:  :stronger_auth_required
+  9:  :reserved
+  10: :referral
+  11: :admin_limit_exceeded
+  12: :unavailable_critical_extension
+  13: :confidentiality_required
+  14: :sasl_bind_in_progress
+  15: :not_used
+  16: :no_such_attribute
+  17: :undefined_attribute_type
+  18: :inappropriate_matching
+  19: :constraint_violation
+  20: :attribute_or_value_exists
+  21: :invalid_attribute_syntax
+  #
+  # 22..31 - Not used.
+  #
+  32: :no_such_object
+  33: :alias_problem
+  34: :invalid_dn_syntax
+  35: :ldap_is_leaf
+  36: :alias_dereferencing_problem
+  #
+  # 37..47 - Not used.
+  #
+  48: :inappropriate_authentication
+  49: :invalid_credentials
+  50: :insufficient_access_rights
+  51: :busy
+  52: :unavailable
+  53: :unwilling_to_perform
+  54: :loop_detected
+  #
+  # 55..63 - Not used.
+  #
+  64: :naming_violation
+  65: :object_class_violation
+  66: :not_allowed_on_non_leaf
+  67: :not_allowed_on_rdn
+  68: :entry_already_exists
+  69: :object_class_mods_prohibited
+  70: :reserved_for_cldap
+  71: :affects_multiple_dsas
+  #
+  # 72..79 - Not used.
+  #
+  80: :other
+  81: :server_down
+  82: :local_error
+  83: :encoding_error
+  84: :decoding_error
+  85: :timeout
+  86: :auth_method_unknown
+  87: :filter_error
+  88: :user_cancelled
+  89: :param_error
+  90: :no_memory
+  91: :connect_error
+  92: :not_supported
+  93: :control_not_found
+  94: :no_results_returned
+  95: :more_results
+  96: :client_loop
+  97: :referral_limit
+