Show / Hide Table of Contents

Connect Method

Connect(byte[])

Initiate a connection to the specified application represented as an applicationId on a YubiKey device.

C#
public IYubiKeyConnection Connect(byte[] applicationId)

Parameters

Type Name Description
byte[] applicationId

A byte array representing the smart card Application ID (AID) for the application to open.

Returns

IYubiKeyConnection

An instance of a class that implements the IYubiKeyConnection interface.

Implements

IYubiKeyDevice.Connect(byte[])

Connect(YubiKeyApplication)

Initiate a connection to the specified application on a YubiKey device.

C#
public virtual IYubiKeyConnection Connect(YubiKeyApplication application)

Parameters

Type Name Description
YubiKeyApplication application

The application to reference on the device.

Returns

IYubiKeyConnection

An instance of a class that implements the IYubiKeyConnection interface.

Implements

IYubiKeyDevice.Connect(YubiKeyApplication)

Connect(byte[], ScpKeyParameters)

Initiate a connection to the specified application on a YubiKey device using SCP protocol.

C#
public virtual IScpYubiKeyConnection Connect(byte[] applicationId, ScpKeyParameters keyParameters)

Parameters

Type Name Description
byte[] applicationId

A byte array representing the smart card Application ID (AID) for the application to open.

ScpKeyParameters keyParameters

The SCP key parameters to use in making an SCP connection.

Returns

IScpYubiKeyConnection

An instance of a class that implements the IScpYubiKeyConnection interface.

Implements

IYubiKeyDevice.Connect(byte[], ScpKeyParameters)

Remarks

Note that SCP works only with SmartCard applications, namely PIV, OATH, OTP, Security Domain and YubiHsmAuth and OpenPgp. However, SCP03 is supported only on series 5 YubiKeys with firmware version on 5.3 and above. SCP 11 is supported only firmware version 5.7.2 and above.

Note also that the return is an instance of a class that implements IScpYubiKeyConnection which is a "subclass" of IYubiKeyConnection.

Connect(YubiKeyApplication, ScpKeyParameters)

Initiate a connection to the specified application on a YubiKey device using SCP protocol.

C#
public virtual IScpYubiKeyConnection Connect(YubiKeyApplication application, ScpKeyParameters keyParameters)

Parameters

Type Name Description
YubiKeyApplication application

The YubiKeyApplication to reference on the device.

ScpKeyParameters keyParameters

The SCP key parameters to use in making an SCP connection.

Returns

IScpYubiKeyConnection

An instance of a class that implements the IScpYubiKeyConnection interface.

Implements

IYubiKeyDevice.Connect(YubiKeyApplication, ScpKeyParameters)

Remarks

Note that SCP works only with SmartCard applications, namely PIV, OATH, OTP, Security Domain and YubiHsmAuth and OpenPgp. However, SCP03 is supported only on series 5 YubiKeys with firmware version on 5.3 and above. SCP 11 is supported only firmware version 5.7.2 and above.

Note also that the return is an instance of a class that implements IScpYubiKeyConnection which is a "subclass" of IYubiKeyConnection.

Connect(YubiKeyApplication, StaticKeys)

C#
[Obsolete("Obsolete")]
public virtual IYubiKeyConnection Connect(YubiKeyApplication application, StaticKeys scp03Keys)

Parameters

Type Name Description
YubiKeyApplication application
StaticKeys scp03Keys

Returns

IYubiKeyConnection

In this article
Back to top Generated by DocFX