-
Notifications
You must be signed in to change notification settings - Fork 10
/
testofx.py
1509 lines (1276 loc) · 46.6 KB
/
testofx.py
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
#!/usr/bin/env python
"""
OFX Test Client
"""
import json
import re
import requests
import time
from urllib.parse import urlparse
from uuid import uuid4
from xmltodict import parse as xmlparse
#
# Defines
#
USER_AGENT = 'InetClntApp/3.0'
CONTENT_TYPE = 'application/x-ofx'
HDR_OFXHEADER = 'OFXHEADER'
HDR_DATA = 'DATA'
HDR_VERSION = 'VERSION'
HDR_SECURITY = 'SECURITY'
HDR_ENCODING = 'ENCODING'
HDR_CHARSET = 'CHARSET'
HDR_COMPRESSION = 'COMPRESSION'
HDR_OLDFILEUID = 'OLDFILEUID'
HDR_NEWFILEUID = 'NEWFILEUID'
HDR_FIELDS_V1 = [HDR_OFXHEADER, HDR_DATA, HDR_VERSION, HDR_SECURITY,
HDR_ENCODING, HDR_CHARSET, HDR_COMPRESSION, HDR_OLDFILEUID,
HDR_NEWFILEUID]
HDR_FIELDS_V2 = [HDR_OFXHEADER, HDR_VERSION, HDR_SECURITY, HDR_OLDFILEUID,
HDR_NEWFILEUID]
OFX_HEADER_100 = \
'''OFXHEADER:100
DATA:OFXSGML
VERSION:{version}
SECURITY:NONE
ENCODING:USASCII
CHARSET:1252
COMPRESSION:NONE
OLDFILEUID:NONE
NEWFILEUID:NONE
'''
OFX_HEADER_200 = \
'''<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?OFX OFXHEADER="200" VERSION="{version}" SECURITY="NONE" OLDFILEUID="NONE"
NEWFILEUID="NONE"?>
'''
REQ_NAME_GET_ROOT = 'GET /'
REQ_NAME_GET_OFX = 'GET OFX Path'
REQ_NAME_POST_OFX = 'POST OFX Path'
REQ_NAME_OFX_EMPTY = 'OFX Empty'
REQ_NAME_OFX_PROFILE = 'OFX PROFILE'
REQ_NAME_OFX_ACCTINFO = 'OFX ACCTINFO'
REQ_NAMES = [
REQ_NAME_GET_ROOT,
REQ_NAME_GET_OFX,
REQ_NAME_POST_OFX,
REQ_NAME_OFX_EMPTY,
REQ_NAME_OFX_PROFILE,
REQ_NAME_OFX_ACCTINFO
]
REQ_METHODS = {
REQ_NAME_GET_ROOT: 'GET',
REQ_NAME_GET_OFX: 'GET',
REQ_NAME_POST_OFX: 'POST',
REQ_NAME_OFX_EMPTY: 'POST',
REQ_NAME_OFX_PROFILE: 'POST',
REQ_NAME_OFX_ACCTINFO: 'POST'
}
#
# Helper Functions
#
def print_http_response(res):
print("===Request Headers===")
print(dict(res.request.headers))
print("===Request Body===")
print(res.request.body)
print("=== Response Status ===")
print(res.status_code)
print("=== Response Headers ===")
print(dict(res.headers))
print("=== Response Body ===")
print(res.text)
#
# Public Functions
#
def dt_now():
# Example: 20170616141327.123[-7:MST]
return time.strftime("%Y%m%d%H%M%S.123[-7:MST]", time.localtime())
def uid():
# Example: C1B7C870-7CB2-1000-BD91-E1E23E560026
return str(uuid4()).upper()
def is_ofx_response(resp_body):
ret = False
# Version 1 Header
if resp_body.startswith('OFXHEADER'):
ret = True
# Version 2 Header
if resp_body.find('<?OFX OFXHEADER') != -1:
ret = True
return ret
class OFXServerInstance():
'''
Representation of an OFX server
'''
httpserver = ''
webframework = ''
software = dict([
('Company', ''),
('Product', ''),
('Version', '')
])
serviceprovider = ''
tls = dict()
def __init__(self, ofxurl, fid, org):
self.ofxurl = ofxurl
self.fid = fid if fid else ''
self.org = org if org else ''
def _extract_http_header(self, res, header, field, exclude, nooverwrite):
'''
Find and store header in HTTP response.
nooverwrite: list[str] - set if nothing, but don't change exsiting
entry with these values
'''
val = None
try:
val = res.headers[header]
except KeyError:
return
# Skip if header value is in exclusion list
if val in exclude:
return
cur_val = getattr(self, field)
# Skip if we've already recorded the same header value
if cur_val == val:
return
# Store the header value in the ServerInstance
if cur_val == '':
setattr(self, field, val)
else:
if val in nooverwrite:
return
else:
setattr(self, field, val)
def _fingerprint_httpserver(self, req_results):
def _check_resp_body(res):
html = res.text
if html:
# Quick and dirty regex of <title> tag
prog = re.compile('<title>(.*)</title>')
match = prog.search(html)
if match:
title = match.group(1)
if title == 'IIS Windows Server':
if self.httpserver == '':
self.httpserver = 'Microsoft-IIS/8.5'
elif title == 'APACHE OFX APP':
if self.httpserver == '':
self.httpserver = 'Apache/2.2.23'
elif title == 'IBM HTTP Server 8.5':
if self.httpserver == '':
self.httpserver = 'IBM HTTP Server/8.5'
elif title.startswith('Apache Tomcat/'):
if self.httpserver in ['', 'Apache', 'Apache-Coyote/1.1']:
# Removing trailing " - Error Report"
self.httpserver = title[0:-15]
elif title.startswith('VMware vFabric tc Runtime'):
if self.httpserver == '':
# Removing trailing " - Error Report"
self.httpserver = title[0:-15]
elif title.startswith('JBoss'):
if self.httpserver in ['', 'Apache', 'Apache-Coyote/1.1']:
# Removing trailing " - Error Report"
self.httpserver = title[0:-15]
elif title.startswith('JBWEB'):
if self.httpserver in ['', 'Apache', 'Apache-Coyote/1.1']:
self.httpserver = 'JBoss'
# Extract OFX "Server" header from OFX requests
# The HTTP server on the root of the path can be different
exclude = ['', 'not_available', 'Unspecified']
nooverwrite = [
'Apache-Coyote/1.1',
'Apache',
'USAA-Service',
'USAA-Integrity'
]
for req_name in [
REQ_NAME_OFX_PROFILE,
REQ_NAME_OFX_EMPTY,
REQ_NAME_POST_OFX
]:
res = req_results[req_name]
self._extract_http_header(
res,
'Server',
'httpserver',
exclude,
nooverwrite)
# Extract Server out of error body
for req_name in [
REQ_NAME_POST_OFX,
REQ_NAME_GET_OFX,
REQ_NAME_GET_ROOT
]:
res = req_results[req_name]
_check_resp_body(res)
def _fingerprint_webframework(self, req_results):
def _check_resp_body(res):
body = res.text
if body:
first_line = body.splitlines()[0]
if first_line.startswith('Error 404: SRVE0190E:'):
if self.webframework == '':
self.webframework = 'WebSphere'
# Extract Web Framework from successful OFX requests
# The web framework on the root of the path can be different
exclude = ['DI - An Intuit Company']
for req_name in [
REQ_NAME_OFX_PROFILE
]:
res = req_results[req_name]
self._extract_http_header(
res,
'X-Powered-By',
'webframework',
exclude,
[])
if self.webframework == 'ASP.NET':
# Check for extra ASP.NET version headers
val = None
try:
val = res.headers['X-AspNet-Version']
except KeyError:
continue
self.webframework += '/{}'.format(val)
# Extract framework out of error body
for req_name in [
REQ_NAME_GET_ROOT
]:
res = req_results[req_name]
_check_resp_body(res)
def _fingerprint_software(self, req_results):
# Determine software based off URL path
# URL Path: Company, Product
path_map = {
'/cmr/cmr.ofx': ('Enterprise Engineering','EnterpriseFTX'),
'/ofx/servlet/Teller': ('Finastra','Cavion'),
'/ofx/OFXServlet': ('FIS','Metavante'),
'/piles/ofx.pile/': ('First Data Corporation','FundsXPress'),
'/scripts/serverext.dll': ('Fiserv', 'Corillian'),
'/OROFX16Listener': ('Fiserv',''),
'/ofx/process.ofx': ('Fiserv','Corillian'),
'/eftxweb/access.ofx': ('Enterprise Engineering','EnterpriseFTX',),
'/scripts/isaofx.dll': ('Fiserv', ''),
'/scripts/serverext.dll': ('Fiserv','Corillian'),
'/ofx/ofx.dll': ('ULTRADATA Corporation', ''),
'/ofxserver/ofxsrvr.dll': ('Access Softek', 'OFXServer'),
'/OFXServer/ofxsrvr.dll': ('Access Softek', 'OFXServer'),
}
parsed = urlparse(self.ofxurl)
try:
row = path_map[parsed.path]
self.software['Company'] = row[0]
self.software['Product'] = row[1]
except KeyError:
pass
# Fingerprint version number
if self.software['Company'] == 'Enterprise Engineering':
# EFTX has a splash page with version number by default
rpat = r'Servlet Version ([0-9.]+)'
match = re.search(rpat, req_results[REQ_NAME_GET_OFX].text)
if match:
self.software['Version'] = 'Servlet {}'.format(match.group(1))
def _fingerprint_service_provider(self, req_results):
# Determine which service provider (if any) is hosting this instance
domain_map = {
'ofx.netxclient.com': 'Pershing',
'uat-ofx.netxclient.inautix.com': 'Pershing',
'www.oasis.cfree.com': 'Fiserv - CheckFree - Oasis'
}
sp = ''
parsed = urlparse(self.ofxurl)
try:
sp = domain_map[parsed.netloc]
except KeyError:
pass
# Try the domain map first, fallback to SPNAME
if sp == '':
profrs = OFXFile(req_results[REQ_NAME_OFX_PROFILE].text)
try:
sp = profrs.profile['SPNAME']
except KeyError: pass
self.serviceprovider = sp
def fingerprint(self, req_results):
'''
Determine software and web frameworks running on instance.
'''
self._fingerprint_httpserver(req_results)
self._fingerprint_webframework(req_results)
self._fingerprint_software(req_results)
self._fingerprint_service_provider(req_results)
def get_tls(self):
try:
return self.tls['working']
except KeyError:
return True
def set_tls(self, working):
self.tls['working'] = working
class OFXTestClient():
_payload_func = {}
# Whether to print to stdout
_output = True
cache = {}
def __init__(self,
timeout=(3.2, 27),
wait=0,
use_cache=False,
output=False,
version='102',
tls_verify=True
):
self.timeout = timeout
self.wait = wait
self.use_cache = use_cache
self._output=output
self.version = version
self.tls_verify = tls_verify
if self.version[0] == '1':
self.ofxheader = OFX_HEADER_100.format(version=self.version)
self.content_type = 'text/sgml'
elif self.version[0] == '2':
self.ofxheader = OFX_HEADER_200.format(version=self.version)
self.content_type = 'text/xml'
else:
raise ValueError(
'Unknown OFX version number {}'.format(self.version))
def call_url_cached(self, url, tls_verify, body, method):
'''
return (request.response, boolean) - Response and whether it was
cached.
'''
if method not in ['GET', 'POST']:
raise ValueError("Method must be 'GET' or 'POST'")
# Impersonate PFM
headers = {
'User-Agent': USER_AGENT,
}
if method == 'POST':
headers['Content-Type'] = CONTENT_TYPE
# Simple in memory cache to avoid duplicate calls to the same URL.
try:
r = self.cache[url]
return (r, True)
except KeyError:
pass
if self._output: print("{}".format(url))
try:
if method == 'GET':
r = requests.get(
url,
headers=headers,
timeout=self.timeout,
verify=tls_verify
)
elif method == 'POST':
r = requests.post(
url,
headers=headers,
timeout=self.timeout,
verify=tls_verify,
data=body
)
if self.use_cache:
self.cache[url] = r
return (r, False)
except requests.ConnectionError as ex:
if self._output: print('\tConnectionError: {}'.format(ex))
# Set cache, but empty, to avoid further calls this run
# Still cache connection errors even if use_cache == False
self.cache[url] = None
except requests.exceptions.ReadTimeout as ex:
if self._output: print('\tConnectionError: {}'.format(ex))
if wait > 0:
if self._output:
print('\tWaiting for {} seconds'.format(self.wait))
time.sleep(self.wait)
return (None, False)
def call_url_interactive(self, ofxurl, tls_verify, payload, method):
res, was_cached = self.call_url_cached(
ofxurl,
tls_verify,
payload,
method
)
# Connection was completed successfully
if res is not None:
print_http_response(res)
def send_req(self, req_name, si):
'''
Send a pre-defined request to the OFX server.
'''
res = None
if req_name == REQ_NAME_GET_ROOT:
parsed = urlparse(si.ofxurl)
url = parsed.scheme + '://' + parsed.netloc
res, was_cached = self.call_url_cached(
url,
self.tls_verify,
self.get_empty_payload(si),
REQ_METHODS[req_name]
)
elif req_name == REQ_NAME_GET_OFX:
res, was_cached = self.call_url_cached(
si.ofxurl,
self.tls_verify,
self.get_empty_payload(si),
REQ_METHODS[req_name]
)
elif req_name == REQ_NAME_POST_OFX:
res, was_cached = self.call_url_cached(
si.ofxurl,
self.tls_verify,
self.get_empty_payload(si),
REQ_METHODS[req_name]
)
elif req_name == REQ_NAME_OFX_EMPTY:
res, was_cached = self.call_url_cached(
si.ofxurl,
self.tls_verify,
self.get_ofx_empty_payload(si),
REQ_METHODS[req_name]
)
elif req_name == REQ_NAME_OFX_PROFILE:
res, was_cached = self.call_url_cached(
si.ofxurl,
self.tls_verify,
self.get_profile_payload(si),
REQ_METHODS[req_name]
)
else:
raise ValueError('Unknown request name: {}'.format(req_name))
return res
def _get_signonmsg_anonymous_payload(self, si):
if self.content_type == 'text/sgml':
ofx_fi_fmt = \
'''<FI>
<ORG>{org}
<FID>{fid}
</FI>
'''
ofx_signon_fmt = \
'''<SIGNONMSGSRQV1>
<SONRQ>
<DTCLIENT>{dt}
<USERID>anonymous00000000000000000000000
<USERPASS>anonymous00000000000000000000000
<GENUSERKEY>N
<LANGUAGE>ENG
{fi}<APPID>QWIN
<APPVER>2700
</SONRQ>
</SIGNONMSGSRQV1>'''
elif self.content_type == 'text/xml':
ofx_fi_fmt = \
'''<FI>
<ORG>{org}</ORG>
<FID>{fid}</FID>
</FI>
'''
ofx_signon_fmt = \
'''<SIGNONMSGSRQV1>
<SONRQ>
<DTCLIENT>{dt}</DTCLIENT>
<USERID>anonymous00000000000000000000000</USERID>
<USERPASS>anonymous00000000000000000000000</USERPASS>
<GENUSERKEY>N</GENUSERKEY>
<LANGUAGE>ENG</LANGUAGE>
{fi}<APPID>QWIN</APPID>
<APPVER>2700</APPVER>
</SONRQ>
</SIGNONMSGSRQV1>'''
if si is None:
fi = ''
else:
fi = ofx_fi_fmt.format(
fid=si.fid,
org=si.org
)
frag = ofx_signon_fmt.format(
dt=dt_now(),
fi=fi
)
return frag
def get_empty_payload(self, si):
return ''
def get_ofx_empty_payload(self, si):
ofx_body = \
'''<OFX>
</OFX>
'''
return "{}{}{}".format(self.ofxheader, '\n', ofx_body)
def get_profile_payload(self, si):
if self.content_type == 'text/sgml':
ofx_body_fmt = \
'''<OFX>
{signonmsg}
<PROFMSGSRQV1>
<PROFTRNRQ>
<TRNUID>{uid}
<PROFRQ>
<CLIENTROUTING>MSGSET
<DTPROFUP>19900101
</PROFRQ>
</PROFTRNRQ>
</PROFMSGSRQV1>
</OFX>
'''
elif self.content_type == 'text/xml':
ofx_body_fmt = \
'''<OFX>
{signonmsg}
<PROFMSGSRQV1>
<PROFTRNRQ>
<TRNUID>{uid}</TRNUID>
<PROFRQ>
<CLIENTROUTING>MSGSET</CLIENTROUTING>
<DTPROFUP>19900101</DTPROFUP>
</PROFRQ>
</PROFTRNRQ>
</PROFMSGSRQV1>
</OFX>
'''
body = ofx_body_fmt.format(
signonmsg=self._get_signonmsg_anonymous_payload(si),
uid=uid())
return "{}{}{}".format(self.ofxheader, '\n', body)
def get_acctinfo_payload(self, si):
'''
ACCTINFO Request payload
'''
ofx_body_fmt = \
'''<OFX>
{signonmsg}
<SIGNUPMSGSRQV1>
<ACCTINFOTRNRQ>
<TRNUID>{uid}
<ACCTINFORQ>
<DTACCTUP>19900101
</ACCTINFORQ>
</ACCTINFOTRNRQ>
</SIGNUPMSGSRQV1>
</OFX>
'''
body = ofx_body_fmt.format(
signonmsg=self._get_signonmsg_anonymous_payload(si),
uid=uid())
return "{}{}{}".format(self.ofxheader, '\n', body)
def get_invstmtrn_payload(self, si, brokerid, acctid):
'''
INVSTMTTRRQ Request payload
'''
ofx_body_fmt = \
'''<OFX>
{signonmsg}
<INVSTMTMSGSRQV1>
<INVSTMTTRNRQ>
<TRNUID>{uid}
<INVSTMTRQ>
<INVACCTFROM>
<BROKERID>{broker_id}
<ACCTID>{acct_id}
</INVACCTFROM>
<INCTRAN>
<INCLUDE>Y
</INCTRAN>
<INCOO>Y
<INCPOS>
<INCLUDE>Y
</INCPOS>
<INCBAL>Y
</INVSTMTRQ>
</INVSTMTTRNRQ>
</INVSTMTMSGSRQV1>
</OFX>
'''
body = ofx_body_fmt.format(
signonmsg=self._get_signonmsg_anonymous_payload(si),
uid=uid(),
broker_id=brokerid,
acct_id = acctid)
return "{}{}{}".format(self.ofxheader, '\n', body)
class OFXFile():
'''
Read and parse an OFX file.
This is simplistic parsing of specific fields, mainly the header and PROFRS
'''
_file_str = ''
_v2_dict = {}
headers = {}
version = None
signon = {}
profile = {}
def __init__(self, file_str):
self._file_str = file_str
self._convert_newlines()
self._parse_header()
if self.major_version() == 2:
self._v2_dict = xmlparse(file_str)
self._parse_signon()
self._parse_profile()
def _convert_newlines(self):
'''
Convert from network newlines to platform newlines.
For now, just blindly Windows to Unix.
'''
self._file_str = self._file_str.replace('\r\n', '\n')
def _parse_header(self):
# Parse Version 1 Header
# Example:
#
# OFXHEADER:100
# DATA:OFXSGML
# VERSION:102
# SECURITY:NONE
# ENCODING:USASCII
# CHARSET:1252
# COMPRESSION:NONE
# OLDFILEUID:NONE
# NEWFILEUID:NONE
if self._file_str.startswith('OFXHEADER'):
# Assume well formed and parse based on NEWLINES
for line in self._file_str.splitlines():
# End of header
if line == '' or line.startswith('<OFX>') or len(line) > 13:
break
[k,v] = line.split(':')
self.headers[k] = v
try:
self.version = int(self.headers[HDR_VERSION])
except KeyError:
raise ValueError("Parse Error: No version")
# Parse Version 2 Header
# Example:
# <?OFX OFXHEADER="200" VERSION="203" SECURITY="NONE" OLDFILEUID="NONE" NEWFILEUID="NONE"?>
elif self._file_str.find('<?OFX OFXHEADER') != -1:
# Python (as of 3.7) has no way to read prolog declarations.
# https://bugs.python.org/issue24287
# So don't bother parsing as XML, just use a regex to read the
# OFX header.
# TODO: Pull ENCODING out of <?xml> declaration
rpat = r'<\?OFX OFXHEADER="(?P<OFXHEADER>\d+)" VERSION="(?P<VERSION>\d+)" SECURITY="(?P<SECURITY>\w+)" OLDFILEUID="(?P<OLDFILEUID>\w+)" NEWFILEUID="(?P<NEWFILEUID>\w+)"\?>'
match = re.search(rpat, self._file_str)
if not match:
raise ValueError("Parse Error: Unable to parse V2 header with regex")
for field in HDR_FIELDS_V2:
self.headers[field] = match.group(field)
try:
self.version = int(self.headers[HDR_VERSION])
parsed = True
except KeyError:
raise ValueError("Parse Error: No version")
else:
raise ValueError("Parse Error: Unable to parse header")
def major_version(self):
if str(self.version).startswith('1'):
return 1
elif str(self.version).startswith('2'):
return 2
def find_span_value(self, value, ofx_str=None, casesen=False):
'''
Find the span ELEMENT which contains the given value.
'''
if not ofx_str: ofx_str = self._file_str
if self.major_version() == 1:
rpat = r'<([\w.+]+)>'+value
elif self.major_version() == 2:
rpat = r'<(?P<elm>[\w.+]+)>'+value+r'</(?P=elm)>'
flags = 0 if casesen else re.IGNORECASE
matches = re.finditer(rpat, ofx_str, flags)
if matches:
return [m.group(0) for m in matches]
else:
return None
def _parse_element_block(self, element, ofx_str=None):
'''
Read the internal values of a block element including other elements.
'''
if not ofx_str: ofx_str = self._file_str
rpat = r'<'+element+r'>(.*)</'+element+r'>'
match = re.search(rpat, ofx_str, re.DOTALL)
if match:
return match.group(1)
else:
return None
def _parse_element_span(self, element, ofx_str=None):
'''
Read the value of a span <ELEMENT> tag
'''
if not ofx_str: ofx_str = self._file_str
rpat = r'<'+element+r'>([^<\n]+)'
match = re.search(rpat, ofx_str)
if match:
return match.group(1)
else:
return None
def _v2_retrieve_element(self, elmpath, etype):
'''
Walk a dictionary tree and retrieve values from it.
tagpath - ex: 'ofx:signonmsgsrsv1:sonrs:fi:org'
etype - ex: 'string'
'''
val = None
node = self._v2_dict
elmlist = elmpath.split(':')
for elm in elmlist:
try:
node = node[elm.upper()]
except KeyError:
break
if elm == elmlist[-1]:
if etype == 'string':
val = node
if etype == 'bool':
if node == 'Y':
val = True
elif node == 'N':
val = False
else:
raise ValueError('Unknown value for {}: {}'.format(
elmpath, val))
if etype == 'integer':
val = int(node)
elif etype == 'exist':
val = True
break
return val
def _path_to_dict(self, path, value):
'''
Given a string path, nest dictionaries and set a value.
path - ex: 'investment:transactions'
'''
nodelist = path.split(':')
node = self.profile
for name in nodelist:
try:
node = node[name]
except KeyError:
if name == nodelist[-1] and value is not None:
node[name] = value
else:
node[name] = dict()
def _parse_signon(self):
'''
Parse a SIGNON response if one exists
'''
if self.major_version() == 1:
# Confirm a SIGNON response exists
rpat = r'<SONRS>'
match = re.search(rpat, self._file_str)
if not match:
return
# Get Server information
elms = ('ORG', 'FID')
for elm in elms:
val = self._parse_element_span(elm)
if val:
self.signon[elm] = val
elif self.major_version() == 2:
val = self._v2_retrieve_element(
'ofx:signonmsgsrsv1:sonrs:fi:org',
'string'
)
if val:
self.signon['ORG'] = val
val = self._v2_retrieve_element(
'ofx:signonmsgsrsv1:sonrs:fi:fid',
'string'
)
if val:
self.signon['FID'] = val
def _parse_profile(self):
'''
Parse a PROFILE response if one exists
'''
if self.major_version() == 1:
# This is where we'd should start implementing a real SGML parser,
# but I'm parsing with quick and loose regex as a first pass
# Confirm that a PROFILE response exists
profrs = self._parse_element_block('PROFRS')
if not profrs:
return
# Get FI contact information
elms = ('FINAME', 'ADDR1', 'ADDR2', 'ADDR3', 'CITY',
'STATE', 'POSTALCODE', 'COUNTRY', 'EMAIL')
for elm in elms:
val = self._parse_element_span(elm, profrs)
if val:
self.profile[elm] = val
# Get OFX URL
# Technically this can be different for every message set,
# in practice it's usually identical to the PROFILE server.
# However, if it is different, it's usually the same for every
# other message set besides PROFMSGSET.
block = self._parse_element_block('SIGNONMSGSET', profrs)
if block:
val = self._parse_element_span('URL', block)
if val:
self.profile['OFXURL'] = val
val = self._parse_element_span('SPNAME', block)
if val:
self.profile['SPNAME'] = val
# Get FI capabilities
block = self._parse_element_block('BANKMSGSET', profrs)
if block:
self.profile['BANKING'] = dict()
b2 = self._parse_element_block('XFERPROF', block)
if b2:
self.profile['BANKING']['INTRAXFR'] = True
b2 = self._parse_element_block('EMAILPROF', block)
if b2:
self.profile['BANKING']['MESSAGES'] = dict()
val = self._parse_element_span('CANEMAIL', b2)
if val == 'Y':
self.profile['BANKING']['MESSAGES']['EMAIL'] = True
val = self._parse_element_span('CANNOTIFY', b2)
if val == 'Y':
self.profile['BANKING']['MESSAGES']['NOTIFY'] = True
block = self._parse_element_block('INVSTMTMSGSET', profrs)
if block:
self.profile['INVESTMENT'] = dict()
val = self._parse_element_span('TRANDNLD', block)
if val:
self.profile['INVESTMENT']['TRANSACTIONS'] = True
val = self._parse_element_span('OODNLD', block)
if val:
self.profile['INVESTMENT']['OPENORDERS'] = True
val = self._parse_element_span('POSDNLD', block)
if val:
self.profile['INVESTMENT']['POSITIONS'] = True
val = self._parse_element_span('POSDNLD', block)
if val:
self.profile['INVESTMENT']['POSITIONS'] = True
val = self._parse_element_span('BALDNLD', block)