File: README

package info (click to toggle)
libopenhbci 0.9.17-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,056 kB
  • ctags: 4,105
  • sloc: cpp: 26,353; sh: 10,400; ansic: 987; makefile: 423
file content (152 lines) | stat: -rw-r--r-- 5,008 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
$Id: README,v 1.9 2003/06/13 21:50:00 aquamaniac Exp $


OpenHBCI -- the first free client-side implementation of the HBCI
specification.

HBCI is a bank-independent homebanking standard used by many German
banks. This publicly available protocol describes communication,
authentification, encryption, and business transactions taking place
between a homebanking applications and any arbitrary HBCI-enabled bank
server. OpenHBCI provides an object oriented library implementing the
current client-side HBCI specification. The library is written in C++,
with C wrappers also available.

To learn more about how to code with OpenHBCI, look at the
documentation in the source code, starting with the class HBCI::API in
src/openhbci/hbciapi.h or by viewing the doxygen-generated HTML
documentation. Also, some (slightly outdated) documentation about the
design is in "doc/DESIGN".

If you want to code a medium plugin please read "doc/plugin.txt".



Build and Install
=================

  ./configure
  make
  make install

If you retrieved this copy of the source code directly from CVS, you
need to build the ./configure script first, by typing

  make -f Makefile.dist

Also, a common set of arguments to ./configure might be the following:

  ./configure --prefix=/my/prefix \
    --with-openssl-includes=/my/openssl/include \
    --with-openssl-libs=/my/openssl/lib 

To create the HTML documentation of the API by doxygen, do 

  make srcdoc

Note for upgrade from openhbci-0.9.11: The location of the medium
plugins changed from $prefix/share/openhbci to
$prefix/lib/openhbci. Please remove all old plugins from
$prefix/share/openhbci manually.



Compatibility Mode
==================

Since version 0.9.12 some method names have been (and will be) changed in
order to simplify developing OpenHBCI programs. The old names are still
supported, but are subject to removal in one of the next releases.
Writers of OpenHBCI programs should change their programs accordingly.

To help this you can define "OPENHBCI_NO_COMPAT" either by adding
"-DOPENHBCI_NO_COMPAT" to your CXXFLAGS or by including an appropriate line
in your sources. This will keep OpenHBCI from defining those deprecated names
thus giving you compile errors, which help you find the places you have to
change.



IMPORTANT NOTE
==============

If your compiler is GCC 3.0 or better then you may use the new plugin system
of OpenHBCI. In this case you may download and install additional plugins
which are loaded by OpenHBCI when needed.

If your compiler is not GCC or its version is less than 3.0 then you must
statically link OpenHBCI against those plugins.
This only requires you to download the packages of the plugins you want to use
and unpack them into "ext_plugins" within the OpenHBCI source directory.
"configure" will automatically detect all plugins stored in that folder and
add them to OpenHBCI.



License
================

This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License (LGPL) as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details. 

In particular, the authors of this library give NO WARRANTY at all
about what this library might perform with your HBCI financial
data. If you use this library on real HBCI accounts at your bank, you
have to do so TOTALLY AT YOUR OWN RISK.



Requirements
=================

OpenHBCI requires the following packages:

* OpenSSL, any version 0.9.0 or better (note that all versions 0.9.6d
  and lesser are considered to be potentially vulnerable to buffer
  overflow attacks). http://www.openssl.org/

* doxygen (optional) any recent version; necessary if a fully
  cross-references HTML documentation of the API should be
  created. http://www.doxygen.org/

* plugins for your media
  If you want to use a chipcard then you need to download the appropriate
  plugin from http://www.openhbci.de/.


Further Packages
====================

AqMoney
-------

"Aqmoney" is a command-line homebanking application. All features of
OpenHBCI are supported (since this is our primary testing
application). You can

- setup multiple accounts (including INI letters)
- check your accounts balances
- pull a list of transactions from the credit institute
- view these transactions (either plain text or HTML)
- transfer money from your accounts to others.
- issue a debit note
- add, remove and view standing orders
- view institute messages

You can get it from http://aqmoney.sf.net.


OpenHBCI-DDVCard
----------------
This is a plugin for OpenHBCI that allows using HBCI chipcards (only DDV Cards
are supported, both type 0 and type 1).

It should be available at the same place you downloaded OpenHBCI from.