EncryptedXml.Encrypt Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Criptografa o XML externo de um elemento usando a chave ou o certificado especificado na tabela de mapeamento de chaves.
Sobrecargas
Encrypt(XmlElement, X509Certificate2) |
Criptografa o XML externo de um elemento usando o certificado X.509 especificado. |
Encrypt(XmlElement, String) |
Criptografa o XML externo de um elemento usando a chave especificada na tabela de mapeamento de chaves. |
Exemplos
O exemplo de código a seguir demonstra como criptografar um documento XML usando uma chave simétrica.
#using <System.Security.dll>
#using <System.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::Xml;
using namespace System::Security::Cryptography;
using namespace System::Security::Cryptography::Xml;
static void Encrypt( XmlDocument^ Doc, String^ ElementToEncrypt, SymmetricAlgorithm^ Alg, String^ KeyName )
{
// Check the arguments.
if ( Doc == nullptr )
throw gcnew ArgumentNullException( L"Doc" );
if ( ElementToEncrypt == nullptr )
throw gcnew ArgumentNullException( L"ElementToEncrypt" );
if ( Alg == nullptr )
throw gcnew ArgumentNullException( L"Alg" );
////////////////////////////////////////////////
// Find the specified element in the XmlDocument
// object and create a new XmlElemnt object.
////////////////////////////////////////////////
XmlElement^ elementToEncrypt = dynamic_cast<XmlElement^>(Doc->GetElementsByTagName( ElementToEncrypt )->Item( 0 ));
// Throw an XmlException if the element was not found.
if ( elementToEncrypt == nullptr )
{
throw gcnew XmlException( L"The specified element was not found" );
}
//////////////////////////////////////////////////
// Create a new instance of the EncryptedXml class
// and use it to encrypt the XmlElement with the
// symmetric key.
//////////////////////////////////////////////////
EncryptedXml^ eXml = gcnew EncryptedXml;
// Add the key mapping.
eXml->AddKeyNameMapping( KeyName, Alg );
// Encrypt the element.
EncryptedData^ edElement = eXml->Encrypt( elementToEncrypt, KeyName );
////////////////////////////////////////////////////
// Replace the element from the original XmlDocument
// object with the EncryptedData element.
////////////////////////////////////////////////////
EncryptedXml::ReplaceElement( elementToEncrypt, edElement, false );
}
static void Decrypt( XmlDocument^ Doc, SymmetricAlgorithm^ Alg, String^ KeyName )
{
// Check the arguments.
if ( Doc == nullptr )
throw gcnew ArgumentNullException( L"Doc" );
if ( Alg == nullptr )
throw gcnew ArgumentNullException( L"Alg" );
if ( KeyName == nullptr )
throw gcnew ArgumentNullException( L"KeyName" );
// Create a new EncryptedXml object.
EncryptedXml^ exml = gcnew EncryptedXml( Doc );
// Add the key name mapping.
exml->AddKeyNameMapping( KeyName, Alg );
// Decrypt the XML document.
exml->DecryptDocument();
}
int main()
{
// Create an XmlDocument object.
XmlDocument^ xmlDoc = gcnew XmlDocument;
// Load an XML file into the XmlDocument object.
try
{
xmlDoc->PreserveWhitespace = true;
xmlDoc->Load( L"test.xml" );
}
catch ( Exception^ e )
{
Console::WriteLine( e->Message );
}
// Create a new TripleDES key.
TripleDESCryptoServiceProvider^ tDESkey = gcnew TripleDESCryptoServiceProvider;
try
{
// Encrypt the "creditcard" element.
Encrypt( xmlDoc, L"creditcard", tDESkey, L"tDesKey" );
// Display the encrypted XML to the console.
Console::WriteLine( L"Encrypted XML:" );
Console::WriteLine();
Console::WriteLine( xmlDoc->OuterXml );
// Decrypt the "creditcard" element.
Decrypt( xmlDoc, tDESkey, L"tDesKey" );
// Display the encrypted XML to the console.
Console::WriteLine();
Console::WriteLine( L"Decrypted XML:" );
Console::WriteLine();
Console::WriteLine( xmlDoc->OuterXml );
}
catch ( Exception^ e )
{
Console::WriteLine( e->Message );
}
finally
{
// Clear the TripleDES key.
tDESkey->Clear();
}
}
using System;
using System.Xml;
using System.Security.Cryptography;
using System.Security.Cryptography.Xml;
class Program
{
static void Main(string[] args)
{
// Create an XmlDocument object.
XmlDocument xmlDoc = new XmlDocument();
// Load an XML file into the XmlDocument object.
try
{
xmlDoc.PreserveWhitespace = true;
xmlDoc.Load("test.xml");
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
// Create a new TripleDES key.
TripleDESCryptoServiceProvider tDESkey = new TripleDESCryptoServiceProvider();
try
{
// Encrypt the "creditcard" element.
Encrypt(xmlDoc, "creditcard", tDESkey, "tDesKey");
// Display the encrypted XML to the console.
Console.WriteLine("Encrypted XML:");
Console.WriteLine();
Console.WriteLine(xmlDoc.OuterXml);
// Decrypt the "creditcard" element.
Decrypt(xmlDoc, tDESkey, "tDesKey");
// Display the encrypted XML to the console.
Console.WriteLine();
Console.WriteLine("Decrypted XML:");
Console.WriteLine();
Console.WriteLine(xmlDoc.OuterXml);
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
finally
{
// Clear the TripleDES key.
tDESkey.Clear();
}
}
public static void Encrypt(XmlDocument Doc, string ElementToEncrypt, SymmetricAlgorithm Alg, string KeyName)
{
// Check the arguments.
if (Doc == null)
throw new ArgumentNullException("Doc");
if (ElementToEncrypt == null)
throw new ArgumentNullException("ElementToEncrypt");
if (Alg == null)
throw new ArgumentNullException("Alg");
////////////////////////////////////////////////
// Find the specified element in the XmlDocument
// object and create a new XmlElemnt object.
////////////////////////////////////////////////
XmlElement elementToEncrypt = Doc.GetElementsByTagName(ElementToEncrypt)[0] as XmlElement;
// Throw an XmlException if the element was not found.
if (elementToEncrypt == null)
{
throw new XmlException("The specified element was not found");
}
//////////////////////////////////////////////////
// Create a new instance of the EncryptedXml class
// and use it to encrypt the XmlElement with the
// symmetric key.
//////////////////////////////////////////////////
EncryptedXml eXml = new EncryptedXml();
// Add the key mapping.
eXml.AddKeyNameMapping(KeyName, Alg);
// Encrypt the element.
EncryptedData edElement = eXml.Encrypt(elementToEncrypt, KeyName);
////////////////////////////////////////////////////
// Replace the element from the original XmlDocument
// object with the EncryptedData element.
////////////////////////////////////////////////////
EncryptedXml.ReplaceElement(elementToEncrypt, edElement, false);
}
public static void Decrypt(XmlDocument Doc, SymmetricAlgorithm Alg, string KeyName)
{
// Check the arguments.
if (Doc == null)
throw new ArgumentNullException("Doc");
if (Alg == null)
throw new ArgumentNullException("Alg");
if (KeyName == null)
throw new ArgumentNullException("KeyName");
// Create a new EncryptedXml object.
EncryptedXml exml = new EncryptedXml(Doc);
// Add the key name mapping.
exml.AddKeyNameMapping(KeyName, Alg);
// Decrypt the XML document.
exml.DecryptDocument();
}
}
Imports System.Xml
Imports System.Security.Cryptography
Imports System.Security.Cryptography.Xml
Module Program
Sub Main(ByVal args() As String)
' Create an XmlDocument object.
Dim xmlDoc As New XmlDocument()
' Load an XML file into the XmlDocument object.
Try
xmlDoc.PreserveWhitespace = True
xmlDoc.Load("test.xml")
Catch e As Exception
Console.WriteLine(e.Message)
End Try
' Create a new TripleDES key.
Dim tDESkey As New TripleDESCryptoServiceProvider()
Try
' Encrypt the "creditcard" element.
Encrypt(xmlDoc, "creditcard", tDESkey, "tDesKey")
' Display the encrypted XML to the console.
Console.WriteLine("Encrypted XML:")
Console.WriteLine()
Console.WriteLine(xmlDoc.OuterXml)
' Decrypt the "creditcard" element.
Decrypt(xmlDoc, tDESkey, "tDesKey")
' Display the encrypted XML to the console.
Console.WriteLine()
Console.WriteLine("Decrypted XML:")
Console.WriteLine()
Console.WriteLine(xmlDoc.OuterXml)
Catch e As Exception
Console.WriteLine(e.Message)
Finally
' Clear the TripleDES key.
tDESkey.Clear()
End Try
End Sub
Sub Encrypt(ByVal Doc As XmlDocument, ByVal ElementToEncrypt As String, ByVal Alg As SymmetricAlgorithm, ByVal KeyName As String)
' Check the arguments.
If Doc Is Nothing Then
Throw New ArgumentNullException("Doc")
End If
If ElementToEncrypt Is Nothing Then
Throw New ArgumentNullException("ElementToEncrypt")
End If
If Alg Is Nothing Then
Throw New ArgumentNullException("Alg")
End If
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Find the specified element in the XmlDocument
' object and create a new XmlElemnt object.
'''''''''''''''''''''''''''''''''''''''''''''''''''
Dim elementEncrypt As XmlElement = Doc.GetElementsByTagName(ElementToEncrypt)(0)
' Throw an XmlException if the element was not found.
If ElementToEncrypt Is Nothing Then
Throw New XmlException("The specified element was not found")
End If
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Create a new instance of the EncryptedXml class
' and use it to encrypt the XmlElement with the
' symmetric key.
'''''''''''''''''''''''''''''''''''''''''''''''''''
Dim eXml As New EncryptedXml()
' Add the key mapping.
eXml.AddKeyNameMapping(KeyName, Alg)
' Encrypt the element.
Dim edElement As EncryptedData = eXml.Encrypt(elementEncrypt, KeyName)
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Replace the element from the original XmlDocument
' object with the EncryptedData element.
'''''''''''''''''''''''''''''''''''''''''''''''''''
EncryptedXml.ReplaceElement(elementEncrypt, edElement, False)
End Sub
Sub Decrypt(ByVal Doc As XmlDocument, ByVal Alg As SymmetricAlgorithm, ByVal KeyName As String)
' Check the arguments.
If Doc Is Nothing Then
Throw New ArgumentNullException("Doc")
End If
If Alg Is Nothing Then
Throw New ArgumentNullException("Alg")
End If
If KeyName Is Nothing Then
Throw New ArgumentNullException("KeyName")
End If
' Create a new EncryptedXml object.
Dim exml As New EncryptedXml(Doc)
' Add the key name mapping.
exml.AddKeyNameMapping(KeyName, Alg)
' Decrypt the XML document.
exml.DecryptDocument()
End Sub
End Module
O exemplo de código a seguir demonstra como criptografar um documento XML usando um certificado X.509. Este exemplo cria uma chave de sessão simétrica para criptografar o documento e usa o certificado X.509 para inserir uma versão criptografada da chave de sessão no documento XML.
#using <System.Security.dll>
#using <System.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::Xml;
using namespace System::Security::Cryptography;
using namespace System::Security::Cryptography::Xml;
using namespace System::Security::Cryptography::X509Certificates;
static void Encrypt( XmlDocument^ Doc, String^ ElementToEncrypt, X509Certificate2^ Cert )
{
// Check the arguments.
if ( Doc == nullptr )
throw gcnew ArgumentNullException( L"Doc" );
if ( ElementToEncrypt == nullptr )
throw gcnew ArgumentNullException( L"ElementToEncrypt" );
if ( Cert == nullptr )
throw gcnew ArgumentNullException( L"Cert" );
////////////////////////////////////////////////
// Find the specified element in the XmlDocument
// object and create a new XmlElemnt object.
////////////////////////////////////////////////
XmlElement^ elementToEncrypt = dynamic_cast<XmlElement^>(Doc->GetElementsByTagName( ElementToEncrypt )->Item( 0 ));
// Throw an XmlException if the element was not found.
if ( elementToEncrypt == nullptr )
{
throw gcnew XmlException( L"The specified element was not found" );
}
//////////////////////////////////////////////////
// Create a new instance of the EncryptedXml class
// and use it to encrypt the XmlElement with the
// X.509 Certificate.
//////////////////////////////////////////////////
EncryptedXml^ eXml = gcnew EncryptedXml;
// Encrypt the element.
EncryptedData^ edElement = eXml->Encrypt( elementToEncrypt, Cert );
////////////////////////////////////////////////////
// Replace the element from the original XmlDocument
// object with the EncryptedData element.
////////////////////////////////////////////////////
EncryptedXml::ReplaceElement( elementToEncrypt, edElement, false );
}
static void Decrypt( XmlDocument^ Doc )
{
// Check the arguments.
if ( Doc == nullptr )
throw gcnew ArgumentNullException( L"Doc" );
// Create a new EncryptedXml object.
EncryptedXml^ exml = gcnew EncryptedXml( Doc );
// Decrypt the XML document.
exml->DecryptDocument();
}
int main()
{
// Create an XmlDocument object.
XmlDocument^ xmlDoc = gcnew XmlDocument;
// Load an XML file into the XmlDocument object.
try
{
xmlDoc->PreserveWhitespace = true;
xmlDoc->Load( L"test.xml" );
}
catch ( Exception^ e )
{
Console::WriteLine( e->Message );
return 0;
}
// Create a new X509Certificate2 object by loading
// an X.509 certificate file. To use XML encryption
// with an X.509 certificate, use an X509Certificate2
// object to encrypt, but use a certificate in a certificate
// store to decrypt.
// You can create a new test certificate file using the
// makecert.exe tool.
// Create an X509Certificate2 object for encryption.
X509Certificate2^ cert = gcnew X509Certificate2( L"test.pfx" );
// Put the certificate in certificate store for decryption.
X509Store^ store = gcnew X509Store( StoreLocation::CurrentUser );
store->Open( OpenFlags::ReadWrite );
store->Add( cert );
store->Close();
try
{
// Encrypt the "creditcard" element.
Encrypt( xmlDoc, L"creditcard", cert );
// Display the encrypted XML to the console.
Console::WriteLine( L"Encrypted XML:" );
Console::WriteLine();
Console::WriteLine( xmlDoc->OuterXml );
// Decrypt the "creditcard" element.
Decrypt( xmlDoc );
// Display the encrypted XML to the console.
Console::WriteLine();
Console::WriteLine( L"Decrypted XML:" );
Console::WriteLine();
Console::WriteLine( xmlDoc->OuterXml );
}
catch ( Exception^ e )
{
Console::WriteLine( e->Message );
}
return 1;
}
using System;
using System.Xml;
using System.Security.Cryptography;
using System.Security.Cryptography.Xml;
using System.Security.Cryptography.X509Certificates;
class Program
{
static void Main(string[] args)
{
// Create an XmlDocument object.
XmlDocument xmlDoc = new XmlDocument();
// Load an XML file into the XmlDocument object.
try
{
xmlDoc.PreserveWhitespace = true;
xmlDoc.Load("test.xml");
}
catch (Exception e)
{
Console.WriteLine(e.Message);
return;
}
// Create a new X509Certificate2 object by loading
// an X.509 certificate file. To use XML encryption
// with an X.509 certificate, use an X509Certificate2
// object to encrypt, but use a certificate in a certificate
// store to decrypt.
// You can create a new test certificate file using the
// makecert.exe tool.
// Create an X509Certificate2 object for encryption.
X509Certificate2 cert = new X509Certificate2("test.pfx");
// Put the certificate in certificate store for decryption.
X509Store store = new X509Store(StoreLocation.CurrentUser);
store.Open(OpenFlags.ReadWrite);
store.Add(cert);
store.Close();
try
{
// Encrypt the "creditcard" element.
Encrypt(xmlDoc, "creditcard", cert);
// Display the encrypted XML to the console.
Console.WriteLine("Encrypted XML:");
Console.WriteLine();
Console.WriteLine(xmlDoc.OuterXml);
// Decrypt the "creditcard" element.
Decrypt(xmlDoc);
// Display the encrypted XML to the console.
Console.WriteLine();
Console.WriteLine("Decrypted XML:");
Console.WriteLine();
Console.WriteLine(xmlDoc.OuterXml);
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
}
public static void Encrypt(XmlDocument Doc, string ElementToEncrypt, X509Certificate2 Cert)
{
// Check the arguments.
if (Doc == null)
throw new ArgumentNullException("Doc");
if (ElementToEncrypt == null)
throw new ArgumentNullException("ElementToEncrypt");
if (Cert == null)
throw new ArgumentNullException("Cert");
////////////////////////////////////////////////
// Find the specified element in the XmlDocument
// object and create a new XmlElemnt object.
////////////////////////////////////////////////
XmlElement elementToEncrypt = Doc.GetElementsByTagName(ElementToEncrypt)[0] as XmlElement;
// Throw an XmlException if the element was not found.
if (elementToEncrypt == null)
{
throw new XmlException("The specified element was not found");
}
//////////////////////////////////////////////////
// Create a new instance of the EncryptedXml class
// and use it to encrypt the XmlElement with the
// X.509 Certificate.
//////////////////////////////////////////////////
EncryptedXml eXml = new EncryptedXml();
// Encrypt the element.
EncryptedData edElement = eXml.Encrypt(elementToEncrypt, Cert);
////////////////////////////////////////////////////
// Replace the element from the original XmlDocument
// object with the EncryptedData element.
////////////////////////////////////////////////////
EncryptedXml.ReplaceElement(elementToEncrypt, edElement, false);
}
public static void Decrypt(XmlDocument Doc)
{
// Check the arguments.
if (Doc == null)
throw new ArgumentNullException("Doc");
// Create a new EncryptedXml object.
EncryptedXml exml = new EncryptedXml(Doc);
// Decrypt the XML document.
exml.DecryptDocument();
}
}
Imports System.Xml
Imports System.Security.Cryptography
Imports System.Security.Cryptography.Xml
Imports System.Security.Cryptography.X509Certificates
Module Program
Sub Main(ByVal args() As String)
' Create an XmlDocument object.
Dim xmlDoc As New XmlDocument()
' Load an XML file into the XmlDocument object.
Try
xmlDoc.PreserveWhitespace = True
xmlDoc.Load("test.xml")
Catch e As Exception
Console.WriteLine(e.Message)
Return
End Try
' Create a new X509Certificate2 object by loading
' an X.509 certificate file. To use XML encryption
' with an X.509 certificate, use an X509Certificate2
' object to encrypt, but use a certificate in a certificate
' store to decrypt.
' You can create a new test certificate file using the
' makecert.exe tool.
' Create an X509Certificate2 object for encryption.
Dim cert As New X509Certificate2("test.pfx")
' Put the certificate in certificate store for decryption.
Dim store As New X509Store(StoreLocation.CurrentUser)
store.Open(OpenFlags.ReadWrite)
store.Add(cert)
store.Close()
Try
' Encrypt the "creditcard" element.
Encrypt(xmlDoc, "creditcard", cert)
' Display the encrypted XML to the console.
Console.WriteLine("Encrypted XML:")
Console.WriteLine()
Console.WriteLine(xmlDoc.OuterXml)
' Decrypt the "creditcard" element.
Decrypt(xmlDoc)
' Display the encrypted XML to the console.
Console.WriteLine()
Console.WriteLine("Decrypted XML:")
Console.WriteLine()
Console.WriteLine(xmlDoc.OuterXml)
Catch e As Exception
Console.WriteLine(e.Message)
End Try
End Sub
Sub Encrypt(ByVal Doc As XmlDocument, ByVal ElementToEncrypt As String, ByVal Cert As X509Certificate2)
' Check the arguments.
If Doc Is Nothing Then
Throw New ArgumentNullException("Doc")
End If
If ElementToEncrypt Is Nothing Then
Throw New ArgumentNullException("ElementToEncrypt")
End If
If Cert Is Nothing Then
Throw New ArgumentNullException("Cert")
End If
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Find the specified element in the XmlDocument
' object and create a new XmlElemnt object.
'''''''''''''''''''''''''''''''''''''''''''''''''''
Dim elementEncrypt As XmlElement = Doc.GetElementsByTagName(ElementToEncrypt)(0)
' Throw an XmlException if the element was not found.
If elementToEncrypt Is Nothing Then
Throw New XmlException("The specified element was not found")
End If
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Create a new instance of the EncryptedXml class
' and use it to encrypt the XmlElement with the
' X.509 Certificate.
'''''''''''''''''''''''''''''''''''''''''''''''''''
Dim eXml As New EncryptedXml()
' Encrypt the element.
Dim edElement As EncryptedData = eXml.Encrypt(elementEncrypt, Cert)
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Replace the element from the original XmlDocument
' object with the EncryptedData element.
'''''''''''''''''''''''''''''''''''''''''''''''''''
EncryptedXml.ReplaceElement(elementEncrypt, edElement, False)
End Sub
Sub Decrypt(ByVal Doc As XmlDocument)
' Check the arguments.
If Doc Is Nothing Then
Throw New ArgumentNullException("Doc")
End If
' Create a new EncryptedXml object.
Dim exml As New EncryptedXml(Doc)
' Decrypt the XML document.
exml.DecryptDocument()
End Sub
End Module
Encrypt(XmlElement, X509Certificate2)
- Origem:
- EncryptedXml.cs
- Origem:
- EncryptedXml.cs
- Origem:
- EncryptedXml.cs
- Origem:
- EncryptedXml.cs
- Origem:
- EncryptedXml.cs
Criptografa o XML externo de um elemento usando o certificado X.509 especificado.
public:
System::Security::Cryptography::Xml::EncryptedData ^ Encrypt(System::Xml::XmlElement ^ inputElement, System::Security::Cryptography::X509Certificates::X509Certificate2 ^ certificate);
public System.Security.Cryptography.Xml.EncryptedData Encrypt (System.Xml.XmlElement inputElement, System.Security.Cryptography.X509Certificates.X509Certificate2 certificate);
member this.Encrypt : System.Xml.XmlElement * System.Security.Cryptography.X509Certificates.X509Certificate2 -> System.Security.Cryptography.Xml.EncryptedData
Public Function Encrypt (inputElement As XmlElement, certificate As X509Certificate2) As EncryptedData
Parâmetros
- inputElement
- XmlElement
O elemento XML a ser criptografado.
- certificate
- X509Certificate2
O certificado X.509 a ser usado para criptografia.
Retornos
Um elemento EncryptedData que representa os dados XML criptografados.
Exceções
O valor do parâmetro inputElement
é null
.
- ou -
O valor do parâmetro certificate
é null
.
O valor do parâmetro certificate
não representa um algoritmo de chave RSA.
Exemplos
O exemplo de código a seguir demonstra como criptografar um documento XML usando um certificado X.509. Este exemplo cria uma chave de sessão simétrica para criptografar o documento e usa o certificado X.509 para inserir uma versão criptografada da chave de sessão no documento XML.
#using <System.Security.dll>
#using <System.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::Xml;
using namespace System::Security::Cryptography;
using namespace System::Security::Cryptography::Xml;
using namespace System::Security::Cryptography::X509Certificates;
static void Encrypt( XmlDocument^ Doc, String^ ElementToEncrypt, X509Certificate2^ Cert )
{
// Check the arguments.
if ( Doc == nullptr )
throw gcnew ArgumentNullException( L"Doc" );
if ( ElementToEncrypt == nullptr )
throw gcnew ArgumentNullException( L"ElementToEncrypt" );
if ( Cert == nullptr )
throw gcnew ArgumentNullException( L"Cert" );
////////////////////////////////////////////////
// Find the specified element in the XmlDocument
// object and create a new XmlElemnt object.
////////////////////////////////////////////////
XmlElement^ elementToEncrypt = dynamic_cast<XmlElement^>(Doc->GetElementsByTagName( ElementToEncrypt )->Item( 0 ));
// Throw an XmlException if the element was not found.
if ( elementToEncrypt == nullptr )
{
throw gcnew XmlException( L"The specified element was not found" );
}
//////////////////////////////////////////////////
// Create a new instance of the EncryptedXml class
// and use it to encrypt the XmlElement with the
// X.509 Certificate.
//////////////////////////////////////////////////
EncryptedXml^ eXml = gcnew EncryptedXml;
// Encrypt the element.
EncryptedData^ edElement = eXml->Encrypt( elementToEncrypt, Cert );
////////////////////////////////////////////////////
// Replace the element from the original XmlDocument
// object with the EncryptedData element.
////////////////////////////////////////////////////
EncryptedXml::ReplaceElement( elementToEncrypt, edElement, false );
}
static void Decrypt( XmlDocument^ Doc )
{
// Check the arguments.
if ( Doc == nullptr )
throw gcnew ArgumentNullException( L"Doc" );
// Create a new EncryptedXml object.
EncryptedXml^ exml = gcnew EncryptedXml( Doc );
// Decrypt the XML document.
exml->DecryptDocument();
}
int main()
{
// Create an XmlDocument object.
XmlDocument^ xmlDoc = gcnew XmlDocument;
// Load an XML file into the XmlDocument object.
try
{
xmlDoc->PreserveWhitespace = true;
xmlDoc->Load( L"test.xml" );
}
catch ( Exception^ e )
{
Console::WriteLine( e->Message );
return 0;
}
// Create a new X509Certificate2 object by loading
// an X.509 certificate file. To use XML encryption
// with an X.509 certificate, use an X509Certificate2
// object to encrypt, but use a certificate in a certificate
// store to decrypt.
// You can create a new test certificate file using the
// makecert.exe tool.
// Create an X509Certificate2 object for encryption.
X509Certificate2^ cert = gcnew X509Certificate2( L"test.pfx" );
// Put the certificate in certificate store for decryption.
X509Store^ store = gcnew X509Store( StoreLocation::CurrentUser );
store->Open( OpenFlags::ReadWrite );
store->Add( cert );
store->Close();
try
{
// Encrypt the "creditcard" element.
Encrypt( xmlDoc, L"creditcard", cert );
// Display the encrypted XML to the console.
Console::WriteLine( L"Encrypted XML:" );
Console::WriteLine();
Console::WriteLine( xmlDoc->OuterXml );
// Decrypt the "creditcard" element.
Decrypt( xmlDoc );
// Display the encrypted XML to the console.
Console::WriteLine();
Console::WriteLine( L"Decrypted XML:" );
Console::WriteLine();
Console::WriteLine( xmlDoc->OuterXml );
}
catch ( Exception^ e )
{
Console::WriteLine( e->Message );
}
return 1;
}
using System;
using System.Xml;
using System.Security.Cryptography;
using System.Security.Cryptography.Xml;
using System.Security.Cryptography.X509Certificates;
class Program
{
static void Main(string[] args)
{
// Create an XmlDocument object.
XmlDocument xmlDoc = new XmlDocument();
// Load an XML file into the XmlDocument object.
try
{
xmlDoc.PreserveWhitespace = true;
xmlDoc.Load("test.xml");
}
catch (Exception e)
{
Console.WriteLine(e.Message);
return;
}
// Create a new X509Certificate2 object by loading
// an X.509 certificate file. To use XML encryption
// with an X.509 certificate, use an X509Certificate2
// object to encrypt, but use a certificate in a certificate
// store to decrypt.
// You can create a new test certificate file using the
// makecert.exe tool.
// Create an X509Certificate2 object for encryption.
X509Certificate2 cert = new X509Certificate2("test.pfx");
// Put the certificate in certificate store for decryption.
X509Store store = new X509Store(StoreLocation.CurrentUser);
store.Open(OpenFlags.ReadWrite);
store.Add(cert);
store.Close();
try
{
// Encrypt the "creditcard" element.
Encrypt(xmlDoc, "creditcard", cert);
// Display the encrypted XML to the console.
Console.WriteLine("Encrypted XML:");
Console.WriteLine();
Console.WriteLine(xmlDoc.OuterXml);
// Decrypt the "creditcard" element.
Decrypt(xmlDoc);
// Display the encrypted XML to the console.
Console.WriteLine();
Console.WriteLine("Decrypted XML:");
Console.WriteLine();
Console.WriteLine(xmlDoc.OuterXml);
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
}
public static void Encrypt(XmlDocument Doc, string ElementToEncrypt, X509Certificate2 Cert)
{
// Check the arguments.
if (Doc == null)
throw new ArgumentNullException("Doc");
if (ElementToEncrypt == null)
throw new ArgumentNullException("ElementToEncrypt");
if (Cert == null)
throw new ArgumentNullException("Cert");
////////////////////////////////////////////////
// Find the specified element in the XmlDocument
// object and create a new XmlElemnt object.
////////////////////////////////////////////////
XmlElement elementToEncrypt = Doc.GetElementsByTagName(ElementToEncrypt)[0] as XmlElement;
// Throw an XmlException if the element was not found.
if (elementToEncrypt == null)
{
throw new XmlException("The specified element was not found");
}
//////////////////////////////////////////////////
// Create a new instance of the EncryptedXml class
// and use it to encrypt the XmlElement with the
// X.509 Certificate.
//////////////////////////////////////////////////
EncryptedXml eXml = new EncryptedXml();
// Encrypt the element.
EncryptedData edElement = eXml.Encrypt(elementToEncrypt, Cert);
////////////////////////////////////////////////////
// Replace the element from the original XmlDocument
// object with the EncryptedData element.
////////////////////////////////////////////////////
EncryptedXml.ReplaceElement(elementToEncrypt, edElement, false);
}
public static void Decrypt(XmlDocument Doc)
{
// Check the arguments.
if (Doc == null)
throw new ArgumentNullException("Doc");
// Create a new EncryptedXml object.
EncryptedXml exml = new EncryptedXml(Doc);
// Decrypt the XML document.
exml.DecryptDocument();
}
}
Imports System.Xml
Imports System.Security.Cryptography
Imports System.Security.Cryptography.Xml
Imports System.Security.Cryptography.X509Certificates
Module Program
Sub Main(ByVal args() As String)
' Create an XmlDocument object.
Dim xmlDoc As New XmlDocument()
' Load an XML file into the XmlDocument object.
Try
xmlDoc.PreserveWhitespace = True
xmlDoc.Load("test.xml")
Catch e As Exception
Console.WriteLine(e.Message)
Return
End Try
' Create a new X509Certificate2 object by loading
' an X.509 certificate file. To use XML encryption
' with an X.509 certificate, use an X509Certificate2
' object to encrypt, but use a certificate in a certificate
' store to decrypt.
' You can create a new test certificate file using the
' makecert.exe tool.
' Create an X509Certificate2 object for encryption.
Dim cert As New X509Certificate2("test.pfx")
' Put the certificate in certificate store for decryption.
Dim store As New X509Store(StoreLocation.CurrentUser)
store.Open(OpenFlags.ReadWrite)
store.Add(cert)
store.Close()
Try
' Encrypt the "creditcard" element.
Encrypt(xmlDoc, "creditcard", cert)
' Display the encrypted XML to the console.
Console.WriteLine("Encrypted XML:")
Console.WriteLine()
Console.WriteLine(xmlDoc.OuterXml)
' Decrypt the "creditcard" element.
Decrypt(xmlDoc)
' Display the encrypted XML to the console.
Console.WriteLine()
Console.WriteLine("Decrypted XML:")
Console.WriteLine()
Console.WriteLine(xmlDoc.OuterXml)
Catch e As Exception
Console.WriteLine(e.Message)
End Try
End Sub
Sub Encrypt(ByVal Doc As XmlDocument, ByVal ElementToEncrypt As String, ByVal Cert As X509Certificate2)
' Check the arguments.
If Doc Is Nothing Then
Throw New ArgumentNullException("Doc")
End If
If ElementToEncrypt Is Nothing Then
Throw New ArgumentNullException("ElementToEncrypt")
End If
If Cert Is Nothing Then
Throw New ArgumentNullException("Cert")
End If
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Find the specified element in the XmlDocument
' object and create a new XmlElemnt object.
'''''''''''''''''''''''''''''''''''''''''''''''''''
Dim elementEncrypt As XmlElement = Doc.GetElementsByTagName(ElementToEncrypt)(0)
' Throw an XmlException if the element was not found.
If elementToEncrypt Is Nothing Then
Throw New XmlException("The specified element was not found")
End If
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Create a new instance of the EncryptedXml class
' and use it to encrypt the XmlElement with the
' X.509 Certificate.
'''''''''''''''''''''''''''''''''''''''''''''''''''
Dim eXml As New EncryptedXml()
' Encrypt the element.
Dim edElement As EncryptedData = eXml.Encrypt(elementEncrypt, Cert)
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Replace the element from the original XmlDocument
' object with the EncryptedData element.
'''''''''''''''''''''''''''''''''''''''''''''''''''
EncryptedXml.ReplaceElement(elementEncrypt, edElement, False)
End Sub
Sub Decrypt(ByVal Doc As XmlDocument)
' Check the arguments.
If Doc Is Nothing Then
Throw New ArgumentNullException("Doc")
End If
' Create a new EncryptedXml object.
Dim exml As New EncryptedXml(Doc)
' Decrypt the XML document.
exml.DecryptDocument()
End Sub
End Module
Comentários
O Encrypt método é uma maneira conveniente de criptografar o XML externo de um elemento usando um certificado. Esse método gera uma chave de sessão AES (Advanced Encryption Standard) de 256 bits para criptografar um elemento XML e criptografa e assina a chave AES usando o X509Certificate2 objeto . Em Encrypt seguida, o método retorna o XML resultante como um EncryptedData elemento .
Se você precisar de mais controle sobre a criptografia, para que possa colocar as informações criptografadas em um <CipherReference>
elemento ou especificar se todo o elemento XML ou apenas seu conteúdo deve ser criptografado, use as sobrecargas do EncryptData método.
Para usar a Criptografia XML com certificados X.509, você deve ter o Provedor criptográfico avançado da Microsoft instalado e o certificado X.509 deve usar o Provedor Avançado. Se você não tiver o Provedor criptográfico avançado da Microsoft instalado ou o certificado X.509 não usar o Provedor Avançado, um CryptographicException com um "Erro Desconhecido" será gerado quando você descriptografar um documento XML.
Aplica-se a
Encrypt(XmlElement, String)
- Origem:
- EncryptedXml.cs
- Origem:
- EncryptedXml.cs
- Origem:
- EncryptedXml.cs
- Origem:
- EncryptedXml.cs
- Origem:
- EncryptedXml.cs
Criptografa o XML externo de um elemento usando a chave especificada na tabela de mapeamento de chaves.
public:
System::Security::Cryptography::Xml::EncryptedData ^ Encrypt(System::Xml::XmlElement ^ inputElement, System::String ^ keyName);
public System.Security.Cryptography.Xml.EncryptedData Encrypt (System.Xml.XmlElement inputElement, string keyName);
member this.Encrypt : System.Xml.XmlElement * string -> System.Security.Cryptography.Xml.EncryptedData
Public Function Encrypt (inputElement As XmlElement, keyName As String) As EncryptedData
Parâmetros
- inputElement
- XmlElement
O elemento XML a ser criptografado.
- keyName
- String
Um nome de chave que pode ser encontrado na tabela de mapeamento de chaves.
Retornos
Um objeto EncryptedData que representa os dados XML criptografados.
Exceções
O valor do parâmetro inputElement
é null
.
- ou -
O valor do parâmetro keyName
é null
.
O valor do parâmetro keyName
não corresponde a um par de nome de chave registrado.
- ou -
A chave de criptografia descrita pelo parâmetro keyName
não tem suporte.
Exemplos
O exemplo de código a seguir demonstra como criptografar um documento XML usando uma chave simétrica.
#using <System.Security.dll>
#using <System.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::Xml;
using namespace System::Security::Cryptography;
using namespace System::Security::Cryptography::Xml;
static void Encrypt( XmlDocument^ Doc, String^ ElementToEncrypt, SymmetricAlgorithm^ Alg, String^ KeyName )
{
// Check the arguments.
if ( Doc == nullptr )
throw gcnew ArgumentNullException( L"Doc" );
if ( ElementToEncrypt == nullptr )
throw gcnew ArgumentNullException( L"ElementToEncrypt" );
if ( Alg == nullptr )
throw gcnew ArgumentNullException( L"Alg" );
////////////////////////////////////////////////
// Find the specified element in the XmlDocument
// object and create a new XmlElemnt object.
////////////////////////////////////////////////
XmlElement^ elementToEncrypt = dynamic_cast<XmlElement^>(Doc->GetElementsByTagName( ElementToEncrypt )->Item( 0 ));
// Throw an XmlException if the element was not found.
if ( elementToEncrypt == nullptr )
{
throw gcnew XmlException( L"The specified element was not found" );
}
//////////////////////////////////////////////////
// Create a new instance of the EncryptedXml class
// and use it to encrypt the XmlElement with the
// symmetric key.
//////////////////////////////////////////////////
EncryptedXml^ eXml = gcnew EncryptedXml;
// Add the key mapping.
eXml->AddKeyNameMapping( KeyName, Alg );
// Encrypt the element.
EncryptedData^ edElement = eXml->Encrypt( elementToEncrypt, KeyName );
////////////////////////////////////////////////////
// Replace the element from the original XmlDocument
// object with the EncryptedData element.
////////////////////////////////////////////////////
EncryptedXml::ReplaceElement( elementToEncrypt, edElement, false );
}
static void Decrypt( XmlDocument^ Doc, SymmetricAlgorithm^ Alg, String^ KeyName )
{
// Check the arguments.
if ( Doc == nullptr )
throw gcnew ArgumentNullException( L"Doc" );
if ( Alg == nullptr )
throw gcnew ArgumentNullException( L"Alg" );
if ( KeyName == nullptr )
throw gcnew ArgumentNullException( L"KeyName" );
// Create a new EncryptedXml object.
EncryptedXml^ exml = gcnew EncryptedXml( Doc );
// Add the key name mapping.
exml->AddKeyNameMapping( KeyName, Alg );
// Decrypt the XML document.
exml->DecryptDocument();
}
int main()
{
// Create an XmlDocument object.
XmlDocument^ xmlDoc = gcnew XmlDocument;
// Load an XML file into the XmlDocument object.
try
{
xmlDoc->PreserveWhitespace = true;
xmlDoc->Load( L"test.xml" );
}
catch ( Exception^ e )
{
Console::WriteLine( e->Message );
}
// Create a new TripleDES key.
TripleDESCryptoServiceProvider^ tDESkey = gcnew TripleDESCryptoServiceProvider;
try
{
// Encrypt the "creditcard" element.
Encrypt( xmlDoc, L"creditcard", tDESkey, L"tDesKey" );
// Display the encrypted XML to the console.
Console::WriteLine( L"Encrypted XML:" );
Console::WriteLine();
Console::WriteLine( xmlDoc->OuterXml );
// Decrypt the "creditcard" element.
Decrypt( xmlDoc, tDESkey, L"tDesKey" );
// Display the encrypted XML to the console.
Console::WriteLine();
Console::WriteLine( L"Decrypted XML:" );
Console::WriteLine();
Console::WriteLine( xmlDoc->OuterXml );
}
catch ( Exception^ e )
{
Console::WriteLine( e->Message );
}
finally
{
// Clear the TripleDES key.
tDESkey->Clear();
}
}
using System;
using System.Xml;
using System.Security.Cryptography;
using System.Security.Cryptography.Xml;
class Program
{
static void Main(string[] args)
{
// Create an XmlDocument object.
XmlDocument xmlDoc = new XmlDocument();
// Load an XML file into the XmlDocument object.
try
{
xmlDoc.PreserveWhitespace = true;
xmlDoc.Load("test.xml");
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
// Create a new TripleDES key.
TripleDESCryptoServiceProvider tDESkey = new TripleDESCryptoServiceProvider();
try
{
// Encrypt the "creditcard" element.
Encrypt(xmlDoc, "creditcard", tDESkey, "tDesKey");
// Display the encrypted XML to the console.
Console.WriteLine("Encrypted XML:");
Console.WriteLine();
Console.WriteLine(xmlDoc.OuterXml);
// Decrypt the "creditcard" element.
Decrypt(xmlDoc, tDESkey, "tDesKey");
// Display the encrypted XML to the console.
Console.WriteLine();
Console.WriteLine("Decrypted XML:");
Console.WriteLine();
Console.WriteLine(xmlDoc.OuterXml);
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
finally
{
// Clear the TripleDES key.
tDESkey.Clear();
}
}
public static void Encrypt(XmlDocument Doc, string ElementToEncrypt, SymmetricAlgorithm Alg, string KeyName)
{
// Check the arguments.
if (Doc == null)
throw new ArgumentNullException("Doc");
if (ElementToEncrypt == null)
throw new ArgumentNullException("ElementToEncrypt");
if (Alg == null)
throw new ArgumentNullException("Alg");
////////////////////////////////////////////////
// Find the specified element in the XmlDocument
// object and create a new XmlElemnt object.
////////////////////////////////////////////////
XmlElement elementToEncrypt = Doc.GetElementsByTagName(ElementToEncrypt)[0] as XmlElement;
// Throw an XmlException if the element was not found.
if (elementToEncrypt == null)
{
throw new XmlException("The specified element was not found");
}
//////////////////////////////////////////////////
// Create a new instance of the EncryptedXml class
// and use it to encrypt the XmlElement with the
// symmetric key.
//////////////////////////////////////////////////
EncryptedXml eXml = new EncryptedXml();
// Add the key mapping.
eXml.AddKeyNameMapping(KeyName, Alg);
// Encrypt the element.
EncryptedData edElement = eXml.Encrypt(elementToEncrypt, KeyName);
////////////////////////////////////////////////////
// Replace the element from the original XmlDocument
// object with the EncryptedData element.
////////////////////////////////////////////////////
EncryptedXml.ReplaceElement(elementToEncrypt, edElement, false);
}
public static void Decrypt(XmlDocument Doc, SymmetricAlgorithm Alg, string KeyName)
{
// Check the arguments.
if (Doc == null)
throw new ArgumentNullException("Doc");
if (Alg == null)
throw new ArgumentNullException("Alg");
if (KeyName == null)
throw new ArgumentNullException("KeyName");
// Create a new EncryptedXml object.
EncryptedXml exml = new EncryptedXml(Doc);
// Add the key name mapping.
exml.AddKeyNameMapping(KeyName, Alg);
// Decrypt the XML document.
exml.DecryptDocument();
}
}
Imports System.Xml
Imports System.Security.Cryptography
Imports System.Security.Cryptography.Xml
Module Program
Sub Main(ByVal args() As String)
' Create an XmlDocument object.
Dim xmlDoc As New XmlDocument()
' Load an XML file into the XmlDocument object.
Try
xmlDoc.PreserveWhitespace = True
xmlDoc.Load("test.xml")
Catch e As Exception
Console.WriteLine(e.Message)
End Try
' Create a new TripleDES key.
Dim tDESkey As New TripleDESCryptoServiceProvider()
Try
' Encrypt the "creditcard" element.
Encrypt(xmlDoc, "creditcard", tDESkey, "tDesKey")
' Display the encrypted XML to the console.
Console.WriteLine("Encrypted XML:")
Console.WriteLine()
Console.WriteLine(xmlDoc.OuterXml)
' Decrypt the "creditcard" element.
Decrypt(xmlDoc, tDESkey, "tDesKey")
' Display the encrypted XML to the console.
Console.WriteLine()
Console.WriteLine("Decrypted XML:")
Console.WriteLine()
Console.WriteLine(xmlDoc.OuterXml)
Catch e As Exception
Console.WriteLine(e.Message)
Finally
' Clear the TripleDES key.
tDESkey.Clear()
End Try
End Sub
Sub Encrypt(ByVal Doc As XmlDocument, ByVal ElementToEncrypt As String, ByVal Alg As SymmetricAlgorithm, ByVal KeyName As String)
' Check the arguments.
If Doc Is Nothing Then
Throw New ArgumentNullException("Doc")
End If
If ElementToEncrypt Is Nothing Then
Throw New ArgumentNullException("ElementToEncrypt")
End If
If Alg Is Nothing Then
Throw New ArgumentNullException("Alg")
End If
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Find the specified element in the XmlDocument
' object and create a new XmlElemnt object.
'''''''''''''''''''''''''''''''''''''''''''''''''''
Dim elementEncrypt As XmlElement = Doc.GetElementsByTagName(ElementToEncrypt)(0)
' Throw an XmlException if the element was not found.
If ElementToEncrypt Is Nothing Then
Throw New XmlException("The specified element was not found")
End If
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Create a new instance of the EncryptedXml class
' and use it to encrypt the XmlElement with the
' symmetric key.
'''''''''''''''''''''''''''''''''''''''''''''''''''
Dim eXml As New EncryptedXml()
' Add the key mapping.
eXml.AddKeyNameMapping(KeyName, Alg)
' Encrypt the element.
Dim edElement As EncryptedData = eXml.Encrypt(elementEncrypt, KeyName)
'''''''''''''''''''''''''''''''''''''''''''''''''''
' Replace the element from the original XmlDocument
' object with the EncryptedData element.
'''''''''''''''''''''''''''''''''''''''''''''''''''
EncryptedXml.ReplaceElement(elementEncrypt, edElement, False)
End Sub
Sub Decrypt(ByVal Doc As XmlDocument, ByVal Alg As SymmetricAlgorithm, ByVal KeyName As String)
' Check the arguments.
If Doc Is Nothing Then
Throw New ArgumentNullException("Doc")
End If
If Alg Is Nothing Then
Throw New ArgumentNullException("Alg")
End If
If KeyName Is Nothing Then
Throw New ArgumentNullException("KeyName")
End If
' Create a new EncryptedXml object.
Dim exml As New EncryptedXml(Doc)
' Add the key name mapping.
exml.AddKeyNameMapping(KeyName, Alg)
' Decrypt the XML document.
exml.DecryptDocument()
End Sub
End Module
Comentários
Esse método é uma maneira conveniente de criptografar o XML externo de um elemento usando um nome de chave. Se você precisar de mais controle sobre a criptografia, para que possa colocar as informações criptografadas em um <CipherReference>
elemento ou especificar se todo o elemento XML ou apenas seu conteúdo deve ser criptografado, use as sobrecargas do EncryptData método.
Para obter uma lista de todos os algoritmos com suporte, consulte a lista de campos constantes associados à EncryptedXml classe .