Class: Net::BER::BerIdentifiedString

Inherits:
String
  • Object
show all
Defined in:
lib/net/ber.rb

Overview

A String object with a BER identifier attached.

Constant Summary

Constants included from BERParser

Net::BER::BERParser::BuiltinSyntax

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Extensions::String

#read_ber, #read_ber!, #reject_empty_ber_arrays, #to_ber, #to_ber_application_string, #to_ber_bin, #to_ber_contextspecific

Methods included from BERParser

#read_ber

Constructor Details

#initialize(args) ⇒ BerIdentifiedString

The binary data provided when parsing the result of the LDAP search has the encoding ‘ASCII-8BIT’ (which is basically ‘BINARY’, or ‘unknown’).

This is the kind of a backtrace showing how the binary ‘data` comes to BerIdentifiedString.new(data):

@conn.read_ber(syntax)
   -> StringIO.new(self).read_ber(syntax), i.e. included from module
   -> Net::BER::BERParser.read_ber(syntax)
      -> (private)Net::BER::BERParser.parse_ber_object(syntax, id, data)

In the ‘#parse_ber_object` method `data`, according to its OID, is being ’casted’ to one of the Net::BER:BerIdentifiedXXX classes.

As we are using LDAP v3 we can safely assume that the data is encoded in UTF-8 and therefore the only thing to be done when instantiating is to switch the encoding from ‘ASCII-8BIT’ to ‘UTF-8’.

Unfortunately, there are some ActiveDirectory specific attributes (like ‘objectguid`) that should remain binary (do they really?). Using the `#valid_encoding?` we can trap this cases. Special cases like Japanese, Korean, etc. encodings might also profit from this. However I have no clue how this encodings function.



324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/net/ber.rb', line 324

def initialize args
  super
  #
  # Check the encoding of the newly created String and set the encoding
  # to 'UTF-8' (NOTE: we do NOT change the bytes, but only set the
  # encoding to 'UTF-8').
  return unless encoding == Encoding::BINARY
  current_encoding = encoding
  force_encoding('UTF-8')
  force_encoding(current_encoding) unless valid_encoding?
end

Instance Attribute Details

#ber_identifier ⇒ Object

Returns the value of attribute ber_identifier.



299
300
301
 
# File 'lib/net/ber.rb', line 299

def ber_identifier
  @ber_identifier
end