Export (0) Print
Expand All

SignatureDescription Class

Contains information about the properties of a digital signature.

Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

<ComVisibleAttribute(True)> _
Public Class SignatureDescription

The SignatureDescription type exposes the following members.

Public methodSignatureDescriptionInitializes a new instance of the SignatureDescription class.
Public methodSignatureDescription(SecurityElement)Initializes a new instance of the SignatureDescription class from the specified SecurityElement.

Public propertyDeformatterAlgorithmGets or sets the deformatter algorithm for the signature description.
Public propertyDigestAlgorithmGets or sets the digest algorithm for the signature description.
Public propertyFormatterAlgorithmGets or sets the formatter algorithm for the signature description.
Public propertyKeyAlgorithmGets or sets the key algorithm for the signature description.

Public methodCreateDeformatterCreates an AsymmetricSignatureDeformatter instance with the specified key using the DeformatterAlgorithm property.
Public methodCreateDigestCreates a HashAlgorithm instance using the DigestAlgorithm property.
Public methodCreateFormatterCreates an AsymmetricSignatureFormatter instance with the specified key using the FormatterAlgorithm property.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

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

Imports System
Imports System.Security
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 digital signature based on RSA encryption. 
        Dim rsaSignature As SignatureDescription = CreateRSAPKCS1Signature()

        ' Create a digital signature based on DSA encryption. 
        Dim dsaSignature As SignatureDescription = CreateDSASignature()

        ' Create a HashAlgorithm using the digest algorithm of the signature. 
        Dim hashAlgorithm As HashAlgorithm = dsaSignature.CreateDigest()
        WriteLine("Hash algorithm for the DigestAlgorithm property: " + _

        ' Create an AsymmetricSignatureFormatter instance using the DSA key. 
        Dim dsa As DSA = dsa.Create()
        Dim asymmetricFormatter As AsymmetricSignatureFormatter = _

        ' Create an AsymmetricSignatureDeformatter instance using the DSA key.
        dim asymmetricDeformatter as AsymmetricSignatureDeformatter = _

        ' Align interface and conclude application.
        WriteLine("This sample completed successfully;" + _
            " press Exit to continue.")

        ' Reset the cursor to the default look.
        tbxOutput.Cursor = Cursors.Default 
    End Sub 

    ' Create a SignatureDescription for RSA encryption. 
    Private Function CreateRSAPKCS1Signature() As SignatureDescription
        Dim signatureDescription As New SignatureDescription

        ' Set the key algorithm property for RSA encryption.
        signatureDescription.KeyAlgorithm = _

        ' Set the digest algorithm for RSA encryption using the SHA1 provider.
        signatureDescription.DigestAlgorithm = _

        ' Set the formatter algorithm with the RSAPKCS1 formatter.
        signatureDescription.FormatterAlgorithm = _

        ' Set the formatter algorithm with the RSAPKCS1 deformatter.
        signatureDescription.DeformatterAlgorithm = _

        Return SignatureDescription
    End Function 

    ' Create a SignatureDescription using a constructed SecurityElement for  
    ' DSA encryption. 
    Private Function CreateDSASignature() As SignatureDescription
        Dim securityElement As New SecurityElement("DSASignature")

        ' Create new security elements for the four algorithms.
        securityElement.AddChild(new SecurityElement( _
            "Key", _
        securityElement.AddChild(New SecurityElement( _
            "Digest", _
        securityElement.AddChild(new SecurityElement( _
            "Formatter", _
        securityElement.AddChild(new SecurityElement( _
            "Deformatter", _

        Dim signatureDescription As New SignatureDescription(securityElement)

        Return signatureDescription
    End Function 

    ' Create a signature formatter for DSA encryption. 
    Private Function CreateDSAFormatter(ByVal dsa As DSA) _
        As AsymmetricSignatureFormatter

        ' Create a DSA signature formatter for encryption. 
        Dim signatureDescription As New SignatureDescription
        signatureDescription.FormatterAlgorithm = _

        Dim asymmetricFormatter As AsymmetricSignatureFormatter
        asymmetricFormatter = signatureDescription.CreateFormatter(dsa)

        WriteLine("Created formatter : " + asymmetricFormatter.ToString())
        Return asymmetricFormatter
    End Function 

    ' Create a signature deformatter for DSA decryption. 
    Private Function CreateDSADeformatter(ByVal dsa As DSA) _
        As AsymmetricSignatureDeformatter

        ' Create a DSA signature deformatter to verify the signature. 
        Dim signatureDescription As New SignatureDescription
        signatureDescription.DeformatterAlgorithm = _

        Dim asymmetricDeformatter As AsymmetricSignatureDeformatter
        asymmetricDeformatter = SignatureDescription.CreateDeformatter(dsa)

        WriteLine("Created deformatter : " + asymmetricDeformatter.ToString())
        Return asymmetricDeformatter
    End Function 

    ' Display to the console the properties of the specified 
    ' SignatureDescription. 
    Private Sub ShowProperties(ByVal signatureDescription _
        As SignatureDescription)

        ' Retrieve the class path for the specified SignatureDescription. 
        Dim classDescription As String = signatureDescription.ToString()

        Dim deformatterAlgorithm As String 
        deformatterAlgorithm = signatureDescription.DeformatterAlgorithm
        Dim formatterAlgorithm As String 
        formatterAlgorithm = signatureDescription.FormatterAlgorithm
        Dim digestAlgorithm As String 
        digestAlgorithm = signatureDescription.DigestAlgorithm
        Dim keyAlgorithm As String 
        keyAlgorithm = signatureDescription.KeyAlgorithm

        WriteLine(vbCrLf + "** " + classDescription + " **")
        WriteLine("DeformatterAlgorithm : " + deformatterAlgorithm)
        WriteLine("FormatterAlgorithm : " + formatterAlgorithm)
        WriteLine("DigestAlgorithm : " + digestAlgorithm)
        WriteLine("KeyAlgorithm : " + keyAlgorithm)
    End Sub 

    ' Write the specified message and carriage return to the output textbox. 
    Private Sub WriteLine(ByVal message As String)
        tbxOutput.AppendText(message + vbCrLf)
    End Sub 

    ' Event handler for Exit button. 
    Private Sub Button2_Click( _
        ByVal sender As System.Object, _
        ByVal e As System.EventArgs) Handles Button2.Click

    End Sub
#Region " Windows Form Designer generated code " 

    Public Sub New()

        'This call is required by the Windows Form Designer.

        '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
            End If 
        End If 
    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.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
        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" 
        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" 
        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
        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." 
        Me.AutoScaleBaseSize = New System.Drawing.Size(6, 15)
        Me.ClientSize = New System.Drawing.Size(616, 384)
        Me.Name = "Form1" 
        Me.Text = "SignatureDescription" 

    End Sub

#End Region
End Class 

' This sample produces the following output: 

' ** System.Security.Cryptography.SignatureDescription ** 
' DeformatterAlgorithm : System.Security.Cryptography. 
' RSAPKCS1SignatureDeformatter 
' FormatterAlgorithm : System.Security.Cryptography.RSAPKCS1SignatureFormatter 
' DigestAlgorithm : System.Security.Cryptography.SHA1CryptoServiceProvider 
' KeyAlgorithm : System.Security.Cryptography.RSACryptoServiceProvider 
' ** System.Security.Cryptography.SignatureDescription ** 
' DeformatterAlgorithm : System.Security.Cryptography.DSASignatureDeformatter 
' FormatterAlgorithm : System.Security.Cryptography.DSASignatureFormatter 
' DigestAlgorithm : System.Security.Cryptography.SHA1CryptoServiceProvider 
' KeyAlgorithm : System.Security.Cryptography.DSACryptoServiceProvider 
' Hash algorithm for the DigestAlgorithm property: System.Security. 
' Cryptography. 
' SHA1CryptoServiceProvider 
' Created formatter : System.Security.Cryptography.DSASignatureFormatter 
' Created deformatter : System.Security.Cryptography.DSASignatureDeformatter 
' This sample completed successfully; press Exit to continue.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2014 Microsoft