HBCI User Extensions
[HBCI Backend (AqHBCI)]


Detailed Description

HBCI-specific user functions.

Author:
Martin Preuss<martin@libchipcard.de>


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 void AH_User_TanMethods_toDb (GWEN_DB_NODE *db, const char *name, GWEN_TYPE_UINT32 m)
AQHBCI_API GWEN_TYPE_UINT32 AH_User_TanMethods_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)

PIN/TAN Specific Functions

AQHBCI_API GWEN_TYPE_UINT32 AH_User_GetTanMethods (const AB_USER *u)
AQHBCI_API void AH_User_SetTanMethods (AB_USER *u, GWEN_TYPE_UINT32 m)
AQHBCI_API void AH_User_AddTanMethods (AB_USER *u, GWEN_TYPE_UINT32 m)
AQHBCI_API void AH_User_SubTanMethods (AB_USER *u, GWEN_TYPE_UINT32 m)

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)

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

HBCI TAN Methods

#define AH_USER_TANMETHOD_SINGLE_STEP   0x00000001
#define AH_USER_TANMETHOD_TWO_STEP_0   0x00000002
#define AH_USER_TANMETHOD_TWO_STEP_1   0x00000004
#define AH_USER_TANMETHOD_TWO_STEP_2   0x00000008
#define AH_USER_TANMETHOD_TWO_STEP_3   0x00000010
#define AH_USER_TANMETHOD_TWO_STEP_4   0x00000020
#define AH_USER_TANMETHOD_TWO_STEP_5   0x00000040
#define AH_USER_TANMETHOD_TWO_STEP_6   0x00000060
#define AH_USER_TANMETHOD_TWO_STEP_7   0x00000080
#define AH_USER_TANMETHOD_TWO_STEP_00   0x00000100
#define AH_USER_TANMETHOD_TWO_STEP_01   0x00000400
#define AH_USER_TANMETHOD_TWO_STEP_02   0x00000800
#define AH_USER_TANMETHOD_TWO_STEP_03   0x00001000
#define AH_USER_TANMETHOD_TWO_STEP_04   0x00002000
#define AH_USER_TANMETHOD_TWO_STEP_05   0x00004000
#define AH_USER_TANMETHOD_TWO_STEP_06   0x00008000
#define AH_USER_TANMETHOD_TWO_STEP_07   0x00010000


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.

#define AH_USER_TANMETHOD_SINGLE_STEP   0x00000001

single step PIN/TAN

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

#define AH_USER_TANMETHOD_TWO_STEP_0   0x00000002

two step PIN/TAN, method 0 (990)

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

#define AH_USER_TANMETHOD_TWO_STEP_00   0x00000100

two step PIN/TAN, method 0 (900)

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

#define AH_USER_TANMETHOD_TWO_STEP_01   0x00000400

two step PIN/TAN, method 0 (901)

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

#define AH_USER_TANMETHOD_TWO_STEP_02   0x00000800

two step PIN/TAN, method 0 (902)

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

#define AH_USER_TANMETHOD_TWO_STEP_03   0x00001000

two step PIN/TAN, method 0 (903)

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

#define AH_USER_TANMETHOD_TWO_STEP_04   0x00002000

two step PIN/TAN, method 0 (904)

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

#define AH_USER_TANMETHOD_TWO_STEP_05   0x00004000

two step PIN/TAN, method 0 (905)

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

#define AH_USER_TANMETHOD_TWO_STEP_06   0x00008000

two step PIN/TAN, method 0 (906)

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

#define AH_USER_TANMETHOD_TWO_STEP_07   0x00010000

two step PIN/TAN, method 0 (907)

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

#define AH_USER_TANMETHOD_TWO_STEP_1   0x00000004

two step PIN/TAN, method 1 (991)

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

#define AH_USER_TANMETHOD_TWO_STEP_2   0x00000008

two step PIN/TAN, method 2 (992)

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

#define AH_USER_TANMETHOD_TWO_STEP_3   0x00000010

two step PIN/TAN, method 3 (993)

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

#define AH_USER_TANMETHOD_TWO_STEP_4   0x00000020

two step PIN/TAN, method 4 (994)

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

#define AH_USER_TANMETHOD_TWO_STEP_5   0x00000040

two step PIN/TAN, method 5 (995)

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

#define AH_USER_TANMETHOD_TWO_STEP_6   0x00000060

two step PIN/TAN, method 6 (996)

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

#define AH_USER_TANMETHOD_TWO_STEP_7   0x00000080

two step PIN/TAN, method 7 (997)

Definition at line 83 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 124 of file aqhbci/user.h.


Function Documentation

AQHBCI_API void AH_User_AddFlags ( AB_USER u,
GWEN_TYPE_UINT32  flags 
)

AQHBCI_API void AH_User_AddTanMethods ( AB_USER u,
GWEN_TYPE_UINT32  m 
)

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 GWEN_TYPE_UINT32 AH_User_GetTanMethods ( 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 void AH_User_SetTanMethods ( AB_USER u,
GWEN_TYPE_UINT32  m 
)

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 
)

AQHBCI_API void AH_User_SubTanMethods ( AB_USER u,
GWEN_TYPE_UINT32  m 
)

AQHBCI_API GWEN_TYPE_UINT32 AH_User_TanMethods_fromDb ( GWEN_DB_NODE *  db,
const char *  name 
)

AQHBCI_API void AH_User_TanMethods_toDb ( GWEN_DB_NODE *  db,
const char *  name,
GWEN_TYPE_UINT32  m 
)


Generated on Sun Apr 29 17:23:06 2007 for aqbanking by  doxygen 1.5.1