ISCardISO7816::InternalAuthenticate method
[The InternalAuthenticate method is available for use in the operating systems specified in the Requirements section. It is not available for use in Windows Server 2003 with Service Pack 1 (SP1) and later, Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The Smart Card Modules provide similar functionality.]
The InternalAuthenticate method constructs an application protocol data unit (APDU) command that initiates the computation of the authentication data by the card using the challenge data sent from the interface device and a relevant secret (for example, a key) stored in the card.
When the relevant secret is attached to the MF, the command may be used to authenticate the card as a whole.
When the relevant secret is attached to another DF, the command may be used to authenticate that DF.
Syntax
HRESULT InternalAuthenticate(
[in] BYTE byAlgorithmRef,
[in] BYTE bySecretRef,
[in] LPBYTEBUFFER pChallenge,
[in] LONG lReplyBytes,
[in, out] LPSCARDCMD *ppCmd
);
Parameters
-
byAlgorithmRef [in]
-
Reference of the algorithm in the card.
If this value is zero, this indicates that no information is given. The reference of the algorithm is known either before issuing the command or is provided in the data field.
-
bySecretRef [in]
-
Reference of the secret.
Value Meaning - No Info
Bit position: 00000000
No information is given. The reference of the secret is known either before issuing the command or is provided in the data field.- Global ref
Bit position: 0-------
Global reference data (an MF specific key).- Specific ref
Bit position: 1-------
Specific reference data (a DF specific key).- RFU
Bit position: -xx-----
00 (other values are RFU).- Secret
Bit position: ---xxxxx
Number of the secret. -
pChallenge [in]
-
Pointer to the authentication-related data (for example, challenge).
-
lReplyBytes [in]
-
Maximum number of bytes expected in response.
-
ppCmd [in, out]
-
On input, a pointer to an ISCardCmd interface object or NULL.
On return, it is filled with the APDU command constructed by this operation. If ppCmd was set to NULL, a smart card ISCardCmd object is internally created and returned using the ppCmd pointer.
Return value
The method returns one of the following possible values.
| Return code | Description |
|---|---|
|
Operation completed successfully. |
|
Invalid parameter. |
|
A bad pointer was passed in. |
|
Out of memory. |
Remarks
The successful execution of the command may be subject to successful completion of prior commands (for example, VERIFY or SELECT FILE) or selections (for example, the relevant secret).
If a key and an algorithm are currently selected when issuing the command, then the command may implicitly use the key and the algorithm.
The number of times the command is issued may be recorded in the card to limit the number of further attempts of using the relevant secret or the algorithm.
For a list of all the methods provided by this interface, see ISCardISO7816.
In addition to the COM error codes listed above, this interface may return a smart card error code if a smart card function was called to complete the request. For more information, see Smart Card Return Values.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows XP [desktop apps only] |
| Minimum supported server |
Windows Server 2003 [desktop apps only] |
| End of client support |
Windows XP |
| End of server support |
Windows Server 2003 |
| Header |
|
| Type library |
|
| DLL |
|
| IID |
IID_ISCardISO7816 is defined as 53B6AA68-3F56-11D0-916B-00AA00C18068 |
See also