Windows Dev Center

IX500DistinguishedName interface

The IX500DistinguishedName interface represents an X.500 distinguished name (DN). The X.500 series of networking standards covers electronic directory services. A distinguished name uniquely identifies (distinguishes) each entry in the directory from all other entries. Each DN consists of one or more relative distinguished names (RDNs).

The subject field of a PKCS #10 certificate request contains the DN of the entity requesting the certificate


CertificationRequestInfo ::= SEQUENCE 
{
   version                 CertificationRequestInfoVersion,
   subject                 Name,
   subjectPublicKeyInfo    SubjectPublicKeyInfo,
   attributes              [0] IMPLICIT Attributes
}

The DN consists of a sequence of RDNs. Each RDN consists of a set of attributes, and each attribute consists of an object identifier (OID) and a value. The data type of the value is identified by the DirectoryString structure.


Name ::= SEQUENCE OF RelativeDistinguishedName

RelativeDistinguishedName ::= SET OF AttributeTypeValue

AttributeTypeValue ::= SEQUENCE 
{
   type       EncodedObjectID,
   value      ANY 
}

DirectoryString ::= CHOICE 
{
   teletexString           TeletexString (SIZE (1..MAX)),
   printableString         PrintableString (SIZE (1..MAX)),
   universalString         UniversalString (SIZE (1..MAX)),
   utf8String              UTF8String (SIZE (1..MAX)),
   bmpString               BMPString (SIZE (1..MAX)) 
}

The following RDN keys and associated OIDs are currently supported.

KeyOIDDescriptionRDN type
CXCN_OID_COUNTRY_NAMEContains a two-letter ISO 3166 country or region code.PrintableString
CNXCN_OID_COMMON_NAMEContains a common name.PrintableString
E

EMAIL

XCN_OID_RSA_emailAddrContains an email address.IA5String
DCXCN_OID_DOMAIN_COMPONENTContains one component of a Domain Name System (DNS) name.IA5String
G

GivenName

XCN_OID_GIVEN_NAMEContains the part of a person's name that is not a surname.PrintableString
IXCN_OID_INITIALSContains a person's initials.PrintableString
LXCN_OID_LOCALITY_NAMEContains the locality name that identifies a city, country, or other geographic region.PrintableString
OXCN_OID_ORGANIZATION_NAMEContains the name of an organization.PrintableString
OUXCN_OID_ORGANIZATIONAL_UNIT_NAMEContains the name of a unit subdivision within an organization.PrintableString
S

ST

XCN_OID_STATE_OR_PROVINCE_NAMEContains the full name of a state or province.PrintableString
STREETXCN_OID_STREET_ADDRESSContains the physical address.PrintableString
SNXCN_OID_SUR_NAMEContains the family name of a person.PrintableString
T

TITLE

XCN_OID_TITLEContains the title of a person in the organization.PrintableString

 

Each service that is based on X.500 defines its own distinguished name string representation. For example, LDAP uses a comma-delimited list arranged from right to left. Active Directory uses a forward slash (/) and arranges the list from left to right. Other services use semicolons as separators. The following example shows an Active Directory entry for an employee named John Peoples who works in the pharmaceutical division of a company named Contoso, Ltd.


/c=gb/o=Contoso Ltd./ou=Contoso Pharmaceuticals/cn=John Peoples

Members

The IX500DistinguishedName interface inherits from the IDispatch interface. IX500DistinguishedName also has these types of members:

Methods

The IX500DistinguishedName interface has these methods.

MethodDescription
Decode

Initializes the object from a Unicode-encoded distinguished name.

Encode

Initializes the object from a string that contains a distinguished name.

[WebEnabled]

 

Properties

The IX500DistinguishedName interface has these properties.

PropertyDescription

EncodedName

Retrieves a Unicode-encoded distinguished name.

Name

Retrieves a distinguished name.

 

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

CertEnroll.h

DLL

CertEnroll.dll

See also

IDispatch
CertEnroll Interfaces
Subject Names

 

 

Community Additions

ADD
Show:
© 2015 Microsoft