OdCryptoServices.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2022 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
//OdCryptoServices - interface that provides services to enable developers to secure applications using cryptography
 
#ifndef _ODCRYPTOSERVICES_H__458F3BE0_8868_489B_B1D1_B1102D86667D__INCLUDED_
#define _ODCRYPTOSERVICES_H__458F3BE0_8868_489B_B1D1_B1102D86667D__INCLUDED_
 
#include "TD_PackPush.h"
 
#include "RootExport.h"
#include "SharedPtr.h"
#include "OdArray.h"
#include "OdString.h"
#include "OdBinaryData.h"
#include "OdLinkedArray.h"
 
class OdCertificateShortDesc
{
public:
  OdString m_CertSubject;
  OdString m_CertIssuer;
  OdString m_CertSerialNum; 
  //FELIX_CHANGE_BEGIN
  OdString m_CertLongSubject;
  //FELIX_CHANGE_END
};
 
class OdCertificateDescription : public OdCertificateShortDesc
{
public:
  OdString m_CertValidFrom;
  OdString m_CertValidTo;
};
 
class OdCertificateObject
{
public:
  virtual ~OdCertificateObject() {}
 
  virtual OdCertificateDescription getCertDescription() const = 0;
 
  virtual bool isTrusted() const = 0;
};
 
typedef OdSharedPtr<OdCertificateObject> OdCertificateObjectPtr;
 
class OdSubjectKeyIdAttrib
{
public:
  virtual ~OdSubjectKeyIdAttrib() {}
 
  virtual void getData(OdBinaryData& dataOfAttrValue) const = 0;
};
 
typedef OdSharedPtr<OdSubjectKeyIdAttrib> OdSubjectKeyIdAttribPtr;
 
class OdCryptSignMessagePara
{
protected:
  OdCryptSignMessagePara() {}
public:
  virtual ~OdCryptSignMessagePara() {}
};
 
typedef OdSharedPtr<OdCryptSignMessagePara> OdCryptSignMessageParaPtr;
 
class OdSignatureBaseDescription
{
public:
  virtual ~OdSignatureBaseDescription() {}
 
  OdCertificateDescription m_certDesc;
};
 
class FIRSTDLL_EXPORT OdCryptoServices : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdCryptoServices);
 
  virtual OdUInt32 getPersonalCertsWithTrustedStatus(OdArray<OdCertificateDescription>& certificates) const = 0;
 
  virtual OdCertificateObjectPtr getCertObjByShortDesc(const OdCertificateShortDesc& certShortDesc) const = 0;
 
  enum OdSignatureVerificationResult
  {
    kSuccess = 0,
    kHasNoSignature,
    kBadSignature,
    kCertificateChainProblem,
    kBadAlgId,
    kNoSigner,
    kUnexpectedMsgType,
    kInvalidArg,
    kUnknownError
  };
 
  virtual OdSubjectKeyIdAttribPtr newSubjectKeyIdentifierAttr(const OdBinaryData& dataOfAttrValue) = 0;
 
  virtual OdCryptSignMessageParaPtr newCryptSignMessagePara(const OdCertificateObjectPtr& pCertObj,
    const OdSubjectKeyIdAttribPtr& pSubjectKeyIdAttr) = 0;
 
  virtual bool generateDetachedSignature(const OdCryptSignMessageParaPtr& pSignPara, 
    const OdLinkedArray<OdBinaryData>& message, OdBinaryData& signature) = 0;
 
  virtual void verifyDetachedSignature(const OdLinkedArray<OdBinaryData>& message, const OdBinaryData& signature, 
    OdSignatureVerificationResult& verificationResult) = 0;
 
 
  virtual OdCertificateObjectPtr getCertFromDetachedSignature(const OdBinaryData& signature) = 0;
 
  virtual OdSubjectKeyIdAttribPtr getSubjectKeyIdFromDetachedSignature(const OdBinaryData& signature) = 0;
 
 
  virtual bool initSessionKeyToEncryptData(const OdBinaryData& passwordAsBinaryData, 
    OdUInt32 nProvType, const OdString& provName, OdUInt32 nAlgId, OdUInt32 nKeyLength) = 0;
 
  virtual void resetSessionKeyToEncryptData() = 0;
 
  virtual bool encryptData(OdUInt8* buffer, OdUInt32 bufferSize) = 0;
 
  virtual bool decryptData(OdUInt8* buffer, OdUInt32 bufferSize) = 0;
};
 
typedef OdSmartPtr<OdCryptoServices> OdCryptoServicesPtr;
 
 
#include "TD_PackPop.h"
 
#endif