Crate objc2_crypto_token_kit 

Bindings to the CryptoTokenKit framework

See Apple’s docs and the general docs on framework crates for more information.

Structs

TKBERTLVRecordTKTLVRecord

TKBERTLVRecord implements encoding using BER-TLV encoding rules. It is able to parse BER-encoded data and always produces DER-encoded data. No interpretation of tag values is made, all values are treated only as NSData irrespective of the tag.

TKCompactTLVRecordTKTLVRecord

TKCompactTLVRecord implements Compact-TLV encoding according to ISO7816-4 Tag is number in range < 0..15> encoded as high 4 bits of initial byte, length is number in range < 0..15> encoded as low 4 bits of initial byte. Value immediatelly follows leading byte.

TKErrorCodeTKError

Apple’s documentation

TKSimpleTLVRecordTKTLVRecord

TKSimpleTLVRecord implements Simple-TLV encoding according to ISO7816-4. Tag is number in range < 1..254> encoded as single byte, length is either single byte specifying length 0-254 or 3 bytes encoded as 0xff followed by 2 bytes of big-endian encoded number.

TKSmartCardTKSmartCard

Represents SmartCard inserted in the slot. Once the card is physically removed from the slot, the session object is invalid and will always fail the operation invoked on it. In order to communicate with the card, an exclusive session must be established.

TKSmartCardATRTKSmartCardATR

Represents parsed SmartCard ATR. Provides routine for parsing byte stream or NSData with binary ATR and accessors to parsed ATR parts.

TKSmartCardATRInterfaceGroupTKSmartCardATR

Represents single interface-bytes group of ATR.

TKSmartCardPINCharsetTKSmartCard

Enumerates all possible PIN character sets.

TKSmartCardPINCompletionTKSmartCard

Bitmask specifying condition(s) under which PIN entry should be considered complete.

TKSmartCardPINConfirmationTKSmartCard

Bitmask specifying whether PIN confirmation should be requested.

TKSmartCardPINEncodingTKSmartCard

Enumerates all possible PIN encoding types.

TKSmartCardPINFormatTKSmartCard

Specifies PIN formatting properties.

TKSmartCardPINJustificationTKSmartCard

Enumerates all posible PIN justification types.

TKSmartCardProtocolTKSmartCardATR

Bitmask of available SmartCard protocols.

TKSmartCardSlotTKSmartCard

Represents single slot which can contain SmartCard.

TKSmartCardSlotManagerTKSmartCard

Represents pool of SmartCard reader slots.

TKSmartCardSlotNFCSessionTKSmartCardSlotNFCSession

NFC session that’s related to NFC smart card slot which was created.

TKSmartCardSlotStateTKSmartCard

Enumerates all possible slot states.

TKSmartCardTokenTKSmartCardToken and TKToken

TKSmartCardToken base class for implementing SmartCard based token.

TKSmartCardTokenDriverTKSmartCardToken and TKToken

TKSmartCardTokenDriver represents driver for specific SmartCard type.

TKSmartCardTokenRegistrationManagerTKSmartCardTokenRegistrationManager

Provides a centralized management system for registering and unregistering smartcards using their token IDs.

TKSmartCardTokenSessionTKSmartCardToken and TKToken

TKSmartCardTokenSession represents token session based on SmartCard token.

TKSmartCardUserInteractionTKSmartCard

Represents handle to a user interaction involving the SmartCard reader.

TKSmartCardUserInteractionForPINOperationTKSmartCard

User interaction for the secure PIN operations on the SmartCard reader.

TKSmartCardUserInteractionForSecurePINChangeTKSmartCard

User interaction for the secure PIN change on the SmartCard reader.

TKSmartCardUserInteractionForSecurePINVerificationTKSmartCard

User interaction for the secure PIN verification on the SmartCard reader.

TKTLVRecordTKTLVRecord

Base class representing Tag-Length-Value record. Every record has its tag and binary value represented as NSData instance. Allows retrieving record’s tag, value (as NSData object) and binary representation of the record. Existing subclasses implement assorted encodings - TKBERTLVRecord, TKSimpleTLVRecord and TKCompactTLVRecord.

TKTokenTKToken

Class representing single token. When implementing SmartCard based token, it is recommended to inherit the implementation from TKSmartCardToken. Token object serves as synchronization point, all operations invoked upon token and all its sessions are serialized.

TKTokenAuthOperationTKToken

Context of a pending authentication operation.

TKTokenConfigurationTKTokenConfiguration

Holds configuration of one token identified by unique token’s instanceID

TKTokenDriverTKToken

Base class for token drivers. SmartCard token drivers should use TKSmartCardTokenDriver subclass.

TKTokenDriverConfigurationTKTokenConfiguration

Holds configuration of one class of tokens

TKTokenKeyAlgorithmTKToken

TKTokenKeyAlgorithm Encapsulates cryptographic algorithm, possibly with additional associated required algorithms.

TKTokenKeyExchangeParametersTKToken

TKTokenKeyExchangeParameters Encapsulates parameters needed for performing specific Key Exchange operation types.

TKTokenKeychainCertificateTKTokenKeychainItem

Interface for propagation token’s certificates into the keychain.

TKTokenKeychainContentsTKTokenKeychainItem

Contains TKTokenKeychainItem instances (keys and certificates) which represent keychain state (i.e. set of items) of specific token.

TKTokenKeychainItemTKTokenKeychainItem

Base interface for propagation token’s items into the keychain.

TKTokenKeychainKeyTKTokenKeychainItem

Interface for propagation token’s keys into the keychain.

TKTokenOperationTKToken

Apple’s documentation

TKTokenPasswordAuthOperationTKToken

Context of a password authentication operation.

TKTokenSessionTKToken

TKTokenSession represents token session which shares authentication status.

TKTokenSmartCardPINAuthOperationTKSmartCardToken and TKToken

Context of a SmartCard PIN authentication operation.

TKTokenWatcherTKTokenWatcher

Apple’s documentation

TKTokenWatcherTokenInfoTKTokenWatcher

Apple’s documentation

Statics

TKErrorDomain^⚠TKError

Apple’s documentation

Traits

TKSmartCardTokenDriverDelegateTKSmartCardToken and TKToken

TKSmartCardTokenDriverDelegate is used to implement creation of new token instance according to the SmartCard.

TKSmartCardUserInteractionDelegateTKSmartCard

Delegate for user interactions involving the SmartCard reader.

TKTokenDelegateTKToken

TKTokenDelegate contains operations implementing functionality of token class.

TKTokenDriverDelegateTKToken

Delegate for customizing token driver operations. SmartCard tokens should implement TKSmartCardTokenDriverDelegate instead of this base protocol.

TKTokenSessionDelegateTKToken

TKTokenSessionDelegate contains operations with token objects provided by token implementors which should be performed in the context of authentication session.

Type Aliases

TKTLVTagTKTLVRecord

Type used for identifying TLV format tags. Although for some encodings tags can have theoretically any length, this implementation supports tag length only up to 64bits.

TKTokenDriverClassIDTKToken

TKTokenDriverClassID ClassID of the token driver.

TKTokenInstanceIDTKToken

TKTokenInstanceID Unique, persistent identifier of this token in the form of string.

TKTokenObjectIDTKToken

TKTokenObjectID Unique and persistent identification of objects on the token.

TKTokenOperationConstraintTKToken

TKTokenOperationConstraint represents authentication constraint of token object for specific token operation.