Public Member Functions | List of all members
DsigQuery Class Reference

Information about a digital signature. More...

#include <Dsig.h>

Inheritance diagram for DsigQuery:
DigitalSignatureCellHeaderHandler::DigitalSignatureData

Public Member Functions

RMGRSUBS_EXPORT DsigQuery (DsigDigitalSignature const &)
 
RMGRSUBS_EXPORT DsigQuery (DsigQuery const &)
 
RMGRSUBS_EXPORT DsigQueryoperator= (DsigQuery const &)
 
RMGRSUBS_EXPORT ~DsigQuery ()
 
RMGRSUBS_EXPORT bool IsValid () const
 Returns false if the element queried is not a digital signature. More...
 
RMGRSUBS_EXPORT WCharCP GetCommonName () const
 The common name (CN) from the Subject field of the signer's certificate, if the signature has a copy of the signer's certificate. More...
 
RMGRSUBS_EXPORT WCharCP GetEmail () const
 Subject e-mail (E) name from signer's certificate, if the signature has a copy of the signer's certificate. Not always available. More...
 
RMGRSUBS_EXPORT bool IncludesEntireFile () const
 Query if the scope of the signature includes the content of the entire file */. More...
 
RMGRSUBS_EXPORT bool IncludesReferences () const
 Query if the scope of the signature includes the content of referenced models. More...
 
RMGRSUBS_EXPORT StatusInt GetCertificate (bvector< byte > &x509Cert) const
 Get the signer's certificate, if stored. More...
 
RMGRSUBS_EXPORT StatusInt GetCertificateChain (bvector< byte > &pkcs7) const
 Get the PKCS#7 certficate chain, if stored. More...
 
RMGRSUBS_EXPORT StatusInt GetPublicKey (bvector< byte > &x509PublicKeyInfo) const
 Get the signer's public key. More...
 
RMGRSUBS_EXPORT
DsigAnnotationData const & 
GetAnnotationData () const
 Get the optional annotation data that the signer stored with the signature. More...
 

Detailed Description

Information about a digital signature.

Remarks
Required library : RmgrTools<ApiNumber>.lib i.e. RmgrTools3.lib

Constructor & Destructor Documentation

RMGRSUBS_EXPORT DsigQuery ( DsigDigitalSignature const &  )

Member Function Documentation

RMGRSUBS_EXPORT DsigAnnotationData const& GetAnnotationData ( ) const

Get the optional annotation data that the signer stored with the signature.

RMGRSUBS_EXPORT StatusInt GetCertificate ( bvector< byte > &  x509Cert) const

Get the signer's certificate, if stored.

Parameters
[out]x509CertDER-encoded X.509 certificate.
Returns
non-zero error status if !IsValid or if the certificate appears to be invalid.
See also
GetPublicKey, GetCertificateChain
RMGRSUBS_EXPORT StatusInt GetCertificateChain ( bvector< byte > &  pkcs7) const

Get the PKCS#7 certficate chain, if stored.

See also
GetCertificate
RMGRSUBS_EXPORT WCharCP GetCommonName ( ) const

The common name (CN) from the Subject field of the signer's certificate, if the signature has a copy of the signer's certificate.

RMGRSUBS_EXPORT WCharCP GetEmail ( ) const

Subject e-mail (E) name from signer's certificate, if the signature has a copy of the signer's certificate. Not always available.

RMGRSUBS_EXPORT StatusInt GetPublicKey ( bvector< byte > &  x509PublicKeyInfo) const

Get the signer's public key.

Parameters
[out]x509PublicKeyInfoDER-encoded X.509 PublicKeyInfo.
Returns
non-zero error status if !IsValid or if the certificate or public key appears to be invalid.
RMGRSUBS_EXPORT bool IncludesEntireFile ( ) const

Query if the scope of the signature includes the content of the entire file */.

RMGRSUBS_EXPORT bool IncludesReferences ( ) const

Query if the scope of the signature includes the content of referenced models.

RMGRSUBS_EXPORT bool IsValid ( ) const

Returns false if the element queried is not a digital signature.

RMGRSUBS_EXPORT DsigQuery& operator= ( DsigQuery const &  )

The documentation for this class was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.