Lightweight Directory Access Protocol (LDAP): Additional Syntaxes

Syntaxes The following additional syntaxes and their associated descriptions and OBJECT IDENTIFIER are defined.

ASN.1 Syntax Definitions The following additional syntaxes are defined and are based on .

Date The Date type represents a date in the Gregorian calender. It is defined as a useful TIME type in and conforms to the extended format syntax of a calendar date as defined in . A Date value SHALL be written using the following syntax: YYYY-MM-DD where YYYY represents a year between 1582 and 9999, MM the month value from 01 to 12 and DD a day in the month from 01 to 31. Examples

9999-02-25
1583-01-31

The LDAP definition for the Date syntax is:

( 1.3.6.1.4.1.61799.5.40.31 DESC 'Date' )

This syntax corresponds to the DATE ASN.1 type from .

Date-Time The Date-time type represents a date and local time using a 24 hour clock. It is defined as a useful TIME type in and conforms to the extended format syntax of a date and time without any timezone specifier as defined in . A Date-Time value SHALL be written using the following syntax: YYYY-MM-DDThh:mm:ss where YYYY represents a year between 1582 and 9999, MM the month value from 01 to 12, DD a day in the month from 01 to 31, hh the hour from 00 to 24, mm the minute from 00 to 59, and ss the seconds with allowed values of 00 to 60 where 60 represents a leap second Examples

1583-01-01T00:59:59
1975-01-19T23:45:34

The LDAP definition for the Date-Time syntax is:

( 1.3.6.1.4.1.61799.5.40.33 DESC 'Date-Time' )

This syntax corresponds to the DATE-TIME ASN.1 type from .

Duration The Duration type represents an elapsed time with a resolution of up to a fractions of seconds. It is defined as a useful TIME type in and conforms to the extended format syntax of a time interval by duration as defined in . A duration syntax value SHALL conform to the following regular expression P([0-9]+Y)?([0-9]+M)?([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)? Examples

P29M0D -- 29 months
P29MT0S -- 29 months
PT3445.5S -- 3445.55 seconds

The LDAP definition for the Duration syntax is:

( 1.3.6.1.4.1.61799.5.40.34 DESC 'Duration' )

This syntax corresponds to a very strict subset of DURATION ASN.1 type from , in that the order of parameters need to be respected.

Real The Real type represents the computational approximations to the mathematical "real number". The format for the Real is as defined in Section 21 of . A Real syntax value SHALL conform to the following regular expression ([-]?[0-9]+\.?[0-9]+([E][-]?[0-9]+)?)|PLUS-INFINITY|MINUS-INFINITY|NOT-A-NUMBER Examples

3.14159
MINUS-INFINITY
-5.3E4 -- Equal to -53000

The LDAP definition for the Real syntax is:

( 1.3.6.1.4.1.61799.5.40.9 DESC 'Real' )

This syntax corresponds to a subset of the REAL ASN.1 type from where the sequence syntax is not allowed, the values are limited to base ten, where a digit before the decimal point is required, where only the character 'E' is allowed to specify the exponent and that the preceding optional "+" sign is prohibited in the exponent.

Time Of Day The Time Of Day type represents a local time using a 24 hour clock. It is defined as a useful TIME type in and conforms to the extended format syntax of a local time as defined in . A Time Of Day value SHALL be written using the following syntax: hh:mm:ss where hh represents the hour from 00 to 24, mm represents the minute from 00 to 59, and ss represents the seconds with allowed values of 00 to 60 where 60 represents a leap second. Examples for Time Of Day:

00:59:59
01:45:54

The LDAP definition for the Time Of Day syntax is:

( 1.3.6.1.4.1.61799.5.40.32 DESC 'Time Of Day' )

This syntax corresponds to the TIME-OF-DAY ASN.1 type from .

Visible String The Visible string type represents a character repertoire that the contains printable ASCII character set (in the range 0020-007E hexadecimal). It is defined in . This syntax value SHALL conform to the following regular expression [0-9A-Za-z !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~] Examples

hello world
(x+y)=z

The LDAP definition for the Visible String syntax is:

( 1.3.6.1.4.1.61799.5.40.26 DESC 'Visible String' )

This syntax corresponds to the VisibleString ASN.1 type from .

Constrained ASN.1 Syntax Definitions The following additional syntaxes are defined as constraints of basic ASN.1 types that may be used to be more precise in encoding and input validation.

Short String The Short String type represents a string that is limited to 31 characters when encoded. The length was chosen so that when using DER encoding, using the worst-case scenario of 4 octets per character in UTF-8, the string can be encoded using one length octet. It is also sufficient for labels and short titles. Examples

Hello world
Short

The LDAP definition for the Short String type syntax is:

( 1.3.6.1.4.1.61799.5.40.12.1 DESC 'Short String' )

This syntax corresponds to the following ASN.1 type from : Shortstring ::= DirectoryString{31}

Long String The Long String type represents a string that is limited to 250 characters when encoded. The length was chosen so that when using CER encoding, using the worst-case scenario of 4 octets per character, the string can still be encoded using a primitive construct. This length seems sufficient for descriptive text. Examples

This is a bigger sentence
Ceci est une phrase qui est plus longue que la précèdente

The LDAP definition for the Long String type syntax is:

( 1.3.6.1.4.1.61799.5.40.12.2 DESC 'Long String' )

This syntax corresponds to the following ASN.1 type from : Longstring ::= DirectoryString{250}

Text The text type represents a string that is limited to 16383 characters when encoded. . The length was mainly defined based on historical system constraints of 65535 octets using the worst case scenario of 4 octets per character. Examples

Hello world
Ceci est une phrase qui est encore plus longue que la précèdente

The LDAP definition for the Text type syntax is:

( 1.3.6.1.4.1.61799.5.40.12.3 DESC 'Text' )

This syntax corresponds to the following ASN.1 type from : Text ::= DirectoryString{16383}

Float32 The Float32 type represents a real number which fits in the range of a single precision floating point value. The Float32 syntax follows the syntax of the real type (See ) with a constrained range. Examples

3.14159
MINUS-INFINITY
-5.3E4 -- Equal to -53000

The LDAP definition for the Float32 type syntax is:

( 1.3.6.1.4.1.61799.5.40.9.4 DESC 'Float32' )

This syntax corresponds to the following ASN.1 type from : Float32 ::= REAL (WITH COMPONENTS { mantissa (-16777215..16777215), base (2), exponent (-149..104) })

Float64 The Float64 type represents a real number which fits in the range of a double precision floating point value. The Float64 syntax follows the syntax of the real type (See ) with a constrained range. Examples

3.1415926535897932
NOT-A-NUMBER
-5.3E4 -- Equal to -53000

The LDAP definition for the Float64 type syntax is:

( 1.3.6.1.4.1.61799.5.40.9.8 DESC 'Float64' )

This syntax corresponds to the following ASN.1 type from : Float64 ::= REAL (WITH COMPONENTS { mantissa (-9007199254740991..9007199254740991), base (2), exponent (-1074..971) })

UInt8 The UInt8 type represents an unsigned integer value within the range 0 to 255 inclusive. Examples

The LDAP definition for the UInt8 type syntax is:

( 1.3.6.1.4.1.61799.5.40.2.21 DESC 'UInt8' )

This syntax corresponds to the following ASN.1 type from : UInt8 ::= INTEGER(0..255)

UInt16 The UInt16 type represents an unsigned integer value within the range 0 to 65535 inclusive. Examples

0
64991

The LDAP definition for the UInt16 type syntax is:

( 1.3.6.1.4.1.61799.5.40.2.22 DESC 'UInt16' )

This syntax syntax corresponds to the following ASN.1 type from : UInt16 ::= INTEGER(0..65535)

UInt32 The UInt32 type represents an unsigned integer value within the range 0 to 4294967295 inclusive. Examples

0
40000000

The LDAP definition for the UInt32 type syntax is:

( 1.3.6.1.4.1.61799.5.40.2.24 DESC 'UInt32' )

This syntax corresponds to the following ASN.1 type from : UInt32 ::= INTEGER(0..4294967295)

UInt64 The UInt64 type represents an unsigned integer value within the range 0 to 18446744073709551615 inclusive. Examples

0
844674407370955

The LDAP definition for the UInt64 type syntax is:

( 1.3.6.1.4.1.61799.5.40.2.28 DESC 'UInt64' )

This syntax corresponds to the following ASN.1 type from : UInt64 ::= INTEGER(0..18446744073709551615)

Int8 The Int8 type represents a signed integer value within the range -128 to 127 inclusive. Examples

0
-123

The LDAP definition for the Int8 type syntax is:

( 1.3.6.1.4.1.61799.5.40.2.1 DESC 'Int8' )

This syntax corresponds to the following ASN.1 type from : Int8 ::= INTEGER(-128..127)

Int16 The Int16 type represents a signed integer value within the range -32768 to 32767 inclusive. Examples

15667
-32000

The LDAP definition for the Int16 type syntax is:

( 1.3.6.1.4.1.61799.5.40.2.2 DESC 'Int16' )

This syntax corresponds to the following ASN.1 type from : Int16 ::= INTEGER(-32768 .. 32767)

Int32 The Int32 type represents a signed integer value within the range -2147483648 to 2147483647 inclusive. Examples

15667
-3200000

The LDAP definition for the Int32 type syntax is:

( 1.3.6.1.4.1.61799.5.40.2.4 DESC 'Int32' )

This syntax corresponds to the following ASN.1 type from : Int32 ::= INTEGER(-2147483648..2147483647)

Int64 The Int64 type represents a signed integer value within the range -9223372036854775808 to 9223372036854775807 inclusive. Examples

-2337203685477580
3372036854775807

The LDAP definition for the Int64 type syntax is:

( 1.3.6.1.4.1.61799.5.40.2.8 DESC 'Int64' )

This syntax corresponds to the following ASN.1 type from : Int64 ::= INTEGER(-9223372036854775808..9223372036854775807)

Percentage The Percentage type represents a percentage value, that is an unsigned integer in the range 0 to 100 inclusive. Examples

The LDAP definition for the Percentage type syntax is:

( 1.3.6.1.4.1.61799.5.40.2.20 DESC 'Percentage' )

This syntax corresponds to the following ASN.1 type from : Percentage ::= INTEGER(0..100)

Other Syntax Definitions The following additional syntaxes are defined and are based on IETF RFC's, or other international standards.

DCMIType DCMIType is a controlled vocabulary to describe the type of a resource. It is specified in Examples

Text
Moving Image

The LDAP definition for the DCMIType syntax is:

( 1.3.6.1.4.1.61799.5.40.19.2 DESC 'DCMIType' )

Language A language provides a representation of a spoken or written language as well as an optional locale specifier. The exact syntax allowed is defined in Section 2 of . A Language syntax value SHALL conform to the following regular expression [a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})* Examples

en
fr-CA

The LDAP definition for the Language syntax is:

( 1.3.6.1.4.1.61799.5.40.19.1 DESC 'Language' )

This syntax corresponds to the following ASN.1 type from : Language ::= VisibleString (PATTERN "[a-zA-Z]#(1,8)(-[a-zA-Z0-9]#(1,8))*") -- ISO 639 code minimally

Media type The Media Type syntax type should be used to identify values that represent a Media type. The format for the MIME Media type is defined in Section 5.1 of . This syntax value SHALL conform to the following regular expression [A-Za-z0-9]([A-Za-z0-9!#$&^_.+-]){0,126}/[A-Za-z0-9]([A-Za-z0-9!#$&^_.+-]){0,126} Examples

text/xhtml
application/alto-costmap+json

The LDAP definition for the MIME Media type syntax is:

( 1.3.6.1.4.1.61799.5.40.26.5 DESC 'Media Type' )

This syntax corresponds to the following ASN.1 type from : MediaType ::= VisibleString (SIZE(3..255)) -- IANA Registered Media type

OpenDate An OpenDate represents either part of a Date or a Date and Time in extended format as specified in ISO 8601. The exact syntax allowed is defined by W3C Date and Time formats with a 3 digit fraction. The time component, when present, always contains timezone information. Examples for OpenDate:

2034
1975-01
1975-01-19
1975-01-19T19:20+01:00
1975-01-19T19:20:30+01:00
1975-01-19T19:20:30.451+01:00
1975-01-19T18:20Z
1975-01-19T18:20:30Z
1975-01-19T18:20:30.451Z

The LDAP definition for the OpenDate syntax is:

( 1.3.6.1.4.1.61799.5.40.14.1 DESC 'OpenDate' )

This syntax corresponds to a subset of the TIME ASN.1 type from with the specified configuration: OpenDate ::= TIME((SETTINGS "Basic=Date Date=Y Year=Basic")| (SETTINGS "Basic=Date Date=YM Year=Basic")| (SETTINGS "Basic=Date Date=YMD Year=Basic")| (SETTINGS "Basic=Date-Time Date=YMD Year=Basic Time=HM Local-or-UTC=LD")| (SETTINGS "Basic=Date-Time Date=YMD Year=Basic Time=HMS Local-or-UTC=LD")| (SETTINGS "Basic=Date-Time Date=YMD Year=Basic Time=HMSF3 Local-or-UTC=LD")| (SETTINGS "Basic=Date-Time Date=YMD Year=Basic Time=HM Local-or-UTC=Z")| (SETTINGS "Basic=Date-Time Date=YMD Year=Basic Time=HMS Local-or-UTC=Z")| (SETTINGS "Basic=Date-Time Date=YMD Year=Basic Time=HMSF3 Local-or-UTC=Z"))

URI The URI syntax type should be used to identify values that are referenced by a Uniform Resource Identifier (URI). The format and encoding for the URI is as defined in . Even if relative URI's are allowed, it is recommended they not be used unless the context of use is known. Examples

http://www.example.com/my/picture.jpg
ldap://ldap.example.com/cn=babs%20jensen

The LDAP definition for the URI syntax is:

( 1.3.6.1.4.1.61799.5.40.26.4 DESC 'URI' )

This syntax corresponds to the following ASN.1 type from : URI ::= VisibleString (SIZE(1..ub-uri-length)) The value of ub-uri-length (an integer) is implementation defined but must be at least 2000 octets.

NCName The NCName syntax type should be used to identify values that represent identifiers and local attribute names. A name is a subset of the NCName definition in . This syntax value SHALL conform to the following regular expression [\p{L}\p{Nl}_][\p{L}\p{Nl}\p{Nd}.-_]* Examples

MyID
attribte.0.subdivision

The LDAP definition for the NCName type syntax is:

( 1.3.6.1.4.1.61799.5.40.26.6 DESC 'NCName' )

This syntax corresponds to the following ASN.1 type from : NCName ::= UnboundedDirectoryString

Normalized String The Normalized String syntax type represents white space normalized strings. A Normalized String is a string that does not contain any control characters including the carriage return (%xD), line feed (%xA) or tab (%x9) character. This is similar to the NormaliedString datatype in based on the Char type defined in . Examples

MyID
attribte.0.subdivision

The LDAP definition for the Normalized String type syntax is:

( 1.3.6.1.4.1.61799.5.40.12.4 DESC 'Normalized String' )

This syntax corresponds to the following ASN.1 type from : NormalizedString ::= CHOICE { printableString PrintableString, bmpString BMPString (FROM( {0, 0, 0, 32} .. {0, 0, 215, 255} | {0, 0, 224, 0} .. {0, 0, 255, 253})), universalString UniversalString (FROM( {0, 0, 0, 32} .. {0, 0, 215, 255} | {0, 0, 224, 0} .. {0, 0, 255, 253} | {0, 1, 0, 0} .. {0, 16, 255, 253})), uTF8String UTF8String (FROM( {0, 0, 0, 32} .. {0, 0, 215, 255} | {0, 0, 224, 0} .. {0, 0, 255, 253} | {0, 1, 0, 0} .. {0, 16, 255, 253})) }

QualifiedName The QualifiedName syntax type may be used to identify values that represent identifiers and attribute names using namespaces. This is a subset of the QName definition in . This syntax value SHALL conform to the following regular expression [\p{L}\p{Nl}_][\p{L}\p{Nl}\p{Nd}.-_]*(:)?[\p{L}\p{Nl}\p{Nd}.-_]+ Examples

MyID
attribte.0:subdivision

The LDAP definition for the QualifiedName type syntax is:

( 1.3.6.1.4.1.61799.5.40.26.6 DESC 'QualifiedName' )

This syntax corresponds to the following ASN.1 type from : QualifiedName ::= UnboundedDirectoryString

Time Of Day with Timezone The Time Of Day type with Timezone represents a time with explicit timezone information using a 24 hour clock. It is defined as a TIME type in and conforms to the extended format syntax of a time either represented as a Local time and the difference from UTC or UTC of day as defined in . A Time Of Day with Timezone value SHALL be written using the following syntax: hh:mm:ss where hh represents the hour from 00 to 24, mm represents the minute from 00 to 59, and ss represents the seconds with allowed values of 00 to 60 where 60 represents a leap second followed by a timezone indicator. The timezone indicator is in the form +hh:mm where hh represents the number of hours and mm the number of minutes if the local time is ahead of or equal to UTC time. The timezone indicator is -hh:mm if the local time is behind UTC time. If the time represents an UTC time, the time shall be followed without space, by the timezone UTC designator [Z]. This standard supports time differences in the range –15 hours to +15 hours to align with . Examples for Time Of Day with Timezone:

00:59:59Z
01:45:54-01:00

The LDAP definition for the Time Of Day with Timezone syntax is:

( 1.3.6.1.4.1.61799.5.40.35 DESC 'Time Of Day with Timzone' )

This syntax corresponds to a subset of the TIME ASN.1 type from with the specified configuration: Time-with-timezone ::= TIME((SETTINGS "Basic=Time Time=HMS Local-or-UTC=LD")| (SETTINGS "Basic=Time Time=HMS Local-or-UTC=Z"))

Token The Token syntax type represents white space normalized strings. A Normalized String is a string that does not contain any control characters including the carriage return (%xD), line feed (%xA) or tab (%x9) character, that have no leading or trailing spaces (%x20) and that have no internal sequences of two or more spaces This is similar to the Token datatype in based on the Char type defined in . Examples

MyID
attribte.0.subdivision

The LDAP definition for the Normalized String type syntax is:

( 1.3.6.1.4.1.61799.5.40.12.5 DESC 'Token' )

This syntax corresponds to the following ASN.1 type from : Token ::= CHOICE { printableString PrintableString(PATTERN "[^ ]+( [^ ]+)*"), bmpString BMPString (FROM( {0, 0, 0, 32} .. {0, 0, 215, 255} | {0, 0, 224, 0} .. {0, 0, 255, 253})) (PATTERN "[^ ]+( [^ ]+)*"), universalString UniversalString (FROM( {0, 0, 0, 32} .. {0, 0, 215, 255} | {0, 0, 224, 0} .. {0, 0, 255, 253} | {0, 1, 0, 0} .. {0, 16, 255, 253})) (PATTERN "[^ ]+( [^ ]+)*"), uTF8String UTF8String (FROM( {0, 0, 0, 32} .. {0, 0, 215, 255} | {0, 0, 224, 0} .. {0, 0, 255, 253} | {0, 1, 0, 0} .. {0, 16, 255, 253})) (PATTERN "[^ ]+( [^ ]+)*") }

Object Identifier	Syntax
1.3.6.1.4.1.61799.5.40.31	Date
1.3.6.1.4.1.61799.5.40.33	Date-Time
1.3.6.1.4.1.61799.5.40.19.2	DCMIType
1.3.6.1.4.1.61799.5.40.34	Duration
1.3.6.1.4.1.61799.5.40.9.4	Float32
1.3.6.1.4.1.61799.5.40.9.8	Float64
1.3.6.1.4.1.61799.5.40.2.1	Int8
1.3.6.1.4.1.61799.5.40.2.2	Int16
1.3.6.1.4.1.61799.5.40.2.4	Int32
1.3.6.1.4.1.61799.5.40.2.8	Int64
1.3.6.1.4.1.61799.5.40.19.1	Language
1.3.6.1.4.1.61799.5.40.26.6	NCName
1.3.6.1.4.1.61799.5.40.12.4	Normalized String
1.3.6.1.4.1.61799.5.40.12.1	Short String
1.3.6.1.4.1.61799.5.40.12.2	Long String
1.3.6.1.4.1.61799.5.40.26.5	Media Type
1.3.6.1.4.1.61799.5.40.14.1	OpenDate
1.3.6.1.4.1.61799.5.40.2.20	Percentage
1.3.6.1.4.1.61799.5.40.26.7	QualifiedName
1.3.6.1.4.1.61799.5.40.9	Real
1.3.6.1.4.1.61799.5.40.12.3	Text
1.3.6.1.4.1.61799.5.40.12.5	Token
1.3.6.1.4.1.61799.5.40.32	Time Of Day
1.3.6.1.4.1.61799.5.40.35	Time Of Day with Timezone
1.3.6.1.4.1.61799.5.40.2.21	UInt8
1.3.6.1.4.1.61799.5.40.2.22	UInt16
1.3.6.1.4.1.61799.5.40.2.24	UInt32
1.3.6.1.4.1.61799.5.40.2.28	UInt64
1.3.6.1.4.1.61799.5.40.26.4	URI
1.3.6.1.4.1.61799.5.40.26	Visible String