RFC 1488
The X.500 String Representation of Standard Attribute Syntaxes
RFC 1488 ๐ The X.500 String Representation of Standard Attribute Syntaxes
Bestie, this one is a whole vibe ๐ Here's the title block tea โ
- Number: RFC 1488 โจ
- Authors: T. Howes (University of Michigan), S. Kille (ISODE Consortium), W. Yeong (Performance Systems International), and C. Robbins (NeXor Ltd.) ๐ง
- Date: July 1993 ๐
- Category: an IAB standards track protocol ๐ฅ
Status of this Memo ๐ธ
Okay so this RFC is an IAB standards track protocol for the Internet community, and it's asking for discussion and suggestions for improvements ๐ซถ For the standardization state and status of this protocol, check the current edition of the "IAB Official Protocol Standards" ๐ Distribution of this memo is unlimited ๐ฆ
Abstract ๐ฆ
The Lightweight Directory Access Protocol (LDAP) [9] is giving strict energy here: the contents of AttributeValue fields in protocol elements have to be octet strings ๐ This document lays out the requirements that encoding rules MUST be satisfied by when they're rendering Directory attribute syntaxes into a form suitable for use in LDAP โจ Then it goes on to define the encoding rules for the standard set of attribute syntaxes defined in [1,2] and [3] ๐
1. Attribute Syntax Encoding Requirements โจ
This section is where the general requirements live for lightweight directory protocol attribute syntax encodings ๐ All documents defining attribute syntax encodings for use by the lightweight directory protocols are expected to conform to these requirements ๐
The encoding rules defined for a given attribute syntax MUST produce octet strings ๐ญ Like, to the greatest extent possible, encoded octet strings SHOULD be usable in their native encoded form for display purposes ๐ Especially for attribute syntaxes defining non-binary values: their encoding rules SHOULD produce strings that can be displayed with little or no translation by clients implementing the lightweight directory protocols ๐ฅ
2. Standard Attribute Syntax Encodings ๐ง
Okay, so for defining the encoding rules for the standard attribute syntaxes, these auxiliary BNF definitions are going to be used ๐
<a> ::= 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' |
'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' |
's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' | 'A' |
'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' |
'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' |
'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z'
<d> ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
<hex-digit> ::= <d> | 'a' | 'b' | 'c' | 'd' | 'e' | 'f' |
'A' | 'B' | 'C' | 'D' | 'E' | 'F'
<k> ::= <a> | <d> | '-'
<p> ::= <a> | <d> | ''' | '(' | ')' | '+' | ',' | '-' | '.' |
'/' | ':' | '?' | ' '
<CRLF> ::= The ASCII newline character with hexadecimal value 0x0A
<letterstring> ::= <a> | <a> <letterstring>
<numericstring> ::= <d> | <d> <numericstring>
<keystring> ::= <a> | <a> <anhstring>
<anhstring> ::= <k> | <k> <anhstring>
<printablestring> ::= <p> | <p> <printablestring>
<space> ::= ' ' | ' ' <space>
2.1. Undefined ๐ซง
Values of type Undefined are encoded as if they were values of type Octet String ๐ธ
2.2. Case Ignore String ๐
A string of type caseIgnoreStringSyntax is encoded as the string value itself ๐
2.3. Case Exact String ๐
The encoding of a string of type caseExactStringSyntax is the string value itself โจ
2.4. Printable String ๐ฆ
The encoding of a string of type printableStringSyntax is the string value itself ๐
2.5. Numeric String ๐ฅ
The encoding of a string of type numericStringSyntax is the string value itself ๐
2.6. Octet String ๐ง
The encoding of a string of type octetStringSyntax is the string value itself ๐
2.7. Case Ignore IA5 String ๐ธ
The encoding of a string of type caseIgnoreIA5String is the string value itself ๐ซถ
2.8. IA5 String ๐
The encoding of a string of type iA5StringSyntax is the string value itself โจ
2.9. T61 String ๐
The encoding of a string of type t61StringSyntax is the string value itself ๐
2.10. Case Ignore List ๐
Values of type caseIgnoreListSyntax are encoded according to the following BNF, and it's giving very structured ๐
<caseignorelist> ::= <caseignorestring> |
<caseignorestring> '$' <caseignorelist>
<caseignorestring> ::= a string encoded according to the rules
for Case Ignore String as above.
2.11. Case Exact List ๐ฆ
Values of type caseExactListSyntax are encoded according to the following BNF ๐ซถ
<caseexactlist> ::= <caseexactstring> |
<caseexactstring> '$' <caseexactlist>
<caseexactstring> ::= a string encoded according to the rules for
Case Exact String as above.
2.12. Distinguished Name ๐
Values of type distinguishedNameSyntax are encoded to have the representation defined in [5] ๐ง
2.13. Boolean ๐ธ
Values of type booleanSyntax are encoded according to the following BNF, and it's a simple one ๐
<boolean> ::= "TRUE" | "FALSE"
Boolean values have an encoding of "TRUE" if they are logically true, and have an encoding of "FALSE" otherwise ๐
2.14. Integer ๐ข
Values of type integerSyntax are encoded as the decimal representation of their values, with each decimal digit represented by the its character equivalent ๐ So the digit 1 is represented by the character
2.15. Object Identifier ๐
Values of type objectIdentifierSyntax are encoded according to the following BNF, and this part is so iconic ๐ฅ
<oid> ::= <descr> | <descr> '.' <numericoid> | <numericoid>
<descr> ::= <keystring>
<numericoid> ::= <numericstring> | <numericstring> '.' <numericoid>
In the above BNF, <descr> is the syntactic representation of an object descriptor ๐ง When encoding values of type objectIdentifierSyntax, the first encoding option SHOULD be used in preference to the second, which SHOULD be used in preference to the third wherever possible ๐
That is, in encoding object identifiers, object descriptors (where assigned and known by the implementation) SHOULD be used in preference to numeric oids to the greatest extent possible ๐ซถ For example, in encoding the object identifier representing an organizationName, the descriptor "organizationName" is preferable to "ds.4.10", which is in turn preferable to the string "2.5.4.10" ๐
2.16. Telephone Number ๐
Values of type telephoneNumberSyntax are encoded as if they were Printable String types ๐
2.17. Telex Number ๐
Values of type telexNumberSyntax are encoded according to the following BNF, and it's a whole multi-part situation ๐
<telex-number> ::= <actual-number> '$' <country> '$' <answerback>
<actual-number> ::= <printablestring>
<country> ::= <printablestring>
<answerback> ::= <printablestring>
In the above, <actual-number> is the syntactic representation of the number portion of the TELEX number being encoded, <country> is the TELEX country code, and <answerback> is the answerback code of a TELEX terminal ๐ง
2.18. Teletex Terminal Identifier ๐ฅ๏ธ
Values of type teletexTerminalIdentifier are encoded according to the following BNF ๐
<teletex-id> ::= <printablestring> 0*( '$' <printablestring>)
In the above, the first <printablestring> is the encoding of the first portion of the teletex terminal identifier to be encoded, and the subsequent 0 or more <printablestrings> are subsequent portions of the teletex terminal identifier โจ
2.19. Facsimile Telephone Number ๐
Values of type FacsimileTelephoneNumber are encoded according to the following BNF, and the parameters are lowkey the best part ๐ฆ
<fax-number> ::= <printablestring> [ '$' <faxparameters> ]
<faxparameters> ::= <faxparm> | <faxparm> '$' <faxparameters>
<faxparm> ::= 'twoDimensional' | 'fineResolution' | 'unlimitedLength' |
'b4Length' | 'a3Width' | 'b4Width' | 'uncompressed'
In the above, the first <printablestring> is the actual fax number, and the <faxparm> tokens represent fax parameters ๐
2.20. Presentation Address ๐ธ
Values of type PresentationAddress are encoded to have the representation described in [6] ๐
2.21. UTC Time โฐ
Values of type uTCTimeSyntax are encoded as if they were Printable Strings with the strings containing a UTCTime value ๐
2.22. Guide (search guide) ๐
Values of type Guide, such as values of the searchGuide attribute, are encoded according to the following BNF, and it's giving logic puzzle ๐งฉ
<guide-value> ::= [ <object-class> '#' ] <criteria>
<object-class> ::= an encoded value of type objectIdentifierSyntax
<criteria> ::= <criteria-item> | <criteria-set> | '!' <criteria>
<criteria-set> ::= [ '(' ] <criteria> '&' <criteria-set> [ ')' ] |
[ '(' ] <criteria> '|' <criteria-set> [ ')' ]
<criteria-item> ::= [ '(' ] <attributetype> '$' <match-type> [ ')' ]
<match-type> ::= "EQ" | "SUBSTR" | "GE" | "LE" | "APPROX"
2.23. Postal Address ๐ฎ
Values of type PostalAddress are encoded according to the following BNF ๐
<postal-address> ::= <t61string> | <t61string> '$' <postal-address>
In the above, each <t61string> component of a postal address value is encoded as a value of type t61StringSyntax ๐ง
2.24. User Password ๐
Values of type userPasswordSyntax are encoded as if they were of type octetStringSyntax ๐ซถ
2.25. User Certificate ๐
Values of type userCertificate are encoded according to the following BNF, and there are a lot of hash marks here ๐
<certificate> ::= <signature> '#' <issuer> '#' <validity> '#' <subject>
'#' <public-key-info>
<signature> ::= <algorithm-id>
<issuer> ::= an encoded Distinguished Name
<validity> ::= <not-before-time> '#' <not-after-time>
<not-before-time> ::= <utc-time>
<not-after-time> ::= <utc-time>
<algorithm-parameters> ::= <null> | <integervalue> |
'{ASN}' <hex-string>
<subject> ::= an encoded Distinguished Name
<public-key-info> ::= <algorithm-id> '#' <encrypted-value>
<encrypted-value> ::= <hex-string> | <hex-string> '-' <d>
<algorithm-id> ::= <oid> '#' <algorithm-parameters>
<utc-time> ::= an encoded UTCTime value
<hex-string> ::= <hex-digit> | <hex-digit> <hex-string>
2.26. CA Certificate ๐๏ธ
Values of type cACertificate are encoded as if the values were of type userCertificate ๐
2.27. Authority Revocation List ๐ซ
Values of type authorityRevocationList are encoded according to the following BNF, and yes there are two <revoked-certificates> lines, it's not a typo ๐
<certificate-list> ::= <signature> '#' <issuer> '#'
<utc-time> [ '#' <revoked-certificates> ]
<revoked-certificates> ::= <algorithm> '#' <encrypted-value>
[ '#' 0*(<revoked-certificate>) '#']
<revoked-certificates> ::= <subject> '#' <algorithm> '#'
<serial> '#' <utc-time>
The syntactic components <algorithm>, <issuer>, <encrypted-value>, <utc-time>, <subject> and <serial> have the same definitions as in the BNF for the userCertificate attribute syntax ๐ง
2.28. Certificate Revocation List ๐
Values of type certificateRevocationList are encoded as if the values were of type authorityRevocationList ๐ธ
2.29. Cross Certificate Pair ๐
Values of type crossCertificatePair are encoded according to the following BNF, and the pipe is doing a lot of work here ๐ซถ
<certificate-pair> ::= <certificate> '|' <certificate>
The syntactic component <certificate> has the same definition as in the BNF for the userCertificate attribute syntax ๐
2.30. Delivery Method ๐ฌ
Okay so values of type deliveryMethod get encoded using this BNF, and it's giving pure grammar energy ๐
<delivery-value> ::= <pdm> | <pdm> '$' <delivery-value>
<pdm> ::= 'any' | 'mhs' | 'physical' | 'telex' | 'teletex' |
'g3fax' | 'g4fax' | 'ia5' | 'videotex' | 'telephone'
2.31. Other Mailbox ๐ซ
Values of the type otherMailboxSyntax get encoded using this BNF ๐
<otherMailbox> ::= <mailbox-type> '$' <mailbox>
<mailbox-type> ::= an encoded Printable String
<mailbox> ::= an encoded IA5 String
So the <mailbox-type> is the kind of mail system where the mailbox lives, like "Internet" or "MCIMail" ๐ธ And the <mailbox> is the actual mailbox inside that mail system, the one defined by <mailbox-type>. Iconic pairing, honestly ๐ฆ
2.32. Mail Preference ๐
Values of type mailPreferenceOption are encoded using this BNF โจ
<mail-preference> ::= "NO-LISTS" | "ANY-LIST" | "PROFESSIONAL-LISTS"
2.33. MHS OR Address ๐ฎ
Values of type MHS OR Address are encoded as strings, following the format defined in [10]. No notes, just vibes ๐ซถ
2.34. Photo ๐ธ
Values of type Photo are encoded as if they were octet strings holding JPEG images in the JPEG File Interchange Format (JFIF), as described in [8]. Main character photo energy ๐
2.35. Fax ๐
Values of type Fax are encoded as if they were octet strings holding Group 3 Fax images, as defined in [7]. Old-school but iconic ๐ง
3. Acknowledgements ๐ซถ
Lowkey, a lot of the attribute syntax encodings in this document are adapted from the ones used in the QUIPU X.500 implementation. The authors of the QUIPU implementation get all the love for their work on the QUIPU syntaxes [4] ๐
4. Bibliography ๐
- [1] The Directory: Selected Attribute Syntaxes. CCITT, Recommendation X.520.
- [2] Information Processing Systems -- Open Systems Interconnection -- The Directory: Selected Attribute Syntaxes.
- [3] Barker, P., and S. Kille, "The COSINE and Internet X.500 Schema", RFC 1274, University College London, November 1991.
- [4] The ISO Development Environment: User's Manual -- Volume 5: QUIPU. Colin Robbins, Stephen E. Kille.
- [5] Kille, S., "A String Representation of Distinguished Names", RFC 1485, July 1993.
- [6] Kille, S., "A String Representation for Presentation Addresses", RFC 1278, University College London, November 1991.
- [7] Terminal Equipment and Protocols for Telematic Services - Standardization of Group 3 facsimile apparatus for document transmission. CCITT, Recommendation T.4.
- [8] JPEG File Interchange Format (Version 1.02). Eric Hamilton, C-Cube Microsystems, Milpitas, CA, September 1, 1992.
- [9] Yeong, W., Howes, T., and S. Kille, "Lightweight Directory Access Protocol", RFC 1487, Performance Systems International, University of Michigan, ISODE Consortium, July 1993.
- [10] Kille, S., "Mapping between X.400(1988)/ISO 10021 and RFC 822", RFC 1327, University College London, May 1992.
5. Security Considerations ๐ฑ
Okay, prepare yourself ๐ Security issues are not discussed in this memo. The whole doc is silent on security, so don't go looking for it in here ๐
6. Authors' Addresses ๐ฆ
Tim Howes
Tim Howes
University of Michigan
ITD Research Systems
535 W William St.
Ann Arbor, MI 48103-4943
USA
Phone: +1 313 747-4454
EMail: tim@umich.edu
Steve Kille
Steve Kille
ISODE Consortium
PO Box 505
London
SW11 1DX
UK
Phone: +44-71-223-4062
EMail: S.Kille@isode.com
Wengyik Yeong
Wengyik Yeong
PSI, Inc.
510 Huntmar Park Drive
Herndon, VA 22070
USA
Phone: +1 703-450-8001
EMail: yeongw@psilink.com
Colin Robbins
Colin Robbins
NeXor Ltd
University Park
Nottingham
NG7 2RD
UK
๐ฆ where this page comes from
- ietf: rfc1488 1993-07
- ๐ girlified by claude-haiku-5-5 on : a language model's rewrite of the original, under its terms