PKIFCertificateNodeEntry.h

Go to the documentation of this file.

#ifndef __PKIFCERTIFICATENODEENTRY_H__
#define __PKIFCERTIFICATENODEENTRY_H__

#include "PKIFdll.h"
#include "IPKIFPkiArtifact.h"
#include <vector>

FD_SMART_PTR(CPKIFCertificate);
FD_SMART_PTR(CPKIFX509Extension);
FD_SMART_PTR(CPKIFCertStatus);

//The CPKIFCertificateNodeEntry and CPKIFCertStatus business is intended to support a style of validation
//processing that is currently not implemented by the library.  Currently, the CPKIFPathValidator::ValidatePath
//function (and functions it calls) will fail upon the first encountered failure.  These pieces could be 
//rewritten such that failure information is collected but not returned until the entire path has been
//fully processed.  CPKIFCertificateNodeEntry and CPKIFCertStatus are intended to support such processing.
//Essentially, all certs in a path are wrapped with a CPKIFCertificateNodeEntry, which includes a CPKIFCertStatus.
//Failure information can be stored, further processing performed, then the list of certs in the path walked
//to determine if processing was successful and if not what the problem was.  This approach permits a finer
//granularity for failure override.

// forward declaration
struct CPKIFCertificateNodeEntryImpl;

class CAC_API CPKIFCertificateNodeEntry : public IPKIFPkiArtifact
{
public:
    CPKIFCertificateNodeEntry(void);
    CPKIFCertificateNodeEntry(CPKIFCertificatePtr& cert);
    virtual ~CPKIFCertificateNodeEntry(void);

    //function to get and set the cert wrapped by this node instance
    CPKIFCertificatePtr GetCert()const;
    void SetCert(const CPKIFCertificatePtr& cert);

    //functions to set, clear and get the ignore flag (used by builder)
    void SetIgnore();
    void ClearIgnore();
    bool GetIgnore() const;

    void SetNameIgnore();
    void ClearNameIgnore();

    //hard ignore is now nameIgnore && signatureIgnore && policyIgnore
    bool GetHardIgnore() const;

    //functions to flag processed extensions and to return an indication if any critical extensions
    //have not been processed
    void ClearProcessedExtensions();
    void MarkExtensionAsProcessed(CPKIFX509ExtensionPtr& ref);
    bool AreThereAnyUnprocessedCriticalExtensions();

    //function to get and set the status class associated with this node
    void SetStatus(CPKIFCertStatusPtr& status);
    void GetStatus(CPKIFCertStatusPtr& status) const;
    CPKIFCertStatusPtr GetStatus() const;

    //convenience function that keys off of the diagnostic code of the underlying status class
    bool GetProcessedSuccessfully() const;

    void ClearScore();
    void AddToScore(int add);
    int GetScore() const;

    PKIInfoSource GetSource() const;
    void SetSource(PKIInfoSource source);

    bool operator==(const CPKIFCertificateNodeEntry& rhs) const;

private:
    CPKIFCertificateNodeEntry(const CPKIFCertificateNodeEntry& copy);
    CPKIFCertificateNodeEntry& operator=(const CPKIFCertificateNodeEntry& rhs); //added 4/6/2004

    struct CPKIFCertificateNodeEntryImpl *m_impl;
};
DECLARE_SMART_POINTERS(CPKIFCertificateNodeEntry);
typedef std::vector<CPKIFCertificateNodeEntryPtr, PKIFAlloc<CPKIFCertificateNodeEntryPtr> > CPKIFCertificateNodeList;
DECLARE_SMART_POINTERS(CPKIFCertificateNodeList);

#endif