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, uint32_t flags)
AQHBCI_API uint32_t 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 uint32_t AH_User_GetFlags (const AB_USER *u)
AQHBCI_API void AH_User_SetFlags (AB_USER *u, uint32_t flags)
AQHBCI_API void AH_User_AddFlags (AB_USER *u, uint32_t flags)
AQHBCI_API void AH_User_SubFlags (AB_USER *u, uint32_t flags)

PIN/TAN Specific Functions

AQHBCI_API const int * AH_User_GetTanMethodList (const AB_USER *u)
AQHBCI_API int AH_User_GetTanMethodCount (const AB_USER *u)
AQHBCI_API int AH_User_HasTanMethod (const AB_USER *u, int method)
AQHBCI_API int AH_User_HasTanMethodOtherThan (const AB_USER *u, int method)
AQHBCI_API void AH_User_AddTanMethod (AB_USER *u, int method)
AQHBCI_API void AH_User_ClearTanMethodList (AB_USER *u)
AQHBCI_API int AH_User_GetSelectedTanMethod (const AB_USER *u)
AQHBCI_API void AH_User_SetSelectedTanMethod (AB_USER *u, int i)
AQHBCI_API const char * AH_User_GetHttpContentType (const AB_USER *u)
AQHBCI_API void AH_User_SetHttpContentType (AB_USER *u, const char *s)

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 int AH_User_GetRdhType (const AB_USER *u)
AQHBCI_API void AH_User_SetRdhType (AB_USER *u, int i)
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)

Passwords/Pins/Tans

AQHBCI_API int AH_User_MkPasswdName (const AB_USER *u, GWEN_BUFFER *buf)
AQHBCI_API int AH_User_MkPinName (const AB_USER *u, GWEN_BUFFER *buf)
AQHBCI_API int AH_User_MkTanName (const AB_USER *u, const char *challenge, GWEN_BUFFER *buf)
AQHBCI_API const
AH_TAN_METHOD_LIST
AH_User_GetTanMethodDescriptions (const AB_USER *u)

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
#define AH_USER_FLAGS_FORCE_SSL3   0x00000040
#define AH_USER_FLAGS_NO_BASE64   0x00000080
#define AH_USER_FLAGS_KEEP_MULTIPLE_BLANKS   0x00000100

Functions

AQHBCI_API const char * AH_User_GetTokenType (const AB_USER *u)
AQHBCI_API void AH_User_SetTokenType (AB_USER *u, const char *s)
AQHBCI_API const char * AH_User_GetTokenName (const AB_USER *u)
AQHBCI_API void AH_User_SetTokenName (AB_USER *u, const char *s)
AQHBCI_API uint32_t AH_User_GetTokenContextId (const AB_USER *u)
AQHBCI_API void AH_User_SetTokenContextId (AB_USER *u, uint32_t id)
AQHBCI_API int AH_User_GetMaxTransfersPerJob (const AB_USER *u)
AQHBCI_API void AH_User_SetMaxTransfersPerJob (AB_USER *u, int i)
AQHBCI_API int AH_User_GetMaxDebitNotesPerJob (const AB_USER *u)
AQHBCI_API void AH_User_SetMaxDebitNotesPerJob (AB_USER *u, int i)


Define Documentation

#define AH_USER_FLAGS_BANK_DOESNT_SIGN   0x00000001

bank doesn't sign its messages

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

#define AH_USER_FLAGS_FORCE_SSL3   0x00000040

forces use of SSLv3 for Pin/TAN mode

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

#define AH_USER_FLAGS_KEEP_MULTIPLE_BLANKS   0x00000100

Normally the SWIFT parser removed double blanks, with this flag set it no longer does (as requested by Andreas Filsinger).

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

#define AH_USER_FLAGS_NO_BASE64   0x00000080

do not encode message in BASE64 (needed for APO bank)

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

#define AH_USER_FLAGS_RESERVED1   0x00000004

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

#define AH_USER_FLAGS_RESERVED2   0x00000008

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


Enumeration Type Documentation

Enumerator:
AH_UserStatusNew 
AH_UserStatusEnabled 
AH_UserStatusPending 
AH_UserStatusDisabled 
AH_UserStatusUnknown 

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


Function Documentation

AQHBCI_API void AH_User_AddFlags ( AB_USER u,
uint32_t  flags 
)

AQHBCI_API void AH_User_AddTanMethod ( AB_USER u,
int  method 
)

AQHBCI_API void AH_User_ClearTanMethodList ( AB_USER u  ) 

AQHBCI_API uint32_t 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,
uint32_t  flags 
)

AQHBCI_API AH_CRYPT_MODE AH_User_GetCryptMode ( const AB_USER u  ) 

Crypt mode (see AH_CryptMode_Ddv and following).

AQHBCI_API uint32_t 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_GetHttpContentType ( 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 int AH_User_GetMaxDebitNotesPerJob ( const AB_USER u  ) 

AQHBCI_API int AH_User_GetMaxTransfersPerJob ( const AB_USER u  ) 

AQHBCI_API const char* AH_User_GetPeerId ( const AB_USER u  ) 

AQHBCI_API int AH_User_GetRdhType ( const AB_USER u  ) 

AQHBCI_API int AH_User_GetSelectedTanMethod ( 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 int AH_User_GetTanMethodCount ( const AB_USER u  ) 

AQHBCI_API const AH_TAN_METHOD_LIST* AH_User_GetTanMethodDescriptions ( const AB_USER u  ) 

AQHBCI_API const int* AH_User_GetTanMethodList ( const AB_USER u  ) 

AQHBCI_API uint32_t AH_User_GetTokenContextId ( const AB_USER u  ) 

AQHBCI_API const char* AH_User_GetTokenName ( const AB_USER u  ) 

AQHBCI_API const char* AH_User_GetTokenType ( const AB_USER u  ) 

AQHBCI_API int AH_User_HasTanMethod ( const AB_USER u,
int  method 
)

AQHBCI_API int AH_User_HasTanMethodOtherThan ( const AB_USER u,
int  method 
)

AQHBCI_API int AH_User_MkPasswdName ( const AB_USER u,
GWEN_BUFFER *  buf 
)

AQHBCI_API int AH_User_MkPinName ( const AB_USER u,
GWEN_BUFFER *  buf 
)

AQHBCI_API int AH_User_MkTanName ( const AB_USER u,
const char *  challenge,
GWEN_BUFFER *  buf 
)

AQHBCI_API void AH_User_SetCryptMode ( AB_USER u,
AH_CRYPT_MODE  m 
)

AQHBCI_API void AH_User_SetFlags ( AB_USER u,
uint32_t  flags 
)

AQHBCI_API void AH_User_SetHbciVersion ( AB_USER u,
int  i 
)

AQHBCI_API void AH_User_SetHttpContentType ( AB_USER u,
const char *  s 
)

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_SetMaxDebitNotesPerJob ( AB_USER u,
int  i 
)

AQHBCI_API void AH_User_SetMaxTransfersPerJob ( AB_USER u,
int  i 
)

AQHBCI_API void AH_User_SetPeerId ( AB_USER u,
const char *  s 
)

AQHBCI_API void AH_User_SetRdhType ( AB_USER u,
int  i 
)

AQHBCI_API void AH_User_SetSelectedTanMethod ( AB_USER u,
int  i 
)

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_SetTokenContextId ( AB_USER u,
uint32_t  id 
)

AQHBCI_API void AH_User_SetTokenName ( AB_USER u,
const char *  s 
)

AQHBCI_API void AH_User_SetTokenType ( 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,
uint32_t  flags 
)


Generated on Thu Aug 19 20:22:14 2010 for aqbanking by  doxygen 1.5.6