CX500DistinguishedName Class Reference

#include <x500dn.h>

Link against: x500.lib

class CX500DistinguishedName : public CBase

Inherits from

  • CX500DistinguishedName

Detailed Description

Holds the Distinguished Name of a subject.

A collection of 'attribute type and value' objects, as defined by the X.520 standard.

The name used in X.509 certificates is the X.500 Distinguished Name, which describes a path through an X.500 Directory Information Tree.

A Distinguished Name is a series of name-value pairs that uniquely identify an entity, i.e. the certificate subject.

Constructor & Destructor Documentation

~CX500DistinguishedName ( )

IMPORT_C~CX500DistinguishedName()

Destructor.

Frees all resources owned by the object, prior to its destruction.

Member Function Documentation

Count ( )

IMPORT_C TIntCount()const

Gets the number of 'attribute type and value' objects contained by this Distinguished Name object.

Return Value
The number of 'attribute type and value' objects.

DisplayNameL ( )

IMPORT_C HBufC *DisplayNameL()const

Gets the decoded value for the common or organisation name.

Return Value
A heap descriptor containing the decoded value of the common or organisation name.

Element ( TInt )

IMPORT_C const CX520AttributeTypeAndValue &Element(TIntaIndex)const

Gets a reference to specific 'attribute type and value' object as identified by the specified index.

Parameters
aIndexThe index number identifying the specific 'attribute type and value' object. This number is relative to zero. This value must be non-negative and less than the number of objects currently contained by this Distinguished Name object.
Return Value
The referenced 'attribute type and value' object.

EncodeASN1L ( )

IMPORT_C CASN1EncSequence *EncodeASN1L()const

Encodes a DN into an ASN.1 object tree.

See note in the description of EncodeASN1LC for the explanation of the resulting encoding tree format.

Return Value
ASN.1 sequence object containing the DN.

EncodeASN1LC ( )

IMPORT_C CASN1EncSequence *EncodeASN1LC()const

Encodes a DN into an ASN.1 object tree.

Note that the tree has the following format:
         SEQUENCE-OF
             SET-OF
                 SEQUENCE-OF
                     OID
                     value (usually OCTET STRING)
             ...

A SEQUENCE-OF object with a changed tag is used instead of a SET-OF object. This should be all right as long as it contains only one child, because otherwise child order in a SET-OF becomes important.

This function does not introduce an additional dependency on ASN1 library because X500 library already depends on it -- the attribute type/value class stores and manipulated ASN.1 encodings as its values.

Return Value
ASN.1 sequence object containing the DN, pushed on the cleanup stack.

ExactMatchL ( const CX500DistinguishedName & )

IMPORT_C TBoolExactMatchL(const CX500DistinguishedName &aName)const

Compares the specified Distinguished Name object with this Distinguished Name object.

See also: CX520AttributeTypeAndValue::ExactMatchL()

Parameters
aNameThe Distinguished Name object to be compared.
Return Value
ETrue, if the Distinguished Name objects contain exactly the same 'attribute type and value' objects; EFalse, otherwise.

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Externalises an object of this class to a write stream.

The presence of this function means that the standard templated operator<<() can be used to externalise objects of this class.

Parameters
aStreamStream to which the object should be externalised.

ExtractFieldL ( const TDesC & )

IMPORT_C HBufC *ExtractFieldL(const TDesC &aFieldName)const

Gets the decoded value associated with the specified field/attribute name, from the Distinguished Name.

Parameters
aFieldNameThe field name.
Return Value
A heap descriptor containing the decoded value associated with the specified field name.

IsWithinSubtreeL ( const CX500DistinguishedName & )

IMPORT_C TBoolIsWithinSubtreeL(const CX500DistinguishedName &aName)const

Tests whether all 'attribute type and value' objects contained in the specified Distinguished Name object are also contained within this Distinguished Name object.

This function checks if the elements of iElements are a superset of the fields in aName.

Parameters
aNameThe Distinguished Name object to be compared.
Return Value
ETrue, if all 'attribute type and value' objects contained in the specified Distinguished Name object are also contained within this Distinguished Name object; EFalse, otherwise.

MatchElementL ( const CX520AttributeTypeAndValue & )

IMPORT_C TBoolMatchElementL(const CX520AttributeTypeAndValue &aElement)const

Tests whether this Distinguished Name object contains the specified 'attribute type and value' object.

This function compares each of the elements in iElements with aElement. The comparison is made by the CX520AttributeTypeAndValue::ExactMatchL() function.

Parameters
aElementThe 'attribute type and value' object to be checked.
Return Value
ETrue, if the specified 'attribute type and value' object is contained in this Distinguished Name object; EFalse otherwise.

NewL ( const TDesC8 &, TInt & )

IMPORT_C CX500DistinguishedName *NewL(const TDesC8 &aBinaryData,
TInt &aPos
)[static]

Creates a new Distinguished Name object from the specified buffer containing the encoded binary representation, starting at the specified offset.

Parameters
aBinaryDataThe encoded binary representation.
aPosThe position from which to start decoding.
Return Value
The new Distinguished Name object.

NewL ( const TDesC8 & )

IMPORT_C CX500DistinguishedName *NewL(const TDesC8 &aBinaryData)[static]

Creates a new Distinguished Name object from the specified buffer containing the encoded binary representation.

Initialises the object from its encoded binary form into an internal representation.

Parameters
aBinaryDataThe encoded binary representation.
Return Value
The new Distinguished Name object.

NewL ( RReadStream & )

IMPORT_C CX500DistinguishedName *NewL(RReadStream &aStream)[static]

Creates a new Distinguished Name object from the specified read stream.

Construction is from a stream.

Parameters
aStreamStream from which the contents should be internalised.
Return Value
The newDistinguished Name object.

NewL ( const CArrayPtr< CX520AttributeTypeAndValue > & )

IMPORT_C CX500DistinguishedName *NewL(const CArrayPtr< CX520AttributeTypeAndValue > &aElements)[static]

Creates a new Distinguished Name object from the specified array of 'attribute type and value' objects.

The elements of the specified array are copied into this object.

Parameters
aElementsThe array of 'attribute type and value' objects to be copied.
Return Value
The new Distinguished Name object.

NewL ( const CX500DistinguishedName & )

IMPORT_C CX500DistinguishedName *NewL(const CX500DistinguishedName &aName)[static]

Creates a new Distinguished Name object from an existing object.

This is equivalent to a copy constructor.

Parameters
aNameThe Distinguished Name object to be copied.
Return Value
The new Distinguished Name object.

NewLC ( const TDesC8 &, TInt & )

IMPORT_C CX500DistinguishedName *NewLC(const TDesC8 &aBinaryData,
TInt &aPos
)[static]

Creates a new Distinguished Name object from the specified buffer containing the encoded binary representation, starting at the specified offset, and puts a pointer to it onto the cleanup stack.

Parameters
aBinaryDataThe encoded binary representation.
aPosThe position from which to start decoding.
Return Value
The new Distinguished Name object.

NewLC ( const TDesC8 & )

IMPORT_C CX500DistinguishedName *NewLC(const TDesC8 &aBinaryData)[static]

Creates a new Distinguished Name object from the specified buffer containing the encoded binary representation, and puts a pointer to it onto the cleanup stack.

Initialises the object from its encoded binary form into an internal representation.

Parameters
aBinaryDataThe encoded binary representation.
Return Value
The new Distinguished Name object.

NewLC ( RReadStream & )

IMPORT_C CX500DistinguishedName *NewLC(RReadStream &aStream)[static]

Creates a new Distinguished Name object from the specified read stream, and puts a pointer to it onto the cleanup stack.

Parameters
aStreamStream from which the contents should be internalised.
Return Value
The new Distinguished Name object.

NewLC ( const CArrayPtr< CX520AttributeTypeAndValue > & )

IMPORT_C CX500DistinguishedName *NewLC(const CArrayPtr< CX520AttributeTypeAndValue > &aElements)[static]

Creates a new Distinguished Name object from the specified array of 'attribute type and value' objects, and puts a pointer to it onto the cleanup stack.

The elements of the specified array are copied into this object.

Parameters
aElementsThe array of 'attribute type and value' objects to be copied.
Return Value
The new Distinguished Name object.

NewLC ( const CX500DistinguishedName & )

IMPORT_C CX500DistinguishedName *NewLC(const CX500DistinguishedName &aName)[static]

Creates a new Distinguished Name object from an existing object, and puts a pointer to it onto the cleanup stack.

This is equivalent to a copy constructor.

Parameters
aNameThe Distinguished Name object to be copied.
Return Value
The new Distinguished Name object.