IOpcDigitalSignatureManager::Sign method

Signs the package by generating a signature by using the specified certificate and IOpcSigningOptions interface pointer. The resultant signature is represented by an IOpcDigitalSignature interface pointer.

Syntax

HRESULT Sign(
  [in]          const CERT_CONTEXT         *certificate,
  [in]                IOpcSigningOptions   *signingOptions,
  [out, retval]       IOpcDigitalSignature **digitalSignature
);

Parameters

certificate [in]

A pointer to a CERT_CONTEXT structure that contains the certificate.

signingOptions [in]

An IOpcSigningOptions interface pointer that is used to generate the signature.

digitalSignature [out, retval]

A new IOpcDigitalSignature interface pointer that represents the signature.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Remarks

This method uses Packaging objects to make changes to a package. The resultant changes are not saved until the package itself is saved.

Before this method is called to generate a signature, call the IOpcSigningOptions::SetDefaultDigestMethod and IOpcSigningOptions::SetSignatureMethod methods.

To create an IOpcSigningOptions interface pointer, which is required by this method, call the CreateSigningOptions method.

This method may create the following parts and relationships:

• The Digital Signature Origin part
• The package relationship of the digital signature origin relationship type
• One signature part that contains signature markup
• One or more part that contains a certificate
• One relationship that targets a signature part and that has the Digital Signature Origin part as its source
• One or more relationship that targets a signature part that contains a certificate and that has another signature part as its source

If Sign fails, any of the above parts and relationships may be represented, in the package, by Packaging objects. If the method returns the OPC_E_DS_SIGNATURE_METHOD_NOT_SET or OPC_E_DS_DEFAULT_DIGEST_METHOD_NOT_SET error code, the package has not been altered.

If Sign is successful, digest values are calculated for signed enitities, and the generated signature is serialized as signature markup. Possible signed entities include the Signature element, references, parts, relationships, and package-specific and application-specific Object elements.

Errors that are introduced into a package signature when the caller is using the IOpcSigningOptions interface to set signature information may not be exposed until Sign is called.

Thread Safety

Packaging objects are not thread-safe.

For more information, see the Getting Started with the Packaging API.

Requirements

See also

IOpcDigitalSignatureManager

Overviews

Digital Certificates

Digital Signatures Overview

Getting Started with the Packaging API

Packaging API Programming Guide

Saving a Package

Reference

Core Packaging Interfaces

Packaging Digital Signature Interfaces

Packaging Interfaces

Packaging API Reference

Packaging API Samples