CVRequest.h

Go to the documentation of this file.

#ifndef __CVREQUEST_H__
#define __CVREQUEST_H__

#include "PKIFSCVPDLL.h"
#include "IPKIFHasExtensions.h"

// forward declarations
struct CPKIFCVRequestImpl;

FD_MC_PTR();
FD_SMART_PTR(CPKIFQuery);
FD_SMART_PTR(CPKIFAlgorithmIdentifier);

FD_LIST_PTR(CPKIFGeneralName);

//typedef CPKIFGeneralNameList CPKIFGeneralNames;
//DECLARE_SMART_POINTERS(CPKIFGeneralNames);

class PKIFSCVP_API CPKIFCVRequest: public IPKIFHasExtensions
{
public:
    CPKIFCVRequest();
    virtual ~CPKIFCVRequest(void);

    //Default version is 1
    int GetVersion() const;
    void SetVersion(int v);

    //query field
    void SetQuery(CPKIFQueryPtr& query); 
    const CPKIFQueryPtr GetQuery() const;

    //optional field
    void SetRequestorRef(CPKIFGeneralNameListPtr& requestorRef);
    void GetRequestorRef(CPKIFGeneralNameListPtr& requestorRef) const;

    //optional field
    void SetNonce(CPKIFBufferPtr& nonce); 
    const CPKIFBufferPtr GetNonce() const;

    //optional field
    void SetRequestorName(CPKIFGeneralNamePtr& requestorName);
    const CPKIFGeneralNamePtr GetRequestorName() const;

    //optional field
    void SetResponderName(CPKIFGeneralNamePtr& responderName);
    const CPKIFGeneralNamePtr GetResponderName() const;

    //optional field
    void SetSigAlgorithm(CPKIFAlgorithmIdentifierPtr& sigAlgorithm);
    const CPKIFAlgorithmIdentifierPtr GetSigAlgorithm() const;

    //optional field
    void SetHashAlgorithm(CPKIFOIDPtr& hashAlgorithm);
    const CPKIFOIDPtr GetHashAlgorithm() const;

    //optional field
    void SetRequestorText(CPKIFStringPtr& nonce); 
    const CPKIFStringPtr GetRequestorText() const;

    //CPKIFCVRequest supports automatic nonce generation.  The mediator parameter allows caller 
    //to control what random number generator will be used.  If m is NULL (or does not contain
    //the IPKIFCryptoMisc interface) then a temporary instance of CPKIFCAPIRaw or CPKIFNSSRaw will 
    //be used to produce the nonce.  
    void SetGenerateNonce(bool generateNonce);
    void SetGenerateNonce(bool generateNonce, IPKIFMediatorPtr& m);
    bool GetGenerateNonce() const;

    //convenience function to allow quick failure in the SCVP server, i.e., if the server does not 
    //implement support for extensions
    bool ExtensionsPresent() const;

    template <class T> boost::shared_ptr<T> GetExtension();
    void GetExtensionByOID(const CPKIFOID& oid, CPKIFX509ExtensionPtr& ref);
    void GetEncodedExtensions (CPKIFBufferPtr& buf);
    bool AreThereAnyUnprocessedCriticalExtensions();

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

private:
    CPKIFCVRequest(const CPKIFCVRequest& copy);
    CPKIFCVRequest& operator=(const CPKIFCVRequest& rhs);

    struct CPKIFCVRequestImpl *m_impl;
};
DECLARE_SMART_POINTERS(CPKIFCVRequest);

#endif //__CVREQUEST_H__