Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

X500NameFlags enumeration

The X500NameFlags enumeration type specifies the display and encoding characteristics of a distinguished name or relative distinguished name (RDN). This enumeration is used to initialize an IX500DistinguishedName object.

Syntax


typedef enum X500NameFlags { 
  XCN_CERT_NAME_STR_NONE                       = 0,
  XCN_CERT_SIMPLE_NAME_STR                     = 1,
  XCN_CERT_OID_NAME_STR                        = 2,
  XCN_CERT_X500_NAME_STR                       = 3,
  XCN_CERT_XML_NAME_STR                        = 4,
  XCN_CERT_NAME_STR_SEMICOLON_FLAG             = 0x40000000,
  XCN_CERT_NAME_STR_NO_PLUS_FLAG               = 0x20000000,
  XCN_CERT_NAME_STR_NO_QUOTING_FLAG            = 0x10000000,
  XCN_CERT_NAME_STR_CRLF_FLAG                  = 0x8000000,
  XCN_CERT_NAME_STR_COMMA_FLAG                 = 0x4000000,
  XCN_CERT_NAME_STR_REVERSE_FLAG               = 0x2000000,
  XCN_CERT_NAME_STR_FORWARD_FLAG               = 0x1000000,
  XCN_CERT_NAME_STR_DISABLE_IE4_UTF8_FLAG      = 0x10000,
  XCN_CERT_NAME_STR_ENABLE_T61_UNICODE_FLAG    = 0x20000,
  XCN_CERT_NAME_STR_ENABLE_UTF8_UNICODE_FLAG   = 0x40000,
  XCN_CERT_NAME_STR_FORCE_UTF8_DIR_STR_FLAG    = 0x80000,
  XCN_CERT_NAME_STR_DISABLE_UTF8_DIR_STR_FLAG  = 0x100000
} X500NameFlags;

Constants

XCN_CERT_NAME_STR_NONE

Display characteristics are not identified.

XCN_CERT_SIMPLE_NAME_STR

All object identifiers (OIDs) are discarded. Relative distinguished names (RDNs) are separated by commas followed by a space (, ). RDN attributes are separated by a plus sign enclosed within spaces ( + ).

XCN_CERT_OID_NAME_STR

OIDs are separated from their associated attribute value by using an equal sign (=). RDNs are separated by a comma followed by a space (, ). RDN attributes are separated by a plus sign followed by a space (+ ).

XCN_CERT_X500_NAME_STR

OIDs are converted to their X.500 key names. They are separated from their associated attribute value by using an equal sign (=). RDNs are separated by a comma followed by a space (, ). RDN attributes are separated by a plus sign followed by a space (+ ).

If an OID does not have a corresponding X.500 name, the OID is used with a prefix of OID. The RDN is enclosed within quotation marks (" ") if it contains leading or trailing white space or one of the following characters:

  • Comma (,)
  • Plus sign (+)
  • Equal sign (=)
  • Inch mark (")
  • Line feed (\n)
  • Less than sign (<)
  • Greater than sign (>)
  • Number sign (#)
  • Semicolon (;)
  • Embedded quotation mark (")
XCN_CERT_XML_NAME_STR

OIDs are treated in the same manner as that used to convert XCN_CERT_X500_NAME_ST values except that they are formatted as a sequence of XML elements. This is shown in the following example.


<CN>cart.contoso.com</CN>
<OU>Terms of use at www.verisign.com/rpa (c)00</OU>
<OU rDNAttribute="true">IT Operations</OU>
<O>Contoso.com</O>
<L>New York</L>
<S>New York</S>
<C>US</C>
<RDN oid="1.2.3.4" type="string">name</RDN>
<RDN rDNAttribute="true" oid="1.2.1.3" type="encoded">0500</RDN>
<RDN oid="1.2.1.4" type="encoded">020135</RDN>
<RDN oid="1.2.2.5.3" type="octet">01FF7F</RDN>

The Unicode XML markup characters are escaped in the following manner. Characters greater than 0x7F are escaped by using character references (L"&#xXXXX;").

  • & becomes L"&amp;"
  • < becomes L"&lt;"
  • > becomes L"&gt;"
  • \' becomes L"&apos;"
  • \" becomes L"&quot;"
XCN_CERT_NAME_STR_SEMICOLON_FLAG

The comma (,) separator used between RDNs is replaced with a semicolon (;) character.

XCN_CERT_NAME_STR_NO_PLUS_FLAG

The (+) separator used between RDN attributes is replaced with a single space character.

XCN_CERT_NAME_STR_NO_QUOTING_FLAG

Inhibits the use of quotation marks for the XCN_CERT_X500_NAME_ST value.

XCN_CERT_NAME_STR_CRLF_FLAG

The comma (,) separator used between RDNs is replaced with a carriage return/line feed (\r\n) sequence.

XCN_CERT_NAME_STR_COMMA_FLAG

Specifies that the separator between RDNs is a comma (,).

XCN_CERT_NAME_STR_REVERSE_FLAG

Specifies that the order of the RDNs that make up the distinguished name (DN) is reversed for encoding. The typical DN display order is CN=name,...,DC=com. Use this flag to change the encoding order to DC=com,...,CN=name. An IX500DistinguishedName object sets this flag by default unless you specify XCN_CERT_NAME_STR_FORWARD_FLAG.

XCN_CERT_NAME_STR_FORWARD_FLAG

Use to undo the encoding order specified by setting the XCN_CERT_NAME_STR_REVERSE_FLAG value.

XCN_CERT_NAME_STR_DISABLE_IE4_UTF8_FLAG

Skips the initial attempt to decode T.61 Teletex character values to UTF-8 values. By default, T.61 values are initially decoded to UTF-8, but if UTF-8 decoding fails, the values are decoded as 8-bit characters.

XCN_CERT_NAME_STR_ENABLE_T61_UNICODE_FLAG

T.61 is used rather than Unicode character encoding for all characters less than 0xFF. LDAP, for example, uses T.61.

XCN_CERT_NAME_STR_ENABLE_UTF8_UNICODE_FLAG

UTF-8 is used for the DN instead of Unicode character encoding.

XCN_CERT_NAME_STR_FORCE_UTF8_DIR_STR_FLAG

Forces the following X.500 keys to be encoded as UTF-8 strings rather than printable Unicode strings.

KeyOID
CNXCN_OID_COMMON_NAME
G XCN_OID_GIVEN_NAME
GivenNameXCN_OID_GIVEN_NAME
GNXCN_OID_GIVEN_NAME
IXCN_OID_INITIALS
InitialsXCN_OID_INITIALS
LXCN_OID_LOCALITY_NAME
OXCN_ORGANIZATION_NAME
OU XCN_OID_ORGANIZATIONAL_UNIT_NAME
SXCN_OID_STATE_OR_PROVINCE_NAME
SNXCN_ID_SUR_NAME
STXCN_OID_STATE_OR_PROVINCE_NAME
STREETXCN_OID_STREET_ADDRESS
TXCN_OID_TITLE
TitleXCN_OID_TITLE

 

XCN_CERT_NAME_STR_DISABLE_UTF8_DIR_STR_FLAG

Prevents forcing printable Unicode strings to be encoded by using UTF-8. Use when desired when XCN_CERT_NAME_STR_FORCE_UTF8_DIR_STR_FLAG is the default behavior.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

CertEnroll.h

See also

CertEnroll Enumerations
CertEnroll Interfaces
IX500DistinguishedName

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.