SymmetricSecurityKey Class

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents the abstract base class for all keys that are generated using symmetric algorithms.

Namespace: System.IdentityModel.Tokens
Assembly: System.IdentityModel (in System.IdentityModel.dll)

Inheritance Hierarchy

System.Object
System.IdentityModel.Tokens.SecurityKey
System.IdentityModel.Tokens.SymmetricSecurityKey
System.IdentityModel.Tokens.InMemorySymmetricSecurityKey

Syntax

C++

public abstract class SymmetricSecurityKey : SecurityKey

Constructors

	Name	Description
	SymmetricSecurityKey()	Initializes a new instance of the SymmetricSecurityKey class.

Properties

	Name	Description
	KeySize	When overridden in a derived class, gets the size, in bits, of the key.(Inherited from SecurityKey.)

Methods

	Name	Description
	DecryptKey(String, Byte[])	When overridden in a derived class, decrypts the specified encrypted key.(Inherited from SecurityKey.)
	EncryptKey(String, Byte[])	When overridden in a derived class, encrypts the specified key.(Inherited from SecurityKey.)
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GenerateDerivedKey(String, Byte[], Byte[], Int32, Int32)	When overridden in a derived class, generates a derived key using the specified cryptographic algorithm and parameters for the current key.
	GetDecryptionTransform(String, Byte[])	When overridden in a derived class, gets a transform that decrypts cipher text using the specified cryptographic algorithm.
	GetEncryptionTransform(String, Byte[])	When overridden in a derived class, gets a transform that encrypts XML using the specified cryptographic algorithm.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetIVSize(String)	When overridden in a derived class, gets the size, in bits, of the initialization vector (IV) that is required for the specified cryptographic algorithm.
	GetKeyedHashAlgorithm(String)	When overridden in a derived class, gets an instance of the specified keyed hash algorithm.
	GetSymmetricAlgorithm(String)	When overridden in a derived class, gets an instance of the specified symmetric algorithm.
	GetSymmetricKey()	When overridden in a derived class, gets the bytes that represent the symmetric key.
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	IsAsymmetricAlgorithm(String)	When overridden in a derived class, gets a value that indicates whether the specified algorithm uses asymmetric keys. (Inherited from SecurityKey.)
	IsSupportedAlgorithm(String)	When overridden in a derived class, gets a value that indicates whether the specified algorithm is supported by this class. (Inherited from SecurityKey.)
	IsSymmetricAlgorithm(String)	When overridden in a derived class, gets a value that indicates whether the specified algorithm uses symmetric keys.(Inherited from SecurityKey.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Remarks

Typically, this class is used by the infrastructure to transform XML using a symmetric key.

Version Information

.NET Framework
Available since 3.0

Thread Safety

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