module Net::BER::Extensions::String

BER extensions to the String class.

Public Instance Methods

read_ber(syntax = nil) click to toggle source

Nondestructively reads a BER object from this string.

# File lib/net/ber/core_ext/string.rb, line 61
def read_ber(syntax = nil)
  StringIO.new(self).read_ber(syntax)
end
read_ber!(syntax = nil) click to toggle source

Destructively reads a BER object from the string.

# File lib/net/ber/core_ext/string.rb, line 67
def read_ber!(syntax = nil)
  io = StringIO.new(self)

  result = io.read_ber(syntax)
  self.slice!(0...io.pos)

  return result
end
reject_empty_ber_arrays() click to toggle source
# File lib/net/ber/core_ext/string.rb, line 76
def reject_empty_ber_arrays
  self.gsub(/0\000/n, '')
end
to_ber(code = 0x04) click to toggle source

Converts a string to a BER string. Universal octet-strings are tagged with 0x04, but other values are possible depending on the context, so we let the caller give us one.

User code should call either to_ber_application_string or to_ber_contextspecific.

# File lib/net/ber/core_ext/string.rb, line 13
def to_ber(code = 0x04)
  raw_string = raw_utf8_encoded
  [code].pack('C') + raw_string.length.to_ber_length_encoding + raw_string
end
to_ber_application_string(code) click to toggle source

Creates an application-specific BER string encoded value with the provided syntax code value.

# File lib/net/ber/core_ext/string.rb, line 48
def to_ber_application_string(code)
  to_ber(0x40 + code)
end
to_ber_bin(code = 0x04) click to toggle source

Converts a string to a BER string but does not encode to UTF-8 first. This is required for proper representation of binary data for Microsoft Active Directory

# File lib/net/ber/core_ext/string.rb, line 22
def to_ber_bin(code = 0x04)
  [code].pack('C') + length.to_ber_length_encoding + self
end
to_ber_contextspecific(code) click to toggle source

Creates a context-specific BER string encoded value with the provided syntax code value.

# File lib/net/ber/core_ext/string.rb, line 55
def to_ber_contextspecific(code)
  to_ber(0x80 + code)
end

Private Instance Methods

raw_utf8_encoded() click to toggle source
# File lib/net/ber/core_ext/string.rb, line 26
def raw_utf8_encoded
  if self.respond_to?(:encode)
    # Strings should be UTF-8 encoded according to LDAP.
    # However, the BER code is not necessarily valid UTF-8
    begin
      self.encode('UTF-8').force_encoding('ASCII-8BIT')
    rescue Encoding::UndefinedConversionError
      self
    rescue Encoding::ConverterNotFoundError
      self
    rescue Encoding::InvalidByteSequenceError
      self
    end
  else
    self
  end
end