distinguished_name 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Midpoint Data Layer
+
+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,3 @@
+A String Representation of Distinguished Names
+
+This is a gem for interacting with the string representation of distinguished names, per the RFC-1779 (http://www.ietf.org/rfc/rfc1779.txt)

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/*_test.rb'
+end

data/distinguished_name.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'distinguished_name/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "distinguished_name"
+  gem.version       = DistinguishedName::VERSION
+  gem.authors       = ["Team Bavaro"]
+  gem.email         = [""]
+  gem.summary       = %q{Methods for interacting with distinguished name strings}
+  gem.description   = %q{This is a gem for interacting with the string representation of distinguished names, per the RFC-1779 (http://www.ietf.org/rfc/rfc1779.txt)}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/distinguished_name/canonicalize.rb

@@ -0,0 +1,142 @@
+require File.join(File.dirname(__FILE__), '..', 'distinguished_name')
+
+class DistinguishedName::Canonicalize
+
+  class << self
+
+    def reverse(dn, order=['CN','OU','O','C'])
+      @dn = dn
+      @order = []
+      order.each {|o| @order << o + '='}
+      @separators = [',', '/']
+      return @dn if dn_contains_no_equals || dn_invalid?
+      @separators.each do |s|
+        @current_separator = s
+        @dn_elements = @dn.split(s)
+        clean_array
+        possibly_join_elements
+        break if number_of_elements_matches_given_number_of_equal_signs?
+      end
+      @order.reverse! if @current_separator == '/'
+      reorder_dn
+      rejoin_dn
+      return @dn
+    end
+
+    def comma_separated_format(dn, order=['CN','OU','O','C'])
+      return dn if dn.nil? || dn == ""
+      return dn if in_comma_separated_format?(dn)
+      reverse(dn, order)
+    end
+
+    def slash_separated_format(dn, order=['CN','OU','O','C'])
+      return dn if dn.nil? || dn == ""
+      return reverse(reverse(dn, order), order) if in_slash_separated_format?(dn)
+      reverse(dn, order)
+    end
+
+    def rasify(dn)
+      comma_separated_format(dn)
+    end
+
+    def apachify(dn)
+      slash_separated_format(dn)
+    end
+
+    def in_comma_separated_format?(dn)
+      return false if dn_does_not_contain_separator(',', dn)
+      (((dn.scan('=')).size - (dn.scan('\=')).size) == ((dn.scan(',')).size - (dn.scan('\,')).size) + 1)
+    end
+
+    def in_slash_separated_format?(dn)
+      return false if dn_does_not_contain_separator('/', dn)
+      (((dn.scan('=')).size - (dn.scan('\=')).size) == ((dn.scan('/')).size - (dn.scan('\/')).size))
+    end
+
+  private
+
+    def rejoin_dn
+      if @current_separator == ',' 
+        @dn = '/' + @dn_elements.join('/')
+      else
+        @dn = @dn_elements.join(',')
+      end
+    end
+
+    def reorder_dn
+      tmp_dn_elements = []
+      @order.each do |o|
+        @dn_elements.each {|e| (tmp_dn_elements << e) if e.downcase.match("^#{o.downcase}")}
+      end
+      @dn_elements = tmp_dn_elements.reverse!
+    end
+
+    def possibly_join_elements
+      @dn_elements.each_with_index do |element, index|
+        if number_of_unescaped_equal_signs(element) == 0
+          join_with_prev(index)
+        end
+      end
+    end
+
+    def join_with_prev(index)
+      curr = @dn_elements[index]
+      prev = @dn_elements[index - 1]
+      new_element = [prev, curr].join(@current_separator)
+      @dn_elements[index - 1] = new_element
+      @dn_elements.delete_at(index)
+    end
+
+    def clean_array
+      @dn_elements.delete_if{ |d| d.nil? || d =="" }
+    end
+
+    def dn_does_not_contain_separator(separator, dn)
+      !((dn.scan(separator).size - dn.scan("\\#{separator}").size) > 0)
+    end
+    
+    def number_of_elements_matches_given_number_of_equal_signs?
+      count = 0
+      @dn_elements.each do |element|
+        count += number_of_unescaped_equal_signs(element)
+        element.strip!
+      end
+      count == @dn_elements.size
+    end
+
+    def dn_contains_no_equals
+      @dn.count('=') == 0
+    end
+
+    def dn_invalid?
+      count = 0
+      dn_downcase = @dn.downcase
+      @order.each do |o|
+        curr = dn_downcase.scan(o.downcase)
+        if !(curr.nil? || curr == "")
+          case curr[0]
+            when "c="
+              count += 1
+            when "cn="
+              count += 1
+          end
+        end
+      end
+      count != 2
+    end
+
+    def number_of_unescaped_equal_signs(element)
+      n = 1
+      num_esc_equals = 0
+      num_equals = element.count('=')
+      while (element.index('\=', n))
+        num_esc_equals += 1
+        n = element.index('\=', n)
+        n += 2
+      end
+      return (num_equals - num_esc_equals)
+    end
+
+  end
+
+end

data/lib/distinguished_name/version.rb

@@ -0,0 +1,3 @@
+module DistinguishedName
+  VERSION = "0.0.2"
+end

data/lib/distinguished_name.rb

@@ -0,0 +1,4 @@
+module DistinguishedName
+end
+
+require File.join(File.dirname(__FILE__), 'distinguished_name', 'canonicalize')

data/test/canonicalize_test.rb

@@ -0,0 +1,214 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class CanonicalizeTest < Test::Unit::TestCase
+
+  def test_reversing_a_dn_string_with_slashes_happy_path
+    dn = '/C=US/O=company_name/OU=developers/CN=John Smith'
+    assert_equal 'CN=John Smith,OU=developers,O=company_name,C=US', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_putting_a_dn_string_with_slashes_in_comma_separated_format_happy_path
+    dn = '/C=US/O=company_name/OU=developers/CN=John Smith'
+    assert_equal 'CN=John Smith,OU=developers,O=company_name,C=US', DistinguishedName::Canonicalize.comma_separated_format(dn)
+  end
+
+  def test_reversing_a_dn_string_with_commas_happy_path
+    dn = 'CN=John Smith,OU=developers,O=company_name,C=US'
+    assert_equal '/C=US/O=company_name/OU=developers/CN=John Smith', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_putting_a_dn_string_with_commas_in_slash_separated_format_happy_path
+    dn = 'CN=John Smith,OU=developers,O=company_name,C=US'
+    assert_equal '/C=US/O=company_name/OU=developers/CN=John Smith', DistinguishedName::Canonicalize.slash_separated_format(dn)
+  end
+
+  def test_reversing_a_dn_string_with_non_default_keys_returns_that_string_unaltered
+    dn_with_nonstandard_keys = 'X=person,Y=place,Z=thing'
+    assert_equal dn_with_nonstandard_keys, DistinguishedName::Canonicalize.reverse(dn_with_nonstandard_keys)
+  end
+
+  def test_reversing_a_dn_string_with_no_equal_signs_just_returns_that_string_unaltered
+    dn = '/hi/there/how/are/you?'
+    assert_equal dn, DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_reversing_a_dn_string_with_escaped_equal_signs_returns_that_string_unaltered
+    dn = 'CN\=foo,OU\=bar,O\=baz,C\=US'
+    assert_equal dn, DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_reversing_a_dn_string_with_unescaped_comma_returns_that_string_unaltered
+    dn = "CN=boo,OU=foo,choo,voo,O=bar,C=beeeergood"
+    assert_equal dn, DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_reversing_a_dn_string_with_only_commas_just_returns_that_string_unaltered
+    dn = 'hi,there,how,are,you?'
+    assert_equal dn, DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_reversing_a_dn_string_with_empty_slashes_ignores_those_empty_elements
+    assert_equal 'CN=b,C=a', DistinguishedName::Canonicalize.reverse('/C=a////CN=b')
+  end
+
+  def test_reversing_a_dn_string_with_empty_commas_ignores_those_empty_elements
+    assert_equal '/C=b/CN=a', DistinguishedName::Canonicalize.reverse('CN=a,,,,C=b')
+  end
+
+  def test_reversing_a_dn_string_with_two_CNs_and_no_Cs_returns_that_string_unaltered_per_the_default_format
+    dn = 'CN=John Smith,OU=developers,O=company_name,CN=US'
+    assert_equal dn, DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_dn_reversing_strips_spaces
+    dn = 'CN=blah, OU=foo, C=bar'
+    assert_equal '/C=bar/OU=foo/CN=blah', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_slashed_dn_with_escaped_comma_can_be_reversed
+    dn = '/CN=John Smith\, jr./C=US/OU=developers/O=company_name'
+    assert_equal 'CN=John Smith\, jr.,OU=developers,O=company_name,C=US', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_slashed_dn_with_escaped_slash_can_be_reversed
+    dn = '/C=US/O=company_name/OU=developers\/testers/CN=John Smith'
+    assert_equal 'CN=John Smith,OU=developers\/testers,O=company_name,C=US', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_slashed_dn_with_escaped_end_comma_can_be_reversed
+    dn = '/C=US/O=company_name\, inc./OU=developers/CN=John Smith'
+    assert_equal 'CN=John Smith,OU=developers,O=company_name\, inc.,C=US', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_comma_dn_with_escaped_comma_can_be_reversed
+    dn = 'CN=John Smith\, jr.,OU=developers,O=company_name,C=US'
+    assert_equal '/C=US/O=company_name/OU=developers/CN=John Smith\, jr.', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_comma_dn_with_escaped_slash_can_be_reversed
+    dn = 'CN=John Smith,OU=developers\/testers,O=company_name,C=US'
+    assert_equal '/C=US/O=company_name/OU=developers\/testers/CN=John Smith', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_multiple_ou_dn_canonicalized_for_comma_dn
+    dn = '/C=US/O=company_name/OU=asdf/OU=blerg/OU=developers/CN=John Smith'
+    assert_equal 'CN=John Smith,OU=developers,OU=blerg,OU=asdf,O=company_name,C=US', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_removal_of_extra_fields_not_in_order_with_slashy
+    dn = '/C=US/O=company_name/OU=asdf/OU=blerg/OU=developers/CN=John Smith/FOO=bar'
+    assert_equal 'CN=John Smith,OU=developers,OU=blerg,OU=asdf,O=company_name,C=US', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_removal_of_extra_fields_not_in_order_with_commas
+    dn = 'FOO=bar,CN=John Smith,CNOODLE=yum,FII=fofum,OU=asdf,OU=blerg,OU=developers,O=company_name,C=US'
+    assert_equal '/C=US/O=company_name/OU=developers/OU=blerg/OU=asdf/CN=John Smith', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_multiple_ou_dn_canonicalized_with_comma
+    dn = 'CN=John Smith,OU=asdf,OU=blerg,OU=developers,O=company_name,C=US'
+    assert_equal '/C=US/O=company_name/OU=developers/OU=blerg/OU=asdf/CN=John Smith', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_escaped_equals_in_dn_can_be_reversed
+    dn = '/C=US/O=company_name/OU=asdf/CN=login\=John Smith'
+    assert_equal 'CN=login\=John Smith,OU=asdf,O=company_name,C=US', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_escaped_equals_in_dn_is_reverse_canonicalized
+    dn = 'CN=login\=John Smith,C=US,OU=asdf,O=company_name'
+    assert_equal '/C=US/O=company_name/OU=asdf/CN=login\=John Smith', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_reversing_a_slash_separated_dn_orders_dn_appropriately_with_non_default_order
+    dn = '/C=US/O=Test/OU=abc/CN=xyz'
+    assert_equal 'O=Test,OU=abc,C=US,CN=xyz', DistinguishedName::Canonicalize.reverse(dn, ['O', 'OU', 'C', 'CN'])
+  end
+
+  def test_reversing_a_comma_separated_dn_orders_dn_appropriately_with_non_default_order
+    dn = 'O=Test,OU=abc,C=US,CN=xyz'
+    assert_equal '/CN=xyz/C=US/OU=abc/O=Test', DistinguishedName::Canonicalize.reverse(dn, ['O', 'OU', 'C', 'CN'])
+  end
+
+  def test_comma_separated_format_with_a_comma_separated_style_dn
+    dn = 'CN=david,OU=abc,O=Beckham,C=US'
+    assert_equal 'CN=david,OU=abc,O=Beckham,C=US', DistinguishedName::Canonicalize.comma_separated_format(dn) 
+  end
+  
+  def test_slash_separated_format_with_a_comma_separated_style_dn
+    dn = 'CN=david,OU=abc,O=Beckham,C=US'
+    assert_equal '/C=US/O=Beckham/OU=abc/CN=david', DistinguishedName::Canonicalize.slash_separated_format(dn) 
+  end
+  
+  def test_comma_separated_format_with_a_slash_separated_style_dn
+    dn = '/C=US/O=Beckham/OU=abc/CN=david'
+    assert_equal 'CN=david,OU=abc,O=Beckham,C=US', DistinguishedName::Canonicalize.comma_separated_format(dn) 
+  end
+  
+  def test_slash_separated_format_with_a_slash_separated_style_dn
+    dn = '/C=US/O=Beckham/OU=abc/CN=david'
+    assert_equal '/C=US/O=Beckham/OU=abc/CN=david', DistinguishedName::Canonicalize.slash_separated_format(dn) 
+  end
+
+  def test_comma_separated_format_with_a_comma_separated_style_dn_lowercase
+    dn = 'cn=david,ou=abc,o=Beckham,c=US'
+    assert_equal 'cn=david,ou=abc,o=Beckham,c=US', DistinguishedName::Canonicalize.comma_separated_format(dn) 
+  end
+  
+  def test_slash_separated_format_with_a_comma_separated_style_dn_lowercase
+    dn = 'cn=david,ou=abc,o=Beckham,c=US'
+    assert_equal '/c=US/o=Beckham/ou=abc/cn=david', DistinguishedName::Canonicalize.slash_separated_format(dn) 
+  end
+  
+  def test_comma_separated_format_with_a_slash_separated_style_dn_lowercase
+    dn = '/c=US/o=Beckham/ou=abc/cn=david'
+    assert_equal 'cn=david,ou=abc,o=Beckham,c=US', DistinguishedName::Canonicalize.comma_separated_format(dn) 
+  end
+  
+  def test_slash_separated_format_with_a_slash_separated_style_dn_lowercase
+    dn = '/c=US/o=Beckham/ou=abc/cn=david'
+    assert_equal '/c=US/o=Beckham/ou=abc/cn=david', DistinguishedName::Canonicalize.slash_separated_format(dn) 
+  end
+
+  def test_in_comma_separated_format_returns_true_if_its_given_a_comma_separated_dn
+    dn = 'CN=david,OU=abc,O=Beckham,C=US'
+    assert DistinguishedName::Canonicalize.in_comma_separated_format?(dn) 
+  end
+  
+  def test_in_comma_separated_format_returns_false_if_its_given_a_slash_separated_style_dn
+    dn = '/C=US/O=Beckham/OU=abc/CN=david'
+    assert !DistinguishedName::Canonicalize.in_comma_separated_format?(dn) 
+  end
+
+  def test_slash_separated_style_format_with_extra_field_ST_gets_stripped_after_reversing
+    dn = '/C=US/ST=NJ/O=My Company, L.L.C./OU=QA/CN=John Smith'
+    comma_dn = 'CN=John Smith,OU=QA,O=My Company, L.L.C.,C=US'
+    assert_equal comma_dn, DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_in_comma_separated_format_must_contain_at_least_one_unescaped_comma_or_else_its_not_in_comma_separated_format
+    assert_equal false, DistinguishedName::Canonicalize.in_comma_separated_format?('/C=US/ST=NJ/O=My Company, L.L.C./OU=QA/CN=John Smith')
+  end
+
+  def test_in_slash_separated_format_must_contain_at_least_one_unescaped_slash_or_else_its_not_in_slash_separated_format
+    assert_equal false, DistinguishedName::Canonicalize.in_slash_separated_format?('CN=John Smith,OU=QA,O=My Company, L.L.C.,C=US')
+  end
+
+  def test_long_dn_sent_from_browser_is_properly_reversed
+    sent_from_browser = '/C=US/ST=NJ/O=My Company, L.L.C./OU=QA/CN=John Smith'
+    in_db = '/C=US/O=My Company, L.L.C./OU=QA/CN=John Smith'
+    assert_equal in_db, DistinguishedName::Canonicalize.slash_separated_format(sent_from_browser)
+  end
+
+  def test_dn_with_less_than_sign_gets_reversed_properly
+    dn = 'CN=lt\<lt,OU=Q\<A,O=My Company, L.L.C.,C=US'
+    assert_equal '/C=US/O=My Company, L.L.C./OU=Q\<A/CN=lt\<lt', DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+  def test_a_strange_dn_string_does_not_cause_problems
+    dn = "CN=escapes \~\`\!\@\$\%\^\*\(\)\-\_\{\}\[\]\|\.\?, OU=A\~\`\!\@\$\%\^\*\(\)\-\_\{\}\[\]\|\.\?A, O=My Company, L.L.C., ST=NJ, C=US"
+    assert_equal "/C=US/O=My Company, L.L.C./OU=A~`!@$%^*()-_{}[]|.?A/CN=escapes ~`!@$%^*()-_{}[]|.?", DistinguishedName::Canonicalize.reverse(dn)
+  end
+
+
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'distinguished_name')

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: distinguished_name
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease:
+platform: ruby
+authors:
+- Team Bavaro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-12-03 00:00:00.000000000 Z
+dependencies: []
+description: This is a gem for interacting with the string representation of distinguished names, per the RFC-1779 (http://www.ietf.org/rfc/rfc1779.txt)
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- distinguished_name.gemspec
+- lib/distinguished_name.rb
+- lib/distinguished_name/canonicalize.rb
+- lib/distinguished_name/version.rb
+- test/canonicalize_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Methods for interacting with distinguished name strings
+test_files:
+- test/canonicalize_test.rb
+- test/test_helper.rb
+...