CPKIFSigningTimeAttribute Class Reference
#include <SigningTimeAttribute.h>
Detailed Description
This class provides support for the CMS Signing Time attribute. See CPKIFSignerInfo::AddSignedAttribute for details on how to create and associate CMS attributes with signed data objects.TSP-enforcing: No
Definition at line 30 of file SigningTimeAttribute.h.
Public Member Functions | |
| CPKIFSigningTimeAttribute () | |
| CPKIFSigningTimeAttribute (const CPKIFBufferPtr &buf) | |
| ~CPKIFSigningTimeAttribute () | |
| CPKIFOIDPtr | GetOID () const |
| void | GetValues (CPKIFBufferList &values) const |
| CPKIFTimePtr | GetTime () const |
| void | SetTime (CPKIFTimePtr &time) |
| void | SetUseUtcTimeIfPossible (bool bUseUtcIfPossible) |
| bool | GetUseUtcTimeIfPossible () |
Static Public Attributes | |
| static char | extOID [] = "1.2.840.113549.1.9.5" |
Constructor & Destructor Documentation
| CPKIFSigningTimeAttribute::CPKIFSigningTimeAttribute | ( | ) |
Interface: External
Default constructor.
- Returns:
- None
Definition at line 92 of file SigningTimeAttribute.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_MESSAGE_ASN.
| CPKIFSigningTimeAttribute::CPKIFSigningTimeAttribute | ( | const CPKIFBufferPtr & | buf | ) |
Interface: External
This constructor is called from CPKIFSigningTimeAttributeFactory::create().
- Returns:
- None Interface: External
- Returns:
- None
- Parameters:
-
buf [in] The raw attribute to convert to a CPKIFSigningTimeAttribute.
Definition at line 125 of file SigningTimeAttribute.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_MESSAGE_ASN.
| CPKIFSigningTimeAttribute::~CPKIFSigningTimeAttribute | ( | ) |
Interface: External
Destroys an instance of CPKIFSigningTimeAttribute object.
- Returns:
- None
Definition at line 143 of file SigningTimeAttribute.cpp.
References LOG_STRING_DEBUG, and TOOLKIT_MESSAGE_ASN.
Member Function Documentation
| CPKIFOIDPtr CPKIFSigningTimeAttribute::GetOID | ( | ) | const [virtual] |
Interface: External
This function returns the OID associated with this type of CMS attribute.
- Returns:
- The OID associated with this type of CMS attribute
Reimplemented from CPKIFAttribute.
Definition at line 191 of file SigningTimeAttribute.cpp.
References g_signingTimeAttribute.
| void CPKIFSigningTimeAttribute::GetValues | ( | CPKIFBufferList & | values | ) | const [virtual] |
Interface: External
This function returns the raw, encoded signing time attribute value.
- Returns:
- None
- Parameters:
-
values [out] The list of values stored by the attribute.
Reimplemented from CPKIFAttribute.
Definition at line 202 of file SigningTimeAttribute.cpp.
References CPKIFASNWrapper< T >::Encode(), LOG_STRING_DEBUG, and TOOLKIT_MESSAGE_ASN.
| CPKIFTimePtr CPKIFSigningTimeAttribute::GetTime | ( | ) | const |
Interface: External
Th function is used to get the time value conveyed by the CPKIFSigningTImeAttribute object.
- Returns:
- A smart pointer to CPKIFTime object
Definition at line 157 of file SigningTimeAttribute.cpp.
| void CPKIFSigningTimeAttribute::SetTime | ( | CPKIFTimePtr & | time | ) |
Interface: External
This function is used to set the time value conveyed by the CPKIFSigningTImeAttribute object.
- Returns:
- None
- Exceptions:
-
CPKIFMessageException(COMMON_INVALID_INPUT)
- Parameters:
-
time [in] The time to set.
Definition at line 170 of file SigningTimeAttribute.cpp.
References COMMON_INVALID_INPUT, LOG_STRING_DEBUG, TOOLKIT_MESSAGE, and TOOLKIT_MESSAGE_ASN.
| void CPKIFSigningTimeAttribute::SetUseUtcTimeIfPossible | ( | bool | bUseUtcIfPossible | ) |
Interface: External
This function tells the class to use UTC time when possible
- Returns:
- None
- Parameters:
-
bUseUtcIfPossible [out] If true is passed in UTC time will be used when possible
Definition at line 249 of file SigningTimeAttribute.cpp.
| bool CPKIFSigningTimeAttribute::GetUseUtcTimeIfPossible | ( | ) |
Interface: External
This function indicates if UTC time will be used when possible
- Returns:
- True if UTC time will be used when possible, false otherwise
Definition at line 262 of file SigningTimeAttribute.cpp.
Member Data Documentation
char CPKIFSigningTimeAttribute::extOID = "1.2.840.113549.1.9.5" [static] |
Definition at line 37 of file SigningTimeAttribute.h.
Referenced by CPKIFSigningTimeAttributeFactory::refOID().
The documentation for this class was generated from the following files:
