HBCI Backend (AqHBCI)
[Backends]


Modules

 HBCI Account Extensions
 HBCI-specific user functions.
 HBCI Message Engine
 HBCI-specific message engine extension.
 HBCI User Extensions
 HBCI-specific user functions.

Functions

AQHBCI_API AB_PROVIDERAH_Provider_new (AB_BANKING *ab, const char *name)
AQHBCI_API int AH_Provider_CreateKeys (AB_PROVIDER *pro, AB_USER *u, int nounmount, uint32_t guiid)
AQHBCI_API int AH_Provider_Test (AB_PROVIDER *pro)

Informative Functions

AQHBCI_API const char * AH_Provider_GetProductName (const AB_PROVIDER *pro)
AQHBCI_API const char * AH_Provider_GetProductVersion (const AB_PROVIDER *pro)

Server Interactive Functions

Functions in this group are used from setup wizards or tools. They send requests to the server (including opening and closing of the progress dialog by calling AB_Banking_ProgressStart etc).

AQHBCI_API int AH_Provider_GetAccounts (AB_PROVIDER *pro, AB_USER *u, AB_IMEXPORTER_CONTEXT *ctx, int nounmount, uint32_t guiid)
AQHBCI_API int AH_Provider_GetSysId (AB_PROVIDER *pro, AB_USER *u, AB_IMEXPORTER_CONTEXT *ctx, int nounmount, uint32_t guiid)
AQHBCI_API int AH_Provider_GetServerKeys (AB_PROVIDER *pro, AB_USER *u, AB_IMEXPORTER_CONTEXT *ctx, int nounmount, uint32_t guiid)
AQHBCI_API int AH_Provider_SendUserKeys (AB_PROVIDER *pro, AB_USER *u, AB_IMEXPORTER_CONTEXT *ctx, int nounmount, uint32_t guiid)
AQHBCI_API int AH_Provider_SendUserKeys2 (AB_PROVIDER *pro, AB_USER *u, AB_IMEXPORTER_CONTEXT *ctx, int withAuthKey, int nounmount, uint32_t guiid)
AQHBCI_API int AH_Provider_GetCert (AB_PROVIDER *pro, AB_USER *u, int nounmount, uint32_t guiid)
AQHBCI_API int AH_Provider_GetItanModes (AB_PROVIDER *pro, AB_USER *u, AB_IMEXPORTER_CONTEXT *ctx, int nounmount, uint32_t guiid)
AQHBCI_API int AH_Provider_ChangePin (AB_PROVIDER *pro, AB_USER *u, AB_IMEXPORTER_CONTEXT *ctx, int nounmount, uint32_t guiid)

Generating Ini-Letters

INI letters are used in RDH mode only. They are used to verify the public server keys and to create a letter to be sent to the bank for verification of the public user keys.

AQHBCI_API int AH_Provider_GetIniLetterTxt (AB_PROVIDER *pro, AB_USER *u, int useBankKey, int variant, GWEN_BUFFER *lbuf, int nounmount, uint32_t guiid)
AQHBCI_API int AH_Provider_GetIniLetterHtml (AB_PROVIDER *pro, AB_USER *u, int useBankKey, int variant, GWEN_BUFFER *lbuf, int nounmount, uint32_t guiid)

Detailed Description

AqHBCI supports the German HBCI (Homebanking Computer Interface) protocol for online banking. It currently supports version 2.01, 2.10 and 2.20 of the HBCI specification.

Function Documentation

AQHBCI_API int AH_Provider_ChangePin ( AB_PROVIDER pro,
AB_USER u,
AB_IMEXPORTER_CONTEXT ctx,
int  nounmount,
uint32_t  guiid 
)

Ask the user for a new PIN and make the server change the PIN to the newly entered one.

Parameters:
pro pointer to the HBCI provider
u user for which the pin is to be changed
nounmount if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

AQHBCI_API int AH_Provider_CreateKeys ( AB_PROVIDER pro,
AB_USER u,
int  nounmount,
uint32_t  guiid 
)

AQHBCI_API int AH_Provider_GetAccounts ( AB_PROVIDER pro,
AB_USER u,
AB_IMEXPORTER_CONTEXT ctx,
int  nounmount,
uint32_t  guiid 
)

Retrieve a list of accounts. Not all banks support this. If the bank does then the retrieved accounts are automatically added to AqBanking.

Parameters:
pro pointer to the HBCI provider
u user for which the list of accounts is to be received
nounmount if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

AQHBCI_API int AH_Provider_GetCert ( AB_PROVIDER pro,
AB_USER u,
int  nounmount,
uint32_t  guiid 
)

Retrieve the SSL certificate for the given user. This is only needed for PIN/TAN mode.

Parameters:
pro pointer to the HBCI provider
u user for which the SSL certificate is to be received
nounmount if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

AQHBCI_API int AH_Provider_GetIniLetterHtml ( AB_PROVIDER pro,
AB_USER u,
int  useBankKey,
int  variant,
GWEN_BUFFER *  lbuf,
int  nounmount,
uint32_t  guiid 
)

Creates a HTML version of the INI letter. This function needs to mount the medium so the user will be ask for the pin.

Parameters:
pro provider
u user for which the iniletter is to be created
useBankKey if !=0 create an iniletter for the bank key
variant use 1 for RDH1, 2 for RDH2-10 (or 0 for autoselection)
lbuf buffer to write the iniletter to
nounmount if !=0 the CryptToken will not be unmounted after use
guiid GUI id in whose context the function is called (for GWEN_Gui_ProgressLog etc)

AQHBCI_API int AH_Provider_GetIniLetterTxt ( AB_PROVIDER pro,
AB_USER u,
int  useBankKey,
int  variant,
GWEN_BUFFER *  lbuf,
int  nounmount,
uint32_t  guiid 
)

Creates a text version of the INI letter. This function needs to mount the medium so the user will be ask for the pin.

Parameters:
pro provider
u user for which the iniletter is to be created
useBankKey if !=0 create an iniletter for the bank key
variant use 1 for RDH1, 2 for RDH2-10 (or 0 for autoselection)
lbuf buffer to write the iniletter to
nounmount if !=0 the CryptToken will not be unmounted after use
guiid GUI id in whose context the function is called (for GWEN_Gui_ProgressLog etc)

AQHBCI_API int AH_Provider_GetItanModes ( AB_PROVIDER pro,
AB_USER u,
AB_IMEXPORTER_CONTEXT ctx,
int  nounmount,
uint32_t  guiid 
)

Ask the server for the list of supported iTAN modes. Not all servers support iTAN so it is ok for the server to not report any modes.

Parameters:
pro pointer to the HBCI provider
u user for which the list of iTAN modes is to be received
nounmount if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

AQHBCI_API const char* AH_Provider_GetProductName ( const AB_PROVIDER pro  ) 

AQHBCI_API const char* AH_Provider_GetProductVersion ( const AB_PROVIDER pro  ) 

AQHBCI_API int AH_Provider_GetServerKeys ( AB_PROVIDER pro,
AB_USER u,
AB_IMEXPORTER_CONTEXT ctx,
int  nounmount,
uint32_t  guiid 
)

Retrieve the public server keys for the given user. This is only needed for PIN/TAN and for RDH mode.

Parameters:
pro pointer to the HBCI provider
u user for which the public keys are to be received
nounmount if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

AQHBCI_API int AH_Provider_GetSysId ( AB_PROVIDER pro,
AB_USER u,
AB_IMEXPORTER_CONTEXT ctx,
int  nounmount,
uint32_t  guiid 
)

Retrieve the system id for the given user. This is only needed for PIN/TAN and for RDH mode.

Parameters:
pro pointer to the HBCI provider
u user for which the system id is to be received
nounmount if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

AQHBCI_API AB_PROVIDER* AH_Provider_new ( AB_BANKING ab,
const char *  name 
)

AQHBCI_API int AH_Provider_SendUserKeys ( AB_PROVIDER pro,
AB_USER u,
AB_IMEXPORTER_CONTEXT ctx,
int  nounmount,
uint32_t  guiid 
)

Send the public keys of the given user. This is only needed for PIN/TAN and for RDH mode.

Parameters:
pro pointer to the HBCI provider
u user for which the public keys are to be sent
nounmount if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

AQHBCI_API int AH_Provider_SendUserKeys2 ( AB_PROVIDER pro,
AB_USER u,
AB_IMEXPORTER_CONTEXT ctx,
int  withAuthKey,
int  nounmount,
uint32_t  guiid 
)

Send the public keys of the given user. This is only needed for PIN/TAN and for RDH mode. In addition to AH_Provider_SendUserKeys this function also sends the authentication key if requested.

Parameters:
pro pointer to the HBCI provider
u user for which the public keys are to be sent
nounmount if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

AQHBCI_API int AH_Provider_Test ( AB_PROVIDER pro  ) 


Generated on Wed Aug 26 20:51:09 2009 for aqbanking by  doxygen 1.5.9