Framework

CryptoTokenKit

Access Smart Cards and manage user interactions.

Overview

The CryptoTokenKit framework provides programmatic access to Smart Cards.

Topics

Classes

class TKBERTLVRecord

The TKBERTLVRecord class is a concrete subclass of TKTLVRecord that parses BER-encoded data and produces DER-encoded data for TLV records.

class TKCompactTLVRecord

The TKCompactTLVRecord class is a concrete subclass of TKTLVRecord that implements encoding using Compact-TLV encoding according to ISO 7816-4.

class TKSimpleTLVRecord

The TKSimpleTLVRecord class is a concrete subclass of TKTLVRecord that implements encoding using Simple-TLV encoding according to ISO 7816-4.

class TKSmartCard

A TKSmartCard object represents a Smart Card. The TKSmartCard class provides an interface for managing sessions with a Smart Card, transmitting requests, and facilitating user interaction.

class TKSmartCardATR

A TKSmartCardATR object represents a parsed ATR (Answer To Reset) message from a Smart Card. The TKSmartCardATR class declares a programmatic interface to parsing an ATR from an NSData object or byte stream, and accessing individual parts.

class TKSmartCardATR.InterfaceGroup

A TKSmartCardATRInterfaceGroup object represents a single interface-bytes group for a Smart Card ATR (Answer to Reset). The TKSmartCardATRInterfaceGroup class declares a programmatic interface for accessing the protocol and the interface bytes of an ATR.

class TKSmartCardPINFormat

The TKSmartCardPINFormat class encapsulates the formatting properties for a PIN, including the allowed characters, the character encoding, the minimum and maximum length, and the block length, offset, and justification.

class TKSmartCardSlot

A TKSmartCardSlot object represents a single Smart Card reader slot. The TKSmartCardSlot class declares a programmatic interface to information about the inserted Smart Card and instantiate TKSmartCard objects.

class TKSmartCardSlotManager

The TKSmartCardSlotManager class provides a programmatic interface to the Smart Card reader slots available to the system.

class TKSmartCardToken

The TKSmartCardToken class is a subclass of TKToken that encapsulates a Smart Card based token.

class TKSmartCardTokenDriver

The TKSmartCardTokenDriver class is a TKTokenDriver subclass that encapsulates the driver for specific type of Smart Card.

class TKSmartCardTokenSession

A TKSmartCardTokenSession object represents a token session that is based on a Smart Card token.

class TKSmartCardUserInteraction

The TKSmartCardUserInteraction class is the base class for encapsulating user interaction with a Smart Card reader.

class TKSmartCardUserInteractionForPINOperation

The TKSmartCardUserInteractionForPINOperation is a base subclass of TKSmartCardUserInteraction that represents the user interaction for the secure PIN operations on a Smart Card reader.

class TKSmartCardUserInteractionForSecurePINChange

The TKSmartCardUserInteractionForSecurePINChange is a subclass of TKSmartCardUserInteractionForPINOperation that represents the user interaction for the secure PIN change operations on a Smart Card reader.

class TKSmartCardUserInteractionForSecurePINVerification

The TKSmartCardUserInteractionForSecurePINVerification is a subclass of TKSmartCardUserInteractionForPINOperation that represents the user interaction for the secure PIN verification operations on a Smart Card reader.

class TKTLVRecord

The TKTLVRecord class is the base class encapsulating a Tag-Length-Value record.

class TKToken

A TKToken object represents a single cryptographic token.

class TKTokenAuthOperation

The TKTokenAuthOperation class is a base class that encapsulates an authentication operation for a cryptographic token.

class TKTokenDriver

The TKTokenDriver class is the base class for encapsulating token drivers.

class TKTokenKeyAlgorithm

The TKTokenKeyAlgorithm class encapsulates cryptographic algorithms used by token keys.

class TKTokenKeychainCertificate

The TKTokenKeychainCertificate class is a concrete subclass of TKTokenKeychainItem that encapsulates the propagation of a token’s certificates to the keychain.

class TKTokenKeychainContents

A TKTokenKeychainContents object contains TKTokenKeychainItem objects, representing the state of the keychain for a particular token.

class TKTokenKeychainItem

The TKTokenKeychainItem class is the base class for encapsulating the propagation of a token’s items to the keychain.

class TKTokenKeychainKey

The TKTokenKeychainKey class is a concrete subclass of TKTokenKeychainItem that encapsulates the propagation of a token’s keys to the keychain.

class TKTokenKeyExchangeParameters

The TKTokenKeyExchangeParameters class encapsulates the parameters necessary for performing specific key exchange operations.

class TKTokenPasswordAuthOperation

The TKTokenPasswordAuthOperation class is a subclass of TKTokenAuthOperation that encapsulates a password-based authentication operation.

class TKTokenSession

The TKTokenSession class encapsulates a token session that manages the authentication state of a token. A TKTokenSession object communicates with its delegate to perform operations with its token that are bound to the authentication state.

class TKTokenSmartCardPINAuthOperation

The TKTokenSmartCardPINAuthOperation class is a TKTokenAuthOperation subclass that encapsulates the context of a Smart Card PIN authentication operation.

class TKTokenWatcher

The TKTokenWatcher class encapsulates the programmatic interface for monitoring system tokens. A TKTokenWatcher object can register to be notified when tokens are added and removed from the system.

Protocols

protocol TKSmartCardTokenDriverDelegate

The TKSmartCardTokenDriverDelegate protocol inherits from the TKTokenDriverDelegate protocol and defines the methods that a delegate of a TKSmartCardTokenDriver object can implement to respond to token creation events.

protocol TKSmartCardUserInteractionDelegate

The TKSmartCardUserInteractionDelegate protocol defines the methods that a delegate of a TKSmartCardUserInteraction object can implement to handle user interaction events.

protocol TKTokenDelegate

The TKTokenDelegate protocol defines the methods that a delegate of a TKToken object can implement to respond to create session and respond to events.

protocol TKTokenDriverDelegate

The TKTokenDriverDelegate protocol defines the methods that a delegate of a TKTokenDriver object can implement to respond to token creation events.

protocol TKTokenSessionDelegate

The TKTokenSessionDelegate protocol defines the methods that a delegate of a TKTokenSession object can implement to respond to token session authentication events.

Reference

See Also