CryptoConfig CryptoConfig CryptoConfig CryptoConfig Class

Definition

Accesses the cryptography configuration information.

public ref class CryptoConfig
[System.Runtime.InteropServices.ComVisible(true)]
public class CryptoConfig
type CryptoConfig = class
Public Class CryptoConfig
Inheritance
CryptoConfigCryptoConfigCryptoConfigCryptoConfig
Attributes

Examples

The following code example demonstrates how to use members of the CryptoConfig class.

using namespace System;
using namespace System::Security::Cryptography;

int main()
{
   // Create a CryptoConfig object to store configuration information.
   CryptoConfig^ cryptoConfig = gcnew CryptoConfig;

   // Retrieve the class path for CryptoConfig.
   String^ classDescription = cryptoConfig->ToString();

   // Create a new SHA1 provider.
   SHA1CryptoServiceProvider^ SHA1alg =
      dynamic_cast<SHA1CryptoServiceProvider^>(
         CryptoConfig::CreateFromName( L"SHA1" ));

   // Create an RSAParameters with the TestContainer key container.
   CspParameters^ parameters = gcnew CspParameters;
   parameters->KeyContainerName = L"TestContainer";
   array<Object^>^argsArray = gcnew array<Object^>(1){
      parameters
   };
   
   // Instantiate the RSA provider instance accessing the TestContainer
   // key container.
   RSACryptoServiceProvider^ rsaProvider =
      static_cast<RSACryptoServiceProvider^>(
         CryptoConfig::CreateFromName( L"RSA", argsArray ));

   // Use the MapNameToOID method to get an object identifier
   // (OID) from the string name of the SHA1 algorithm.
   String^ sha1Oid = CryptoConfig::MapNameToOID( L"SHA1" );

   // Encode the specified object identifier.
   array<Byte>^encodedMessage = CryptoConfig::EncodeOID( sha1Oid );
   
   // Display the results to the console.
   Console::WriteLine( L"** {0} **", classDescription );
   Console::WriteLine( L"Created an RSA provider with a KeyContainerName called {0}.",
      parameters->KeyContainerName );
   Console::WriteLine( L"Object identifier from the SHA1 name:{0}",
      sha1Oid );
   Console::WriteLine( L"The object identifier encoded: {0}",
      System::Text::Encoding::ASCII->GetString( encodedMessage ) );
   Console::WriteLine( L"This sample completed successfully; press Enter to exit." );
   Console::ReadLine();
}

//
// This sample produces the following output:
//
// ** System.Security.Cryptography.CryptoConfig **
// Created an RSA provider with a KeyContainerName called TestContainer.
// Object identifier from the SHA1 name:1.3.14.3.2.26
// The object identifier encoded: HH*((*H9
// This sample completed successfully; press Enter to exit.
using System;
using System.Security.Cryptography;

class Members
{
    static void Main(string[] args)
    {
        // Create a CryptoConfig object to store configuration information.
        CryptoConfig cryptoConfig = new CryptoConfig();

        // Retrieve the class path for CryptoConfig.
        string classDescription = cryptoConfig.ToString();

        // Create a new SHA1 provider.
        SHA1CryptoServiceProvider SHA1alg = 
            (SHA1CryptoServiceProvider)CryptoConfig.CreateFromName("SHA1");

        // Create an RSAParameters with the TestContainer key container.
        CspParameters parameters = new CspParameters();
        parameters.KeyContainerName = "TestContainer";
        Object[] argsArray = new Object[] {parameters};

        // Instantiate the RSA provider instance accessing the TestContainer
        // key container.
        RSACryptoServiceProvider rsaProvider = (RSACryptoServiceProvider) 
            CryptoConfig.CreateFromName("RSA",argsArray);

        // Use the MapNameToOID method to get an object identifier  
        // (OID) from the string name of the SHA1 algorithm.
        string sha1Oid = CryptoConfig.MapNameToOID("SHA1");

        // Encode the specified object identifier.
        byte[] encodedMessage = CryptoConfig.EncodeOID(sha1Oid);

        // Display the results to the console.
        Console.WriteLine("** " + classDescription + " **");
        Console.WriteLine("Created an RSA provider " + 
            "with a KeyContainerName called " + parameters.KeyContainerName +
            ".");
        Console.WriteLine("Object identifier from the SHA1 name:" + sha1Oid);
        Console.WriteLine("The object identifier encoded: " + 
            System.Text.Encoding.ASCII.GetString(encodedMessage));
        Console.WriteLine("This sample completed successfully; " +
            "press Enter to exit.");
        Console.ReadLine();
    }
}
//
// This sample produces the following output:
//
// ** System.Security.Cryptography.CryptoConfig **
// Created an RSA provider with a KeyContainerName called TestContainer.
// Object identifier from the SHA1 name:1.3.14.3.2.26
// The object identifier encoded: HH*((*H9
// This sample completed successfully; press Enter to exit.
Imports System
Imports System.Security.Cryptography

Public Class Form1
    Inherits System.Windows.Forms.Form

    ' Event handler for Run button.
    Private Sub Button1_Click( _
        ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button1.Click

        tbxOutput.Cursor = Cursors.WaitCursor
        tbxOutput.Text = ""

        ' Create a CryptoConfig object to store configuration information.
        Dim cryptoConfig As New CryptoConfig

        ' Retrieve the class path for CryptoConfig.
        Dim classDescription As String = cryptoConfig.ToString()

        ' Create a new SHA1 provider.
        Dim SHA1alg As SHA1CryptoServiceProvider
        SHA1alg = CType( _
            cryptoConfig.CreateFromName("SHA1"), SHA1CryptoServiceProvider)

        ' Create an RSAParameters with the TestContainer key container.
        Dim parameters As New CspParameters
        parameters.KeyContainerName = "TestContainer"
        Dim argsArray() = New Object() {parameters}

        ' Instantiate the RSA provider instance accessing the key container
        '  TestContainer.
        Dim rsaProvider As New RSACryptoServiceProvider
        rsaProvider = CType(cryptoConfig.CreateFromName( _
            "RSA", argsArray), _
            RSACryptoServiceProvider)

        ' Use the MapNameToOID method to get an object identifier.
        ' (OID) from the string name of the SHA1 algorithm.
        Dim sha1Oid As String = cryptoConfig.MapNameToOID("SHA1")

        ' Encode the specified object identifier.
        Dim encodedMessage() As Byte = cryptoConfig.EncodeOID(sha1Oid)

        ' Display the results to the console.
        tbxOutput.AppendText("** " + classDescription + " **" + vbCrLf)
        tbxOutput.AppendText("Created an RSA provider with a ")
        tbxOutput.AppendText("KeyContainerName called ")
        tbxOutput.AppendText(parameters.KeyContainerName + "." + vbCrLf)
        tbxOutput.AppendText("Object identifier from the SHA1 name:")
        tbxOutput.AppendText(sha1Oid + vbCrLf)
        tbxOutput.AppendText("The object identifier encoded: ")
        tbxOutput.AppendText( _
            System.Text.Encoding.ASCII.GetString(encodedMessage))

        ' Reset the cursor and conclude application.
        tbxOutput.AppendText(vbCrLf + "This sample completed " + _
            "successfully; press Exit to continue.")
        tbxOutput.Cursor = Cursors.Default
    End Sub
    ' Event handler for Exit button.
    Private Sub Button2_Click( _
        ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button2.Click

        Application.Exit()
    End Sub
#Region " Windows Form Designer generated code "

    Public Sub New()
        MyBase.New()

        'This call is required by the Windows Form Designer.
        InitializeComponent()

        'Add any initialization after the InitializeComponent() call

    End Sub

    'Form overrides dispose to clean up the component list.
    Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean)
        If disposing Then
            If Not (components Is Nothing) Then
                components.Dispose()
            End If
        End If
        MyBase.Dispose(disposing)
    End Sub

    'Required by the Windows Form Designer
    Private components As System.ComponentModel.IContainer

    'NOTE: The following procedure is required by the Windows Form Designer
    'It can be modified using the Windows Form Designer.  
    'Do not modify it using the code editor.
    Friend WithEvents Panel2 As System.Windows.Forms.Panel
    Friend WithEvents Panel1 As System.Windows.Forms.Panel
    Friend WithEvents Button1 As System.Windows.Forms.Button
    Friend WithEvents Button2 As System.Windows.Forms.Button
    Friend WithEvents tbxOutput As System.Windows.Forms.RichTextBox
    <System.Diagnostics.DebuggerStepThrough()> _
    Private Sub InitializeComponent()
        Me.Panel2 = New System.Windows.Forms.Panel
        Me.Button1 = New System.Windows.Forms.Button
        Me.Button2 = New System.Windows.Forms.Button
        Me.Panel1 = New System.Windows.Forms.Panel
        Me.tbxOutput = New System.Windows.Forms.RichTextBox
        Me.Panel2.SuspendLayout()
        Me.Panel1.SuspendLayout()
        Me.SuspendLayout()
        '
        'Panel2
        '
        Me.Panel2.Controls.Add(Me.Button1)
        Me.Panel2.Controls.Add(Me.Button2)
        Me.Panel2.Dock = System.Windows.Forms.DockStyle.Bottom
        Me.Panel2.DockPadding.All = 20
        Me.Panel2.Location = New System.Drawing.Point(0, 320)
        Me.Panel2.Name = "Panel2"
        Me.Panel2.Size = New System.Drawing.Size(616, 64)
        Me.Panel2.TabIndex = 1
        '
        'Button1
        '
        Me.Button1.Dock = System.Windows.Forms.DockStyle.Right
        Me.Button1.Font = New System.Drawing.Font( _
            "Microsoft Sans Serif", 9.0!, _
            System.Drawing.FontStyle.Regular, _
            System.Drawing.GraphicsUnit.Point, _
            CType(0, Byte))
        Me.Button1.Location = New System.Drawing.Point(446, 20)
        Me.Button1.Name = "Button1"
        Me.Button1.Size = New System.Drawing.Size(75, 24)
        Me.Button1.TabIndex = 2
        Me.Button1.Text = "&Run"
        '
        'Button2
        '
        Me.Button2.Dock = System.Windows.Forms.DockStyle.Right
        Me.Button2.Font = New System.Drawing.Font( _
            "Microsoft Sans Serif", _
            9.0!, _
            System.Drawing.FontStyle.Regular, _
            System.Drawing.GraphicsUnit.Point, _
            CType(0, Byte))
        Me.Button2.Location = New System.Drawing.Point(521, 20)
        Me.Button2.Name = "Button2"
        Me.Button2.Size = New System.Drawing.Size(75, 24)
        Me.Button2.TabIndex = 3
        Me.Button2.Text = "E&xit"
        '
        'Panel1
        '
        Me.Panel1.Controls.Add(Me.tbxOutput)
        Me.Panel1.Dock = System.Windows.Forms.DockStyle.Fill
        Me.Panel1.DockPadding.All = 20
        Me.Panel1.Location = New System.Drawing.Point(0, 0)
        Me.Panel1.Name = "Panel1"
        Me.Panel1.Size = New System.Drawing.Size(616, 320)
        Me.Panel1.TabIndex = 2
        '
        'tbxOutput
        '
        Me.tbxOutput.AccessibleDescription = _
            "Displays output from application."
        Me.tbxOutput.AccessibleName = "Output textbox."
        Me.tbxOutput.Dock = System.Windows.Forms.DockStyle.Fill
        Me.tbxOutput.Location = New System.Drawing.Point(20, 20)
        Me.tbxOutput.Name = "tbxOutput"
        Me.tbxOutput.Size = New System.Drawing.Size(576, 280)
        Me.tbxOutput.TabIndex = 1
        Me.tbxOutput.Text = "Click the Run button to run the application."
        '
        'Form1
        '
        Me.AutoScaleBaseSize = New System.Drawing.Size(6, 15)
        Me.ClientSize = New System.Drawing.Size(616, 384)
        Me.Controls.Add(Me.Panel1)
        Me.Controls.Add(Me.Panel2)
        Me.Name = "Form1"
        Me.Text = "CryptoConfig"
        Me.Panel2.ResumeLayout(False)
        Me.Panel1.ResumeLayout(False)
        Me.ResumeLayout(False)

    End Sub

#End Region
End Class
'
' This sample produces the following output:
'
' ** System.Security.Cryptography.CryptoConfig **
' Created an RSA provider with a KeyContainerName called TestContainer.
' Object identifier from the SHA1 name:1.3.14.3.2.26
' The object identifier encoded: 6767gG&*(*
' This sample completed successfully; press Exit to continue.

Remarks

The following table shows the simple names recognized by this class and the default algorithm implementations to which they map. Alternatively, you can map other implementations to these names, as described in Mapping Algorithm Names to Cryptography Classes.

Simple name Algorithm implementation
3DES, Triple DES, TripleDES, System.Security.Cryptography.TripleDES TripleDESCryptoServiceProvider
AES, System.Security.Cryptography.AesCryptoServiceProvider AesCryptoServiceProvider
AesManaged, System.Security.Cryptography.AesManaged AesManaged
System.Security.Cryptography.AsymmetricAlgorithm RSACryptoServiceProvider
DES, System.Security.Cryptography.DES DESCryptoServiceProvider
DSA, System.Security.Cryptography.DSA DSACryptoServiceProvider
ECDH, ECDiffieHellman, ECDiffieHellmanCng, System.Security.Cryptography.ECDiffieHellmanCng ECDiffieHellmanCng
ECDsa, ECDsaCng, System.Security.Cryptography.ECDsaCng ECDsaCng
System.Security.Cryptography.HashAlgorithm SHA1CryptoServiceProvider
HMAC, System.Security.Cryptography.HMAC HMACSHA1
HMACMD5, System.Security.Cryptography.HMACMD5 HMACMD5
HMACRIPEMD160, System.Security.Cryptography.HMACRIPEMD160 HMACRIPEMD160
HMACSHA1, System.Security.Cryptography.HMACSHA1 HMACSHA1
HMACSHA256, System.Security.Cryptography.HMACSHA256 HMACSHA256
HMACSHA384, System.Security.Cryptography.HMACSHA384 HMACSHA384
HMACSHA512, System.Security.Cryptography.HMACSHA512 HMACSHA512
System.Security.Cryptography.KeyedHashAlgorithm HMACSHA1
MACTripleDES, System.Security.Cryptography.MACTripleDES MACTripleDES
MD5, System.Security.Cryptography.MD5 MD5CryptoServiceProvider
System.Security.Cryptography.MD5Cng MD5Cng
RandomNumberGenerator RNGCryptoServiceProvider
RC2, System.Security.Cryptography.RC2 RC2CryptoServiceProvider
Rijndael, System.Security.Cryptography.Rijndael RijndaelManaged
RIPEMD160, RIPEMD-160, System.Security.Cryptography.RIPEMD160Managed RIPEMD160Managed
RSA, System.Security.Cryptography.RSA RSACryptoServiceProvider
SHA, SHA1, System.Security.Cryptography.SHA1 SHA1CryptoServiceProvider
System.Security.Cryptography.SHA1Cng SHA1Cng
SHA256, SHA-256, System.Security.Cryptography.SHA256 SHA256Managed
System.Security.Cryptography.SHA256Cng SHA256Cng
System.Security.Cryptography.SHA256CryptoServiceProvider SHA256CryptoServiceProvider
SHA384, SHA-384, System.Security.Cryptography.SHA384 SHA384Managed
System.Security.Cryptography.SHA384Cng SHA384Cng
System.Security.Cryptography.SHA384CryptoServiceProvider SHA384CryptoServiceProvider
SHA512, SHA-512, System.Security.Cryptography.SHA512 SHA512Managed
System.Security.Cryptography.SHA512Cng SHA512Cng
System.Security.Cryptography.SHA512CryptoServiceProvider SHA512CryptoServiceProvider
System.Security.Cryptography.SymmetricAlgorithm RijndaelManaged

Constructors

CryptoConfig() CryptoConfig() CryptoConfig() CryptoConfig()

Initializes a new instance of the CryptoConfig class.

Properties

AllowOnlyFipsAlgorithms AllowOnlyFipsAlgorithms AllowOnlyFipsAlgorithms AllowOnlyFipsAlgorithms

Indicates whether the runtime should enforce the policy to create only Federal Information Processing Standard (FIPS) certified algorithms.

Methods

AddAlgorithm(Type, String[]) AddAlgorithm(Type, String[]) AddAlgorithm(Type, String[]) AddAlgorithm(Type, String[])

Adds a set of names to algorithm mappings to be used for the current application domain.

AddOID(String, String[]) AddOID(String, String[]) AddOID(String, String[]) AddOID(String, String[])

Adds a set of names to object identifier (OID) mappings to be used for the current application domain.

CreateFromName(String) CreateFromName(String) CreateFromName(String) CreateFromName(String)

Creates a new instance of the specified cryptographic object.

CreateFromName(String, Object[]) CreateFromName(String, Object[]) CreateFromName(String, Object[]) CreateFromName(String, Object[])

Creates a new instance of the specified cryptographic object with the specified arguments.

EncodeOID(String) EncodeOID(String) EncodeOID(String) EncodeOID(String)

Encodes the specified object identifier (OID).

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MapNameToOID(String) MapNameToOID(String) MapNameToOID(String) MapNameToOID(String)

Gets the object identifier (OID) of the algorithm corresponding to the specified simple name.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to