SymmetricSignatureProvider.GetKeyBytes(SecurityKey) Method

Reference

Definition

Namespace:: Microsoft.IdentityModel.Tokens

Assembly:: Microsoft.IdentityModel.Tokens.dll

Package:: Microsoft.IdentityModel.Tokens v7.5.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Called to obtain the byte[] needed to create a KeyedHashAlgorithm

protected virtual byte[] GetKeyBytes (Microsoft.IdentityModel.Tokens.SecurityKey key);

abstract member GetKeyBytes : Microsoft.IdentityModel.Tokens.SecurityKey -> byte[]
override this.GetKeyBytes : Microsoft.IdentityModel.Tokens.SecurityKey -> byte[]

Protected Overridable Function GetKeyBytes (key As SecurityKey) As Byte()

Parameters

key: SecurityKey

SecurityKeythat will be used to obtain the byte[].

Returns

Byte[]

Byte[] that is used to populated the KeyedHashAlgorithm.

Exceptions

ArgumentNullException

if key is null.

ArgumentException

if a byte[] can not be obtained from SecurityKey.

Remarks

SymmetricSecurityKey and JsonWebKey are supported.

For a SymmetricSecurityKey .Key is returned

For a JsonWebKeyBase64UrlEncoder.DecodeBytes is called with K if Kty == JsonWebAlgorithmsKeyTypes.Octet

Applies to