方法: デジタル署名で XML ドキュメントに署名する

[アーティクル]
05/10/2023

System.Security.Cryptography.Xml 名前空間のクラスを使用すると、XML ドキュメントまたは XML ドキュメントの一部にデジタル署名で署名することができます。 XML デジタル署名 (XMLDSIG) を使用すると、データが署名後に変更されなかったことを確認できます。 XMLDSIG の基準の詳細については、World Wide Web コンソーシアム (W3C) の推奨事項「XML 署名の構文と処理」を参照してください。

注意

この記事のコードは、Windows に適用されます。

この手順のコード例は、XML ドキュメント全体にデジタル署名する方法、および <Signature> 要素内のドキュメントに署名を付す方法を示しています。この例では、RSA 署名キーを作成し、キーをセキュリティで保護されたキーコンテナーに追加してから、キーを使用して XML ドキュメントにデジタル署名しています。キーは、XML デジタル署名を確認するために取得したり、別の XML ドキュメントの署名に使用したりすることができます。

この手順を使用して作成された XML デジタル署名を確認する方法については、「方法: XML ドキュメントのデジタル署名を検証する」を参照してください。

XML ドキュメントにデジタル署名するには

CspParameters オブジェクトを作成し、キーのコンテナーの名前を指定します。

CspParameters cspParams = new()
{
    KeyContainerName = "XML_DSIG_RSA_KEY"
};

Dim cspParams As New CspParameters With {
    .KeyContainerName = "XML_DSIG_RSA_KEY"
}

RSACryptoServiceProvider クラスを使用して非対称キーを生成します。 CspParameters オブジェクトを RSACryptoServiceProvider クラスのコンストラクターに渡すと、キーは自動的にキーコンテナーに保存されます。このキーは、XML ドキュメントの署名に使用されます。
```
RSACryptoServiceProvider rsaKey = new(cspParams);
```
```
Dim rsaKey As New RSACryptoServiceProvider(cspParams)
```

ディスクから XML ファイルを読み込んで XmlDocument オブジェクトを作成します。 XmlDocument オブジェクトには、暗号化する XML 要素が含まれています。

XmlDocument xmlDoc = new()
{
    // Load an XML file into the XmlDocument object.
    PreserveWhitespace = true
};
xmlDoc.Load("test.xml");

' Load an XML file into the XmlDocument object.
Dim xmlDoc As New XmlDocument With {
    .PreserveWhitespace = True
}
xmlDoc.Load("test.xml")

SignedXml オブジェクトを新規作成し、それに XmlDocument オブジェクトを渡します。
```
SignedXml signedXml = new(xmlDoc)
{
```
```
Dim signedXml As New SignedXml(xmlDoc)
```
署名する RSA キーを SignedXml オブジェクトに追加します。
```
    SigningKey = rsaKey
};
```
```
signedXml.SigningKey = rsaKey
```
署名内容について記述する Reference オブジェクトを作成します。ドキュメント全体に署名するには、Uri プロパティを "" に設定します。
```
// Create a reference to be signed.
Reference reference = new()
{
    Uri = ""
};
```
```
' Create a reference to be signed.
Dim reference As New Reference()
reference.Uri = ""
```
XmlDsigEnvelopedSignatureTransform オブジェクトを Reference オブジェクトに追加します。変換を使用すると、検証側は、署名側が使用した方法と同一の方法で XML データを表すことができます。 XML データはさまざまな方法で表すことができるため、この手順は検証にとって重要です。
```
XmlDsigEnvelopedSignatureTransform env = new();
reference.AddTransform(env);
```
```
Dim env As New XmlDsigEnvelopedSignatureTransform()
reference.AddTransform(env)
```
Reference オブジェクトを SignedXml オブジェクトに追加します。
```
signedXml.AddReference(reference);
```
```
signedXml.AddReference(reference)
```
ComputeSignature メソッドを呼び出して署名を計算します。
```
signedXml.ComputeSignature();
```
```
signedXml.ComputeSignature()
```
署名の XML 表記 (<Signature> 要素) を取得して、新しい XmlElement オブジェクトに保存します。
```
XmlElement xmlDigitalSignature = signedXml.GetXml();
```
```
Dim xmlDigitalSignature As XmlElement = signedXml.GetXml()
```

XmlDocument オブジェクトに要素を追加します。

xmlDoc.DocumentElement?.AppendChild(xmlDoc.ImportNode(xmlDigitalSignature, true));

xmlDoc.DocumentElement.AppendChild(xmlDoc.ImportNode(xmlDigitalSignature, True))

ドキュメントを保存します。

xmlDoc.Save("test.xml");

xmlDoc.Save("test.xml")

例

この例では、test.xml という名前のファイルがコンパイル済みのプログラムと同じディレクトリに存在することを前提としています。次の XML を test.xml というファイルに配置し、この例で使用することができます。

<root>  
    <creditcard>  
        <number>19834209</number>  
        <expiry>02/02/2002</expiry>  
    </creditcard>  
</root>

using System;
using System.Runtime.Versioning;
using System.Security.Cryptography;
using System.Security.Cryptography.Xml;
using System.Xml;

[SupportedOSPlatform("Windows")]
public class SignXML
{
    public static void Main(String[] args)
    {
        try
        {
            // Create a new CspParameters object to specify
            // a key container.
            CspParameters cspParams = new()
            {
                KeyContainerName = "XML_DSIG_RSA_KEY"
            };

            // Create a new RSA signing key and save it in the container.
            RSACryptoServiceProvider rsaKey = new(cspParams);

            // Create a new XML document.
            XmlDocument xmlDoc = new()
            {
                // Load an XML file into the XmlDocument object.
                PreserveWhitespace = true
            };
            xmlDoc.Load("test.xml");

            // Sign the XML document.
            SignXml(xmlDoc, rsaKey);

            Console.WriteLine("XML file signed.");

            // Save the document.
            xmlDoc.Save("test.xml");
        }
        catch (Exception e)
        {
            Console.WriteLine(e.Message);
        }
    }

    // Sign an XML file.
    // This document cannot be verified unless the verifying
    // code has the key with which it was signed.
    public static void SignXml(XmlDocument xmlDoc, RSA rsaKey)
    {
        // Check arguments.
        if (xmlDoc == null)
            throw new ArgumentException(null, nameof(xmlDoc));
        if (rsaKey == null)
            throw new ArgumentException(null, nameof(rsaKey));

        // Create a SignedXml object.
        SignedXml signedXml = new(xmlDoc)
        {

            // Add the key to the SignedXml document.
            SigningKey = rsaKey
        };

        // Create a reference to be signed.
        Reference reference = new()
        {
            Uri = ""
        };

        // Add an enveloped transformation to the reference.
        XmlDsigEnvelopedSignatureTransform env = new();
        reference.AddTransform(env);

        // Add the reference to the SignedXml object.
        signedXml.AddReference(reference);

        // Compute the signature.
        signedXml.ComputeSignature();

        // Get the XML representation of the signature and save
        // it to an XmlElement object.
        XmlElement xmlDigitalSignature = signedXml.GetXml();

        // Append the element to the XML document.
        xmlDoc.DocumentElement?.AppendChild(xmlDoc.ImportNode(xmlDigitalSignature, true));
    }
}

Imports System.Security.Cryptography
Imports System.Security.Cryptography.Xml
Imports System.Xml

Module SignXML
    Sub Main(ByVal args() As String)
        Try
            ' Create a new CspParameters object to specify
            ' a key container.
            Dim cspParams As New CspParameters With {
                .KeyContainerName = "XML_DSIG_RSA_KEY"
            }
            ' Create a new RSA signing key and save it in the container. 
            Dim rsaKey As New RSACryptoServiceProvider(cspParams)
            ' Create a new XML document.
            ' Load an XML file into the XmlDocument object.
            Dim xmlDoc As New XmlDocument With {
                .PreserveWhitespace = True
            }
            xmlDoc.Load("test.xml")
            ' Sign the XML document. 
            SignXml(xmlDoc, rsaKey)

            Console.WriteLine("XML file signed.")

            ' Save the document.
            xmlDoc.Save("test.xml")
        Catch e As Exception
            Console.WriteLine(e.Message)
        End Try
    End Sub

    ' Sign an XML file. 
    ' This document cannot be verified unless the verifying 
    ' code has the key with which it was signed.
    Sub SignXml(ByVal xmlDoc As XmlDocument, ByVal rsaKey As RSA)
        ' Check arguments.
        If xmlDoc Is Nothing Then
            Throw New ArgumentException(
                "The XML doc cannot be nothing.", NameOf(xmlDoc))
        End If
        If rsaKey Is Nothing Then
            Throw New ArgumentException(
                "The RSA key cannot be nothing.", NameOf(rsaKey))
        End If
        ' Create a SignedXml object.
        Dim signedXml As New SignedXml(xmlDoc)
        ' Add the key to the SignedXml document.
        signedXml.SigningKey = rsaKey
        ' Create a reference to be signed.
        Dim reference As New Reference()
        reference.Uri = ""
        ' Add an enveloped transformation to the reference.
        Dim env As New XmlDsigEnvelopedSignatureTransform()
        reference.AddTransform(env)
        ' Add the reference to the SignedXml object.
        signedXml.AddReference(reference)
        ' Compute the signature.
        signedXml.ComputeSignature()
        ' Get the XML representation of the signature and save
        ' it to an XmlElement object.
        Dim xmlDigitalSignature As XmlElement = signedXml.GetXml()
        ' Append the element to the XML document.
        xmlDoc.DocumentElement.AppendChild(xmlDoc.ImportNode(xmlDigitalSignature, True))
    End Sub
End Module

コードのコンパイル

.NET Framework を対象とするプロジェクトでは、System.Security.dll への参照を含めます。
.NET Core または .NET 5 を対象とするプロジェクトでは、NuGet パッケージ System.Security.Cryptography.Xml をインストールします。
名前空間 System.Xml、System.Security.Cryptography、および System.Security.Cryptography.Xml を含めます。

.NET セキュリティ

非対称キーペアの秘密キーをプレーンテキストで保存または転送しないでください。対称および非対称暗号化キーの詳細については、「暗号化と復号化のためのキーの生成」を参照してください。

秘密キーをソースコードに直接埋め込まないでください。埋め込まれたキーは、Ildasm.exe (IL 逆アセンブラー) を使用するか、メモ帳などのテキストエディターでアセンブリを開くことで、アセンブリから簡単に読み取ることができます。

次の方法で共有

方法: デジタル署名で XML ドキュメントに署名する

XML ドキュメントにデジタル署名するには

例

コードのコンパイル

.NET セキュリティ

関連項目

その他のリソース