Connect Method
Connect(YubiKeyApplication)
Initiate a connection to the specified application on a YubiKey device.
IYubiKeyConnection Connect(YubiKeyApplication application)Parameters
| Type | Name | Description |
|---|---|---|
| YubiKeyApplication | application | The application to reference on the device. |
Returns
An instance of a class that implements the IYubiKeyConnection interface.
Connect(byte[])
Initiate a connection to the specified application represented as an
applicationId on a YubiKey device.
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
An instance of a class that implements the IYubiKeyConnection interface.
Connect(YubiKeyApplication, ScpKeyParameters)
Initiate a connection to the specified application on a YubiKey device using SCP protocol.
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
An instance of a class that implements the IScpYubiKeyConnection interface.
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(byte[], ScpKeyParameters)
Initiate a connection to the specified application on a YubiKey device using SCP protocol.
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
An instance of a class that implements the IScpYubiKeyConnection interface.
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.