SCM iOS API
TokenObject Class Reference

Class describes a cryptographic object located in a smart card. More...

Inheritance diagram for TokenObject:
Certificate Key PrivateKey PublicKey

Instance Methods

(NSString *) - getType
 
(NSString *) - getCkLabel
 
(NSString *) - getCkId
 
(Token *) - getParent
 
(NSUInteger) - getPinNumber
 

Detailed Description

Class describes a cryptographic object located in a smart card.

Note that the constructor is not intended to be called by user code. Such objects are constructed internally by the API.

Method Documentation

◆ getCkId()

- (NSString *) getCkId

Gets identifier string, corresponding to the hexadecimal representation of the CKA_ID attribute of the object, as seen by the PKCS#11.

This value can be used to match keys and certificates that are linked together (belong in the same container).

Returns
the CKA_ID attribute of the object.

◆ getCkLabel()

- (NSString *) getCkLabel

Gets label string, corresponding to the CKA_LABEL attribute of the object, as seen by the PKCS#11 interface.

Returns
the CKA_LABEL attribute of the object.

◆ getParent()

- (Token *) getParent

Gets the Token object form which the object has been retrieved.

Returns
the Token object.

◆ getPinNumber()

- (NSUInteger) getPinNumber

Gets index of the PIN which grants acces to the object. This corresponds to the index within the Token#pins array.

For public objects (certificates and public keys), it is the PIN which grants access to the corresponding private key (association is determined by the TokenObject#getCkId attribute).

Returns
the index of the PIN.

◆ getType()

- (NSString *) getType

Gets the type of the object.

Possible values are : "certificate" , "publicKey" and "privateKey.

Returns
the type of the object.

The documentation for this class was generated from the following files: