DbSecurity.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _ODDBSECURITY_INCLUDED_
#define _ODDBSECURITY_INCLUDED_
 
#include "TD_PackPush.h"
 
#include "RxObject.h"
#include "OdArray.h"
#include "DbExport.h"
#include "OdString.h"
#include "OdBinaryData.h"
 
#include "OdCryptoServices/OdCryptoServices.h"
 
enum
{
  SECURITYPARAMS_ENCRYPT_DATA     = 0x00000001,
  SECURITYPARAMS_ENCRYPT_PROPS    = 0x00000002,
 
  SECURITYPARAMS_SIGN_DATA        = 0x00000010,
  SECURITYPARAMS_ADD_TIMESTAMP    = 0x00000020,
  //FELIX_CHANGE_BEGIN: To support Remove Sign functionality
  SECURITYPARAMS_UNSIGN_DATA        = 0x00000040,
  //FELIX_CHANGE_END
 
  SECURITYPARAMS_ALGID_RC4        = 0x00006801
};
 
 
typedef OdString OdPassword;

class OdSecurityParams
{
public:
  OdSecurityParams()
    : nFlags(0)
    , nProvType(0)
    , nAlgId (SECURITYPARAMS_ALGID_RC4)
    , nKeyLength(40)
  {}
 
  OdUInt32    nFlags;
  OdPassword  password;
  OdUInt32    nProvType;
  OdString   provName;
  OdUInt32    nAlgId;
  OdUInt32    nKeyLength;
 
  OdString   sCertSubject;
  OdString   sCertIssuer;
  OdString   sCertSerialNum;
  OdString   sComment;
  OdString   sTimeServer;
};

class OdSignatureDescription : public OdSignatureBaseDescription
{
public:
  OdString m_signatureDateAndTime;
  OdString m_timeServiceUsed;
 
  OdString m_comment;
};

class TOOLKIT_EXPORT OdDbCrypt : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbCrypt);

  virtual bool initialize(const OdSecurityParams& securityParams) = 0;
  virtual bool encryptData(OdUInt8* buffer, OdUInt32 bufferSize) = 0;

  virtual bool decryptData(OdUInt8* buffer, OdUInt32 bufferSize) = 0;

  virtual bool digitalSignatureModeLaunched();

  virtual void appendDataToProcessSignature(const OdBinaryData& dataBlock) = 0;

  virtual bool signData(const OdSecurityParams& securityParams, OdBinaryData& signatureBlock) = 0;

  virtual void verifyDataSignature(const OdBinaryData& signatureBlock, 
    OdCryptoServices::OdSignatureVerificationResult& verificationResult, 
    OdSignatureDescription& signatureDesc) = 0;
};

typedef OdSmartPtr<OdDbCrypt> OdDbCryptPtr;

class TOOLKIT_EXPORT OdPwdIterator : public OdRxObject
{
public:
    virtual bool done() const = 0;
  virtual void next() = 0;
  virtual void get(OdPassword& password) const = 0;
};

typedef OdSmartPtr<OdPwdIterator> OdPwdIteratorPtr;

class TOOLKIT_EXPORT OdPwdCache : public OdRxObject
{
public:
  virtual void add(const OdPassword& password) = 0;
  virtual OdPwdIteratorPtr newIterator() = 0;
};

typedef OdSmartPtr<OdPwdCache> OdPwdCachePtr;
 
#include "TD_PackPop.h"
 
#endif  // _ODDBSECURITY_INCLUDED_