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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
|
import datetime
import logging
from abc import ABCMeta, abstractmethod
from base64 import b64decode
from collections import OrderedDict
from contextlib import contextmanager
from decimal import Decimal
from enum import Enum
import bleach
from sepaxml import SepaTransfer
from . import version
from .connection import FinTSHTTPSConnection
from .dialog import FinTSDialog
from .exceptions import *
from .formals import (
CUSTOMER_ID_ANONYMOUS, KTI1, BankIdentifier, DescriptionRequired,
SynchronizationMode, TANMediaClass4, TANMediaType2,
SupportedMessageTypes)
from .message import FinTSInstituteMessage
from .models import SEPAAccount
from .parser import FinTS3Serializer
from .security import (
PinTanDummyEncryptionMechanism, PinTanOneStepAuthenticationMechanism,
PinTanTwoStepAuthenticationMechanism,
)
from .segments.accounts import HISPA1, HKSPA1
from .segments.auth import HIPINS1, HKTAB4, HKTAB5, HKTAN2, HKTAN3, HKTAN5, HKTAN6
from .segments.bank import HIBPA3, HIUPA4, HKKOM4
from .segments.debit import (
HKDBS1, HKDBS2, HKDMB1, HKDMC1, HKDME1, HKDME2,
HKDSC1, HKDSE1, HKDSE2, DebitResponseBase,
)
from .segments.depot import HKWPD5, HKWPD6
from .segments.dialog import HIRMG2, HIRMS2, HISYN4, HKSYN3
from .segments.journal import HKPRO3, HKPRO4
from .segments.saldo import HKSAL5, HKSAL6, HKSAL7
from .segments.statement import DKKKU2, HKKAZ5, HKKAZ6, HKKAZ7, HKCAZ1
from .segments.transfer import HKCCM1, HKCCS1, HKIPZ1, HKIPM1
from .types import SegmentSequence
from .utils import (
MT535_Miniparser, Password, SubclassesMixin,
compress_datablob, decompress_datablob, mt940_to_array,
)
logger = logging.getLogger(__name__)
SYSTEM_ID_UNASSIGNED = '0'
DATA_BLOB_MAGIC = b'python-fints_DATABLOB'
DATA_BLOB_MAGIC_RETRY = b'python-fints_RETRY_DATABLOB'
class FinTSOperations(Enum):
"""This enum is used as keys in the 'supported_operations' member of the get_information() response.
The enum value is a tuple of transaction types ("Geschäftsvorfälle"). The operation is supported if
any of the listed transaction types is present/allowed.
"""
GET_BALANCE = ("HKSAL", )
GET_TRANSACTIONS = ("HKKAZ", )
GET_TRANSACTIONS_XML = ("HKCAZ", )
GET_CREDIT_CARD_TRANSACTIONS = ("DKKKU", )
GET_STATEMENT = ("HKEKA", )
GET_STATEMENT_PDF = ("HKEKP", )
GET_HOLDINGS = ("HKWPD", )
GET_SEPA_ACCOUNTS = ("HKSPA", )
GET_SCHEDULED_DEBITS_SINGLE = ("HKDBS", )
GET_SCHEDULED_DEBITS_MULTIPLE = ("HKDMB", )
GET_STATUS_PROTOCOL = ("HKPRO", )
SEPA_TRANSFER_SINGLE = ("HKCCS", )
SEPA_TRANSFER_MULTIPLE = ("HKCCM", )
SEPA_DEBIT_SINGLE = ("HKDSE", )
SEPA_DEBIT_MULTIPLE = ("HKDME", )
SEPA_DEBIT_SINGLE_COR1 = ("HKDSC", )
SEPA_DEBIT_MULTIPLE_COR1 = ("HKDMC", )
SEPA_STANDING_DEBIT_SINGLE_CREATE = ("HKDDE", )
GET_SEPA_STANDING_DEBITS_SINGLE = ("HKDDB", )
SEPA_STANDING_DEBIT_SINGLE_DELETE = ("HKDDL", )
class NeedRetryResponse(SubclassesMixin, metaclass=ABCMeta):
"""Base class for Responses that need the operation to be externally retried.
A concrete subclass of this class is returned, if an operation cannot be completed and needs a retry/completion.
Typical (and only) example: Requiring a TAN to be provided."""
@abstractmethod
def get_data(self) -> bytes:
"""Return a compressed datablob representing this object.
To restore the object, use :func:`fints.client.NeedRetryResponse.from_data`.
"""
raise NotImplementedError
@classmethod
def from_data(cls, blob):
"""Restore an object instance from a compressed datablob.
Returns an instance of a concrete subclass."""
version, data = decompress_datablob(DATA_BLOB_MAGIC_RETRY, blob)
if version == 1:
for clazz in cls._all_subclasses():
if clazz.__name__ == data["_class_name"]:
return clazz._from_data_v1(data)
raise Exception("Invalid data blob data or version")
class ResponseStatus(Enum):
"""Error status of the response"""
UNKNOWN = 0
SUCCESS = 1 #: Response indicates Success
WARNING = 2 #: Response indicates a Warning
ERROR = 3 #: Response indicates an Error
_RESPONSE_STATUS_MAPPING = {
'0': ResponseStatus.SUCCESS,
'3': ResponseStatus.WARNING,
'9': ResponseStatus.ERROR,
}
class TransactionResponse:
"""Result of a FinTS operation.
The status member indicates the highest type of errors included in this Response object.
The responses member lists all individual response lines/messages, there may be multiple (e.g. 'Message accepted' and 'Order executed').
The data member may contain further data appropriate to the operation that was executed."""
status = ResponseStatus
responses = list
data = dict
def __init__(self, response_message):
self.status = ResponseStatus.UNKNOWN
self.responses = []
self.data = {}
for hirms in response_message.find_segments(HIRMS2):
for resp in hirms.responses:
self.set_status_if_higher(_RESPONSE_STATUS_MAPPING.get(resp.code[0], ResponseStatus.UNKNOWN))
def set_status_if_higher(self, status):
if status.value > self.status.value:
self.status = status
def __repr__(self):
return "<{o.__class__.__name__}(status={o.status!r}, responses={o.responses!r}, data={o.data!r})>".format(o=self)
class FinTSClientMode(Enum):
OFFLINE = 'offline'
INTERACTIVE = 'interactive'
class FinTS3Client:
def __init__(self,
bank_identifier, user_id, customer_id=None,
from_data: bytes=None,
product_id=None, product_version=version[:5],
mode=FinTSClientMode.INTERACTIVE):
self.accounts = []
if isinstance(bank_identifier, BankIdentifier):
self.bank_identifier = bank_identifier
elif isinstance(bank_identifier, str):
self.bank_identifier = BankIdentifier(BankIdentifier.COUNTRY_ALPHA_TO_NUMERIC['DE'], bank_identifier)
else:
raise TypeError("bank_identifier must be BankIdentifier or str (BLZ)")
self.system_id = SYSTEM_ID_UNASSIGNED
if not product_id:
raise TypeError("The product_id keyword argument is mandatory starting with python-fints version 4. See "
"https://python-fints.readthedocs.io/en/latest/upgrading_3_4.html for more information.")
self.user_id = user_id
self.customer_id = customer_id or user_id
self.bpd_version = 0
self.bpa = None
self.bpd = SegmentSequence()
self.upd_version = 0
self.upa = None
self.upd = SegmentSequence()
self.product_name = product_id
self.product_version = product_version
self.response_callbacks = []
self.mode = mode
self.init_tan_response = None
self._standing_dialog = None
if from_data:
self.set_data(bytes(from_data))
def _new_dialog(self, lazy_init=False):
raise NotImplemented()
def _ensure_system_id(self):
raise NotImplemented()
def _process_response(self, dialog, segment, response):
pass
def process_response_message(self, dialog, message: FinTSInstituteMessage, internal_send=True):
bpa = message.find_segment_first(HIBPA3)
if bpa:
self.bpa = bpa
self.bpd_version = bpa.bpd_version
self.bpd = SegmentSequence(
message.find_segments(
callback=lambda m: len(m.header.type) == 6 and m.header.type[1] == 'I' and m.header.type[5] == 'S'
)
)
upa = message.find_segment_first(HIUPA4)
if upa:
self.upa = upa
self.upd_version = upa.upd_version
self.upd = SegmentSequence(
message.find_segments('HIUPD')
)
for seg in message.find_segments(HIRMG2):
for response in seg.responses:
if not internal_send:
self._log_response(None, response)
self._call_callbacks(None, response)
self._process_response(dialog, None, response)
for seg in message.find_segments(HIRMS2):
for response in seg.responses:
segment = None # FIXME: Provide segment
if not internal_send:
self._log_response(segment, response)
self._call_callbacks(segment, response)
self._process_response(dialog, segment, response)
def _send_with_possible_retry(self, dialog, command_seg, resume_func):
response = dialog._send(command_seg)
return resume_func(command_seg, response)
def __enter__(self):
if self._standing_dialog:
raise Exception("Cannot double __enter__() {}".format(self))
self._standing_dialog = self._get_dialog()
self._standing_dialog.__enter__()
def __exit__(self, exc_type, exc_value, traceback):
if self._standing_dialog:
if exc_type is not None and issubclass(exc_type, FinTSSCARequiredError):
# In case of SCARequiredError, the dialog has already been closed by the bank
self._standing_dialog.open = False
else:
self._standing_dialog.__exit__(exc_type, exc_value, traceback)
else:
raise Exception("Cannot double __exit__() {}".format(self))
self._standing_dialog = None
def _get_dialog(self, lazy_init=False):
if lazy_init and self._standing_dialog:
raise Exception("Cannot _get_dialog(lazy_init=True) with _standing_dialog")
if self._standing_dialog:
return self._standing_dialog
if not lazy_init:
self._ensure_system_id()
return self._new_dialog(lazy_init=lazy_init)
def _set_data_v1(self, data):
self.system_id = data.get('system_id', self.system_id)
if all(x in data for x in ('bpd_bin', 'bpa_bin', 'bpd_version')):
if data['bpd_version'] >= self.bpd_version and data['bpa_bin']:
self.bpd = SegmentSequence(data['bpd_bin'])
self.bpa = SegmentSequence(data['bpa_bin']).segments[0]
self.bpd_version = data['bpd_version']
if all(x in data for x in ('upd_bin', 'upa_bin', 'upd_version')):
if data['upd_version'] >= self.upd_version and data['upa_bin']:
self.upd = SegmentSequence(data['upd_bin'])
self.upa = SegmentSequence(data['upa_bin']).segments[0]
self.upd_version = data['upd_version']
def _deconstruct_v1(self, including_private=False):
data = {
"system_id": self.system_id,
"bpd_bin": self.bpd.render_bytes(),
"bpa_bin": FinTS3Serializer().serialize_message(self.bpa) if self.bpa else None,
"bpd_version": self.bpd_version,
}
if including_private:
data.update({
"upd_bin": self.upd.render_bytes(),
"upa_bin": FinTS3Serializer().serialize_message(self.upa) if self.upa else None,
"upd_version": self.upd_version,
})
return data
def deconstruct(self, including_private: bool=False) -> bytes:
"""Return state of this FinTSClient instance as an opaque datablob. You should not
use this object after calling this method.
Information about the connection is implicitly retrieved from the bank and
cached in the FinTSClient. This includes: system identifier, bank parameter
data, user parameter data. It's not strictly required to retain this information
across sessions, but beneficial. If possible, an API user SHOULD use this method
to serialize the client instance before destroying it, and provide the serialized
data next time an instance is constructed.
Parameter `including_private` should be set to True, if the storage is sufficiently
secure (with regards to confidentiality) to include private data, specifically,
account numbers and names. Most often this is the case.
Note: No connection information is stored in the datablob, neither is the PIN.
"""
data = self._deconstruct_v1(including_private=including_private)
return compress_datablob(DATA_BLOB_MAGIC, 1, data)
def set_data(self, blob: bytes):
"""Restore a datablob created with deconstruct().
You should only call this method once, and only immediately after constructing
the object and before calling any other method or functionality (e.g. __enter__()).
For convenience, you can pass the `from_data` parameter to __init__()."""
decompress_datablob(DATA_BLOB_MAGIC, blob, self)
def _log_response(self, segment, response):
if response.code[0] in ('0', '1'):
log_target = logger.info
elif response.code[0] in ('3',):
log_target = logger.warning
else:
log_target = logger.error
log_target("Dialog response: {} - {}{}".format(
response.code,
response.text,
" ({!r})".format(response.parameters) if response.parameters else ""),
extra={
'fints_response_code': response.code,
'fints_response_text': response.text,
'fints_response_parameters': response.parameters,
}
)
def get_information(self):
"""
Return information about the connected bank.
Note: Can only be filled after the first communication with the bank.
If in doubt, use a construction like::
f = FinTS3Client(...)
with f:
info = f.get_information()
Returns a nested dictionary::
bank:
name: Bank Name
supported_operations: dict(FinTSOperations -> boolean)
supported_formats: dict(FinTSOperation -> ['urn:iso:std:iso:20022:tech:xsd:pain.001.003.03', ...])
supported_sepa_formats: ['urn:iso:std:iso:20022:tech:xsd:pain.001.003.03', ...]
accounts:
- iban: IBAN
account_number: Account Number
subaccount_number: Sub-Account Number
bank_identifier: fints.formals.BankIdentifier(...)
customer_id: Customer ID
type: Account type
currency: Currency
owner_name: ['Owner Name 1', 'Owner Name 2 (optional)']
product_name: Account product name
supported_operations: dict(FinTSOperations -> boolean)
- ...
"""
retval = {
'bank': {},
'accounts': [],
'auth': {},
}
if self.bpa:
retval['bank']['name'] = self.bpa.bank_name
if self.bpd.segments:
retval['bank']['supported_operations'] = {
op: any(self.bpd.find_segment_first(cmd[0]+'I'+cmd[2:]+'S') for cmd in op.value)
for op in FinTSOperations
}
retval['bank']['supported_formats'] = {}
for op in FinTSOperations:
for segment in (self.bpd.find_segment_first(cmd[0] + 'I' + cmd[2:] + 'S') for cmd in op.value):
if not hasattr(segment, 'parameter'):
continue
formats = getattr(segment.parameter, 'supported_sepa_formats', [])
retval['bank']['supported_formats'][op] = list(
set(retval['bank']['supported_formats'].get(op, [])).union(set(formats))
)
hispas = self.bpd.find_segment_first('HISPAS')
if hispas:
retval['bank']['supported_sepa_formats'] = list(hispas.parameter.supported_sepa_formats)
else:
retval['bank']['supported_sepa_formats'] = []
if self.upd.segments:
for upd in self.upd.find_segments('HIUPD'):
acc = {}
acc['iban'] = upd.iban
acc['account_number'] = upd.account_information.account_number
acc['subaccount_number'] = upd.account_information.subaccount_number
acc['bank_identifier'] = upd.account_information.bank_identifier
acc['customer_id'] = upd.customer_id
acc['type'] = upd.account_type
acc['currency'] = upd.account_currency
acc['owner_name'] = []
if upd.name_account_owner_1:
acc['owner_name'].append(upd.name_account_owner_1)
if upd.name_account_owner_2:
acc['owner_name'].append(upd.name_account_owner_2)
acc['product_name'] = upd.account_product_name
acc['supported_operations'] = {
op: any(allowed_transaction.transaction in op.value for allowed_transaction in upd.allowed_transactions)
for op in FinTSOperations
}
retval['accounts'].append(acc)
return retval
def _get_sepa_accounts(self, command_seg, response):
self.accounts = []
for seg in response.find_segments(HISPA1, throw=True):
self.accounts.extend(seg.accounts)
return [a for a in [acc.as_sepa_account() for acc in self.accounts] if a]
def get_sepa_accounts(self):
"""
Returns a list of SEPA accounts
:return: List of SEPAAccount objects.
"""
seg = HKSPA1()
with self._get_dialog() as dialog:
return self._send_with_possible_retry(dialog, seg, self._get_sepa_accounts)
def _continue_fetch_with_touchdowns(self, command_seg, response):
for resp in response.response_segments(command_seg, *self._touchdown_args, **self._touchdown_kwargs):
self._touchdown_responses.append(resp)
touchdown = None
for response in response.responses(command_seg, '3040'):
touchdown = response.parameters[0]
break
if touchdown:
logger.info('Fetching more results ({})...'.format(self._touchdown_counter))
self._touchdown_counter += 1
if touchdown:
seg = self._touchdown_segment_factory(touchdown)
return self._send_with_possible_retry(self._touchdown_dialog, seg, self._continue_fetch_with_touchdowns)
else:
return self._touchdown_response_processor(self._touchdown_responses)
def _fetch_with_touchdowns(self, dialog, segment_factory, response_processor, *args, **kwargs):
"""Execute a sequence of fetch commands on dialog.
segment_factory must be a callable with one argument touchdown. Will be None for the
first call and contains the institute's touchdown point on subsequent calls.
segment_factory must return a command segment.
response_processor can be a callable that will be passed the return value of this function and can
return a new value instead.
Extra arguments will be passed to FinTSMessage.response_segments.
Return value is a concatenated list of the return values of FinTSMessage.response_segments().
"""
self._touchdown_responses = []
self._touchdown_counter = 1
self._touchdown = None
self._touchdown_dialog = dialog
self._touchdown_segment_factory = segment_factory
self._touchdown_response_processor = response_processor
self._touchdown_args = args
self._touchdown_kwargs = kwargs
seg = segment_factory(self._touchdown)
return self._send_with_possible_retry(dialog, seg, self._continue_fetch_with_touchdowns)
def _find_highest_supported_command(self, *segment_classes, **kwargs):
"""Search the BPD for the highest supported version of a segment."""
return_parameter_segment = kwargs.get("return_parameter_segment", False)
parameter_segment_name = "{}I{}S".format(segment_classes[0].TYPE[0], segment_classes[0].TYPE[2:])
version_map = dict((clazz.VERSION, clazz) for clazz in segment_classes)
max_version = self.bpd.find_segment_highest_version(parameter_segment_name, version_map.keys())
if not max_version:
raise FinTSUnsupportedOperation('No supported {} version found. I support {}, bank supports {}.'.format(
parameter_segment_name,
tuple(version_map.keys()),
tuple(v.header.version for v in self.bpd.find_segments(parameter_segment_name))
))
if return_parameter_segment:
return max_version, version_map.get(max_version.header.version)
else:
return version_map.get(max_version.header.version)
def get_transactions(self, account: SEPAAccount, start_date: datetime.date = None, end_date: datetime.date = None):
"""
Fetches the list of transactions of a bank account in a certain timeframe.
:param account: SEPA
:param start_date: First day to fetch
:param end_date: Last day to fetch
:return: A list of mt940.models.Transaction objects
"""
with self._get_dialog() as dialog:
hkkaz = self._find_highest_supported_command(HKKAZ5, HKKAZ6, HKKAZ7)
logger.info('Start fetching from {} to {}'.format(start_date, end_date))
response = self._fetch_with_touchdowns(
dialog,
lambda touchdown: hkkaz(
account=hkkaz._fields['account'].type.from_sepa_account(account),
all_accounts=False,
date_start=start_date,
date_end=end_date,
touchdown_point=touchdown,
),
lambda responses: mt940_to_array(''.join([seg.statement_booked.decode('iso-8859-1') for seg in responses])),
'HIKAZ',
# Note 1: Some banks send the HIKAZ data in arbitrary splits.
# So better concatenate them before MT940 parsing.
# Note 2: MT940 messages are encoded in the S.W.I.F.T character set,
# which is a subset of ISO 8859. There are no character in it that
# differ between ISO 8859 variants, so we'll arbitrarily chose 8859-1.
)
logger.info('Fetching done.')
return response
@staticmethod
def _response_handler_get_transactions_xml(responses):
booked_streams = []
pending_streams = []
for seg in responses:
booked_streams.extend(seg.statement_booked.camt_statements)
pending_streams.append(seg.statement_pending)
return booked_streams, pending_streams
def get_transactions_xml(self, account: SEPAAccount, start_date: datetime.date = None,
end_date: datetime.date = None) -> list:
"""
Fetches the list of transactions of a bank account in a certain timeframe as camt.052.001.02 XML files.
Returns both booked and pending transactions.
:param account: SEPA
:param start_date: First day to fetch
:param end_date: Last day to fetch
:return: Two lists of bytestrings containing XML documents, possibly empty: first one for booked transactions,
second for pending transactions
"""
with self._get_dialog() as dialog:
hkcaz = self._find_highest_supported_command(HKCAZ1)
logger.info('Start fetching from {} to {}'.format(start_date, end_date))
responses = self._fetch_with_touchdowns(
dialog,
lambda touchdown: hkcaz(
account=hkcaz._fields['account'].type.from_sepa_account(account),
all_accounts=False,
date_start=start_date,
date_end=end_date,
touchdown_point=touchdown,
supported_camt_messages=SupportedMessageTypes(['urn:iso:std:iso:20022:tech:xsd:camt.052.001.02']),
),
FinTS3Client._response_handler_get_transactions_xml,
'HICAZ'
)
logger.info('Fetching done.')
return responses
def get_credit_card_transactions(self, account: SEPAAccount, credit_card_number: str, start_date: datetime.date = None, end_date: datetime.date = None):
# FIXME Reverse engineered, probably wrong
with self._get_dialog() as dialog:
dkkku = self._find_highest_supported_command(DKKKU2)
responses = self._fetch_with_touchdowns(
dialog,
lambda touchdown: dkkku(
account=dkkku._fields['account'].type.from_sepa_account(account) if account else None,
credit_card_number=credit_card_number,
date_start=start_date,
date_end=end_date,
touchdown_point=touchdown,
),
lambda responses: responses,
'DIKKU'
)
return responses
def _get_balance(self, command_seg, response):
for resp in response.response_segments(command_seg, 'HISAL'):
return resp.balance_booked.as_mt940_Balance()
def get_balance(self, account: SEPAAccount):
"""
Fetches an accounts current balance.
:param account: SEPA account to fetch the balance
:return: A mt940.models.Balance object
"""
with self._get_dialog() as dialog:
hksal = self._find_highest_supported_command(HKSAL5, HKSAL6, HKSAL7)
seg = hksal(
account=hksal._fields['account'].type.from_sepa_account(account),
all_accounts=False,
)
response = self._send_with_possible_retry(dialog, seg, self._get_balance)
return response
def get_holdings(self, account: SEPAAccount):
"""
Retrieve holdings of an account.
:param account: SEPAAccount to retrieve holdings for.
:return: List of Holding objects
"""
# init dialog
with self._get_dialog() as dialog:
hkwpd = self._find_highest_supported_command(HKWPD5, HKWPD6)
responses = self._fetch_with_touchdowns(
dialog,
lambda touchdown: hkwpd(
account=hkwpd._fields['account'].type.from_sepa_account(account),
touchdown_point=touchdown,
),
lambda responses: responses, # TODO
'HIWPD'
)
if isinstance(responses, NeedTANResponse):
return responses
holdings = []
for resp in responses:
if type(resp.holdings) == bytes:
holding_str = resp.holdings.decode()
else:
holding_str = resp.holdings
mt535_lines = str.splitlines(holding_str)
# The first line is empty - drop it.
del mt535_lines[0]
mt535 = MT535_Miniparser()
holdings.extend(mt535.parse(mt535_lines))
if not holdings:
logger.debug('No HIWPD response segment found - maybe account has no holdings?')
return holdings
def get_scheduled_debits(self, account: SEPAAccount, multiple=False):
with self._get_dialog() as dialog:
if multiple:
command_classes = (HKDMB1, )
response_type = "HIDMB"
else:
command_classes = (HKDBS1, HKDBS2)
response_type = "HKDBS"
hkdbs = self._find_highest_supported_command(*command_classes)
responses = self._fetch_with_touchdowns(
dialog,
lambda touchdown: hkdbs(
account=hkdbs._fields['account'].type.from_sepa_account(account),
touchdown_point=touchdown,
),
lambda responses: responses,
response_type,
)
return responses
def get_status_protocol(self):
with self._get_dialog() as dialog:
hkpro = self._find_highest_supported_command(HKPRO3, HKPRO4)
responses = self._fetch_with_touchdowns(
dialog,
lambda touchdown: hkpro(
touchdown_point=touchdown,
),
lambda responses: responses,
'HIPRO',
)
return responses
def get_communication_endpoints(self):
with self._get_dialog() as dialog:
hkkom = self._find_highest_supported_command(HKKOM4)
responses = self._fetch_with_touchdowns(
dialog,
lambda touchdown: hkkom(
touchdown_point=touchdown,
),
lambda responses: responses,
'HIKOM'
)
return responses
def _find_supported_sepa_version(self, candidate_versions):
hispas = self.bpd.find_segment_first('HISPAS')
if not hispas:
logger.warning("Could not determine supported SEPA versions, is the dialogue open? Defaulting to first candidate: %s.", candidate_versions[0])
return candidate_versions[0]
bank_supported = list(hispas.parameter.supported_sepa_formats)
for candidate in candidate_versions:
if "urn:iso:std:iso:20022:tech:xsd:{}".format(candidate) in bank_supported:
return candidate
if "urn:iso:std:iso:20022:tech:xsd:{}.xsd".format(candidate) in bank_supported:
return candidate
logger.warning("No common supported SEPA version. Defaulting to first candidate and hoping for the best: %s.", candidate_versions[0])
return candidate_versions[0]
def simple_sepa_transfer(self, account: SEPAAccount, iban: str, bic: str,
recipient_name: str, amount: Decimal, account_name: str, reason: str, instant_payment=False,
endtoend_id='NOTPROVIDED'):
"""
Simple SEPA transfer.
:param account: SEPAAccount to start the transfer from.
:param iban: Recipient's IBAN
:param bic: Recipient's BIC
:param recipient_name: Recipient name
:param amount: Amount as a ``Decimal``
:param account_name: Sender account name
:param reason: Transfer reason
:param instant_payment: Whether to use instant payment (defaults to ``False``)
:param endtoend_id: End-to-end-Id (defaults to ``NOTPROVIDED``)
:return: Returns either a NeedRetryResponse or TransactionResponse
"""
config = {
"name": account_name,
"IBAN": account.iban,
"BIC": account.bic,
"batch": False,
"currency": "EUR",
}
version = self._find_supported_sepa_version(['pain.001.001.03', 'pain.001.003.03'])
sepa = SepaTransfer(config, version)
payment = {
"name": recipient_name,
"IBAN": iban,
"BIC": bic,
"amount": round(Decimal(amount) * 100), # in cents
"execution_date": datetime.date(1999, 1, 1),
"description": reason,
"endtoend_id": endtoend_id,
}
sepa.add_payment(payment)
xml = sepa.export().decode()
return self.sepa_transfer(account, xml, pain_descriptor="urn:iso:std:iso:20022:tech:xsd:"+version, instant_payment=instant_payment)
def sepa_transfer(self, account: SEPAAccount, pain_message: str, multiple=False,
control_sum=None, currency='EUR', book_as_single=False,
pain_descriptor='urn:iso:std:iso:20022:tech:xsd:pain.001.001.03', instant_payment=False):
"""
Custom SEPA transfer.
:param account: SEPAAccount to send the transfer from.
:param pain_message: SEPA PAIN message containing the transfer details.
:param multiple: Whether this message contains multiple transfers.
:param control_sum: Sum of all transfers (required if there are multiple)
:param currency: Transfer currency
:param book_as_single: Kindly ask the bank to put multiple transactions as separate lines on the bank statement (defaults to ``False``)
:param pain_descriptor: URN of the PAIN message schema used.
:param instant_payment: Whether this is an instant transfer (defaults to ``False``)
:return: Returns either a NeedRetryResponse or TransactionResponse
"""
with self._get_dialog() as dialog:
if multiple:
command_class = HKIPM1 if instant_payment else HKCCM1
else:
command_class = HKIPZ1 if instant_payment else HKCCS1
hiccxs, hkccx = self._find_highest_supported_command(
command_class,
return_parameter_segment=True
)
seg = hkccx(
account=hkccx._fields['account'].type.from_sepa_account(account),
sepa_descriptor=pain_descriptor,
sepa_pain_message=pain_message.encode(),
)
# if instant_payment:
# seg.allow_convert_sepa_transfer = True
if multiple:
if hiccxs.parameter.sum_amount_required and control_sum is None:
raise ValueError("Control sum required.")
if book_as_single and not hiccxs.parameter.single_booking_allowed:
raise FinTSUnsupportedOperation("Single booking not allowed by bank.")
if control_sum:
seg.sum_amount.amount = control_sum
seg.sum_amount.currency = currency
if book_as_single:
seg.request_single_booking = True
return self._send_with_possible_retry(dialog, seg, self._continue_sepa_transfer)
def _continue_sepa_transfer(self, command_seg, response):
retval = TransactionResponse(response)
for seg in response.find_segments(HIRMS2):
for resp in seg.responses:
retval.set_status_if_higher(_RESPONSE_STATUS_MAPPING.get(resp.code[0], ResponseStatus.UNKNOWN))
retval.responses.append(resp)
return retval
def _continue_dialog_initialization(self, command_seg, response):
return response
def sepa_debit(self, account: SEPAAccount, pain_message: str, multiple=False, cor1=False,
control_sum=None, currency='EUR', book_as_single=False,
pain_descriptor='urn:iso:std:iso:20022:tech:xsd:pain.008.003.01'):
"""
Custom SEPA debit.
:param account: SEPAAccount to send the debit from.
:param pain_message: SEPA PAIN message containing the debit details.
:param multiple: Whether this message contains multiple debits.
:param cor1: Whether to use COR1 debit (lead time reduced to 1 day)
:param control_sum: Sum of all debits (required if there are multiple)
:param currency: Debit currency
:param book_as_single: Kindly ask the bank to put multiple transactions as separate lines on the bank statement (defaults to ``False``)
:param pain_descriptor: URN of the PAIN message schema used. Defaults to ``urn:iso:std:iso:20022:tech:xsd:pain.008.003.01``.
:return: Returns either a NeedRetryResponse or TransactionResponse (with data['task_id'] set, if available)
"""
with self._get_dialog() as dialog:
if multiple:
if cor1:
command_candidates = (HKDMC1, )
else:
command_candidates = (HKDME1, HKDME2)
else:
if cor1:
command_candidates = (HKDSC1, )
else:
command_candidates = (HKDSE1, HKDSE2)
hidxxs, hkdxx = self._find_highest_supported_command(
*command_candidates,
return_parameter_segment=True
)
seg = hkdxx(
account=hkdxx._fields['account'].type.from_sepa_account(account),
sepa_descriptor=pain_descriptor,
sepa_pain_message=pain_message.encode(),
)
if multiple:
if hidxxs.parameter.sum_amount_required and control_sum is None:
raise ValueError("Control sum required.")
if book_as_single and not hidxxs.parameter.single_booking_allowed:
raise FinTSUnsupportedOperation("Single booking not allowed by bank.")
if control_sum:
seg.sum_amount.amount = control_sum
seg.sum_amount.currency = currency
if book_as_single:
seg.request_single_booking = True
return self._send_with_possible_retry(dialog, seg, self._continue_sepa_debit)
def _continue_sepa_debit(self, command_seg, response):
retval = TransactionResponse(response)
for seg in response.find_segments(HIRMS2):
for resp in seg.responses:
retval.set_status_if_higher(_RESPONSE_STATUS_MAPPING.get(resp.code[0], ResponseStatus.UNKNOWN))
retval.responses.append(resp)
for seg in response.find_segments(DebitResponseBase):
if seg.task_id:
retval.data['task_id'] = seg.task_id
if not 'task_id' in retval.data:
for seg in response.find_segments('HITAN'):
if hasattr(seg, 'task_reference') and seg.task_reference:
retval.data['task_id'] = seg.task_reference
return retval
def add_response_callback(self, cb):
# FIXME document
self.response_callbacks.append(cb)
def remove_response_callback(self, cb):
# FIXME document
self.response_callbacks.remove(cb)
def set_product(self, product_name, product_version):
"""Set the product name and version that is transmitted as part of our identification
According to 'FinTS Financial Transaction Services, Schnittstellenspezifikation, Formals',
version 3.0, section C.3.1.3, you should fill this with useful information about the
end-user product, *NOT* the FinTS library."""
self.product_name = product_name
self.product_version = product_version
def _call_callbacks(self, *cb_data):
for cb in self.response_callbacks:
cb(*cb_data)
def pause_dialog(self):
"""Pause a standing dialog and return the saved dialog state.
Sometimes, for example in a web app, it's not possible to keep a context open
during user input. In some cases, though, it's required to send a response
within the same dialog that issued the original task (f.e. TAN with TANTimeDialogAssociation.NOT_ALLOWED).
This method freezes the current standing dialog (started with FinTS3Client.__enter__()) and
returns the frozen state.
Commands MUST NOT be issued in the dialog after calling this method.
MUST be used in conjunction with deconstruct()/set_data().
Caller SHOULD ensure that the dialog is resumed (and properly ended) within a reasonable amount of time.
:Example:
::
client = FinTS3PinTanClient(..., from_data=None)
with client:
challenge = client.sepa_transfer(...)
dialog_data = client.pause_dialog()
# dialog is now frozen, no new commands may be issued
# exiting the context does not end the dialog
client_data = client.deconstruct()
# Store dialog_data and client_data out-of-band somewhere
# ... Some time passes ...
# Later, possibly in a different process, restore the state
client = FinTS3PinTanClient(..., from_data=client_data)
with client.resume_dialog(dialog_data):
client.send_tan(...)
# Exiting the context here ends the dialog, unless frozen with pause_dialog() again.
"""
if not self._standing_dialog:
raise Exception("Cannot pause dialog, no standing dialog exists")
return self._standing_dialog.pause()
@contextmanager
def resume_dialog(self, dialog_data):
# FIXME document, test, NOTE NO UNTRUSTED SOURCES
if self._standing_dialog:
raise Exception("Cannot resume dialog, existing standing dialog")
self._standing_dialog = FinTSDialog.create_resume(self, dialog_data)
with self._standing_dialog:
yield self
self._standing_dialog = None
class NeedTANResponse(NeedRetryResponse):
challenge_raw = None #: Raw challenge as received by the bank
challenge = None #: Textual challenge to be displayed to the user
challenge_html = None #: HTML-safe challenge text, possibly with formatting
challenge_hhduc = None #: HHD_UC challenge to be transmitted to the TAN generator
challenge_matrix = None #: Matrix code challenge: tuple(mime_type, data)
def __init__(self, command_seg, tan_request, resume_method=None, tan_request_structured=False):
self.command_seg = command_seg
self.tan_request = tan_request
self.tan_request_structured = tan_request_structured
if hasattr(resume_method, '__func__'):
self.resume_method = resume_method.__func__.__name__
else:
self.resume_method = resume_method
self._parse_tan_challenge()
def __repr__(self):
return '<o.__class__.__name__(command_seg={o.command_seg!r}, tan_request={o.tan_request!r})>'.format(o=self)
@classmethod
def _from_data_v1(cls, data):
if data["version"] == 1:
segs = SegmentSequence(data['segments_bin']).segments
return cls(segs[0], segs[1], data['resume_method'], data['tan_request_structured'])
raise Exception("Wrong blob data version")
def get_data(self) -> bytes:
"""Return a compressed datablob representing this object.
To restore the object, use :func:`fints.client.NeedRetryResponse.from_data`.
"""
data = {
"_class_name": self.__class__.__name__,
"version": 1,
"segments_bin": SegmentSequence([self.command_seg, self.tan_request]).render_bytes(),
"resume_method": self.resume_method,
"tan_request_structured": self.tan_request_structured,
}
return compress_datablob(DATA_BLOB_MAGIC_RETRY, 1, data)
def _parse_tan_challenge(self):
self.challenge_raw = self.tan_request.challenge
self.challenge = self.challenge_raw
self.challenge_html = None
self.challenge_hhduc = None
self.challenge_matrix = None
if hasattr(self.tan_request, 'challenge_hhduc'):
if self.tan_request.challenge_hhduc:
if len(self.tan_request.challenge_hhduc) < 256:
self.challenge_hhduc = self.tan_request.challenge_hhduc.decode('us-ascii')
else:
data = self.tan_request.challenge_hhduc
type_len_field, data = data[:2], data[2:]
if len(type_len_field) == 2:
type_len = type_len_field[0]*256 + type_len_field[1]
type_data, data = data[:type_len], data[type_len:]
content_len_field, data = data[:2], data[2:]
if len(content_len_field) == 2:
content_len = content_len_field[0]*256 + content_len_field[1]
content_data, data = data[:content_len], data[content_len:]
self.challenge_matrix = (type_data.decode('us-ascii', 'replace'), content_data)
if self.challenge.startswith('CHLGUC '):
l = self.challenge[8:12]
if l.isdigit():
self.challenge_hhduc = self.challenge[12:(12+int(l,10))]
self.challenge = self.challenge[(12+int(l,10)):]
if self.challenge_hhduc.startswith('iVBO'):
self.challenge_matrix = ('image/png', b64decode(self.challenge_hhduc))
self.challenge_hhduc = None
if self.challenge.startswith('CHLGTEXT'):
self.challenge = self.challenge[12:]
if self.tan_request_structured:
self.challenge_html = bleach.clean(
self.challenge,
tags=['br', 'p', 'b', 'i', 'u', 'ul', 'ol', 'li'],
attributes={},
)
else:
self.challenge_html = bleach.clean(self.challenge, tags=[])
# Note: Implementing HKTAN#6 implies support for Strong Customer Authentication (SCA)
# which may require TANs for many more operations including dialog initialization.
# We do not currently support that.
IMPLEMENTED_HKTAN_VERSIONS = {
2: HKTAN2,
3: HKTAN3,
5: HKTAN5,
6: HKTAN6,
}
class FinTS3PinTanClient(FinTS3Client):
def __init__(self, bank_identifier, user_id, pin, server, customer_id=None, *args, **kwargs):
self.pin = Password(pin) if pin is not None else pin
self._pending_tan = None
self.connection = FinTSHTTPSConnection(server)
self.allowed_security_functions = []
self.selected_security_function = None
self.selected_tan_medium = None
self._bootstrap_mode = True
super().__init__(bank_identifier=bank_identifier, user_id=user_id, customer_id=customer_id, *args, **kwargs)
def _new_dialog(self, lazy_init=False):
if self.pin is None:
enc = None
auth = []
elif not self.selected_security_function or self.selected_security_function == '999':
enc = PinTanDummyEncryptionMechanism(1)
auth = [PinTanOneStepAuthenticationMechanism(self.pin)]
else:
enc = PinTanDummyEncryptionMechanism(2)
auth = [PinTanTwoStepAuthenticationMechanism(
self,
self.selected_security_function,
self.pin,
)]
return FinTSDialog(
self,
lazy_init=lazy_init,
enc_mechanism=enc,
auth_mechanisms=auth,
)
def fetch_tan_mechanisms(self):
self.set_tan_mechanism('999')
self._ensure_system_id()
if self.get_current_tan_mechanism():
# We already got a reply through _ensure_system_id
return self.get_current_tan_mechanism()
with self._new_dialog():
return self.get_current_tan_mechanism()
def _ensure_system_id(self):
if self.system_id != SYSTEM_ID_UNASSIGNED or self.user_id == CUSTOMER_ID_ANONYMOUS:
return
with self._get_dialog(lazy_init=True) as dialog:
response = dialog.init(
HKSYN3(SynchronizationMode.NEW_SYSTEM_ID),
)
self.process_response_message(dialog, response, internal_send=True)
seg = response.find_segment_first(HISYN4)
if not seg:
raise ValueError('Could not find system_id')
self.system_id = seg.system_id
def _set_data_v1(self, data):
super()._set_data_v1(data)
self.selected_tan_medium = data.get('selected_tan_medium', self.selected_tan_medium)
self.selected_security_function = data.get('selected_security_function', self.selected_security_function)
self.allowed_security_functions = data.get('allowed_security_functions', self.allowed_security_functions)
def _deconstruct_v1(self, including_private=False):
data = super()._deconstruct_v1(including_private=including_private)
data.update({
"selected_security_function": self.selected_security_function,
"selected_tan_medium": self.selected_tan_medium,
})
if including_private:
data.update({
"allowed_security_functions": self.allowed_security_functions,
})
return data
def is_tan_media_required(self):
tan_mechanism = self.get_tan_mechanisms()[self.get_current_tan_mechanism()]
return getattr(tan_mechanism, 'supported_media_number', None) is not None and \
tan_mechanism.supported_media_number > 1 and \
tan_mechanism.description_required == DescriptionRequired.MUST
def _get_tan_segment(self, orig_seg, tan_process, tan_seg=None):
tan_mechanism = self.get_tan_mechanisms()[self.get_current_tan_mechanism()]
hktan = IMPLEMENTED_HKTAN_VERSIONS.get(tan_mechanism.VERSION)
seg = hktan(tan_process=tan_process)
if tan_process == '1':
seg.segment_type = orig_seg.header.type
account_ = getattr(orig_seg, 'account', None)
if isinstance(account_, KTI1):
seg.account = account_
raise NotImplementedError("TAN-Process 1 not implemented")
if tan_process in ('1', '3', '4') and self.is_tan_media_required():
if self.selected_tan_medium:
seg.tan_medium_name = self.selected_tan_medium
else:
seg.tan_medium_name = 'DUMMY'
if tan_process == '4' and tan_mechanism.VERSION >= 6:
seg.segment_type = orig_seg.header.type
if tan_process in ('2', '3'):
seg.task_reference = tan_seg.task_reference
if tan_process in ('1', '2'):
seg.further_tan_follows = False
return seg
def _need_twostep_tan_for_segment(self, seg):
if not self.selected_security_function or self.selected_security_function == '999':
return False
else:
hipins = self.bpd.find_segment_first(HIPINS1)
if not hipins:
return False
else:
for requirement in hipins.parameter.transaction_tans_required:
if seg.header.type == requirement.transaction:
return requirement.tan_required
return False
def _send_with_possible_retry(self, dialog, command_seg, resume_func):
with dialog:
if self._need_twostep_tan_for_segment(command_seg):
tan_seg = self._get_tan_segment(command_seg, '4')
response = dialog.send(command_seg, tan_seg)
for resp in response.responses(tan_seg):
if resp.code == '0030':
return NeedTANResponse(command_seg, response.find_segment_first('HITAN'), resume_func, self.is_challenge_structured())
if resp.code.startswith('9'):
raise Exception("Error response: {!r}".format(response))
else:
response = dialog.send(command_seg)
return resume_func(command_seg, response)
def is_challenge_structured(self):
param = self.get_tan_mechanisms()[self.get_current_tan_mechanism()]
if hasattr(param, 'challenge_structured'):
return param.challenge_structured
return False
def send_tan(self, challenge: NeedTANResponse, tan: str):
"""
Sends a TAN to confirm a pending operation.
:param challenge: NeedTANResponse to respond to
:param tan: TAN value
:return: Currently no response
"""
with self._get_dialog() as dialog:
tan_seg = self._get_tan_segment(challenge.command_seg, '2', challenge.tan_request)
self._pending_tan = tan
response = dialog.send(tan_seg)
resume_func = getattr(self, challenge.resume_method)
return resume_func(challenge.command_seg, response)
def _process_response(self, dialog, segment, response):
if response.code == '3920':
self.allowed_security_functions = list(response.parameters)
if self.selected_security_function is None or not self.selected_security_function in self.allowed_security_functions:
# Select the first available twostep security_function that we support
for security_function, parameter in self.get_tan_mechanisms().items():
if security_function == '999':
# Skip onestep TAN
continue
if parameter.tan_process != '2':
# Only support process variant 2 for now
continue
try:
self.set_tan_mechanism(parameter.security_function)
break
except NotImplementedError:
pass
else:
# Fall back to onestep
self.set_tan_mechanism('999')
if response.code == '9010':
raise FinTSClientError("Error during dialog initialization, could not fetch BPD. Please check that you "
"passed the correct bank identifier to the HBCI URL of the correct bank.")
if ((not dialog.open and response.code.startswith('9')) and not self._bootstrap_mode) or response.code in ('9340', '9910', '9930', '9931', '9942'):
# Assume all 9xxx errors in a not-yet-open dialog refer to the PIN or authentication
# During a dialog also listen for the following codes which may explicitly indicate an
# incorrect pin: 9340, 9910, 9930, 9931, 9942
# Fail-safe block all further attempts with this PIN
if self.pin:
self.pin.block()
raise FinTSClientPINError("Error during dialog initialization, PIN wrong?")
if response.code == '3938':
# Account locked, e.g. after three wrong password attempts. Theoretically, the bank might allow us to
# send a HKPSA with a TAN to unlock, but since the library currently doesn't implement it and there's only
# one chance to get it right, let's rather error iout.
if self.pin:
self.pin.block()
raise FinTSClientTemporaryAuthError("Account is temporarily locked.")
if response.code == '9075':
if self._bootstrap_mode:
if self._standing_dialog:
self._standing_dialog.open = False
else:
raise FinTSSCARequiredError("This operation requires strong customer authentication.")
def get_tan_mechanisms(self):
"""
Get the available TAN mechanisms.
Note: Only checks for HITANS versions listed in IMPLEMENTED_HKTAN_VERSIONS.
:return: Dictionary of security_function: TwoStepParameters objects.
"""
retval = OrderedDict()
for version in sorted(IMPLEMENTED_HKTAN_VERSIONS.keys()):
for seg in self.bpd.find_segments('HITANS', version):
for parameter in seg.parameter.twostep_parameters:
if parameter.security_function in self.allowed_security_functions:
retval[parameter.security_function] = parameter
return retval
def get_current_tan_mechanism(self):
return self.selected_security_function
def set_tan_mechanism(self, security_function):
if self._standing_dialog:
raise Exception("Cannot change TAN mechanism with a standing dialog")
self.selected_security_function = security_function
def set_tan_medium(self, tan_medium):
if self._standing_dialog:
raise Exception("Cannot change TAN medium with a standing dialog")
self.selected_tan_medium = tan_medium.tan_medium_name
def get_tan_media(self, media_type = TANMediaType2.ALL, media_class = TANMediaClass4.ALL):
"""Get information about TAN lists/generators.
Returns tuple of fints.formals.TANUsageOption and a list of fints.formals.TANMedia4 or fints.formals.TANMedia5 objects."""
if self.connection.url == 'https://hbci.postbank.de/banking/hbci.do':
# see https://github.com/raphaelm/python-fints/issues/101#issuecomment-572486099
context = self._new_dialog(lazy_init=True)
method = lambda dialog: dialog.init
else:
context = self._get_dialog()
method = lambda dialog: dialog.send
with context as dialog:
hktab = self._find_highest_supported_command(HKTAB4, HKTAB5)
seg = hktab(
tan_media_type=media_type,
tan_media_class=str(media_class),
)
# The specification says we should send a dummy HKTAN object but apparently it seems to do more harm than
# good.
try:
self._bootstrap_mode = True
response = method(dialog)(seg)
finally:
self._bootstrap_mode = False
for resp in response.response_segments(seg, 'HITAB'):
return resp.tan_usage_option, list(resp.tan_media_list)
def get_information(self):
retval = super().get_information()
retval['auth'] = {
'current_tan_mechanism': self.get_current_tan_mechanism(),
'tan_mechanisms': self.get_tan_mechanisms(),
}
return retval
|