You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by ji...@apache.org on 2004/04/11 09:17:43 UTC

[jira] Updated: (DIR-89) Work on BindRequest construction with BERDigester

The following issue has been updated:

    Updater: Alex Karasulu (mailto:aok123@bellsouth.net)
       Date: Sun, 11 Apr 2004 12:16 AM
    Comment:
o correctly represented the anatomy of the bind request
o added some suggestions which nicely distinguish between encoding specific rules, protocol specific rules and even more specific PDU rules
o prepared now to start building some rules

    Changes:
             description changed from BindRequest for Simple Binding
==============================

SEQUENCE 0x30, 0xxx, 
   INTEGER 0x02 0x....
   CHOICE bindRequest 0x40 
       SEQUENCE 0x30, 0xxx
           INTEGER version 0x02
           OCTET STRING name 0x04 0x...
           CHOICE  
               OCTET STRING simple 0x04 0x...

BERDigester should have a general rule that tracks the current message
id.  It can push an Integer instance of the MessageId onto the stack
when ever a pattern of tags { 0x30, 0x02 } are encountered.  Before the
actual BindRequest pattern is hit this object would be popped off of the
stack but will be available through the "root" member referrence.

The BindRequest pattern would then be { 0x30, 0x40 }.  With this and
the message id we could easily create an empty request and push it
onto the stack to be populated by other rules.

0x30 
  0x02
  0x40
    0x30
      0x02
      0x04
      0x04
  0x00

It might be a good idea to implement some of the simpler constructs
firsts with rules and reuse them when building higher message level 
rule sets.

Here's what we can make for BindRequest now that can be reused:

BindRequestRule
LdapDnRule
IntegerRule
OctetStringRule

 to BindRequest for Simple Binding
==============================

* The LOW level BER operation should not have to create objects for simple types that need to be used with a stack.  These types can be pushed and poped off of primitive stacks which we have added to the digester.

* We must recognize that there will be different kinds of rules. Some will be non protocol specific or rather BER specific which will perhaps be used to transform primitive types.  Other rules will be protocol specific and then there will be PDU specific rules.

Now for our specific problem of building a BindRequest lets keep the scope constrained to simple binds without any controls.  Below we have the tag nesting patterns of such a bind request:


 |  0x30 <-------- SEQUENCE
 |      0x02 <-------- INTEGER (messageId)
 |      0x40 <-------- BindRequest (APPLICATION 0)
 |          0x02 <-------- INTEGER (version)
 |          0x04 <-------- OCTET STRING (name)
 |          0x80 <-------- OCTET STRING (CONTEXT-SPECIFIC 0) (simple)
 |      0x80 <------------ Control (CONTEXT-SPECIFIC 0) (OPTIONAL)
 v
time

The BindRequest pattern would then be { 0x30, 0x40 } however before it comes the messageId which we need to create the BindRequest bean.  

A protocol non specific rule can be devised to accumulate and decode the message id integer by matching for { 0x30, 0x02 }.  It could be called PrimitiveIntDecodeRule.  Lets say that it accumulates, decodes and pushes a primitive int onto the primitive int stack for use later as a parameter.  To summerize this step:

addRule( { 0x30, 0x02 }, PrimitiveIntDecodeRule ) ;

A PDU specific rule, LdapBindRequestRule would then match the tag pattern, { 0x30, 0x40 }, pop the primitive int stack, instantiate a BindRequest bean and push it onto the object stack.

addRule( { 0x30, 0x40 }, LdapBindRequestRule ) ;

Next we encounter the sequence of members we need for this PDU.  For the version INTEGER we register two rules in the following order.

addRule( { 0x30, 0x40, 0x02 }, PrimitiveIntDecodeRule ) ;
addRule( { 0x30, 0x40, 0x02 }, LdapBindSetVersion ) ;

Continuing on we set the distinguished name of the user that is binding.  This also is best handled in a two step process.  The first rule simply accumulates a byte array and pushes it onto the object stack.  The next rule pops the byte array off of the object stack, generates a UNICODE string, and parses it to generate a LdapName object which it then uses to set the name property of the bind request.  The rules to handle this stage are as follows:

addRule( { 0x30, 0x40, 0x04 }, OctetStringRule ) ;
addRule( { 0x30, 0x40, 0x04 }, LdapBindSetName ) ;

Now for the last step we're reading an OCTET STRING that is tagged as a context specific [0] tag for the simple credentials.  Again we use a dual rule combination:

addRule( { 0x30, 0x40, 0x80 }, OctetStringRule ) ;
addRule( { 0x30, 0x40, 0x80 }, LdapBindSetSimpleCredentials ) ;

Here the first rule simply collects the credential data into a byte array and pushes it onto the object stack.  The second rule pops the byte[] off of the object stack and sets the BindRequest bean's credentials which is the root object as well as the current top of the object stack.  The second rule also sets the 'simple' boolean property to true.  

Finally the LdapBindRequestRule finishes at which point the completed BindRequest bean can be popped off of the object stack and handed off to a higher facility.


    ---------------------------------------------------------------------
For a full history of the issue, see:

  http://issues.apache.org/jira/browse/DIR-89?page=history

---------------------------------------------------------------------
View the issue:
  http://issues.apache.org/jira/browse/DIR-89

Here is an overview of the issue:
---------------------------------------------------------------------
        Key: DIR-89
    Summary: Work on BindRequest construction with BERDigester
       Type: Task

     Status: In Progress
   Priority: Major

    Project: Directory
 Components: 
             Eve
             ldap
             Snickers

   Assignee: Alex Karasulu
   Reporter: Alex Karasulu

    Created: Sun, 4 Apr 2004 10:13 PM
    Updated: Sun, 11 Apr 2004 12:16 AM

Description:
BindRequest for Simple Binding
==============================

* The LOW level BER operation should not have to create objects for simple types that need to be used with a stack.  These types can be pushed and poped off of primitive stacks which we have added to the digester.

* We must recognize that there will be different kinds of rules. Some will be non protocol specific or rather BER specific which will perhaps be used to transform primitive types.  Other rules will be protocol specific and then there will be PDU specific rules.

Now for our specific problem of building a BindRequest lets keep the scope constrained to simple binds without any controls.  Below we have the tag nesting patterns of such a bind request:


 |  0x30 <-------- SEQUENCE
 |      0x02 <-------- INTEGER (messageId)
 |      0x40 <-------- BindRequest (APPLICATION 0)
 |          0x02 <-------- INTEGER (version)
 |          0x04 <-------- OCTET STRING (name)
 |          0x80 <-------- OCTET STRING (CONTEXT-SPECIFIC 0) (simple)
 |      0x80 <------------ Control (CONTEXT-SPECIFIC 0) (OPTIONAL)
 v
time

The BindRequest pattern would then be { 0x30, 0x40 } however before it comes the messageId which we need to create the BindRequest bean.  

A protocol non specific rule can be devised to accumulate and decode the message id integer by matching for { 0x30, 0x02 }.  It could be called PrimitiveIntDecodeRule.  Lets say that it accumulates, decodes and pushes a primitive int onto the primitive int stack for use later as a parameter.  To summerize this step:

addRule( { 0x30, 0x02 }, PrimitiveIntDecodeRule ) ;

A PDU specific rule, LdapBindRequestRule would then match the tag pattern, { 0x30, 0x40 }, pop the primitive int stack, instantiate a BindRequest bean and push it onto the object stack.

addRule( { 0x30, 0x40 }, LdapBindRequestRule ) ;

Next we encounter the sequence of members we need for this PDU.  For the version INTEGER we register two rules in the following order.

addRule( { 0x30, 0x40, 0x02 }, PrimitiveIntDecodeRule ) ;
addRule( { 0x30, 0x40, 0x02 }, LdapBindSetVersion ) ;

Continuing on we set the distinguished name of the user that is binding.  This also is best handled in a two step process.  The first rule simply accumulates a byte array and pushes it onto the object stack.  The next rule pops the byte array off of the object stack, generates a UNICODE string, and parses it to generate a LdapName object which it then uses to set the name property of the bind request.  The rules to handle this stage are as follows:

addRule( { 0x30, 0x40, 0x04 }, OctetStringRule ) ;
addRule( { 0x30, 0x40, 0x04 }, LdapBindSetName ) ;

Now for the last step we're reading an OCTET STRING that is tagged as a context specific [0] tag for the simple credentials.  Again we use a dual rule combination:

addRule( { 0x30, 0x40, 0x80 }, OctetStringRule ) ;
addRule( { 0x30, 0x40, 0x80 }, LdapBindSetSimpleCredentials ) ;

Here the first rule simply collects the credential data into a byte array and pushes it onto the object stack.  The second rule pops the byte[] off of the object stack and sets the BindRequest bean's credentials which is the root object as well as the current top of the object stack.  The second rule also sets the 'simple' boolean property to true.  

Finally the LdapBindRequestRule finishes at which point the completed BindRequest bean can be popped off of the object stack and handed off to a higher facility.




---------------------------------------------------------------------
JIRA INFORMATION:
This message is automatically generated by JIRA.

If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa

If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira