-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwinmanifest.py
1029 lines (929 loc) · 44 KB
/
winmanifest.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
#
# Copyright (C) 2009, Florian Hoech
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301, USA
# DEV NOTES
#
# Currently not implemented in the Manifest class:
# * Validation (only very basic sanity checks are currently in place)
# * comClass, typelib, comInterfaceProxyStub and windowClass child elements of
# the file element
# * comInterfaceExternalProxyStub and windowClass child elements of the
# assembly element
# * Application Configuration File and Multilanguage User Interface (MUI)
# support when searching for assembly files
#
# Isolated Applications and Side-by-side Assemblies:
# http://msdn.microsoft.com/en-us/library/dd408052%28VS.85%29.aspx
#
# Changelog:
# 2009-12-17 fix: small glitch in toxml / toprettyxml methods (xml declaration
# wasn't replaced when a different encodig than UTF-8 was used)
# chg: catch xml.parsers.expat.ExpatError and re-raise as
# ManifestXMLParseError
# chg: support initialize option in parse method also
#
# 2009-12-13 fix: fixed os import
# fix: skip invalid / empty dependent assemblies
#
# 2009-08-21 fix: Corrected assembly searching sequence for localized
# assemblies
# fix: Allow assemblies with no dependent files
#
# 2009-07-31 chg: Find private assemblies even if unversioned
# add: Manifest.same_id method to check if two manifests have the
# same assemblyIdentity
#
# 2009-07-30 fix: Potential failure in File.calc_hash method if hash
# algorythm not supported
# add: Publisher configuration (policy) support when searching for
# assembly files
# fix: Private assemblies are now actually found if present (and no
# shared assembly exists)
# add: Python 2.3 compatibility (oldest version supported by
# pyinstaller)
#
# 2009-07-28 chg: Code cleanup, removed a bit of redundancy
# add: silent mode (set silent attribute on module)
# chg: Do not print messages in silent mode
#
# 2009-06-18 chg: Use glob instead of regular expression in Manifest.find_files
#
# 2009-05-04 fix: Don't fail if manifest has empty description
# fix: Manifests created by the toxml, toprettyxml, writexml or
# writeprettyxml methods are now correctly recognized by
# Windows, which expects the XML declaration to be ordered
# version-encoding-standalone (standalone being optional)
# add: 'encoding' keyword argument in toxml, toprettyxml, writexml
# and writeprettyxml methods
# chg: UpdateManifestResourcesFromXML and
# UpdateManifestResourcesFromXMLFile: set resource name
# depending on file type ie. exe or dll
# fix: typo in __main__: UpdateManifestResourcesFromDataFile
# should have been UpdateManifestResourcesFromXMLFile
#
# 2009-03-21 First version
"""
winmanifest.py
Create, parse and write MS Windows Manifest files.
Find files which are part of an assembly, by searching shared and
private assemblies.
Update or add manifest resources in Win32 PE files.
Commandline usage:
winmanifest.py <dstpath> <xmlpath>
Updates or adds manifest <xmlpath> as resource in Win32 PE file <dstpath>.
"""
try:
import hashlib
except ImportError, detail:
hashlib = None
import md5
import sha
import os
from glob import glob
import re
import sys
import xml
from xml.dom import Node, minidom
from xml.dom.minidom import Document, Element
try:
import winresource
except ImportError, detail:
winresource = None
print "W:", detail
print "W: Cannot check for assembly dependencies - resource access "
print "W: unavailable. To enable resource access, please install "
print "W: http://sourceforge.net/projects/pywin32/"
try:
sys.getwindowsversion
except AttributeError:
def getwindowsversion():
import win32api
return win32api.GetVersionEx(0)
sys.getwindowsversion = getwindowsversion
silent = False # True suppresses all messages
LANGUAGE_NEUTRAL_NT5 = "x-ww"
LANGUAGE_NEUTRAL_NT6 = "none"
RT_MANIFEST = 24
Document.aChild = Document.appendChild
Document.cE = Document.createElement
Document.cT = Document.createTextNode
Document.getEByTN = Document.getElementsByTagName
Element.aChild = Element.appendChild
Element.getA = Element.getAttribute
Element.getEByTN = Element.getElementsByTagName
Element.remA = Element.removeAttribute
Element.setA = Element.setAttribute
def getChildElementsByTagName(self, tagName):
""" Return child elements of type tagName if found, else [] """
result = []
for child in self.childNodes:
if isinstance(child, Element):
if child.tagName == tagName:
result.append(child)
return result
def getFirstChildElementByTagName(self, tagName):
""" Return the first element of type tagName if found, else None """
for child in self.childNodes:
if isinstance(child, Element):
if child.tagName == tagName:
return child
return None
Document.getCEByTN = getChildElementsByTagName
Document.getFCEByTN = getFirstChildElementByTagName
Element.getCEByTN = getChildElementsByTagName
Element.getFCEByTN = getFirstChildElementByTagName
class _Hash(object):
def __init__(self):
self.md5 = md5.new
self.sha = sha.new
if hashlib is None:
hashlib = _Hash()
class _Dummy:
pass
if winresource:
_File = winresource.File
else:
_File = _Dummy
class File(_File):
""" A file referenced by an assembly inside a manifest. """
def __init__(self, filename="", hashalg=None, hash=None, comClasses=None,
typelibs=None, comInterfaceProxyStubs=None,
windowClasses=None):
if winresource:
winresource.File.__init__(self, filename)
else:
self.filename = filename
self.name = os.path.basename(filename)
if hashalg:
self.hashalg = hashalg.upper()
else:
self.hashalg = None
if os.path.isfile(filename) and hashalg and hashlib and \
hasattr(hashlib, hashalg.lower()):
self.calc_hash()
else:
self.hash = hash
self.comClasses = comClasses or [] # TO-DO: implement
self.typelibs = typelibs or [] # TO-DO: implement
self.comInterfaceProxyStubs = comInterfaceProxyStubs or [] # TO-DO: implement
self.windowClasses = windowClasses or [] # TO-DO: implement
def calc_hash(self, hashalg=None):
"""
Calculate the hash of the file.
Will be called automatically from the constructor if the file exists
and hashalg is given (and supported), but may also be called manually
e.g. to update the hash if the file has changed.
"""
fd = open(self.filename, "rb")
buf = fd.read()
fd.close()
if hashalg:
self.hashalg = hashalg.upper()
self.hash = getattr(hashlib, self.hashalg.lower())(buf).hexdigest()
def find(self, searchpath):
if not silent:
print "I: Searching for file", self.name
fn = os.path.join(searchpath, self.name)
if os.path.isfile(fn):
if not silent:
print "I: Found file", fn
return fn
else:
if not silent:
print "W: No such file", fn
return None
class InvalidManifestError(Exception):
pass
class ManifestXMLParseError(InvalidManifestError):
pass
class Manifest(object):
# Manifests:
# http://msdn.microsoft.com/en-us/library/aa375365%28VS.85%29.aspx
"""
Manifest constructor.
To build a basic manifest for your application:
mf = Manifest(type='win32', name='YourAppName', language='*',
processorArchitecture='x86', version=[1, 0, 0, 0])
To write the XML to a manifest file:
mf.writexml("YourAppName.exe.manifest")
or
mf.writeprettyxml("YourAppName.exe.manifest")
"""
def __init__(self, manifestVersion=None, noInheritable=False,
noInherit=False, type_=None, name=None, language=None,
processorArchitecture=None, version=None,
publicKeyToken=None, description=None,
requestedExecutionLevel=None, uiAccess=None,
dependentAssemblies=None, files=None,
comInterfaceExternalProxyStubs=None):
self.filename = None
self.optional = None
self.manifestType = "assembly"
self.manifestVersion = manifestVersion or [1, 0]
self.noInheritable = noInheritable
self.noInherit = noInherit
self.type = type_
self.name = name
self.language = language
self.processorArchitecture = processorArchitecture
self.version = version
self.publicKeyToken = publicKeyToken
# publicKeyToken:
# A 16-character hexadecimal string that represents the last 8 bytes
# of the SHA-1 hash of the public key under which the assembly is
# signed. The public key used to sign the catalog must be 2048 bits
# or greater. Required for all shared side-by-side assemblies.
# http://msdn.microsoft.com/en-us/library/aa375692(VS.85).aspx
self.applyPublisherPolicy = None
self.description = None
self.requestedExecutionLevel = requestedExecutionLevel
self.uiAccess = uiAccess
self.dependentAssemblies = dependentAssemblies or []
self.bindingRedirects = []
self.files = files or []
self.comInterfaceExternalProxyStubs = comInterfaceExternalProxyStubs or [] # TO-DO: implement
def add_dependent_assembly(self, manifestVersion=None, noInheritable=False,
noInherit=False, type_=None, name=None, language=None,
processorArchitecture=None, version=None,
publicKeyToken=None, description=None,
requestedExecutionLevel=None, uiAccess=None,
dependentAssemblies=None, files=None,
comInterfaceExternalProxyStubs=None):
"""
Shortcut for self.dependentAssemblies.append(Manifest(*args, **kwargs))
"""
self.dependentAssemblies.append(Manifest(manifestVersion,
noInheritable, noInherit, type_, name,
language, processorArchitecture,
version, publicKeyToken, description,
requestedExecutionLevel, uiAccess,
dependentAssemblies, files,
comInterfaceExternalProxyStubs))
if self.filename:
# Enable search for private assembly by assigning bogus filename
# (only the directory has to be correct)
self.dependentAssemblies[-1].filename = ":".join((self.filename,
name))
def add_file(self, name="", hashalg="", hash="", comClasses=None,
typelibs=None, comInterfaceProxyStubs=None,
windowClasses=None):
""" Shortcut for manifest.files.append """
self.files.append(File(name, hashalg, hash, comClasses,
typelibs, comInterfaceProxyStubs, windowClasses))
def find_files(self, ignore_policies=True):
""" Search shared and private assemblies and return a list of files.
If any files are not found, return an empty list.
IMPORTANT NOTE: For the purpose of getting the dependent assembly
files of an executable, the publisher configuration (aka policy)
should be ignored (which is the default). Setting ignore_policies=False
is only useful to find out which files are actually loaded at
runtime.
"""
# Shared Assemblies:
# http://msdn.microsoft.com/en-us/library/aa375996%28VS.85%29.aspx
#
# Private Assemblies:
# http://msdn.microsoft.com/en-us/library/aa375674%28VS.85%29.aspx
#
# Assembly Searching Sequence:
# http://msdn.microsoft.com/en-us/library/aa374224%28VS.85%29.aspx
#
# NOTE:
# Multilanguage User Interface (MUI) support not yet implemented
files = []
languages = []
if self.language not in (None, "", "*", "neutral"):
languages.append(self.getlanguage())
if "-" in self.language:
# language-culture syntax, e.g. en-us
# Add only the language part
languages.append(self.language.split("-")[0])
if self.language not in ("en-us", "en"):
languages.append("en-us")
if self.language != "en":
languages.append("en")
languages.append(self.getlanguage("*"))
winsxs = os.path.join(os.getenv("SystemRoot"), "WinSxS")
if not os.path.isdir(winsxs) and not silent:
print "W: No such dir", winsxs
manifests = os.path.join(winsxs, "Manifests")
if not os.path.isdir(manifests) and not silent:
print "W: No such dir", manifests
if not ignore_policies and self.version:
if sys.getwindowsversion() < (6, ):
# Windows XP
pcfiles = os.path.join(winsxs, "Policies")
if not os.path.isdir(pcfiles) and not silent:
print "W: No such dir", pcfiles
else:
# Vista or later
pcfiles = manifests
for language in languages:
version = self.version
# Search for publisher configuration
if not ignore_policies and version:
# Publisher Configuration (aka policy)
# A publisher configuration file globally redirects
# applications and assemblies having a dependence on one
# version of a side-by-side assembly to use another version of
# the same assembly. This enables applications and assemblies
# to use the updated assembly without having to rebuild all of
# the affected applications.
# http://msdn.microsoft.com/en-us/library/aa375680%28VS.85%29.aspx
#
# Under Windows XP and 2003, policies are stored as
# <version>.policy files inside
# %SystemRoot%\WinSxS\Policies\<name>
# Under Vista and later, policies are stored as
# <name>.manifest files inside %SystemRoot%\winsxs\Manifests
redirected = False
if os.path.isdir(pcfiles):
if not silent:
print ("I: Searching for publisher configuration %s..." %
self.getpolicyid(True, language=language))
if sys.getwindowsversion() < (6, ):
# Windows XP
policies = os.path.join(pcfiles,
self.getpolicyid(True,
language=language) +
".policy")
else:
# Vista or later
policies = os.path.join(pcfiles,
self.getpolicyid(True,
language=language) +
".manifest")
for manifestpth in glob(policies):
if not os.path.isfile(manifestpth):
if not silent:
print "W: Not a file", manifestpth
continue
if not silent:
print "I: Found", manifestpth
try:
policy = ManifestFromXMLFile(manifestpth)
except Exception, exc:
print "E: Could not parse file", manifestpth
print "E:", str(exc)
else:
if not silent:
print ("I: Checking publisher policy for "
"binding redirects")
for assembly in policy.dependentAssemblies:
if not assembly.same_id(self, True) or \
assembly.optional:
continue
for redirect in \
assembly.bindingRedirects:
if not silent:
old = "-".join([".".join([str(i)
for i in
part])
for part in
redirect[0]])
new = ".".join([str(i)
for i in
redirect[1]])
print "I: Found redirect for " \
"version(s)", old, "->", new
if version >= redirect[0][0] and \
version <= redirect[0][-1] and \
version != redirect[1]:
if not silent:
print "I: Applying redirect", \
".".join([str(i)
for i in
version]), \
"->", new
version = redirect[1]
redirected = True
if not redirected and not silent:
print "I: Publisher configuration not used"
# Search for assemblies according to assembly searching sequence
paths = []
if os.path.isdir(manifests):
# Add winsxs search paths
paths.extend(glob(os.path.join(manifests,
self.getid(language=language,
version=version) +
"_*.manifest")))
if self.filename:
# Add private assembly search paths
dirnm = os.path.dirname(self.filename)
if language in (LANGUAGE_NEUTRAL_NT5,
LANGUAGE_NEUTRAL_NT6):
for ext in (".dll", ".manifest"):
paths.extend(glob(os.path.join(dirnm, self.name + ext)))
paths.extend(glob(os.path.join(dirnm, self.name,
self.name + ext)))
else:
for ext in (".dll", ".manifest"):
paths.extend(glob(os.path.join(dirnm, language,
self.name + ext)))
for ext in (".dll", ".manifest"):
paths.extend(glob(os.path.join(dirnm, language,
self.name,
self.name + ext)))
if not silent:
print ("I: Searching for assembly %s..." %
self.getid(language=language,
version=version))
for manifestpth in paths:
if not os.path.isfile(manifestpth):
if not silent:
print "W: Not a file", manifestpth
continue
assemblynm = os.path.basename(
os.path.splitext(manifestpth)[0])
if not silent:
if manifestpth.endswith(".dll"):
print "I: Found manifest in", manifestpth
else:
print "I: Found manifest", manifestpth
try:
if manifestpth.endswith(".dll"):
manifest = ManifestFromResFile(manifestpth, [1])
else:
manifest = ManifestFromXMLFile(manifestpth)
except Exception, exc:
print "E: Could not parse manifest", manifestpth
print "E:", exc
else:
if manifestpth.startswith(winsxs):
assemblydir = os.path.join(winsxs, assemblynm)
if not os.path.isdir(assemblydir):
if not silent:
print "W: No such dir", assemblydir
print "W: Assembly incomplete"
return []
else:
assemblydir = os.path.dirname(manifestpth)
files.append(manifestpth)
for file_ in self.files or manifest.files:
fn = file_.find(assemblydir)
if fn:
files.append(fn)
else:
# If any of our files does not exist,
# the assembly is incomplete
if not silent:
print "W: Assembly incomplete"
return []
return files
print "W: Assembly not found"
return []
def getid(self, language=None, version=None):
"""
Return an identification string which uniquely names a manifest.
This string is a combination of the manifest's processorArchitecture,
name, publicKeyToken, version and language.
Arguments:
version (tuple or list of integers) - If version is given, use it
instead of the manifest's
version.
"""
if not self.name:
if not silent:
print "W: Assembly metadata incomplete"
return ""
id = []
if self.processorArchitecture:
id.append(self.processorArchitecture)
id.append(self.name)
if self.publicKeyToken:
id.append(self.publicKeyToken)
if version or self.version:
id.append(".".join([str(i) for i in version or self.version]))
if not language:
language = self.getlanguage()
if language:
id.append(language)
return "_".join(id)
def getlanguage(self, language=None, windowsversion=None):
"""
Get and return the manifest's language as string.
Can be either language-culture e.g. 'en-us' or a string indicating
language neutrality, e.g. 'x-ww' on Windows XP or 'none' on Vista
and later.
"""
if not language:
language = self.language
if language in (None, "", "*", "neutral"):
return (LANGUAGE_NEUTRAL_NT5,
LANGUAGE_NEUTRAL_NT6)[(windowsversion or
sys.getwindowsversion()) >= (6, )]
return language
def getpolicyid(self, fuzzy=True, language=None, windowsversion=None):
"""
Return an identification string which can be used to find a policy.
This string is a combination of the manifest's processorArchitecture,
major and minor version, name, publicKeyToken and language.
Arguments:
fuzzy (boolean) - If False, insert the full version in
the id string. Default is True (omit).
windowsversion - If not specified (or None), default to
(tuple or list of integers) sys.getwindowsversion().
"""
if not self.name:
if not silent:
print "W: Assembly metadata incomplete"
return ""
id = []
if self.processorArchitecture:
id.append(self.processorArchitecture)
name = []
name.append("policy")
if self.version:
name.append(str(self.version[0]))
name.append(str(self.version[1]))
name.append(self.name)
id.append(".".join(name))
if self.publicKeyToken:
id.append(self.publicKeyToken)
if self.version and (windowsversion or sys.getwindowsversion()) >= (6, ):
# Vista and later
if fuzzy:
id.append("*")
else:
id.append(".".join([str(i) for i in self.version]))
if not language:
language = self.getlanguage(windowsversion=windowsversion)
if language:
id.append(language)
id.append("*")
id = "_".join(id)
if self.version and (windowsversion or sys.getwindowsversion()) < (6, ):
# Windows XP
if fuzzy:
id = os.path.join(id, "*")
else:
id = os.path.join(id, ".".join([str(i) for i in self.version]))
return id
def load_dom(self, domtree, initialize=True):
"""
Load manifest from DOM tree.
If initialize is True (default), reset existing attributes first.
"""
if domtree.nodeType == Node.DOCUMENT_NODE:
rootElement = domtree.documentElement
elif domtree.nodeType == Node.ELEMENT_NODE:
rootElement = domtree
else:
raise InvalidManifestError("Invalid root element node type " +
str(rootElement.nodeType) +
" - has to be one of (DOCUMENT_NODE, "
"ELEMENT_NODE)")
allowed_names = ("assembly", "assemblyBinding", "configuration",
"dependentAssembly")
if rootElement.tagName not in allowed_names:
raise InvalidManifestError(
"Invalid root element <%s> - has to be one of <%s>" %
(rootElement.tagName, ">, <".join(allowed_names)))
# print "I: loading manifest metadata from element <%s>" % \
# rootElement.tagName
if rootElement.tagName == "configuration":
for windows in rootElement.getCEByTN("windows"):
for assemblyBinding in windows.getCEByTN("assemblyBinding"):
self.load_dom(assemblyBinding, initialize)
else:
if initialize:
self.__init__()
self.manifestType = rootElement.tagName
self.manifestVersion = [int(i)
for i in
(rootElement.getA("manifestVersion") or
"1.0").split(".")]
self.noInheritable = bool(rootElement.getFCEByTN("noInheritable"))
self.noInherit = bool(rootElement.getFCEByTN("noInherit"))
for assemblyIdentity in rootElement.getCEByTN("assemblyIdentity"):
self.type = assemblyIdentity.getA("type") or None
self.name = assemblyIdentity.getA("name") or None
self.language = assemblyIdentity.getA("language") or None
self.processorArchitecture = assemblyIdentity.getA(
"processorArchitecture") or None
version = assemblyIdentity.getA("version")
if version:
self.version = [int(i) for i in version.split(".")]
self.publicKeyToken = assemblyIdentity.getA("publicKeyToken") or None
for publisherPolicy in rootElement.getCEByTN("publisherPolicy"):
self.applyPublisherPolicy = (publisherPolicy.getA("apply") or
"").lower() == "yes"
for description in rootElement.getCEByTN("description"):
if description.firstChild:
self.description = description.firstChild.wholeText
for trustInfo in rootElement.getCEByTN("trustInfo"):
for security in trustInfo.getCEByTN("security"):
for requestedPrivileges in \
security.getCEByTN("requestedPrivileges"):
for requestedExecutionLevel in \
requestedPrivileges.getCEByTN(
"requestedExecutionLevel"):
self.requestedExecutionLevel = \
requestedExecutionLevel.getA("level")
self.uiAccess = (
requestedExecutionLevel.getA("uiAccess") or
"").lower() == "true"
if rootElement.tagName == "assemblyBinding":
dependencies = [rootElement]
else:
dependencies = rootElement.getCEByTN("dependency")
for dependency in dependencies:
for dependentAssembly in dependency.getCEByTN(
"dependentAssembly"):
manifest = ManifestFromDOM(dependentAssembly)
if not manifest.name:
# invalid, skip
continue
manifest.optional = (dependency.getA("optional") or
"").lower() == "yes"
self.dependentAssemblies.append(manifest)
if self.filename:
# Enable search for private assembly by assigning bogus
# filename (only the directory has to be correct)
self.dependentAssemblies[-1].filename = ":".join(
(self.filename, manifest.name))
for bindingRedirect in rootElement.getCEByTN("bindingRedirect"):
oldVersion = [[int(i) for i in part.split(".")]
for part in
bindingRedirect.getA("oldVersion").split("-")]
newVersion = [int(i)
for i in
bindingRedirect.getA("newVersion").split(".")]
self.bindingRedirects.append((oldVersion, newVersion))
for file_ in rootElement.getCEByTN("file"):
self.add_file(name=file_.getA("name"),
hashalg=file_.getA("hashalg"),
hash=file_.getA("hash"))
def parse(self, filename_or_file, initialize=True):
""" Load manifest from file or file object """
if isinstance(filename_or_file, (str, unicode)):
filename = filename_or_file
else:
filename = filename_or_file.name
try:
domtree = minidom.parse(filename_or_file)
except xml.parsers.expat.ExpatError, e:
args = [e.args[0]]
if isinstance(filename, unicode):
filename = filename.encode(sys.getdefaultencoding(), "replace")
args.insert(0, '\n File "%s"\n ' % filename)
raise ManifestXMLParseError(" ".join([str(arg) for arg in args]))
if initialize:
self.__init__()
self.filename = filename
self.load_dom(domtree, False)
def parse_string(self, xmlstr, initialize=True):
""" Load manifest from XML string """
try:
domtree = minidom.parseString(xmlstr)
except xml.parsers.expat.ExpatError, e:
raise ManifestXMLParseError(e)
self.load_dom(domtree, initialize)
def same_id(self, manifest, skip_version_check=False):
"""
Return a bool indicating if another manifest has the same identitiy.
This is done by comparing language, name, processorArchitecture,
publicKeyToken, type and version.
"""
if skip_version_check:
version_check = True
else:
version_check = self.version == manifest.version
return (self.language == manifest.language and
self.name == manifest.name and
self.processorArchitecture == manifest.processorArchitecture and
self.publicKeyToken == manifest.publicKeyToken and
self.type == manifest.type and
version_check)
def todom(self):
""" Return the manifest as DOM tree """
doc = Document()
docE = doc.cE(self.manifestType)
if self.manifestType == "assemblyBinding":
cfg = doc.cE("configuration")
win = doc.cE("windows")
win.aChild(docE)
cfg.aChild(win)
doc.aChild(cfg)
else:
doc.aChild(docE)
if self.manifestType != "dependentAssembly":
docE.setA("xmlns", "urn:schemas-microsoft-com:asm.v1")
if self.manifestType != "assemblyBinding":
docE.setA("manifestVersion",
".".join([str(i) for i in self.manifestVersion]))
if self.noInheritable:
docE.aChild(doc.cE("noInheritable"))
if self.noInherit:
docE.aChild(doc.cE("noInherit"))
aId = doc.cE("assemblyIdentity")
if self.type:
aId.setAttribute("type", self.type)
if self.name:
aId.setAttribute("name", self.name)
if self.language:
aId.setAttribute("language", self.language)
if self.processorArchitecture:
aId.setAttribute("processorArchitecture",
self.processorArchitecture)
if self.version:
aId.setAttribute("version",
".".join([str(i) for i in self.version]))
if self.publicKeyToken:
aId.setAttribute("publicKeyToken", self.publicKeyToken)
if aId.hasAttributes():
docE.aChild(aId)
else:
aId.unlink()
if self.applyPublisherPolicy != None:
ppE = doc.cE("publisherPolicy")
if self.applyPublisherPolicy:
ppE.setA("apply", "yes")
else:
ppE.setA("apply", "no")
docE.aChild(ppE)
if self.description:
descE = doc.cE("description")
descE.aChild(doc.cT(self.description))
docE.aChild(descE)
if self.requestedExecutionLevel in ("asInvoker", "highestAvailable",
"requireAdministrator"):
tE = doc.cE("trustInfo")
tE.setA("xmlns", "urn:schemas-microsoft-com:asm.v3")
sE = doc.cE("security")
rpE = doc.cE("requestedPrivileges")
relE = doc.cE("requestedExecutionLevel")
relE.setA("level", self.requestedExecutionLevel)
if self.uiAccess:
relE.setA("uiAccess", "true")
else:
relE.setA("uiAccess", "false")
rpE.aChild(relE)
sE.aChild(rpE)
tE.aChild(sE)
docE.aChild(tE)
if self.dependentAssemblies:
for assembly in self.dependentAssemblies:
if self.manifestType != "assemblyBinding":
dE = doc.cE("dependency")
if assembly.optional:
dE.setAttribute("optional", "yes")
daE = doc.cE("dependentAssembly")
adom = assembly.todom()
for child in adom.documentElement.childNodes:
daE.aChild(child.cloneNode(False))
adom.unlink()
if self.manifestType != "assemblyBinding":
dE.aChild(daE)
docE.aChild(dE)
else:
docE.aChild(daE)
if self.bindingRedirects:
for bindingRedirect in self.bindingRedirects:
brE = doc.cE("bindingRedirect")
brE.setAttribute("oldVersion",
"-".join([".".join([str(i)
for i in
part])
for part in
bindingRedirect[0]]))
brE.setAttribute("newVersion",
".".join([str(i) for i in bindingRedirect[1]]))
docE.aChild(brE)
if self.files:
for file_ in self.files:
fE = doc.cE("file")
for attr in ("name", "hashalg", "hash"):
val = getattr(file_, attr)
if val:
fE.setA(attr, val)
docE.aChild(fE)
return doc
def toprettyxml(self, indent=" ", newl=os.linesep, encoding="UTF-8"):
""" Return the manifest as pretty-printed XML """
domtree = self.todom()
# WARNING: The XML declaration has to follow the order
# version-encoding-standalone (standalone being optional), otherwise
# if it is embedded in an exe the exe will fail to launch!
# ('application configuration incorrect')
if sys.version_info >= (2,3):
xmlstr = domtree.toprettyxml(indent, newl, encoding)
else:
xmlstr = domtree.toprettyxml(indent, newl)
xmlstr = xmlstr.strip(os.linesep).replace(
'<?xml version="1.0" encoding="%s"?>' % encoding,
'<?xml version="1.0" encoding="%s" standalone="yes"?>' %
encoding)
domtree.unlink()
return xmlstr
def toxml(self, encoding="UTF-8"):
""" Return the manifest as XML """
domtree = self.todom()
# WARNING: The XML declaration has to follow the order
# version-encoding-standalone (standalone being optional), otherwise
# if it is embedded in an exe the exe will fail to launch!
# ('application configuration incorrect')
xmlstr = domtree.toxml(encoding).replace(
'<?xml version="1.0" encoding="%s"?>' % encoding,
'<?xml version="1.0" encoding="%s" standalone="yes"?>' % encoding)
domtree.unlink()
return xmlstr
def update_resources(self, dstpath, names=None, languages=None):
""" Update or add manifest resource in dll/exe file dstpath """
UpdateManifestResourcesFromXML(dstpath, self.toprettyxml(), names,
languages)
def writeprettyxml(self, filename_or_file=None, indent=" ", newl=os.linesep,
encoding="UTF-8"):
""" Write the manifest as XML to a file or file object """
if not filename_or_file:
filename_or_file = self.filename
if isinstance(filename_or_file, (str, unicode)):
filename_or_file = open(filename_or_file, "wb")
xmlstr = self.toprettyxml(indent, newl, encoding)
filename_or_file.write(xmlstr)
filename_or_file.close()
def writexml(self, filename_or_file=None, indent=" ", newl=os.linesep,
encoding="UTF-8"):
""" Write the manifest as XML to a file or file object """
if not filename_or_file:
filename_or_file = self.filename
if isinstance(filename_or_file, (str, unicode)):
filename_or_file = open(filename_or_file, "wb")
xmlstr = self.toxml(indent, newl, encoding)
filename_or_file.write(xmlstr)
filename_or_file.close()
def ManifestFromResFile(filename, names=None, languages=None):
""" Create and return manifest instance from resource in dll/exe file """
res = GetManifestResources(filename, names, languages)
pth = []
if res and res[RT_MANIFEST]:
while isinstance(res, dict) and res.keys():
key = res.keys()[0]
pth.append(str(key))
res = res[key]
if isinstance(res, dict):
raise InvalidManifestError("No matching manifest resource found in '%s'" %
filename)
manifest = Manifest()
manifest.filename = ":".join([filename] + pth)
manifest.parse_string(res, False)
return manifest
def ManifestFromDOM(domtree):
""" Create and return manifest instance from DOM tree """
manifest = Manifest()
manifest.load_dom(domtree)
return manifest
def ManifestFromXML(xmlstr):
""" Create and return manifest instance from XML """
manifest = Manifest()
manifest.parse_string(xmlstr)
return manifest
def ManifestFromXMLFile(filename_or_file):
""" Create and return manifest instance from file """
manifest = Manifest()
manifest.parse(filename_or_file)
return manifest
def GetManifestResources(filename, names=None, languages=None):
""" Get manifest resources from file """
return winresource.GetResources(filename, [RT_MANIFEST], names, languages)
def UpdateManifestResourcesFromXML(dstpath, xmlstr, names=None,
languages=None):