HBCI User Extensions
[HBCI Backend (AqHBCI)]


Detailed Description

HBCI-specific user functions.

Author:
Martin Preuss<martin@libchipcard.de>


HBCI User Flags

#define AH_USER_FLAGS_BANK_DOESNT_SIGN   0x00000001
#define AH_USER_FLAGS_BANK_USES_SIGNSEQ   0x00000002
#define AH_USER_FLAGS_RESERVED1   0x00000004
#define AH_USER_FLAGS_RESERVED2   0x00000008
#define AH_USER_FLAGS_KEEPALIVE   0x00000010
#define AH_USER_FLAGS_IGNORE_UPD   0x00000020

Functions for Flags and Status

enum  AH_USER_STATUS {
  AH_UserStatusNew = 0, AH_UserStatusEnabled, AH_UserStatusPending, AH_UserStatusDisabled,
  AH_UserStatusUnknown = 999
}
AQHBCI_API void AH_User_Flags_toDb (GWEN_DB_NODE *db, const char *name, GWEN_TYPE_UINT32 flags)
AQHBCI_API GWEN_TYPE_UINT32 AH_User_Flags_fromDb (GWEN_DB_NODE *db, const char *name)
AQHBCI_API const char * AH_User_Status_toString (AH_USER_STATUS st)
AQHBCI_API AH_USER_STATUS AH_User_Status_fromString (const char *s)
AQHBCI_API AH_USER_STATUS AH_User_GetStatus (const AB_USER *u)
AQHBCI_API void AH_User_SetStatus (AB_USER *u, AH_USER_STATUS i)
AQHBCI_API GWEN_TYPE_UINT32 AH_User_GetFlags (const AB_USER *u)
AQHBCI_API void AH_User_SetFlags (AB_USER *u, GWEN_TYPE_UINT32 flags)
AQHBCI_API void AH_User_AddFlags (AB_USER *u, GWEN_TYPE_UINT32 flags)
AQHBCI_API void AH_User_SubFlags (AB_USER *u, GWEN_TYPE_UINT32 flags)

Medium Functions

AQHBCI_API AH_MEDIUMAH_User_GetMedium (const AB_USER *u)
AQHBCI_API void AH_User_SetMedium (AB_USER *u, AH_MEDIUM *m)
AQHBCI_API int AH_User_GetContextIdx (const AB_USER *u)
AQHBCI_API void AH_User_SetContextIdx (AB_USER *u, int idx)

Miscellanous Settings

AQHBCI_API AH_CRYPT_MODE AH_User_GetCryptMode (const AB_USER *u)
AQHBCI_API void AH_User_SetCryptMode (AB_USER *u, AH_CRYPT_MODE m)
AQHBCI_API const char * AH_User_GetPeerId (const AB_USER *u)
AQHBCI_API void AH_User_SetPeerId (AB_USER *u, const char *s)
AQHBCI_API const char * AH_User_GetSystemId (const AB_USER *u)
AQHBCI_API void AH_User_SetSystemId (AB_USER *u, const char *s)
AQHBCI_API const GWEN_URL * AH_User_GetServerUrl (const AB_USER *u)
AQHBCI_API void AH_User_SetServerUrl (AB_USER *u, const GWEN_URL *url)
AQHBCI_API int AH_User_GetHbciVersion (const AB_USER *u)
AQHBCI_API void AH_User_SetHbciVersion (AB_USER *u, int i)

Pin/Tan Settings

AQHBCI_API int AH_User_GetHttpVMajor (const AB_USER *u)
AQHBCI_API void AH_User_SetHttpVMajor (AB_USER *u, int i)
AQHBCI_API int AH_User_GetHttpVMinor (const AB_USER *u)
AQHBCI_API void AH_User_SetHttpVMinor (AB_USER *u, int i)
AQHBCI_API const char * AH_User_GetHttpUserAgent (const AB_USER *u)
AQHBCI_API void AH_User_SetHttpUserAgent (AB_USER *u, const char *s)


Define Documentation

#define AH_USER_FLAGS_BANK_DOESNT_SIGN   0x00000001
 

bank doesn't sign its messages

Definition at line 46 of file aqhbci/user.h.

#define AH_USER_FLAGS_BANK_USES_SIGNSEQ   0x00000002
 

bank uses correct signature sequence counters for its messages

Definition at line 48 of file aqhbci/user.h.

#define AH_USER_FLAGS_IGNORE_UPD   0x00000020
 

this flag is set automatically by AqHBCI upon BPD/UPD receiption. It indicates that some jobs are supported even when there is no UPD job description for it

Definition at line 57 of file aqhbci/user.h.

#define AH_USER_FLAGS_KEEPALIVE   0x00000010
 

for pin/tan mode: keep HTTP connections alive (reuse for multiple requests)

Definition at line 53 of file aqhbci/user.h.

#define AH_USER_FLAGS_RESERVED1   0x00000004
 

Definition at line 49 of file aqhbci/user.h.

#define AH_USER_FLAGS_RESERVED2   0x00000008
 

Definition at line 50 of file aqhbci/user.h.


Enumeration Type Documentation

enum AH_USER_STATUS
 

Enumerator:
AH_UserStatusNew 
AH_UserStatusEnabled 
AH_UserStatusPending 
AH_UserStatusDisabled 
AH_UserStatusUnknown 

Definition at line 73 of file aqhbci/user.h.


Function Documentation

AQHBCI_API void AH_User_AddFlags AB_USER u,
GWEN_TYPE_UINT32  flags
 

AQHBCI_API GWEN_TYPE_UINT32 AH_User_Flags_fromDb GWEN_DB_NODE *  db,
const char *  name
 

AQHBCI_API void AH_User_Flags_toDb GWEN_DB_NODE *  db,
const char *  name,
GWEN_TYPE_UINT32  flags
 

AQHBCI_API int AH_User_GetContextIdx const AB_USER u  ) 
 

AQHBCI_API AH_CRYPT_MODE AH_User_GetCryptMode const AB_USER u  ) 
 

Crypt mode (see AH_CryptMode_Ddv and following).

AQHBCI_API GWEN_TYPE_UINT32 AH_User_GetFlags const AB_USER u  ) 
 

Returns 0 if the bank doesn't sign messages, 1 otherwise. This can be used in case the bank sends a sign key upon request but never signs it's messages.

AQHBCI_API int AH_User_GetHbciVersion const AB_USER u  ) 
 

AQHBCI_API const char* AH_User_GetHttpUserAgent const AB_USER u  ) 
 

AQHBCI_API int AH_User_GetHttpVMajor const AB_USER u  ) 
 

Returns the major HTTP version to be used in PIN/TAN mode (defaults to 1).

AQHBCI_API int AH_User_GetHttpVMinor const AB_USER u  ) 
 

Returns the minor HTTP version to be used in PIN/TAN mode (defaults to 1).

AQHBCI_API AH_MEDIUM* AH_User_GetMedium const AB_USER u  ) 
 

AQHBCI_API const char* AH_User_GetPeerId const AB_USER u  ) 
 

AQHBCI_API const GWEN_URL* AH_User_GetServerUrl const AB_USER u  ) 
 

AQHBCI_API AH_USER_STATUS AH_User_GetStatus const AB_USER u  ) 
 

AQHBCI_API const char* AH_User_GetSystemId const AB_USER u  ) 
 

AQHBCI_API void AH_User_SetContextIdx AB_USER u,
int  idx
 

AQHBCI_API void AH_User_SetCryptMode AB_USER u,
AH_CRYPT_MODE  m
 

AQHBCI_API void AH_User_SetFlags AB_USER u,
GWEN_TYPE_UINT32  flags
 

AQHBCI_API void AH_User_SetHbciVersion AB_USER u,
int  i
 

AQHBCI_API void AH_User_SetHttpUserAgent AB_USER u,
const char *  s
 

AQHBCI_API void AH_User_SetHttpVMajor AB_USER u,
int  i
 

AQHBCI_API void AH_User_SetHttpVMinor AB_USER u,
int  i
 

AQHBCI_API void AH_User_SetMedium AB_USER u,
AH_MEDIUM m
 

AQHBCI_API void AH_User_SetPeerId AB_USER u,
const char *  s
 

AQHBCI_API void AH_User_SetServerUrl AB_USER u,
const GWEN_URL *  url
 

AQHBCI_API void AH_User_SetStatus AB_USER u,
AH_USER_STATUS  i
 

AQHBCI_API void AH_User_SetSystemId AB_USER u,
const char *  s
 

AQHBCI_API AH_USER_STATUS AH_User_Status_fromString const char *  s  ) 
 

AQHBCI_API const char* AH_User_Status_toString AH_USER_STATUS  st  ) 
 

AQHBCI_API void AH_User_SubFlags AB_USER u,
GWEN_TYPE_UINT32  flags
 


Generated on Wed Jun 28 15:17:45 2006 for aqbanking by  doxygen 1.4.6