class CamCard

Public Methods

•  CamCard ()
•  ~CamCard ()
• long  connect (string host = "")
• long  disconnect ()
• bool  isConnected ()
• vector  readers ()
• bool  setReader (int reader)
• string  reader ()
• long  connectCard ()
• long  disconnectCard ()
• bool  isConnectedCard ()
• bool  cardPresent ()
• int  cardVersion ()
• long  beginTransaction ()
• long  endTransaction ()
• long  sendAPDU (vector apdu, vector &resp)
• unsigned long  APDUReturnCode ()
• long  selectFile (const vector fileID, vector &header)
• long  readFile (const vector header, vector &file)
• bool  presentPIN (string pin)
• bool  changePIN (string old_pin, string new_pin)
• long  sign (int keyID, const vector data, vector &signature)
• vector  keyIDs ()
• long  readCertificate (int keyID, vector &cert)
• long  readModulus (int keyID, vector &modulus)

Public Static Methods

• static string  stringifyError (long errno)
• static string  vec2str (const vector vec)
• static vector  str2vec (string str)

Public Members

• static const vector MF
• static const vector CHUBB
• static const vector PLAYPEN
• static const vector DF_AUT
• static const vector MAIN_PUB_KEY
• static const vector MAIN_CERT
• static const vector SUMMARY
• static const vector CARD_INFO
• static const vector EF_LIST

Detailed Description

This class takes care of communicating to the PC/SC middleware and accessing the features of the Cambridge University smartcard.

Default constructor.

Default destructor.

[static]

Convert an error code to human-readable string.

Returns: a string describing the error code passed.

Connect to the PC/SC middleware. You must call this method before doing anything else.

Parameters:

host	(optional) The hostname of the machine you wish to connect to. If not specified, the PC/SC middleware on the local machine is contacted. By default, the first reported smartcard reader is used.

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

See also: disconnect

Disconnects from the PC/SC middleware peviously connected to with connect().

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

See also: connect

See if a connection has been established to the PC/SC middleware.

Returns: true if a connection is present, false otherwise.

Returns: A vector of strings containing a description of each smartcard reader connected to the PC/SC middleware. Indices into this vector are what you should pass to setReader() when changing readers.

See also: setReader

Set the smartcard reader which should be used. Disconnects from a card if you were connected.

Parameters:

reader

A number from 0 to the number of elements in vector returned by readers().

Returns: true if successful, false otherwise.

See also: readers

Query the name of the current reader.

Returns: A string containing the smartcard reader which is being used.

Connects to the smartcard in the currently selected reader.

Returns: SCARD_S_SUCCESS if successful, -1 if there is no card, an error code otherwise.

See also: disconnectCard

Disconnects ftom a previously connected to card.

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

See also: connectCard

Query the connection state to the card.

Returns: tru is connected to a card, false otherwise

Query the presence of a card in the currently selected reader.

Returns: true if there is a card present, false otherwise.

Query the card version (only returns meaningful results after a call to connectCard().

Returns: the version of the card currently connected to.

Starts a transaction with the card. This must be called before doing anthing with the card after connectCard().

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

Finishes a transaction with the card. This must be called after doing anthing with the card.

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

See also: beginTransaction

Sends an APDU to the card, writing the result into the vector passed by reference.

Parameters:

apdu	The APDU to send.
resp	The vector to write the response into.

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

Get the return code from last APDU.

Returns: 16-bit return code.

Selects a file by the fileID passed.

Parameters:

fileID	A vector containing the two-byte file ID of the file to select.
header	A vector of undigned char's to write the file header into.

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

Reads a file previously selected with selectFile().

Parameters:

header	A vector containing the fileheader returned by selectFile().
file	A vector to write the file contents into.

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

Presents the PIN specified.

Parameters:

pin	String containing PIN

Returns: true if PIN accepted, false otherwise

Chenges the current PIN

Parameters:

old_pin	The original PIN.
new_pin	The new PIN.

Returns: true if PIN accepted, false otherwise

Digitally 'sign' some data using a specified key. The correct PIN must have been presented during the transaction using presentPIN();

Parameters:

data	The data to be signed.
signature	The vector to write the signature into.
keyID	keyID of key to use.

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

See also: presentPIN, keyIDs

Returns: a vector of valid keyIDs

Write the certificate asssociated with the keyID specified into a vector.

Parameters:

keyID	the keyID of required key.
cert	the vector to write the certificate into.

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

See also: keyIDs

Write the public modulus of the specidied key into a vector.

Parameters:

keyID	the keyID of required key.
modulus	the vector to write the modulus into.

Returns: SCARD_S_SUCCESS if successful, an error code otherwise.

See also: keyIDs

[static]

Converts a vector into a string of two-character hex values.

[static]

Converts a string of two-character hex values into a vector.

• Version: 0.1alpha
• Author: Richard Wareham
• Generated: rjw57 on malachite on Fri Aug 31 15:23:05 2001, using kdoc 2.0a53.