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
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
|
%global _empty_manifest_terminate_build 0
Name: python-maltego-trx
Version: 1.6.0
Release: 1
Summary: Python library used to develop Maltego transforms
License: MIT
URL: https://github.com/paterva/maltego-trx/
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/ab/3f/22472b514c03955f8087d336fea00ccb4ccd9a5f3db981892df484e275ba/maltego-trx-1.6.0.tar.gz
BuildArch: noarch
Requires: python3-flask
Requires: python3-six
Requires: python3-cryptography
Requires: python3-dataclasses
%description
# Maltego TRX Python Library
[](https://github.com/paterva/maltego-trx/actions/workflows/pythonx-boot-check.yaml)
[](https://github.com/paterva/maltego-trx/actions/workflows/pythonx-pytest.yaml)
[](https://github.com/paterva/maltego-trx/actions/workflows/sonatype-jack.yml)
## Release Notes
__1.6.0__: Automatically generate am `.mtz` for your local transforms
__1.5.2__: Add logging output for invalid / missing params in xml serialization
__1.5.1__: Add ignored files to starter and use README for pypi
__1.5.0__: XML Serialization via `ElementTree` instead of string interpolation
__1.4.4__: Added skeletons for csv export in template dir and made project.py application import compatible with docs
__1.4.0 + 1.4.1:__ Both versions are incompatible with python3.7 and lower.
__1.4.2__: Fixed python3.6 incompatibility
## Getting Started
_Note: Support for Python 2 has been officially discontinued as of July 2021. Please use Python 3.6 or higher to use
up-to-date versions of Maltego TRX._
To install the trx library run the following command:
``` bash
pip install maltego-trx
```
After installing, you can create a new project by running the following command:
``` bash
maltego-trx start new_project
```
This will create a folder new_project with the recommended project structure.
If you want to copy the starter files to your current directory, run the following command:
```bash
maltego-trx init
```
Alternatively, you can copy either the `gunicorn` or `apache` example projects from the `demo` directory. These also
include Dockerfile and corresponding docker-compose configuration files for production deployment.
**Adding a Transform:**
Add a new transform by creating a new python file in the "transforms" folder of your directory.
Any file in the folder where the **class name matches the filename**, and the class inherits from Transform, will
automatically be discovered and added to your server.
A simple transform would look like the following:
`new_project/transforms/GreetPerson.py`
``` python
from maltego_trx.entities import Phrase
from maltego_trx.transform import DiscoverableTransform
class GreetPerson(DiscoverableTransform):
"""
Returns a phrase greeting a person on the graph.
"""
@classmethod
def create_entities(cls, request, response):
person_name = request.Value
response.addEntity(Phrase, "Hi %s, nice to meet you!" % person_name)
```
## Running The Transform Server
### For Development
You can start the development server, by running the following command:
``` bash
python project.py runserver
```
This will start up a development server that automatically reloads every time the code is changed.
### For Production
You can run a gunicorn transform server, after installing gunicorn on the host machine and then running the command:
``` bash
gunicorn --bind=0.0.0.0:8080 --threads=25 --workers=2 project:application
```
*For publicly accessible servers, it is recommended to run your Gunicorn server behind proxy servers such as Nginx.*
## Run a Docker Transform server
The `demo` folder provides an example project. The Docker files given can be used to set up and run your project in
Docker.
The Dockerfile and docker-compose file can be used to easily set up and run a development transform server.
If you have copied the `docker-compose.yml`, `Dockerfile` and `prod.yml` files into your project, then you can use the
following commands to run the server in Docker.
Run the following to start the development server:
``` bash
docker-compose up
```
Run the following command to run a production gunicorn server:
``` bash
docker-compose -f prod.yml up --build
```
*For publicly accessible servers, it is recommended to run your Gunicorn server behind proxy servers such as Nginx.*
## Local Transforms
[Documentation](https://docs.maltego.com/support/solutions/articles/15000017605-writing-local-transforms-in-python)
Transforms written using this library can be used as either local or server transforms.
To run a local transform from your project, you will need to pass the following arguments:
``` bash
project.py local <transform_name>
```
You can find the correct transform_name to use by running `python project.py list`.
### Caveats
The following values are not passed to local transforms, and will have dummy values in their place:
- `type`: `local.Unknown`
- `weight`: 100
- `slider`: 100
- `transformSettings`: {}
## Using the Transform Registry
###### Added in 1.4.0 (July 2021)
The Transform Registry enables you to annotate Transforms with metadata like display name, description, input and output
entities as well as settings. The Transform Registry will automatically generate CSV files that you can import into the
pTDS and/or your iTDS.
### Configuring the Registry
You can configure your registry with all the info you would normally add for every transform/seed on a TDS. We recommend
creating your registry in an extra file, traditionally called `extensions.py`, to avoid circular imports.
```python
# extensions.py
from maltego_trx.decorator_registry import TransformRegistry
registry = TransformRegistry(
owner="ACME Corporation",
author="John Doe <johndoe@acme.com>",
host_url="https://transforms.acme.org",
seed_ids=["demo"]
)
# The rest of these attributes are optional
# metadata
registry.version = "0.1"
# transform suffix to indicate datasource
registry.display_name_suffix = " [ACME]"
# reference OAuth settings
registry.oauth_settings_id = ['github-oauth']
```
### Annotating Transforms
```python
# transforms/GreetPerson.py
...
from extensions import registry
@registry.register_transform(
display_name='Greet Person',
input_entity='maltego.Phrase',
description='Returns a phrase greeting a person on the graph.',
output_entities=['maltego.Phrase'],
disclaimer='This disclaimer is optional and has to be accepted before this transform is run'
)
class GreetPerson(DiscoverableTransform):
@classmethod
def create_entities(cls, request, response):
...
```
**Pro Tip:** If the `display_name` is either `None` or `""`, the registry will try to create a display name from the
class name:
- `DNSToIP` 'DNS To IP'
- `GreetPerson` 'Greet Person'
### Transform Settings
You can declare transform settings in a central location and add them to the registry.
#### Configuring Global Settings
These settings will apply to all transforms which can be very helpful for api keys.
```python
# settings.py
from maltego_trx.decorator_registry import TransformSetting
api_key_setting = TransformSetting(name='api_key',
display_name='API Key',
setting_type='string',
global_setting=True)
```
```python
# extensions.py
from settings import api_key_setting
from maltego_trx.decorator_registry import TransformRegistry
registry = TransformRegistry(
owner="ACME Corporation",
author="John Doe <johndoe@acme.com>",
host_url="https://transforms.acme.org",
seed_ids=["demo"]
)
registry.global_settings = [api_key_setting]
```
#### Configuring Settings per Transform
Settings that aren't required for every transform have to be added to the `register_transform` decorator explicitly. To
access the setting on the request, use the `id` property, which will have the global prefix if it's a global setting.
The `name` property won't work on global settings.
```python
# settings.py
...
language_setting = TransformSetting(name='language',
display_name="Language",
setting_type='string',
default_value='en',
optional=True,
popup=True)
```
```python
# transforms/GreetPerson.py
...
from settings import language_setting
from maltego_trx.transform import DiscoverableTransform
@registry.register_transform(display_name="Greet Person",
input_entity="maltego.Phrase",
description='Returns a phrase greeting a person on the graph.',
settings=[language_setting])
class GreetPerson(DiscoverableTransform):
@classmethod
def create_entities(cls, request: MaltegoMsg, response: MaltegoTransform):
language = request.getTransformSetting(language_setting.id)
...
```
### Exporting the TDS Configuration
To export the configurations, use the registry methods `write_transforms_config()` and `write_settings_config()`. These
methods have to executed after they have been registered with the TRX server.
```python
# project.py
import sys
import transforms
from maltego_trx.registry import register_transform_function, register_transform_classes
from maltego_trx.server import application
from maltego_trx.handler import handle_run
# register_transform_function(transform_func)
from extensions import registry
register_transform_classes(transforms)
registry.write_transforms_config()
registry.write_settings_config()
handle_run(__name__, sys.argv, application)
```
### Generating an `.mtz` config with your local Transforms
Since `maltego-trx>=1.6.0` you can generate an `.mtz` config file with your local transforms.
If you're already using the `TransformRegistry`, just invoke the `write_local_config()` method.
```python
# project.py
registry.write_local_mtz()
```
This will create a file called `local.mtz` in the current directory. You can then import this file into Maltego and
start using your local transforms faster. Just remember that settings are not passed to local transforms.
The method takes in the same arguments as the interface in the Maltego client.
If you are using a `virtualenv` environment, you might want to change the `command` argument to use that.
```bash
# project.py
registry.write_local_mtz(
mtz_path: str = "./local.mtz", # path to the local .mtz file
working_dir: str = ".",
command: str = "python3", # for a venv you might want to use `./venv/bin/python3`
params: str = "project.py",
debug: bool = True
)
```
## Legacy Transforms
[Documentation](https://docs.maltego.com/support/solutions/articles/15000018299-porting-old-trx-transforms-to-the-latest-version)
If you have old TRX transforms that are written as functions, they can be registered with the server using
the `maltego_trx.registry.register_transform_function` method.
In order to port your old transforms, make two changes:
1. Import the MaltegoTransform class from the `maltego_trx` package instead of from a local file.
2. Call the `register_transform_function` in order for the transform to be registered in your project.
For example
In the legacy transform file, change:
``` python
from Maltego import *
def old_transform(m):
```
To:
```python
from maltego_trx.maltego import MaltegoTransform
def old_transform(m):
...
```
In the `project.py` file add the following:
```python
from maltego_trx.registry import register_transform_function
from legacy_transform import trx_DNS2IP
register_transform_function(trx_DNS2IP)
```
## CLI
The following commands can be run using the project.py file.
### Run Server
``` bash
python project.py runserver
```
Start a development server that you can use to develop new transforms.
### List
``` bash
python project.py list
```
List the available transforms together with their transform server URLs and local transform names.
## Reference
### Constants
The following constants can be imported from `maltego_trx.maltego`.
**Message Types:**
- `UIM_FATAL`
- `UIM_PARTIAL`
- `UIM_INFORM`
- `UIM_DEBUG`
**Please take note:**
You need to enable the `debug` filter option in the Desktop client Output window to view `debug` transform messages.
**Bookmark Colors:**
- `BOOKMARK_COLOR_NONE`
- `BOOKMARK_COLOR_BLUE`
- `BOOKMARK_COLOR_GREEN`
- `BOOKMARK_COLOR_YELLOW`
- `BOOKMARK_COLOR_PURPLE`
- `BOOKMARK_COLOR_RED`
**Link Styles:**
- `LINK_STYLE_NORMAL`
- `LINK_STYLE_DASHED`
- `LINK_STYLE_DOTTED`
- `LINK_STYLE_DASHDOT`
### Enums
**Overlays:**
Overlays Enums are imported from `maltego_trx.overlays`
*Overlay OverlayPosition:*
- `NORTH = "N"`
- `SOUTH = "S"`
- `WEST = "W"`
- `NORTH_WEST = "NW"`
- `SOUTH_WEST = "SW"`
- `CENTER = "C"`
*Overlay Type*
- `IMAGE = "image"`
- `COLOUR = "colour"`
- `TEXT = "text"`
### Request/MaltegoMsg
The request/maltego msg object given to the transform contains the information about the input entity.
**Attributes:**
- `Value: str`: The display value of the input entity on the graph
- `Weight: int`: The weight of the input entity
- `Slider: int`: Results slider setting in the client
- `Type: str`: The input entity type
- `Properties: dict(str: str)`: A key-value dictionary of the input entity properties
- `TransformSettings: dict(str: str)`: A key-value dictionary of the transform settings
- `Genealogy: list(dict(str: str))`: A key-value dictionary of the Entity genealogy, this is only applicable for
extended entities e.g. Website Entity
**Methods:**
- `getProperty(name: str)`: Get a property value of the input entity
- `getTransformSetting(name: str)`: Get a transform setting value
- `clearLegacyProperties()`: Delete (duplicate) legacy properties from the input entity. This will not result in
property information being lost, it will simply clear out some properties that the TRX library duplicates on all
incoming Transform requests. In older versions of TRX, these Entity properties would have a different internal ID when
sent the server than what the Maltego client would advertise in the Entity Manager UI. For a list of Entities with
such properties and their corresponding legacy and actual IDs, see `entity_property_map` in `maltego_trx/entities.py`.
For the majority of projects this distinction can be safely ignored.
### Response/MaltegoTransform
**Methods:**
- `addEntity(type: str, value: str) -> Entity`: Add an entity to the transform response. Returns an Entity object
created by the method.
- `addUIMessage(message: str, messageType='Inform')`: Return a UI message to the user. For message type, use a message
type constant.
### Entity
**Methods:**
- `setType(type: str)`: Set the entity type (e.g. "Phrase" for maltego.Phrase entity)
- `setValue(value: str)`: Set the entity value
- `setWeight(weight: int)`: Set the entity weight
- `addDisplayInformation(content: str, title: str)`: Add display information for the entity.
- `addProperty(fieldName: str, displayName: str, matchingRule: str, value: str)`: Add a property to the entity. Matching
rule can be `strict` or `loose`.
- `addOverlay(propertyName: str, position: OverlayPosition, overlay_type: OverlayType)`: Add an overlay to the entity.
`OverlayPosition` and `OverlayType` are defined in the `maltego_trx.overlays`
Overlay can be added as Text, Image or Color
```python
person_name = request.Value
entity = response.addEntity(Phrase, "Hi %s, nice to meet you!" % person_name)
# Normally, when we create an overlay, we would reference a property name so that Maltego can then use the
# value of that property to create the overlay. Sometimes that means creating a dynamic property, but usually
# it's better to either use an existing property, or, if you created the Entity yourself, and only need the
# property for the overlay, to use a hidden property. Here's an example of using a dynamic property:
entity.addProperty(
'dynamic_overlay_icon_name',
displayName="Name for overlay image",
value="Champion" # references an icon in the Maltego client
)
entity.addOverlay('dynamic_overlay_icon_name', OverlayPosition.WEST, OverlayType.IMAGE)
# DISCOURAGED:
# You *can* also directly supply the string value of the property, however this is not recommended. Why? If
# the entity already has a property of the same ID (in this case, "DE"), then you would in fact be assigning the
# value of that property, not the string "DE", which is not the intention. Nevertheless, here's an example:
entity.addOverlay(
'DE', # name of an icon, however, could also accidentally be a property name
OverlayPosition.SOUTH_WEST,
OverlayType.IMAGE
)
# Overlays can also be used to display extra text on an entity:
entity.addProperty("exampleDynamicPropertyName", "Example Dynamic Property", "loose", "Maltego Overlay Testing")
entity.addOverlay('exampleDynamicPropertyName', OverlayPosition.NORTH, OverlayType.TEXT)
# Or a small color indicator:
entity.addOverlay('#45e06f', OverlayPosition.NORTH_WEST, OverlayType.COLOUR)
```
- `setIconURL(url: str)`: Set the entity icon URL
- `setBookmark(bookmark: int)`: Set bookmark color index (e.g. -1 for BOOKMARK_COLOR_NONE, 3 for BOOKMARK_COLOR_PURPLE)
- `setNote(note: str)`: Set note content
- `setGenealogy(genealogy: dict)`: Set genealogy
**Link Methods:**
- `setLinkColor(color: str)`: Set the link color (e.g. hex "#0000FF" for blue)
- `setLinkStyle(style: int)`: Set the link style index (e.g. 0 for LINK_STYLE_NORMAL, 2 for LINK_STYLE_DOTTED)
- `setLinkThickness(thick: int)`: Set link thickness (default is 1)
- `setLinkLabel(label: str)`: Set the label of the link
- `reverseLink()`: Reverse the link direction
- `addCustomLinkProperty(fieldName=None, displayName=None, value=None)`: Set a custom property for the link
%package -n python3-maltego-trx
Summary: Python library used to develop Maltego transforms
Provides: python-maltego-trx
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-maltego-trx
# Maltego TRX Python Library
[](https://github.com/paterva/maltego-trx/actions/workflows/pythonx-boot-check.yaml)
[](https://github.com/paterva/maltego-trx/actions/workflows/pythonx-pytest.yaml)
[](https://github.com/paterva/maltego-trx/actions/workflows/sonatype-jack.yml)
## Release Notes
__1.6.0__: Automatically generate am `.mtz` for your local transforms
__1.5.2__: Add logging output for invalid / missing params in xml serialization
__1.5.1__: Add ignored files to starter and use README for pypi
__1.5.0__: XML Serialization via `ElementTree` instead of string interpolation
__1.4.4__: Added skeletons for csv export in template dir and made project.py application import compatible with docs
__1.4.0 + 1.4.1:__ Both versions are incompatible with python3.7 and lower.
__1.4.2__: Fixed python3.6 incompatibility
## Getting Started
_Note: Support for Python 2 has been officially discontinued as of July 2021. Please use Python 3.6 or higher to use
up-to-date versions of Maltego TRX._
To install the trx library run the following command:
``` bash
pip install maltego-trx
```
After installing, you can create a new project by running the following command:
``` bash
maltego-trx start new_project
```
This will create a folder new_project with the recommended project structure.
If you want to copy the starter files to your current directory, run the following command:
```bash
maltego-trx init
```
Alternatively, you can copy either the `gunicorn` or `apache` example projects from the `demo` directory. These also
include Dockerfile and corresponding docker-compose configuration files for production deployment.
**Adding a Transform:**
Add a new transform by creating a new python file in the "transforms" folder of your directory.
Any file in the folder where the **class name matches the filename**, and the class inherits from Transform, will
automatically be discovered and added to your server.
A simple transform would look like the following:
`new_project/transforms/GreetPerson.py`
``` python
from maltego_trx.entities import Phrase
from maltego_trx.transform import DiscoverableTransform
class GreetPerson(DiscoverableTransform):
"""
Returns a phrase greeting a person on the graph.
"""
@classmethod
def create_entities(cls, request, response):
person_name = request.Value
response.addEntity(Phrase, "Hi %s, nice to meet you!" % person_name)
```
## Running The Transform Server
### For Development
You can start the development server, by running the following command:
``` bash
python project.py runserver
```
This will start up a development server that automatically reloads every time the code is changed.
### For Production
You can run a gunicorn transform server, after installing gunicorn on the host machine and then running the command:
``` bash
gunicorn --bind=0.0.0.0:8080 --threads=25 --workers=2 project:application
```
*For publicly accessible servers, it is recommended to run your Gunicorn server behind proxy servers such as Nginx.*
## Run a Docker Transform server
The `demo` folder provides an example project. The Docker files given can be used to set up and run your project in
Docker.
The Dockerfile and docker-compose file can be used to easily set up and run a development transform server.
If you have copied the `docker-compose.yml`, `Dockerfile` and `prod.yml` files into your project, then you can use the
following commands to run the server in Docker.
Run the following to start the development server:
``` bash
docker-compose up
```
Run the following command to run a production gunicorn server:
``` bash
docker-compose -f prod.yml up --build
```
*For publicly accessible servers, it is recommended to run your Gunicorn server behind proxy servers such as Nginx.*
## Local Transforms
[Documentation](https://docs.maltego.com/support/solutions/articles/15000017605-writing-local-transforms-in-python)
Transforms written using this library can be used as either local or server transforms.
To run a local transform from your project, you will need to pass the following arguments:
``` bash
project.py local <transform_name>
```
You can find the correct transform_name to use by running `python project.py list`.
### Caveats
The following values are not passed to local transforms, and will have dummy values in their place:
- `type`: `local.Unknown`
- `weight`: 100
- `slider`: 100
- `transformSettings`: {}
## Using the Transform Registry
###### Added in 1.4.0 (July 2021)
The Transform Registry enables you to annotate Transforms with metadata like display name, description, input and output
entities as well as settings. The Transform Registry will automatically generate CSV files that you can import into the
pTDS and/or your iTDS.
### Configuring the Registry
You can configure your registry with all the info you would normally add for every transform/seed on a TDS. We recommend
creating your registry in an extra file, traditionally called `extensions.py`, to avoid circular imports.
```python
# extensions.py
from maltego_trx.decorator_registry import TransformRegistry
registry = TransformRegistry(
owner="ACME Corporation",
author="John Doe <johndoe@acme.com>",
host_url="https://transforms.acme.org",
seed_ids=["demo"]
)
# The rest of these attributes are optional
# metadata
registry.version = "0.1"
# transform suffix to indicate datasource
registry.display_name_suffix = " [ACME]"
# reference OAuth settings
registry.oauth_settings_id = ['github-oauth']
```
### Annotating Transforms
```python
# transforms/GreetPerson.py
...
from extensions import registry
@registry.register_transform(
display_name='Greet Person',
input_entity='maltego.Phrase',
description='Returns a phrase greeting a person on the graph.',
output_entities=['maltego.Phrase'],
disclaimer='This disclaimer is optional and has to be accepted before this transform is run'
)
class GreetPerson(DiscoverableTransform):
@classmethod
def create_entities(cls, request, response):
...
```
**Pro Tip:** If the `display_name` is either `None` or `""`, the registry will try to create a display name from the
class name:
- `DNSToIP` 'DNS To IP'
- `GreetPerson` 'Greet Person'
### Transform Settings
You can declare transform settings in a central location and add them to the registry.
#### Configuring Global Settings
These settings will apply to all transforms which can be very helpful for api keys.
```python
# settings.py
from maltego_trx.decorator_registry import TransformSetting
api_key_setting = TransformSetting(name='api_key',
display_name='API Key',
setting_type='string',
global_setting=True)
```
```python
# extensions.py
from settings import api_key_setting
from maltego_trx.decorator_registry import TransformRegistry
registry = TransformRegistry(
owner="ACME Corporation",
author="John Doe <johndoe@acme.com>",
host_url="https://transforms.acme.org",
seed_ids=["demo"]
)
registry.global_settings = [api_key_setting]
```
#### Configuring Settings per Transform
Settings that aren't required for every transform have to be added to the `register_transform` decorator explicitly. To
access the setting on the request, use the `id` property, which will have the global prefix if it's a global setting.
The `name` property won't work on global settings.
```python
# settings.py
...
language_setting = TransformSetting(name='language',
display_name="Language",
setting_type='string',
default_value='en',
optional=True,
popup=True)
```
```python
# transforms/GreetPerson.py
...
from settings import language_setting
from maltego_trx.transform import DiscoverableTransform
@registry.register_transform(display_name="Greet Person",
input_entity="maltego.Phrase",
description='Returns a phrase greeting a person on the graph.',
settings=[language_setting])
class GreetPerson(DiscoverableTransform):
@classmethod
def create_entities(cls, request: MaltegoMsg, response: MaltegoTransform):
language = request.getTransformSetting(language_setting.id)
...
```
### Exporting the TDS Configuration
To export the configurations, use the registry methods `write_transforms_config()` and `write_settings_config()`. These
methods have to executed after they have been registered with the TRX server.
```python
# project.py
import sys
import transforms
from maltego_trx.registry import register_transform_function, register_transform_classes
from maltego_trx.server import application
from maltego_trx.handler import handle_run
# register_transform_function(transform_func)
from extensions import registry
register_transform_classes(transforms)
registry.write_transforms_config()
registry.write_settings_config()
handle_run(__name__, sys.argv, application)
```
### Generating an `.mtz` config with your local Transforms
Since `maltego-trx>=1.6.0` you can generate an `.mtz` config file with your local transforms.
If you're already using the `TransformRegistry`, just invoke the `write_local_config()` method.
```python
# project.py
registry.write_local_mtz()
```
This will create a file called `local.mtz` in the current directory. You can then import this file into Maltego and
start using your local transforms faster. Just remember that settings are not passed to local transforms.
The method takes in the same arguments as the interface in the Maltego client.
If you are using a `virtualenv` environment, you might want to change the `command` argument to use that.
```bash
# project.py
registry.write_local_mtz(
mtz_path: str = "./local.mtz", # path to the local .mtz file
working_dir: str = ".",
command: str = "python3", # for a venv you might want to use `./venv/bin/python3`
params: str = "project.py",
debug: bool = True
)
```
## Legacy Transforms
[Documentation](https://docs.maltego.com/support/solutions/articles/15000018299-porting-old-trx-transforms-to-the-latest-version)
If you have old TRX transforms that are written as functions, they can be registered with the server using
the `maltego_trx.registry.register_transform_function` method.
In order to port your old transforms, make two changes:
1. Import the MaltegoTransform class from the `maltego_trx` package instead of from a local file.
2. Call the `register_transform_function` in order for the transform to be registered in your project.
For example
In the legacy transform file, change:
``` python
from Maltego import *
def old_transform(m):
```
To:
```python
from maltego_trx.maltego import MaltegoTransform
def old_transform(m):
...
```
In the `project.py` file add the following:
```python
from maltego_trx.registry import register_transform_function
from legacy_transform import trx_DNS2IP
register_transform_function(trx_DNS2IP)
```
## CLI
The following commands can be run using the project.py file.
### Run Server
``` bash
python project.py runserver
```
Start a development server that you can use to develop new transforms.
### List
``` bash
python project.py list
```
List the available transforms together with their transform server URLs and local transform names.
## Reference
### Constants
The following constants can be imported from `maltego_trx.maltego`.
**Message Types:**
- `UIM_FATAL`
- `UIM_PARTIAL`
- `UIM_INFORM`
- `UIM_DEBUG`
**Please take note:**
You need to enable the `debug` filter option in the Desktop client Output window to view `debug` transform messages.
**Bookmark Colors:**
- `BOOKMARK_COLOR_NONE`
- `BOOKMARK_COLOR_BLUE`
- `BOOKMARK_COLOR_GREEN`
- `BOOKMARK_COLOR_YELLOW`
- `BOOKMARK_COLOR_PURPLE`
- `BOOKMARK_COLOR_RED`
**Link Styles:**
- `LINK_STYLE_NORMAL`
- `LINK_STYLE_DASHED`
- `LINK_STYLE_DOTTED`
- `LINK_STYLE_DASHDOT`
### Enums
**Overlays:**
Overlays Enums are imported from `maltego_trx.overlays`
*Overlay OverlayPosition:*
- `NORTH = "N"`
- `SOUTH = "S"`
- `WEST = "W"`
- `NORTH_WEST = "NW"`
- `SOUTH_WEST = "SW"`
- `CENTER = "C"`
*Overlay Type*
- `IMAGE = "image"`
- `COLOUR = "colour"`
- `TEXT = "text"`
### Request/MaltegoMsg
The request/maltego msg object given to the transform contains the information about the input entity.
**Attributes:**
- `Value: str`: The display value of the input entity on the graph
- `Weight: int`: The weight of the input entity
- `Slider: int`: Results slider setting in the client
- `Type: str`: The input entity type
- `Properties: dict(str: str)`: A key-value dictionary of the input entity properties
- `TransformSettings: dict(str: str)`: A key-value dictionary of the transform settings
- `Genealogy: list(dict(str: str))`: A key-value dictionary of the Entity genealogy, this is only applicable for
extended entities e.g. Website Entity
**Methods:**
- `getProperty(name: str)`: Get a property value of the input entity
- `getTransformSetting(name: str)`: Get a transform setting value
- `clearLegacyProperties()`: Delete (duplicate) legacy properties from the input entity. This will not result in
property information being lost, it will simply clear out some properties that the TRX library duplicates on all
incoming Transform requests. In older versions of TRX, these Entity properties would have a different internal ID when
sent the server than what the Maltego client would advertise in the Entity Manager UI. For a list of Entities with
such properties and their corresponding legacy and actual IDs, see `entity_property_map` in `maltego_trx/entities.py`.
For the majority of projects this distinction can be safely ignored.
### Response/MaltegoTransform
**Methods:**
- `addEntity(type: str, value: str) -> Entity`: Add an entity to the transform response. Returns an Entity object
created by the method.
- `addUIMessage(message: str, messageType='Inform')`: Return a UI message to the user. For message type, use a message
type constant.
### Entity
**Methods:**
- `setType(type: str)`: Set the entity type (e.g. "Phrase" for maltego.Phrase entity)
- `setValue(value: str)`: Set the entity value
- `setWeight(weight: int)`: Set the entity weight
- `addDisplayInformation(content: str, title: str)`: Add display information for the entity.
- `addProperty(fieldName: str, displayName: str, matchingRule: str, value: str)`: Add a property to the entity. Matching
rule can be `strict` or `loose`.
- `addOverlay(propertyName: str, position: OverlayPosition, overlay_type: OverlayType)`: Add an overlay to the entity.
`OverlayPosition` and `OverlayType` are defined in the `maltego_trx.overlays`
Overlay can be added as Text, Image or Color
```python
person_name = request.Value
entity = response.addEntity(Phrase, "Hi %s, nice to meet you!" % person_name)
# Normally, when we create an overlay, we would reference a property name so that Maltego can then use the
# value of that property to create the overlay. Sometimes that means creating a dynamic property, but usually
# it's better to either use an existing property, or, if you created the Entity yourself, and only need the
# property for the overlay, to use a hidden property. Here's an example of using a dynamic property:
entity.addProperty(
'dynamic_overlay_icon_name',
displayName="Name for overlay image",
value="Champion" # references an icon in the Maltego client
)
entity.addOverlay('dynamic_overlay_icon_name', OverlayPosition.WEST, OverlayType.IMAGE)
# DISCOURAGED:
# You *can* also directly supply the string value of the property, however this is not recommended. Why? If
# the entity already has a property of the same ID (in this case, "DE"), then you would in fact be assigning the
# value of that property, not the string "DE", which is not the intention. Nevertheless, here's an example:
entity.addOverlay(
'DE', # name of an icon, however, could also accidentally be a property name
OverlayPosition.SOUTH_WEST,
OverlayType.IMAGE
)
# Overlays can also be used to display extra text on an entity:
entity.addProperty("exampleDynamicPropertyName", "Example Dynamic Property", "loose", "Maltego Overlay Testing")
entity.addOverlay('exampleDynamicPropertyName', OverlayPosition.NORTH, OverlayType.TEXT)
# Or a small color indicator:
entity.addOverlay('#45e06f', OverlayPosition.NORTH_WEST, OverlayType.COLOUR)
```
- `setIconURL(url: str)`: Set the entity icon URL
- `setBookmark(bookmark: int)`: Set bookmark color index (e.g. -1 for BOOKMARK_COLOR_NONE, 3 for BOOKMARK_COLOR_PURPLE)
- `setNote(note: str)`: Set note content
- `setGenealogy(genealogy: dict)`: Set genealogy
**Link Methods:**
- `setLinkColor(color: str)`: Set the link color (e.g. hex "#0000FF" for blue)
- `setLinkStyle(style: int)`: Set the link style index (e.g. 0 for LINK_STYLE_NORMAL, 2 for LINK_STYLE_DOTTED)
- `setLinkThickness(thick: int)`: Set link thickness (default is 1)
- `setLinkLabel(label: str)`: Set the label of the link
- `reverseLink()`: Reverse the link direction
- `addCustomLinkProperty(fieldName=None, displayName=None, value=None)`: Set a custom property for the link
%package help
Summary: Development documents and examples for maltego-trx
Provides: python3-maltego-trx-doc
%description help
# Maltego TRX Python Library
[](https://github.com/paterva/maltego-trx/actions/workflows/pythonx-boot-check.yaml)
[](https://github.com/paterva/maltego-trx/actions/workflows/pythonx-pytest.yaml)
[](https://github.com/paterva/maltego-trx/actions/workflows/sonatype-jack.yml)
## Release Notes
__1.6.0__: Automatically generate am `.mtz` for your local transforms
__1.5.2__: Add logging output for invalid / missing params in xml serialization
__1.5.1__: Add ignored files to starter and use README for pypi
__1.5.0__: XML Serialization via `ElementTree` instead of string interpolation
__1.4.4__: Added skeletons for csv export in template dir and made project.py application import compatible with docs
__1.4.0 + 1.4.1:__ Both versions are incompatible with python3.7 and lower.
__1.4.2__: Fixed python3.6 incompatibility
## Getting Started
_Note: Support for Python 2 has been officially discontinued as of July 2021. Please use Python 3.6 or higher to use
up-to-date versions of Maltego TRX._
To install the trx library run the following command:
``` bash
pip install maltego-trx
```
After installing, you can create a new project by running the following command:
``` bash
maltego-trx start new_project
```
This will create a folder new_project with the recommended project structure.
If you want to copy the starter files to your current directory, run the following command:
```bash
maltego-trx init
```
Alternatively, you can copy either the `gunicorn` or `apache` example projects from the `demo` directory. These also
include Dockerfile and corresponding docker-compose configuration files for production deployment.
**Adding a Transform:**
Add a new transform by creating a new python file in the "transforms" folder of your directory.
Any file in the folder where the **class name matches the filename**, and the class inherits from Transform, will
automatically be discovered and added to your server.
A simple transform would look like the following:
`new_project/transforms/GreetPerson.py`
``` python
from maltego_trx.entities import Phrase
from maltego_trx.transform import DiscoverableTransform
class GreetPerson(DiscoverableTransform):
"""
Returns a phrase greeting a person on the graph.
"""
@classmethod
def create_entities(cls, request, response):
person_name = request.Value
response.addEntity(Phrase, "Hi %s, nice to meet you!" % person_name)
```
## Running The Transform Server
### For Development
You can start the development server, by running the following command:
``` bash
python project.py runserver
```
This will start up a development server that automatically reloads every time the code is changed.
### For Production
You can run a gunicorn transform server, after installing gunicorn on the host machine and then running the command:
``` bash
gunicorn --bind=0.0.0.0:8080 --threads=25 --workers=2 project:application
```
*For publicly accessible servers, it is recommended to run your Gunicorn server behind proxy servers such as Nginx.*
## Run a Docker Transform server
The `demo` folder provides an example project. The Docker files given can be used to set up and run your project in
Docker.
The Dockerfile and docker-compose file can be used to easily set up and run a development transform server.
If you have copied the `docker-compose.yml`, `Dockerfile` and `prod.yml` files into your project, then you can use the
following commands to run the server in Docker.
Run the following to start the development server:
``` bash
docker-compose up
```
Run the following command to run a production gunicorn server:
``` bash
docker-compose -f prod.yml up --build
```
*For publicly accessible servers, it is recommended to run your Gunicorn server behind proxy servers such as Nginx.*
## Local Transforms
[Documentation](https://docs.maltego.com/support/solutions/articles/15000017605-writing-local-transforms-in-python)
Transforms written using this library can be used as either local or server transforms.
To run a local transform from your project, you will need to pass the following arguments:
``` bash
project.py local <transform_name>
```
You can find the correct transform_name to use by running `python project.py list`.
### Caveats
The following values are not passed to local transforms, and will have dummy values in their place:
- `type`: `local.Unknown`
- `weight`: 100
- `slider`: 100
- `transformSettings`: {}
## Using the Transform Registry
###### Added in 1.4.0 (July 2021)
The Transform Registry enables you to annotate Transforms with metadata like display name, description, input and output
entities as well as settings. The Transform Registry will automatically generate CSV files that you can import into the
pTDS and/or your iTDS.
### Configuring the Registry
You can configure your registry with all the info you would normally add for every transform/seed on a TDS. We recommend
creating your registry in an extra file, traditionally called `extensions.py`, to avoid circular imports.
```python
# extensions.py
from maltego_trx.decorator_registry import TransformRegistry
registry = TransformRegistry(
owner="ACME Corporation",
author="John Doe <johndoe@acme.com>",
host_url="https://transforms.acme.org",
seed_ids=["demo"]
)
# The rest of these attributes are optional
# metadata
registry.version = "0.1"
# transform suffix to indicate datasource
registry.display_name_suffix = " [ACME]"
# reference OAuth settings
registry.oauth_settings_id = ['github-oauth']
```
### Annotating Transforms
```python
# transforms/GreetPerson.py
...
from extensions import registry
@registry.register_transform(
display_name='Greet Person',
input_entity='maltego.Phrase',
description='Returns a phrase greeting a person on the graph.',
output_entities=['maltego.Phrase'],
disclaimer='This disclaimer is optional and has to be accepted before this transform is run'
)
class GreetPerson(DiscoverableTransform):
@classmethod
def create_entities(cls, request, response):
...
```
**Pro Tip:** If the `display_name` is either `None` or `""`, the registry will try to create a display name from the
class name:
- `DNSToIP` 'DNS To IP'
- `GreetPerson` 'Greet Person'
### Transform Settings
You can declare transform settings in a central location and add them to the registry.
#### Configuring Global Settings
These settings will apply to all transforms which can be very helpful for api keys.
```python
# settings.py
from maltego_trx.decorator_registry import TransformSetting
api_key_setting = TransformSetting(name='api_key',
display_name='API Key',
setting_type='string',
global_setting=True)
```
```python
# extensions.py
from settings import api_key_setting
from maltego_trx.decorator_registry import TransformRegistry
registry = TransformRegistry(
owner="ACME Corporation",
author="John Doe <johndoe@acme.com>",
host_url="https://transforms.acme.org",
seed_ids=["demo"]
)
registry.global_settings = [api_key_setting]
```
#### Configuring Settings per Transform
Settings that aren't required for every transform have to be added to the `register_transform` decorator explicitly. To
access the setting on the request, use the `id` property, which will have the global prefix if it's a global setting.
The `name` property won't work on global settings.
```python
# settings.py
...
language_setting = TransformSetting(name='language',
display_name="Language",
setting_type='string',
default_value='en',
optional=True,
popup=True)
```
```python
# transforms/GreetPerson.py
...
from settings import language_setting
from maltego_trx.transform import DiscoverableTransform
@registry.register_transform(display_name="Greet Person",
input_entity="maltego.Phrase",
description='Returns a phrase greeting a person on the graph.',
settings=[language_setting])
class GreetPerson(DiscoverableTransform):
@classmethod
def create_entities(cls, request: MaltegoMsg, response: MaltegoTransform):
language = request.getTransformSetting(language_setting.id)
...
```
### Exporting the TDS Configuration
To export the configurations, use the registry methods `write_transforms_config()` and `write_settings_config()`. These
methods have to executed after they have been registered with the TRX server.
```python
# project.py
import sys
import transforms
from maltego_trx.registry import register_transform_function, register_transform_classes
from maltego_trx.server import application
from maltego_trx.handler import handle_run
# register_transform_function(transform_func)
from extensions import registry
register_transform_classes(transforms)
registry.write_transforms_config()
registry.write_settings_config()
handle_run(__name__, sys.argv, application)
```
### Generating an `.mtz` config with your local Transforms
Since `maltego-trx>=1.6.0` you can generate an `.mtz` config file with your local transforms.
If you're already using the `TransformRegistry`, just invoke the `write_local_config()` method.
```python
# project.py
registry.write_local_mtz()
```
This will create a file called `local.mtz` in the current directory. You can then import this file into Maltego and
start using your local transforms faster. Just remember that settings are not passed to local transforms.
The method takes in the same arguments as the interface in the Maltego client.
If you are using a `virtualenv` environment, you might want to change the `command` argument to use that.
```bash
# project.py
registry.write_local_mtz(
mtz_path: str = "./local.mtz", # path to the local .mtz file
working_dir: str = ".",
command: str = "python3", # for a venv you might want to use `./venv/bin/python3`
params: str = "project.py",
debug: bool = True
)
```
## Legacy Transforms
[Documentation](https://docs.maltego.com/support/solutions/articles/15000018299-porting-old-trx-transforms-to-the-latest-version)
If you have old TRX transforms that are written as functions, they can be registered with the server using
the `maltego_trx.registry.register_transform_function` method.
In order to port your old transforms, make two changes:
1. Import the MaltegoTransform class from the `maltego_trx` package instead of from a local file.
2. Call the `register_transform_function` in order for the transform to be registered in your project.
For example
In the legacy transform file, change:
``` python
from Maltego import *
def old_transform(m):
```
To:
```python
from maltego_trx.maltego import MaltegoTransform
def old_transform(m):
...
```
In the `project.py` file add the following:
```python
from maltego_trx.registry import register_transform_function
from legacy_transform import trx_DNS2IP
register_transform_function(trx_DNS2IP)
```
## CLI
The following commands can be run using the project.py file.
### Run Server
``` bash
python project.py runserver
```
Start a development server that you can use to develop new transforms.
### List
``` bash
python project.py list
```
List the available transforms together with their transform server URLs and local transform names.
## Reference
### Constants
The following constants can be imported from `maltego_trx.maltego`.
**Message Types:**
- `UIM_FATAL`
- `UIM_PARTIAL`
- `UIM_INFORM`
- `UIM_DEBUG`
**Please take note:**
You need to enable the `debug` filter option in the Desktop client Output window to view `debug` transform messages.
**Bookmark Colors:**
- `BOOKMARK_COLOR_NONE`
- `BOOKMARK_COLOR_BLUE`
- `BOOKMARK_COLOR_GREEN`
- `BOOKMARK_COLOR_YELLOW`
- `BOOKMARK_COLOR_PURPLE`
- `BOOKMARK_COLOR_RED`
**Link Styles:**
- `LINK_STYLE_NORMAL`
- `LINK_STYLE_DASHED`
- `LINK_STYLE_DOTTED`
- `LINK_STYLE_DASHDOT`
### Enums
**Overlays:**
Overlays Enums are imported from `maltego_trx.overlays`
*Overlay OverlayPosition:*
- `NORTH = "N"`
- `SOUTH = "S"`
- `WEST = "W"`
- `NORTH_WEST = "NW"`
- `SOUTH_WEST = "SW"`
- `CENTER = "C"`
*Overlay Type*
- `IMAGE = "image"`
- `COLOUR = "colour"`
- `TEXT = "text"`
### Request/MaltegoMsg
The request/maltego msg object given to the transform contains the information about the input entity.
**Attributes:**
- `Value: str`: The display value of the input entity on the graph
- `Weight: int`: The weight of the input entity
- `Slider: int`: Results slider setting in the client
- `Type: str`: The input entity type
- `Properties: dict(str: str)`: A key-value dictionary of the input entity properties
- `TransformSettings: dict(str: str)`: A key-value dictionary of the transform settings
- `Genealogy: list(dict(str: str))`: A key-value dictionary of the Entity genealogy, this is only applicable for
extended entities e.g. Website Entity
**Methods:**
- `getProperty(name: str)`: Get a property value of the input entity
- `getTransformSetting(name: str)`: Get a transform setting value
- `clearLegacyProperties()`: Delete (duplicate) legacy properties from the input entity. This will not result in
property information being lost, it will simply clear out some properties that the TRX library duplicates on all
incoming Transform requests. In older versions of TRX, these Entity properties would have a different internal ID when
sent the server than what the Maltego client would advertise in the Entity Manager UI. For a list of Entities with
such properties and their corresponding legacy and actual IDs, see `entity_property_map` in `maltego_trx/entities.py`.
For the majority of projects this distinction can be safely ignored.
### Response/MaltegoTransform
**Methods:**
- `addEntity(type: str, value: str) -> Entity`: Add an entity to the transform response. Returns an Entity object
created by the method.
- `addUIMessage(message: str, messageType='Inform')`: Return a UI message to the user. For message type, use a message
type constant.
### Entity
**Methods:**
- `setType(type: str)`: Set the entity type (e.g. "Phrase" for maltego.Phrase entity)
- `setValue(value: str)`: Set the entity value
- `setWeight(weight: int)`: Set the entity weight
- `addDisplayInformation(content: str, title: str)`: Add display information for the entity.
- `addProperty(fieldName: str, displayName: str, matchingRule: str, value: str)`: Add a property to the entity. Matching
rule can be `strict` or `loose`.
- `addOverlay(propertyName: str, position: OverlayPosition, overlay_type: OverlayType)`: Add an overlay to the entity.
`OverlayPosition` and `OverlayType` are defined in the `maltego_trx.overlays`
Overlay can be added as Text, Image or Color
```python
person_name = request.Value
entity = response.addEntity(Phrase, "Hi %s, nice to meet you!" % person_name)
# Normally, when we create an overlay, we would reference a property name so that Maltego can then use the
# value of that property to create the overlay. Sometimes that means creating a dynamic property, but usually
# it's better to either use an existing property, or, if you created the Entity yourself, and only need the
# property for the overlay, to use a hidden property. Here's an example of using a dynamic property:
entity.addProperty(
'dynamic_overlay_icon_name',
displayName="Name for overlay image",
value="Champion" # references an icon in the Maltego client
)
entity.addOverlay('dynamic_overlay_icon_name', OverlayPosition.WEST, OverlayType.IMAGE)
# DISCOURAGED:
# You *can* also directly supply the string value of the property, however this is not recommended. Why? If
# the entity already has a property of the same ID (in this case, "DE"), then you would in fact be assigning the
# value of that property, not the string "DE", which is not the intention. Nevertheless, here's an example:
entity.addOverlay(
'DE', # name of an icon, however, could also accidentally be a property name
OverlayPosition.SOUTH_WEST,
OverlayType.IMAGE
)
# Overlays can also be used to display extra text on an entity:
entity.addProperty("exampleDynamicPropertyName", "Example Dynamic Property", "loose", "Maltego Overlay Testing")
entity.addOverlay('exampleDynamicPropertyName', OverlayPosition.NORTH, OverlayType.TEXT)
# Or a small color indicator:
entity.addOverlay('#45e06f', OverlayPosition.NORTH_WEST, OverlayType.COLOUR)
```
- `setIconURL(url: str)`: Set the entity icon URL
- `setBookmark(bookmark: int)`: Set bookmark color index (e.g. -1 for BOOKMARK_COLOR_NONE, 3 for BOOKMARK_COLOR_PURPLE)
- `setNote(note: str)`: Set note content
- `setGenealogy(genealogy: dict)`: Set genealogy
**Link Methods:**
- `setLinkColor(color: str)`: Set the link color (e.g. hex "#0000FF" for blue)
- `setLinkStyle(style: int)`: Set the link style index (e.g. 0 for LINK_STYLE_NORMAL, 2 for LINK_STYLE_DOTTED)
- `setLinkThickness(thick: int)`: Set link thickness (default is 1)
- `setLinkLabel(label: str)`: Set the label of the link
- `reverseLink()`: Reverse the link direction
- `addCustomLinkProperty(fieldName=None, displayName=None, value=None)`: Set a custom property for the link
%prep
%autosetup -n maltego-trx-1.6.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-maltego-trx -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Sun Apr 23 2023 Python_Bot <Python_Bot@openeuler.org> - 1.6.0-1
- Package Spec generated
|