Class Scp03KeyParameters

Namespace

Yubico.YubiKey.Scp

Assembly

Yubico.YubiKey.dll

Represents the parameters for a Secure Channel Protocol 03 (SCP03) key.

public sealed class Scp03KeyParameters : ScpKeyParameters

Inheritance

object

ScpKeyParameters

Scp03KeyParameters

Inherited Members

ScpKeyParameters.KeyReference

Constructors

Scp03KeyParameters(byte, byte, StaticKeys)

Creates a new instance of Scp03KeyParameters, representing the parameters for a Secure Channel Protocol 03 (SCP03) key.

public Scp03KeyParameters(byte keyId, byte keyVersionNumber, StaticKeys staticKeys)

Parameters

keyId byte

The ID of the key. Must be between 1 and 3 for SCP03.

keyVersionNumber byte

The version number of the key.

staticKeys StaticKeys

The static keys shared with the device.

Exceptions

ArgumentException

Thrown if keyId is not between 1 and 3, which are the only valid Key IDs for SCP03

Scp03KeyParameters(KeyReference, StaticKeys)

Creates a new instance of Scp03KeyParameters, representing the parameters for a Secure Channel Protocol 03 (SCP03) key.

public Scp03KeyParameters(KeyReference keyReference, StaticKeys staticKeys)

Parameters

keyReference KeyReference

A reference to the key.

staticKeys StaticKeys

The static keys shared with the device when initiating the connection.

Exceptions

ArgumentException

Thrown if keyReference.Id.Id is not between 1 and 3, which are the only valid Key IDs for SCP03

Properties

DefaultKey

Gets the default SCP03 key parameters using the default key identifier and static keys.

public static Scp03KeyParameters DefaultKey { get; }

Property Value

Scp03KeyParameters

Remarks

This property provides a convenient way to access default SCP03 key parameters, using the standard SCP03 key identifier (0x03) and default static keys with version number 0xFF.

StaticKeys

The static keys shared with the device when initiating the connection.

public StaticKeys StaticKeys { get; }

Property Value

StaticKeys

Methods

Dispose()

This will clear all references and sensitive buffers

public void Dispose()

FromStaticKeys(StaticKeys)

Creates a new instance of Scp03KeyParameters, representing the parameters for a Secure Channel Protocol 03 (SCP03) key, using the standard SCP03 key identifier and the given static keys.

public static Scp03KeyParameters FromStaticKeys(StaticKeys staticKeys)

Parameters

staticKeys StaticKeys

The static keys shared with the device.

Returns

Scp03KeyParameters

An instance of Scp03KeyParameters with key ID 0x03 and version number 0x01.