IPKIFScvpClient.h

Go to the documentation of this file.

#ifndef __IPKIFScvpClient_H__
#define __IPKIFScvpClient_H__

#include "PKIFSCVPDLL.h"
#include "PKIFdll.h"
#include <string>

FD_LIST_PTR(CPKIFCertificate);
FD_LIST_PTR(CPKIFGeneralSubtree);
FD_LIST_PTR(CPKIFOID);

FD_SMART_PTR(CPKIFContentInfo);
FD_SMART_PTR(CPKIFCredential);
FD_SMART_PTR(CPKIFEvidenceRecordVerifier);
FD_SMART_PTR(CPKIFPathSettings);
FD_SMART_PTR(CPKIFValPolResponse);
FD_SMART_PTR(CPKIFReplyWantBack_ExtDataHandler);

FD_MC_PTR();

struct PKIFScvpClientImpl;


class PKIFSCVP_API IPKIFScvpClient
{
public:
    IPKIFScvpClient(void);
    virtual ~IPKIFScvpClient(void);

    //************************************************************************************
    //SCVP responder location information group box
    //************************************************************************************
    //set/get the HTTP URL to which requests are posted
    virtual void SetResponderUrl(const char* url);
    virtual const char* GetResponderUrl() const;

    //DPD/DPV is determined by the implementation of this interface that is used.

    //set/get instruction that determines is a request includes a nonce
    virtual void SetGenerateNonce(bool b);
    virtual bool GetGenerateNonce() const;

    //set/get instruction that determines if a nonce match is required
    virtual void SetRequireNonceMatch(bool bRequireNonceMatch);
    virtual bool GetRequireNonceMatch();

    //set/get instruction that determines if DPD requests require a signature
    virtual void SetRequireSignedDPD(bool b);
    virtual bool GetRequireSignedDPD() const;

    //************************************************************************************
    //Want backs group box
    //************************************************************************************
    //set/get the list of wantBacks that are included in a CVRequest
    virtual void SetWantBacks(CPKIFOIDListPtr& wantBack);
    virtual CPKIFOIDListPtr GetWantBacks() const;

    //************************************************************************************
    //Evidence record verifier group box
    //************************************************************************************
    //set/get the list of wantBacks that are included in a CVRequest
    virtual void SetEvidenceRecordVerifier(CPKIFEvidenceRecordVerifierPtr& erv);
    virtual CPKIFEvidenceRecordVerifierPtr GetEvidenceRecordVerifier() const;

    //************************************************************************************
    //Validation policy group box
    //************************************************************************************
    //set/get current val pol response
    virtual CPKIFContentInfoPtr FetchValPol();
    virtual void SetValPol(CPKIFContentInfoPtr& vp);
    virtual CPKIFContentInfoPtr GetValPol() const;

    //verify the val pol passed to SetValPol and return the parsed val pol response
    CPKIFValPolResponsePtr VerifyValPol();

    virtual void SetFetchValPolWhenLoading(bool b);
    virtual bool GetFetchValPolWhenLoading() const;

    CPKIFOIDPtr GetValidationPolicy() const;
    void SetValidationPolicy(CPKIFOIDPtr& valPol);

    //************************************************************************************
    //SCVP request signing credential group box
    //************************************************************************************
    //set/get the credential used to sign outbound requests
    virtual void SetSigningCredential(CPKIFCredentialPtr& cred);
    virtual CPKIFCredentialPtr GetSigningCredential() const;

    //************************************************************************************
    //Acceptable namespaces group box
    //************************************************************************************
    //add a namespace/get namespaces that determine if the colleague is consulted during path processing
    virtual void AddNamespace(CPKIFGeneralSubtreePtr& name);
    virtual CPKIFGeneralSubtreeList GetNamespaces();
    bool CheckNamespaces(const CPKIFCertificatePtr& cert);

    //************************************************************************************
    //Settings for SCVP response verification group box
    //************************************************************************************
    //set/get mediator collection that is used to verify signed SCVP responses
    virtual void SetMediator(IPKIFMediatorPtr& m);
    virtual IPKIFMediatorPtr GetMediator() const;

    //set/get path settings that are used to verify signed SCVP responses
    virtual void SetPathSettings(CPKIFPathSettingsPtr& settings);
    virtual CPKIFPathSettingsPtr GetPathSettings() const;

    //************************************************************************************
    //Custom validation policy group box
    //************************************************************************************
    //set/get path settings that are used to customize the val pol stuff in CVRequests
    virtual void SetPathSettingsForValPol(CPKIFPathSettingsPtr& settings);
    virtual CPKIFPathSettingsPtr GetPathSettingsForValPol() const;

    //************************************************************************************
    //Reply wantBack retrieval (used following a path path processing operation)
    //************************************************************************************
    virtual void SetWantBacksFromResponse(CPKIFReplyWantBack_ExtDataHandlerPtr& wantBacks);
    virtual CPKIFReplyWantBack_ExtDataHandlerPtr GetWantBacksFromResponse() const;

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

    struct PKIFScvpClientImpl* m_impl;
};
DECLARE_SMART_POINTERS(IPKIFScvpClient);
#endif