IOpcDigitalSignature

パッケージのデジタル署名を表します。

署名を生成して IOpcDigitalSignature インターフェイスポインターを作成するには、IOpcDigitalSignatureManager::Sign メソッドを呼び出します。

生成済みの署名に IOpcDigitalSignature インターフェイスポインターを使用してアクセスするには、IOpcDigitalSignatureEnumerator::GetCurrent メソッドを呼び出します。

署名が生成されると、これらの情報は署名の XML マークアップ (署名マークアップ) にシリアル化されます。生成された署名マークアップは署名パートに格納されます。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

署名マークアップの Signature 要素におけるプレフィックスと名前空間のマッピングを取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

prefixes バッファーと namespaces バッファーは、インデックスによって相互に対応付けられます。

このメソッドは、prefixes および namespaces で返されるバッファーと、各バッファーに含まれる文字列が使用するメモリを割り当てます。

例

次のコードは、CoTaskMemFree を使用してバッファーおよびそれに含まれる文字列のメモリを解放する方法を示しています。

// Prepare to call GetNamespaces
LPWSTR* prefixes = NULL;
LPWSTR* namespaces = NULL;
UINT32 count = 0;

// Call to GetNamespaces succeeds
if ( SUCCEEDED( signature->GetNamespaces(&prefixes, &namespaces, &count) ) )
{
    // Process strings in prefixes and namespaces as needed for the application

    // Free memory for each string
    for (UINT32 i = 0; i < count; i++)
    {
        CoTaskMemFree(prefixes[i]);
        CoTaskMemFree(namespaces[i]);
    }
    // Free memory for the buffers
    CoTaskMemFree(prefixes);
    CoTaskMemFree(namespaces);
}

署名マークアップの Signature 要素から Id 属性の値を取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

このメソッドは、signatureId で返される文字列が使用するメモリを割り当てます。メソッドが成功した場合は、CoTaskMemFree 関数を呼び出してメモリを解放してください。

Signature 要素の Id 属性は省略可能です。このメソッドが呼び出されない場合、Signature 要素は Id 属性を持ちません。

署名が生成される前に署名 Id を設定するには、IOpcSigningOptions::SetSignatureId メソッドを呼び出します。

署名が生成される前に Id にアクセスするには、IOpcSigningOptions::GetSignatureId メソッドを呼び出します。

署名マークアップを格納しているパートのパート名を取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

署名が生成される前にこの署名パートのパート名を設定するには、IOpcSigningOptions::SetSignaturePartName メソッドを呼び出します。署名が生成される前に署名パート名にアクセスするには、IOpcSigningOptions::GetSignaturePartName を呼び出します。

署名マークアップを格納する署名パートは、その署名に固有のものです。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

署名マークアップの SignatureValue 要素の値を計算するために使用された署名メソッドを取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

このメソッドは、signatureMethod で返される文字列が使用するメモリを割り当てます。メソッドが成功した場合は、CoTaskMemFree 関数を呼び出してメモリを解放してください。

署名が生成される前に署名メソッドを設定するには、IOpcSigningOptions::SetSignatureMethod メソッドを呼び出します。

署名が生成される前に署名メソッドにアクセスするには、IOpcSigningOptions::GetSignatureMethod を呼び出します。署名が生成された後に署名メソッドにアクセスするには、IOpcDigitalSignature::GetSignatureMethod メソッドを呼び出します。いずれのメソッドも、IOpcSigningOptions::SetSignatureMethod によって設定された値を取得します。

署名が検証される際には、署名メソッドを使用してその値が再計算され、再計算された値が署名マークアップ内の SignatureValue 要素の値と比較されます。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

シリアル化された署名の SignedInfo 要素に適用された正規化 (canonicalization) メソッドを取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

API を使用して署名を生成する場合、コメントを削除する C14N 正規化メソッドが SignedInfo 要素に適用されます。このメソッドは OPC_CANONICALIZATION_C14N 列挙値に対応します。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

署名マークアップの SignatureValue 要素に含まれる値をデコードして取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

このメソッドは、signatureValue で返されるバッファーが使用するメモリを割り当てます。メソッドが成功した場合は、CoTaskMemFree 関数を呼び出してメモリを解放してください。

SignatureValue 要素には、署名マークアップの SignedInfo 要素に署名メソッドを適用して計算された、base-64 エンコード済みの値が格納されます。署名メソッドを取得するには、GetSignatureMethod メソッドを呼び出します。

API を使用して署名を生成する場合は、IOpcSigningOptions::SetSignatureMethod メソッドを呼び出して署名メソッドを設定します。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

署名済みのパートへの参照を表す IOpcSignaturePartReference インターフェイスポインターの列挙子を取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

署名済みのリレーションシップへの参照を表す IOpcSignatureRelationshipReference インターフェイスポインターの列挙子を取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

署名が生成された時刻を示す文字列を取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

このメソッドは、signingTime で返される文字列が使用するメモリを割り当てます。メソッドが成功した場合は、CoTaskMemFree 関数を呼び出してメモリを解放してください。

signingTime 文字列の書式を取得するには、GetTimeFormat メソッドを呼び出します。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

GetSigningTime メソッドが返す文字列の書式を取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

現在のパッケージ署名が生成された時刻を示す文字列にアクセスするには、GetSigningTime メソッドを呼び出します。

署名が生成される前に署名時刻文字列の書式を設定するには、IOpcSigningOptions::SetTimeFormat メソッドを呼び出します。署名が生成される前にその書式にアクセスするには、IOpcSigningOptions::GetTimeFormat メソッドを呼び出します。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

署名済みのパッケージ固有の Object 要素への参照を表す IOpcSignatureReference インターフェイスポインターを取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

packageObjectReference パラメーターで受け取る IOpcSignatureReference インターフェイスポインターは、URI 属性値が "#idPackageObject" に設定された Reference 要素を表します。この要素の URI 属性値は、パッケージ固有の Object 要素の Id 属性値の先頭にシャープ記号 ("#") を付けたものです。

署名が生成されて署名マークアップとしてシリアル化されると、この参照と参照先のパッケージ固有の Object 要素が署名されます。次のマークアップは、生成される署名マークアップ内のパッケージ固有の Reference 要素とパッケージ固有の Object 要素を示しています。

<!-- Signature markup. -->
<Signature>
    <SignedInfo>
        [...]
        <!-- A reference to the package-specific <Object> that
        is, or will be, signed. -->
        <Reference URI="#idPackageObject">
             [...]
        </Reference>
    </SignedInfo>
    [...]
    <!-- The package-specific <Object> element. -->
    <Object Id="idPackageObject">
        <!-- This element contains the <Reference> elements that
        refer to parts and relationships in the package that are
        or will be signed. -->
        <Manifest>
            [...] 
        </Manifest>
    </Object>
</Signature>

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

署名で使用されている証明書の列挙子を取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

署名済みのアプリケーション固有の XML 要素への参照を表す IOpcSignatureReference インターフェイスポインターの列挙子を取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

署名済みの XML 要素に IOpcSignatureCustomObject インターフェイスポインターを使用してアクセスするには、IOpcSignatureCustomObjectEnumerator::GetCurrent メソッドを呼び出します。署名済みの XML 要素のマークアップにアクセスするには、IOpcSignatureCustomObject::GetXml メソッドを呼び出します。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。

署名マークアップ内のアプリケーション固有の Object 要素を表す IOpcSignatureCustomObject インターフェイスポインターの列挙子を取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

署名マークアップを取得します。

このメソッドは HRESULT を返します。返される値には、次の表に示すものが含まれます (ただしこれらに限定されません)。

このメソッドは、signatureXml で返されるバッファーが使用するメモリを割り当てます。メソッドが成功した場合は、CoTaskMemFree 関数を呼び出してメモリを解放してください。

スレッドセーフティ

パッケージングオブジェクトはスレッドセーフではありません。

詳細については、Getting Started with the Packaging API を参照してください。