Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

HBCI_Medium and derivations


Medium management

HBCI_Error * HBCI_Medium_selectContext (HBCI_Medium *h, int country, const char *instcode, const char *userid)
HBCI_Error * HBCI_Medium_mountMedium (HBCI_Medium *h, const char *pin)
HBCI_Error * HBCI_Medium_unmountMedium (HBCI_Medium *h, const char *pin)

Medium information

int HBCI_Medium_isMounted (HBCI_Medium *h)
char * HBCI_Medium_mediumId (const HBCI_Medium *h)
int HBCI_Medium_securityMode (const HBCI_Medium *h)
const char * HBCI_Medium_mediumName (const HBCI_Medium *h)
HBCI_Error * HBCI_Medium_getContext (const HBCI_Medium *h, int num, int *countrycode, char **instcode, char **userid, char **server)

HBCI_MediumRDHBase methods

HBCI_Medium * HBCI_MediumRDHBase_Medium (HBCI_MediumRDHBase *h)
HBCI_MediumRDHBase * HBCI_Medium_MediumRDHBase (HBCI_Medium *h)
int HBCI_MediumRDHBase_hasInstSignKey (const HBCI_MediumRDHBase *h)
char * HBCI_MediumRDHBase_getInstIniLetterExponent (const HBCI_MediumRDHBase *h, int usecrypt)
char * HBCI_MediumRDHBase_getInstIniLetterHash (const HBCI_MediumRDHBase *h, int usecrypt)
char * HBCI_MediumRDHBase_getInstIniLetterModulus (const HBCI_MediumRDHBase *h, int usecrypt)
int HBCI_MediumRDHBase_getInstKeyNumber (const HBCI_MediumRDHBase *h, int usecrypt)
int HBCI_MediumRDHBase_getInstKeyVersion (const HBCI_MediumRDHBase *h, int usecrypt)
char * HBCI_MediumRDHBase_getUserIniLetterExponent (const HBCI_MediumRDHBase *h)
char * HBCI_MediumRDHBase_getUserIniLetterHash (const HBCI_MediumRDHBase *h)
char * HBCI_MediumRDHBase_getUserIniLetterModulus (const HBCI_MediumRDHBase *h)
int HBCI_MediumRDHBase_getUserKeyNumber (const HBCI_MediumRDHBase *h)
int HBCI_MediumRDHBase_getUserKeyVersion (const HBCI_MediumRDHBase *h)

Typedefs

typedef HBCI::Medium HBCI_Medium
typedef HBCI::MediumRDHBase HBCI_MediumRDHBase

Typedef Documentation

typedef struct HBCI::Medium HBCI_Medium
 

typedef HBCI::MediumRDHBase HBCI_MediumRDHBase
 

Function Documentation

HBCI_Error* HBCI_Medium_getContext (  const HBCI_Medium *    h,
int    num,
int *    countrycode,
char **    instcode,
char **    userid,
char **    server
) 
 

Returns the context with the given number. Some media are able of storing multiple contexts (like chip cards). Please note that the medium has to be mounted prior to calling this method.

Returns :
NULL if a context with that number exists, or HBCI_Error on error.
Parameters:
h  The medium to perform this action on.
num  number of the context (starting with 1)
countrycode  reference to an int var to receive the country code of the context (280 for Germany)
instcode  reference to a string variable to receive the institute code of that context (German "Bankleitzahl"). To be free'd by the caller, but only if this method didn't return a HBCI_Error, in which case this parameter is left unchanged.
userid  reference to a string variable to receive the user id of the context (assigned to you by the institute). To be free'd by the caller, but only if this method didn't return a HBCI_Error, in which case this parameter is left unchanged.
server  reference to a string to receive the server address. To be free'd by the caller, but only if this method didn't return a HBCI_Error, in which case this parameter is left unchanged.

int HBCI_Medium_isMounted (  HBCI_Medium *    h ) 
 

Checks whether the medium is mounted. This method should check if the CORRECT medium is mounted and return false if no medium or even a false medium is mounted.

Parameters:
h  The medium to perform this action on.
Returns :
TRUE (1) if medium mounted, FALSE (0) if not (or on error)

char* HBCI_Medium_mediumId (  const HBCI_Medium *    h ) 
 

Returns the id of the medium. For DDV this is the CID of the chip card, for RDH this is the system ID assigned to us by an institute.

Parameters:
h  The medium to perform this action on.
Returns :
Pointer to the string with the Id. MUST be free'd by the caller when no longer needed.

const char* HBCI_Medium_mediumName (  const HBCI_Medium *    h ) 
 

Returns the name of the medium.

For DDV this is the card number. For RDH this is the name of the file. This is used when saving HBCIUser data to refer to the medium used.

HBCI_MediumRDHBase* HBCI_Medium_MediumRDHBase (  HBCI_Medium *    h ) 
 

Downcast. Returns NULL if this is not a MediumRDHBase.

HBCI_Error* HBCI_Medium_mountMedium (  HBCI_Medium *    h,
const char *    pin
) 
 

Mounts a medium and makes its crypto methods available.

Parameters:
h  The medium to perform this action on.
pin  The secret PIN that is needed to actually mount this medium (FIXME: is this correct?). May be NULL.
Returns :
NULL if medium mounted, or the HBCI_Error if one occurred.

int HBCI_Medium_securityMode (  const HBCI_Medium *    h ) 
 

Returns the security mode of this medium (DDV, RDH)

HBCI_Error* HBCI_Medium_selectContext (  HBCI_Medium *    h,
int    country,
const char *    instcode,
const char *    userid
) 
 

Since some media (like hbci chip cards) are able to store multiple account entries you have to select one.

HBCI_Error* HBCI_Medium_unmountMedium (  HBCI_Medium *    h,
const char *    pin
) 
 

Unmounts a medium so that it may be removed. See mountMedium() about nested mounts.

Parameters:
h  The medium to perform this action on.
pin  The secret PIN that is needed to actually mount this medium. May be NULL.
Returns :
NULL if medium unmounted, or the HBCI_Error if one occurred.

char* HBCI_MediumRDHBase_getInstIniLetterExponent (  const HBCI_MediumRDHBase *    h,
int    usecrypt
) 
 

Returns the version of the institute key.

Parameters:
h  The object to perform this action on.
usecrypt  If true, then the data of crypt key is read instead of that of the sign key. This exists for the case when your institute does not sign its messages. In that not-so-good case, MediumRDH::hasInstSignKey returned false (the inverse of this argument). If unsure, leave it to the default value false.

char* HBCI_MediumRDHBase_getInstIniLetterHash (  const HBCI_MediumRDHBase *    h,
int    usecrypt
) 
 

Returns the version of the institute key.

Parameters:
h  The object to perform this action on.
usecrypt  If true, then the data of crypt key is read instead of that of the sign key. See HBCI_MediumRDHBase_getInstIniLetterExponent().

char* HBCI_MediumRDHBase_getInstIniLetterModulus (  const HBCI_MediumRDHBase *    h,
int    usecrypt
) 
 

Returns the version of the institute key.

Parameters:
h  The object to perform this action on.
usecrypt  If true, then the data of crypt key is read instead of that of the sign key. See HBCI_MediumRDHBase_getInstIniLetterExponent().

int HBCI_MediumRDHBase_getInstKeyNumber (  const HBCI_MediumRDHBase *    h,
int    usecrypt
) 
 

Returns the version of the institute key.

Parameters:
h  The object to perform this action on.
usecrypt  If true, then the data of crypt key is read instead of that of the sign key. See HBCI_MediumRDHBase_getInstIniLetterExponent().

int HBCI_MediumRDHBase_getInstKeyVersion (  const HBCI_MediumRDHBase *    h,
int    usecrypt
) 
 

Returns the version of the institute key.

Parameters:
h  The object to perform this action on.
usecrypt  If true, then the data of crypt key is read instead of that of the sign key. See HBCI_MediumRDHBase_getInstIniLetterExponent().

char* HBCI_MediumRDHBase_getUserIniLetterExponent (  const HBCI_MediumRDHBase *    h ) 
 

return the ini-letter-exponent that is needed to print the ini-letter

char* HBCI_MediumRDHBase_getUserIniLetterHash (  const HBCI_MediumRDHBase *    h ) 
 

return the ini-letter-hash that is needed to print the ini-letter

char* HBCI_MediumRDHBase_getUserIniLetterModulus (  const HBCI_MediumRDHBase *    h ) 
 

return the ini-letter-modulus that is needed to print the ini-letter

int HBCI_MediumRDHBase_getUserKeyNumber (  const HBCI_MediumRDHBase *    h ) 
 

This method is needed when generating the users ini letter.

Returns :
the number of the user's public crypt key

int HBCI_MediumRDHBase_getUserKeyVersion (  const HBCI_MediumRDHBase *    h ) 
 

This method is needed when generating the users ini letter.

Returns :
the version of the user's public crypt key

int HBCI_MediumRDHBase_hasInstSignKey (  const HBCI_MediumRDHBase *    h ) 
 

Returns true, if the institute/bank of this MediumRDH uses a public signature key.

HBCI_Medium* HBCI_MediumRDHBase_Medium (  HBCI_MediumRDHBase *    h ) 
 

Upcast.

Generated on Mon Jun 23 13:41:08 2003 for openhbci by doxygen1.2.17