CPKIFTrustRoot Class Reference
#include <PKIFTrustRoot.h>
Detailed Description
The CPKIFTrustRoot class provides a means of conveying trust anchor information. Currently such information is always conveyed in certificate form. In the future, support for non-certificate trust anchor information may be implemented.TSP-enforcing: No
Definition at line 34 of file PKIFTrustRoot.h.
Public Member Functions | |
| CPKIFTrustRoot () | |
| virtual | ~CPKIFTrustRoot () |
| CPKIFCertificatePtr | GetCertificate () const |
| CPKIFSubjectKeyIdentifierPtr | GetKeyIdentifier () const |
| void | SetCert (const CPKIFCertificatePtr &cert) |
| void | GetCert (CPKIFCertificatePtr &cert) const |
| void | GetName (CPKIFNamePtr &name) const |
| CPKIFNamePtr | GetSubjectName () const |
| CPKIFNamePtr | GetIssuerName () const |
| CPKIFBufferPtr | GetKey () const |
| virtual CPKIFSubjectPublicKeyInfoPtr | GetSubjectPublicKeyInfo () const |
| bool | operator== (const CPKIFTrustRoot &tr) |
| bool | operator== (const IPKIFTrustAnchor &tr) |
| template<typename T> | |
| boost::shared_ptr< T > | GetExtension () |
| void | GetExtensions (IPKIFParseExtensions *m, std::vector< CPKIFX509ExtensionPtr > &exts) |
| void | GetExtensionByOID (const CPKIFOID &oid, CPKIFX509ExtensionPtr &ref) |
| void | GetEncodedExtensions (CPKIFBufferPtr &buf) |
| virtual CPKIFBufferPtr | Encoded () |
Constructor & Destructor Documentation
| CPKIFTrustRoot::CPKIFTrustRoot | ( | ) |
Interface: External
This function creates and initializes a CPKIFTrustRoot object.
- Returns:
- None
Definition at line 33 of file CACTrustRoot.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
| CPKIFTrustRoot::~CPKIFTrustRoot | ( | ) | [virtual] |
Interface: External
This function destroys a CPKIFTrustRoot object.
- Returns:
- None
Definition at line 44 of file CACTrustRoot.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_PATH_MISC.
Member Function Documentation
| CPKIFCertificatePtr CPKIFTrustRoot::GetCertificate | ( | ) | const [virtual] |
| CPKIFSubjectKeyIdentifierPtr CPKIFTrustRoot::GetKeyIdentifier | ( | ) | const [virtual] |
| void CPKIFTrustRoot::SetCert | ( | const CPKIFCertificatePtr & | cert | ) |
Interface: External
This function is used to specify a certificate that should function as a trust anchor.
- Returns:
- None
- Parameters:
-
cert [in] Const reference to a smart pointer to a CPKIFCertificate object containing a certificate to be used as a trust anchor
Definition at line 57 of file CACTrustRoot.cpp.
| void CPKIFTrustRoot::GetCert | ( | CPKIFCertificatePtr & | cert | ) | const |
Interface: External
This function is used to get a certificate associated with a trust root object.
- Returns:
- None
- Parameters:
-
cert [out] Reference to a smart pointer to a CPKIFCertificate object to receive the certificate associated with a CPKIFTrustRoot instance
Definition at line 71 of file CACTrustRoot.cpp.
Referenced by GetCertificate(), GetExtension(), GetKeyIdentifier(), CPKIFSimpleCertAndCrlPanel::OnInitDialog(), PathDumpDialog::SavePathToDisk(), and SaveStorageAndRetrievalComponents().
| void CPKIFTrustRoot::GetName | ( | CPKIFNamePtr & | name | ) | const |
Interface: External
Theis function is used to set the distinguished name associated with a trust root object (currently this is simply the subject name from the associated certificate).
- Returns:
- None
- Parameters:
-
name [out] Reference to a smart pointer to a CPKIFName object
Definition at line 106 of file CACTrustRoot.cpp.
| CPKIFNamePtr CPKIFTrustRoot::GetSubjectName | ( | ) | const [virtual] |
Interface: External
This function is used to get the distinguished name associated with a trust root object (currently this is simply the subject name from the associated certificate).
- Returns:
- None Interface: External
- Returns:
- CPKIFNamePtr containing the subject name from the certificate
Implements IPKIFNameAndKey.
Definition at line 128 of file CACTrustRoot.cpp.
| CPKIFNamePtr CPKIFTrustRoot::GetIssuerName | ( | ) | const [virtual] |
Interface: External
GetIssuerName returns the issuer name from the certificate associated with an instance of CPKIFTrustRoot
- Returns:
- CPKIFNamePtr containing the issuer name from the certificate
Implements IPKIFNameAndKey.
Definition at line 140 of file CACTrustRoot.cpp.
| CPKIFBufferPtr CPKIFTrustRoot::GetKey | ( | ) | const [virtual] |
Interface: External
GetKey returns the subject public key from the certificate associated with an instance of CPKIFTrustRoot
- Returns:
- CPKIFBufferPtr object containing key
Implements IPKIFNameAndKey.
Definition at line 170 of file CACTrustRoot.cpp.
| CPKIFSubjectPublicKeyInfoPtr CPKIFTrustRoot::GetSubjectPublicKeyInfo | ( | ) | const [virtual] |
Interface: External
GetKey returns the subject public key information from the certificate associated with an instance of CPKIFTrustRoot
- Returns:
- CPKIFSubjectPublicKeyInfoPtr object containing subject public key information
Implements IPKIFNameAndKey.
Definition at line 183 of file CACTrustRoot.cpp.
| bool CPKIFTrustRoot::operator== | ( | const CPKIFTrustRoot & | tr | ) |
Interface: External
The comparison is an invocation of the equality operator on the member certificate objects of each CPKIFTrustRoot (non-certificate-based trust anchor material is not currently supported).
- Returns:
- True if the trust anchor passed via the tr parameter matches the trust anchor material held by the instance of CPKIFTrustRoot on which this function was invoked and false otherwise.
- Parameters:
-
tr [in] Reference to a CPKIFTrustRoot object containing the trust anchor to compare
Definition at line 156 of file CACTrustRoot.cpp.
References m_impl.
| bool CPKIFTrustRoot::operator== | ( | const IPKIFTrustAnchor & | tr | ) | [virtual] |
Interface: External
This function returns true if the trust anchor passed via the tr parameter is a CPKIFTrustRoot object containing the same certificate object.
- Returns:
- true or false
Implements IPKIFTrustAnchor.
Definition at line 196 of file CACTrustRoot.cpp.
| boost::shared_ptr< T > CPKIFTrustRoot::GetExtension | ( | ) | [inline] |
Interface: External
This function is used to retrieve an extension from an CPKIFTrustRoot object. It takes the type of extension sought by an application as a template parameter and returns a smart pointer to that type (containing a NULL pointer if the extension was not found).
- Returns:
- A smart pointer to the appropriate extension
Reimplemented from IPKIFHasExtensions.
Definition at line 89 of file PKIFTrustRoot.h.
References GetCert().
| void CPKIFTrustRoot::GetExtensions | ( | IPKIFParseExtensions * | m, | |
| std::vector< CPKIFX509ExtensionPtr > & | exts | |||
| ) | [virtual] |
Interface: External
This function parses the objects extensions using the IPKIFMediator parameter, and populates the vector parameter with a pointers to the parsed Extension objects.
- Returns:
- None
Reimplemented from IPKIFHasExtensions.
Definition at line 205 of file CACTrustRoot.cpp.
| void CPKIFTrustRoot::GetExtensionByOID | ( | const CPKIFOID & | oid, | |
| CPKIFX509ExtensionPtr & | ref | |||
| ) | [virtual] |
| void CPKIFTrustRoot::GetEncodedExtensions | ( | CPKIFBufferPtr & | buf | ) | [virtual] |
| CPKIFBufferPtr CPKIFTrustRoot::Encoded | ( | ) | [virtual] |
The documentation for this class was generated from the following files:
