TimeStampRequest.h

Go to the documentation of this file.

#ifndef __TIMESTAMPREQUEST_H__
#define __TIMESTAMPREQUEST_H__

#include "PKIFTSPDLL.h"
#include "IPKIFHasExtensions.h"

// forward declarations
struct CPKIFTimeStampRequestImpl;
FD_SMART_PTR(CPKIFMessageImprint);

class PKIFTSP_API CPKIFTimeStampRequest: public IPKIFHasExtensions
{
public:
    CPKIFTimeStampRequest();
    virtual ~CPKIFTimeStampRequest(void);

    //version is always 1 when encoding - hence no Set function
    int GetVersion() const;

    //required field
    void SetMessageImprint(CPKIFMessageImprintPtr& messageImprint);
    CPKIFMessageImprintPtr GetMessageImprint() const;

    //optional field
    void SetPolicy(CPKIFOIDPtr& policy);
    CPKIFOIDPtr GetPolicy() const;

    //optional field
    void SetNonce(CPKIFStringPtr& nonce); //nonce format must be ASCII Hex preceded by 0x
    const char* GetNonce() const;

    //convenience function to trigger automatic generation and inclusion
    //of a random nonce.  the mediator param allows caller to control what
    //random number generator will be used.  if m is NULL (or does not contain
    //the IPKIFCryptoMisc interface) then an instance of CPKIFCAPIRaw will be 
    //used to produce the nonce.  The value passed as m MUST NOT be destroyed
    //prior to calling encode.
    void SetGenerateNonce(bool generateNonce, IPKIFMediator* m = NULL);
    bool GetGenerateNonce() const;

    //required field - default false
    void SetReqCert(bool reqCert);
    bool GetReqCert() const;

    //optional field - this version of PKIF does not support encoding extensions in TSP structures
    //void AddExtension(CPKIFX509ExtensionPtr& ext);

    //convenience function to allow quick failure in the TSA (the prototype TSA built using PKIF
    //does not and will not support TSP extensions)
    bool ExtensionsPresent() const;


    template <class T> boost::shared_ptr<T> GetExtension();

    CPKIFBufferPtr Encode() const;
    void Decode(CPKIFBufferPtr& msg);

    void GetExtensionByOID(const CPKIFOID& oid, CPKIFX509ExtensionPtr& ref);
    void GetEncodedExtensions (CPKIFBufferPtr& buf);
private:
    CPKIFTimeStampRequest(const CPKIFTimeStampRequest& copy);
    CPKIFTimeStampRequest& operator=(const CPKIFTimeStampRequest& rhs); //added 4/6/2004

    struct CPKIFTimeStampRequestImpl *m_impl;
};
DECLARE_SMART_POINTERS(CPKIFTimeStampRequest);
//@b Interface: External
//
//This function is used to get an extension contained by a TimeStampRequest object.
//
//@return A smart pointer to an appropriate extension
//*/
//template <typename T>
//shared_ptr<T> CPKIFTimeStampRequest::GetExtension()
//{
//    CPKIFX509ExtensionPtr ext;
//    CPKIFStringPtr oidStr(new std::string(T::extOID));
//    CPKIFOID oid(oidStr);
//    GetExtensionByOID(oid,ext);
//
//    if(ext && 0 != dynamic_cast<T*>(ext.get())){
//  return *((shared_ptr<T>*)&(ext));
//    }
//
//    shared_ptr<T> nullExt;
//    return nullExt;
//}


/*template <class T> shared_ptr<T> CPKIFTimeStampRequest::GetExtension()

{
    if(m_exts.empty() && 0 != m_signedCert->toBeSigned.extensions.count)
        populateExtensionsVector();

    CPKIFStringPtr oidStr(new std::string(T::extOID));
    CPKIFOID oid(oidStr);

    CPKIFX509Extension* p = NULL;
    vector<CPKIFX509ExtensionPtr>::iterator pos;
    vector<CPKIFX509ExtensionPtr>::iterator end = m_exts.end();
    for(pos = m_exts.begin(); pos != end; ++pos)
    {
        p = &(*(*pos));
        if(oid == (*pos)->oid() && NULL != dynamic_cast<T*>(p))
        {
            return *((shared_ptr<T>*)&(*pos));
        }
    }       


    shared_ptr<T> nullExt;

    return nullExt;
}
*/
#endif //__TIMESTAMPREQUEST_H__