redevelopment from scratch using canari3

.canari

@@ -0,0 +1,6 @@
+[metadata]
+
+author = Christophe Vandeplas
+project = MISP_maltego
+maintainer = Christophe Vandeplas
+email = christophe@vandeplas.com

.gitignore

@@ -0,0 +1,11 @@
+*.py[co]
+*.*~
+*.py~
+# Packages
+*.egg
+*.egg-info
+*.*.swp
+
+# Locally genenerated mtz
+/*.mtz
+

.mrbob.ini

@@ -0,0 +1,11 @@
+[variables]
+project.description = Maltego transform for interacting with a MISP Threat Sharing community.
+project.create_example = True
+canari.major_version = 3
+project.name = MISP_maltego
+canari.version = 3.3.9
+created.year = 2018
+author.email = christophe@vandeplas.com
+author.name = Christophe Vandeplas
+entity.base_name = Misp_maltegoEntity
+

LICENSE

@@ -1,21 +1,661 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 ebouillon
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<http://www.gnu.org/licenses/>.

MANIFEST.in

@@ -0,0 +1,3 @@
+include *.md
+recursive-include src *.py *.conf *.gif *.png *.mtz *.machine
+recursive-include maltego *.mtz

MaltegoTransform.py

@@ -1,174 +0,0 @@
-#!/usr/bin/python 
-#######################################################
-# Maltego Python Local Transform Helper               #
-#   Version 0.2				              #
-#                                                     #
-# Local transform specification can be found at:      #
-#    http://ctas.paterva.com/view/Specification	      #
-#                                                     #
-# For more help and other local transforms            #
-# try the forum or mail me:                           #
-#                                                     #
-#   http://www.paterva.com/forum                      #
-#                                                     #
-#  Andrew MacPherson [ andrew <<at>> Paterva.com ]    #
-#                                                     #
-#######################################################
-import sys
-
-def u2a_ascii(text):
-    # takes care of "'ascii' codec can't encode character" errors
-    return text.encode('unicode-escape')
-
-class MaltegoEntity(object):
-	value = "";
-	weight = 100;
-	displayInformation = None;
-	additionalFields = [];
-	iconURL = "";
-	entityType = "Phrase"
-	
-	def __init__(self,eT=None,v=None):
-		if (eT is not None):
-			self.entityType = eT;
-		if (v is not None):
-			self.value = sanitise(v);
-		self.additionalFields = [];
-		self.displayInformation = None;
-		
-	def setType(self,eT=None):
-		if (eT is not None):
-			self.entityType = eT;
-	
-	def setValue(self,eV=None):
-		if (eV is not None):
-			self.value = sanitise(eV);
-		
-	def setWeight(self,w=None):
-		if (w is not None):
-			self.weight = w;
-	
-	def setDisplayInformation(self,di=None):
-		if (di is not None):
-			self.displayInformation = di;		
-			
-	def addAdditionalFields(self,fieldName=None,displayName=None,matchingRule=False,value=None):
-		self.additionalFields.append([sanitise(fieldName),sanitise(displayName),matchingRule,sanitise(value)]);
-	
-	def setIconURL(self,iU=None):
-		if (iU is not None):
-			self.iconURL = iU;
-			
-	def returnEntity(self):
-		print "<Entity Type=\"" + str(self.entityType) + "\">";
-		print "<Value>" + str(self.value) + "</Value>";
-		print "<Weight>" + str(self.weight) + "</Weight>";
-		if (self.displayInformation is not None):
-			print "<DisplayInformation><Label Name=\"\" Type=\"text/html\"><![CDATA[" + str(self.displayInformation) + "]]></Label></DisplayInformation>";
-		if (len(self.additionalFields) > 0):
-			print "<AdditionalFields>";
-			for i in range(len(self.additionalFields)):
-				if (str(self.additionalFields[i][2]) <> "strict"):
-					print "<Field Name=\"" + str(u2a_ascii(self.additionalFields[i][0])) + "\" DisplayName=\"" + str(u2a_ascii(self.additionalFields[i][1])) + "\">" + str(u2a_ascii(self.additionalFields[i][3])) + "</Field>";
-				else:
-					print "<Field MatchingRule=\"" + str(u2a_ascii(self.additionalFields[i][2])) + "\" Name=\"" + str(u2a_ascii(self.additionalFields[i][0])) + "\" DisplayName=\"" + str(u2a_ascii(self.additionalFields[i][1])) + "\">" + str(u2a_ascii(self.additionalFields[i][3])) + "</Field>";
-			print "</AdditionalFields>";
-		if (len(self.iconURL) > 0):
-			print "<IconURL>" + self.iconURL + "</IconURL>";
-		print "</Entity>";
-	
-class MaltegoTransform(object):
-	entities = []
-	exceptions = []
-	UIMessages = []
-	values = {};
-	
-	def __init__(self):
-		values = {};
-		value = None;
-	
-	def parseArguments(self,argv):
-		if (argv[1] is not None):
-			self.value = argv[1];
-			
-		if (len(argv) > 2):
-			if (argv[2] is not None):
-				vars = argv[2].split('#');
-				for x in range(0,len(vars)):
-					vars_values = vars[x].split('=')
-					if (len(vars_values) == 2):
-						self.values[vars_values[0]] = vars_values[1];
-	
-	def getValue(self):
-		if (self.value is not None):
-			return self.value;
-	
-	def getVar(self,varName):
-		if (varName in self.values.keys()):
-			if (self.values[varName] is not None):
-				return self.values[varName];
-	
-	def addEntity(self,enType,enValue):
-		me = MaltegoEntity(enType,enValue);
-		self.addEntityToMessage(me);
-		return self.entities[len(self.entities)-1];
-	
-	def addEntityToMessage(self,maltegoEntity):
-		self.entities.append(maltegoEntity);
-		
-	def addUIMessage(self,message,messageType="Inform"):
-		self.UIMessages.append([messageType,message]);
-	
-	def addException(self,exceptionString):
-		self.exceptions.append(exceptionString);
-		
-	def throwExceptions(self):
-		print "<MaltegoMessage>";
-		print "<MaltegoTransformExceptionMessage>";
-		print "<Exceptions>"
-		
-		for i in range(len(self.exceptions)):
-			print "<Exception>" + self.exceptions[i] + "</Exception>";
-		print "</Exceptions>"	
-		print "</MaltegoTransformExceptionMessage>";
-		print "</MaltegoMessage>";
-		exit();
-		
-	def returnOutput(self):
-		print "<MaltegoMessage>";
-		print "<MaltegoTransformResponseMessage>";
-						
-		print "<Entities>"
-		for i in range(len(self.entities)):
-			self.entities[i].returnEntity();
-		print "</Entities>"
-						
-		print "<UIMessages>"
-		for i in range(len(self.UIMessages)):
-			print "<UIMessage MessageType=\"" + self.UIMessages[i][0] + "\">" + self.UIMessages[i][1] + "</UIMessage>";
-		print "</UIMessages>"
-			
-		print "</MaltegoTransformResponseMessage>";
-		print "</MaltegoMessage>";
-		
-	def writeSTDERR(self,msg):
-		sys.stderr.write(str(msg));
-	
-	def heartbeat(self):
-		self.writeSTDERR("+");
-	
-	def progress(self,percent):
-		self.writeSTDERR("%" + str(percent));
-	
-	def debug(self,msg):
-		self.writeSTDERR("D:" + str(msg));
-			
-
-
-def sanitise(value):
-	replace_these = ["&",">","<"];
-	replace_with = ["&amp;","&gt;","&lt;"];
-	tempvalue = value;
-	for i in range(0,len(replace_these)):
-		tempvalue = tempvalue.replace(replace_these[i],replace_with[i]);
-	return tempvalue;

README.md

@@ -1,30 +1,94 @@
-# MISP-Maltego
-Set of Maltego transforms to inferface with a MISP instance
+# Quick start guide
+This is a Maltego MISP integration tool allowing you to view (read-only) data from a MISP instance. 
+Currently supported: Event, Attribute, Object, Tag, Taxonomy, Galaxy and relations.
 
-# Prerequisites
-- MISP instance API access
-- PyMISP
+Dependencies:
+* [PyMISP](https://github.com/MISP/PyMISP)
+* [Canari3](https://github.com/redcanari/canari3)
 
-# INSTALL
+## Installation:
+```
+git clone http://github.com/MISP/MISP-maltego
+cd MISP-maltego
+cp  src/MISP_maltego/resources/etc/MISP_maltego.conf MISP_maltego.conf
+python3 setup.py install --user && canari create-profile MISP_maltego
+```
+Import the profile/transforms `MISP_maltego.mtz` in Maltego.  (Import|Export > Import Config)
+
+Edit `$HOME/.canari/MISP_maltego.conf` and enter your `misp_url` and `misp_key`
+```
+[MISP_maltego.local]
+misp_url = https://a.b.c.d
+misp_key = verysecretkey
+misp_verify = True
+misp_debug = False
+``` 
+
+## Usage
+Once installed you will have custom Maltego entities in the MISP group.
+You can start by creating a `MISPEvent`, then load the transform `EventToAttributes`.
+Or by just loading a transform on an existing Maltego entity.
+The currently supported entities are: `AS`, `DNSName`, `Domain`, `EmailAddress`, `File`, `Hash`, `IPv4Address`, `NSRecord`, `Person`, `PhoneNumber`, `URL`, `Website`
+
+![Screenshot](https://github.com/MISP/MISP-maltego/doc/screenshot.png)
+
+## License
+This software is licensed under [GNU Affero General Public License version 3](http://www.gnu.org/licenses/agpl-3.0.html)
+
+* Copyright (C) 2018 Christophe Vandeplas
 
-- Edit `misp_util.py` and set BASE_URL and API_KEY variables with your MISP base URL and MISP API key.
+Note: Before being rewritten from scratch this project was maintained by Emmanuel Bouillon. The code is available in the `v1` branch.
 
-- Create symbolic links to `misp_domain2event.py` and `misp_event2domain.py` in the same directory.
+
+<hr />
+The Canari welcome message:
+# README - MISP_maltego
+
+Welcome to Canari. You might be wondering what all these files are about. Before you can use the power of
+`canari create-profile` you needed to create a transform package and that's exactly what you did here! I've given you a
+directory structure to use in the following manner:
+
+* `src/MISP_maltego` directory is where all your stuff goes in terms of auxiliary modules that you may need for 
+  your modules
+* `src/MISP_maltego/transforms` directory is where all your transform modules should be placed. An example
+  `helloworld` transform is there for your viewing pleasure.
+* `src/MISP_maltego/transforms/common` directory is where you can put some common code for your transforms like
+  result parsing, entities, etc.
+* `src/MISP_maltego/transforms/common/entities.py` is where you define your custom entities. Take a look at the
+  examples provided if you want to play around with custom entities.
+* `maltego/` is where you can store your Maltego entity exports.
+* `src/MISP_maltego/resources/maltego` directory is where your `entities.mtz` and `*.machine` files can be
+  stored for auto install and uninstall.
+* `src/MISP_maltego/resources/external` directory is where you can place non-Python transforms written in other
+  languages.
+
+If you're going to add a new transform in the transforms directory, remember to update the `__all__` variable in
+`src/MISP_maltego/transforms/__init__.py`. Otherwise, `canari install-package` won't attempt to install the
+transform. Alternatively, `canari create-transform <transform name>` can be used within the
+`src/MISP_maltego/transforms` directory to generate a transform module and have it automatically added to the
+`__init__.py` file, like so:
+
+```bash
+$ canari create-transform foo
 ```
-for i in misp_email2event.py misp_email-subject2event.py misp_ip2event.py misp_hash2event.py ; do ln -s misp_domain2event.py $i; done
-for i in misp_event2email.py misp_event2email-subject.py misp_event2hash.py misp_event2ip.py ; do ln -s misp_event2domain.py $i; done
+
+To test your transform, simply `cd` into the src directory and run `canari debug-transform`, like so:
+
+```bash
+$ canari debug-transform MISP_maltego.transforms.helloworld.HelloWorld Phil
+%50
+D:This was pointless!
+%100
+`- MaltegoTransformResponseMessage:
+  `- Entities:
+    `- Entity:  {'Type': 'test.MyTestEntity'}
+      `- Value: Hello Phil!
+      `- Weight: 1
+      `- AdditionalFields:
+        `- Field: 2 {'DisplayName': 'Field 1', 'Name': 'test.field1', 'MatchingRule': 'strict'}
+        `- Field: test {'DisplayName': 'Field N', 'Name': 'test.fieldN', 'MatchingRule': 'strict'}
 ```
 
-- Import transforms in Maltego as follow (for instance):
-
-  * `misp_ip2event.py`: [MISP] IP to Event / Returns MISPEvent entities containing the corresponding IP attribute
-  * `misp_domain2event.py`: [MISP] Domain to Event / Returns MISPEvent entities containing the corresponding Domain attribute
-  * `misp_hash2event.py`: [MISP] Hash to Event / Returns MISPEvent entities containing the corresponding Hash attribute
-  * `misp_email2event.py`: [MISP] Email address to Event / Returns MISPEvent entities containing the corresponding Email address attribute
-  * `misp_email-subject2event.py`: [MISP] Email subject to Event / Returns MISPEvent entities containing the corresponding Email subject attribute
-  * `misp_event2ip.py`: [MISP] Event to IP attribute / Returns the IP attributes belonging to an event
-  * `misp_event2domain.py`: [MISP] Event to Domain attribute / Returns Domain attributes belonging to an event
-  * `misp_event2hash.py`: [MISP] Event to Hash attribute / Returns Hash attributes belonging to an event
-  * `misp_event2email.py`: [MISP] Event to Email address attribute / Returns Email address attributes belonging to an event
-  * `misp_event2email-subject.py`: [MISP] Event to Email subject attribute / Returns Email subject attributes belonging to an event
-  * `misp_getEventInfo.py`: [MISP] Get Event Info / Adorns the Event with Info as notes
+Cool right? If you have any further questions don't hesitate to drop us a line;)
+
+Have fun!

build/lib/MISP_maltego/__init__.py

@@ -0,0 +1,9 @@
+__license__ = 'AGPLv3'
+__version__ = '0.1'
+__author__ = 'Christophe Vandeplas'
+__email__ = 'christophe@vandeplas.com'
+
+__all__ = [
+    'transforms',
+    'resources'
+]

build/lib/MISP_maltego/resources/__init__.py

@@ -0,0 +1,4 @@
+__all__ = [
+    'etc',
+    'images'
+]

build/lib/MISP_maltego/resources/etc/MISP_maltego.conf

@@ -0,0 +1,10 @@
+[MISP_maltego.local]
+misp_url = ''
+misp_key = ''
+
+misp_verify = True
+misp_debug = False
+
+[MISP_maltego.remote]
+
+# TODO: put remote transform options here

build/lib/MISP_maltego/transforms/__init__.py

@@ -0,0 +1,3 @@
+__all__ = [
+    'common'
+]

build/lib/MISP_maltego/transforms/attributetoevent.py

@@ -0,0 +1,84 @@
+from canari.maltego.entities import Hash, Domain, IPv4Address, URL, DNSName, AS, Website, NSRecord, PhoneNumber, EmailAddress, File
+from canari.maltego.transform import Transform
+# from canari.framework import EnableDebugWindow
+from MISP_maltego.transforms.common.entities import MISPEvent
+from MISP_maltego.transforms.common.util import get_misp_connection
+
+__author__ = 'Christophe Vandeplas'
+__copyright__ = 'Copyright 2018, MISP_maltego Project'
+__credits__ = []
+
+__license__ = 'AGPLv3'
+__version__ = '0.1'
+__maintainer__ = 'Christophe Vandeplas'
+__email__ = 'christophe@vandeplas.com'
+__status__ = 'Development'
+
+
+# @EnableDebugWindow
+class AttributeToEvent(Transform):
+    # The transform input entity type.
+    input_type = None
+
+    def do_transform(self, request, response, config):
+        maltego_misp_attribute = request.entity
+        misp = get_misp_connection(config)
+        # misp.
+        events_json = misp.search(controller='events', values=maltego_misp_attribute.value, withAttachments=False)
+        for e in events_json['response']:
+            response += MISPEvent(e['Event']['id'], uuid=e['Event']['uuid'], info=e['Event']['info'])
+        return response
+
+    def on_terminate(self):
+        """This method gets called when transform execution is prematurely terminated. It is only applicable for local
+        transforms. It can be excluded if you don't need it."""
+        pass
+
+
+class HashToEvent(AttributeToEvent):
+    input_type = Hash
+
+
+class DomainToEvent(AttributeToEvent):
+    input_type = Domain
+
+
+class IPv4AddressToEvent(AttributeToEvent):
+    display_name = 'IPv4AddressToEvent'
+    input_type = IPv4Address
+
+
+class URLToEvent(AttributeToEvent):
+    display_name = 'URLToEvent'
+    input_type = URL
+
+
+class DNSNameToEvent(AttributeToEvent):
+    display_name = 'DNSNameToEvent'
+    input_type = DNSName
+
+
+class ASToEvent(AttributeToEvent):
+    display_name = 'ASToEvent'
+    input_type = AS
+
+
+class WebsiteToEvent(AttributeToEvent):
+    input_type = Website
+
+
+class NSRecordToEvent(AttributeToEvent):
+    display_name = 'NSRecordToEvent'
+    input_type = NSRecord
+
+
+class PhoneNumberToEvent(AttributeToEvent):
+    input_type = PhoneNumber
+
+
+class EmailAddressToEvent(AttributeToEvent):
+    input_type = EmailAddress
+
+
+class FileToEvent(AttributeToEvent):
+    input_type = File

build/lib/MISP_maltego/transforms/common/__init__.py

@@ -0,0 +1,4 @@
+__all__ = [
+    'entities',
+    'util'
+]

build/lib/MISP_maltego/transforms/common/entities.py

@@ -0,0 +1,57 @@
+from canari.maltego.message import Entity, IntegerEntityField, StringEntityField, MatchingRule
+
+__author__ = 'Christophe Vandeplas'
+__copyright__ = 'Copyright 2018, MISP_maltego Project'
+__credits__ = []
+
+__license__ = 'AGPLv3'
+__version__ = '0.1'
+__maintainer__ = 'Christophe Vandeplas'
+__email__ = 'christophe@vandeplas.com'
+__status__ = 'Development'
+
+__all__ = [
+    'MISPEvent',
+    'MISPObject',
+    'MISPGalaxy'
+]
+
+
+class MISPEvent(Entity):
+    _category_ = 'MISP'
+    _namespace_ = 'misp'
+
+    icon_url = 'file://MISP_maltego/resources/images/MISPEvent.png'
+    uuid = StringEntityField('uuid', display_name='UUID', matching_rule=MatchingRule.Loose)
+    id = IntegerEntityField('id', display_name='id', is_value=True)
+    # date = DateEntityField('type.date', display_name='Event date')
+    info = StringEntityField('info', display_name='Event info', matching_rule=MatchingRule.Loose)
+    # threat_level = EnumEntityField('type.enum', choices=['Undefined', 'Low', 'Medium', 'High'], display_name='Threat Level')
+    # analysis = EnumEntityField('type.enum', choices=['Initial', 'Ongoing', 'Completed'])
+    # org = StringEntityField('type.str', display_name='Organisation')
+
+
+class MISPObject(Entity):
+    _category_ = 'MISP'
+    _namespace_ = 'misp'
+
+    icon_url = 'file://MISP_maltego/resources/images/MISPObject.png'
+    uuid = StringEntityField('uuid', display_name='UUID')
+    event_id = IntegerEntityField('event_id', display_name='Event ID')
+    name = StringEntityField('name', display_name='Name', is_value=True)
+    meta_category = StringEntityField('meta_category', display_name='Meta Category')
+    description = StringEntityField('description', display_name='Description')
+    comment = StringEntityField('comment', display_name='Comment')
+
+
+class MISPGalaxy(Entity):
+    _category_ = 'MISP'
+    _namespace_ = 'misp'
+
+    uuid = StringEntityField('uuid', display_name='UUID')
+    name = StringEntityField('name', display_name='Name', is_value=True)
+    description = StringEntityField('description', display_name='Description')
+    cluster_type = StringEntityField('galaxy_type', display_name='Type')
+    cluster_value = StringEntityField('value', display_name='Value')
+    synonyms = StringEntityField('synonyms', display_name='Synonyms')
+    tag_name = StringEntityField('tag_name', display_name='Tag')

build/lib/MISP_maltego/transforms/common/util.py

@@ -0,0 +1,288 @@
+from canari.maltego.entities import Unknown, Hash, Domain, IPv4Address, URL, DNSName, AS, Website, NSRecord, PhoneNumber, EmailAddress, File, Person, Hashtag
+from MISP_maltego.transforms.common.entities import MISPEvent, MISPObject, MISPGalaxy
+from canari.maltego.message import UIMessageType, UIMessage, Label
+from pymisp import PyMISP
+import json
+import tempfile
+import os
+
+
+# mapping_maltego_to_misp = {
+#     'maltego.Hash': ['md5', 'sha1', 'sha256', 'sha224', 'sha384', 'sha512', 'sha512/224', 'sha512/256'],
+#     # 'maltego.Banner': [''],
+#     # 'maltego.WebTitle': [''],
+#     'maltego.Domain': ['domain', 'hostname'],
+#     # 'maltego.Netblock': [''],
+#     # 'maltego.MXRecord': [''],
+#     'maltego.IPv4Address': ['ip-src', 'ip-dst', 'ip'],
+#     'maltego.URL': ['url', 'uri'],
+#     'maltego.DNSName': ['domain', 'hostname'],
+#     'maltego.AS': ['AS'],
+#     # 'maltego.UniqueIdentifier': [''],
+#     'maltego.Website': ['domain', 'hostname'],
+#     'maltego.NSRecord': ['domain', 'hostname'],
+#     # 'maltego.Document': [''],
+#     'maltego.PhoneNumber': ['phone-number'],
+#     'maltego.EmailAddress': ['email-src', 'email-dst'],
+#     # 'maltego.Image': [''],  # LATER file image
+#     # 'maltego.Phrase': [''],
+#     'maltego.File': ['filename'],
+#     # 'maltego.Person': [''],
+#     # 'maltego.Sentiment': [''],
+#     # 'maltego.Alias': [''],
+#     # 'maltego.GPS': [''],
+#     # 'maltego.CircularArea': [''],
+#     # 'maltego.NominatimLocation': [''],
+#     # 'maltego.Location': [''],
+#     # 'maltego.Device': [''],
+#     # 'maltego.affiliation.Flickr': [''],
+#     # 'maltego.FacebookObject': [''],
+#     # 'maltego.hashtag': [''],
+#     # 'maltego.affiliation.Twitter': [''],
+#     # 'maltego.affiliation.Facebook': [''],
+#     # 'maltego.Twit': [''],
+#     # 'maltego.Port': [''],
+#     # 'maltego.Service': [''],
+#     # 'maltego.BuiltWithTechnology': [''],
+# }
+
+# mapping_misp_to_maltego = {}
+# for key, vals in mapping_maltego_to_misp.items():
+#     for val in vals:
+#         if val not in mapping_misp_to_maltego:
+#             mapping_misp_to_maltego[val] = []
+#         mapping_misp_to_maltego[val].append(key)
+
+mapping_misp_to_maltego = {
+    'AS': [AS],
+    'domain': [Domain, NSRecord, Website, DNSName],
+    'email-dst': [EmailAddress],
+    'email-src': [EmailAddress],
+    'filename': [File],
+    'hostname': [Website, NSRecord, Domain, DNSName],
+    'ip': [IPv4Address],
+    'ip-dst': [IPv4Address],
+    'ip-src': [IPv4Address],
+    'md5': [Hash],
+    'phone-number': [PhoneNumber],
+    'sha1': [Hash],
+    'sha224': [Hash],
+    'sha256': [Hash],
+    'sha384': [Hash],
+    'sha512': [Hash],
+    'sha512/224': [Hash],
+    'sha512/256': [Hash],
+    'uri': [URL],
+    'url': [URL],
+
+    'whois-registrant-email': [EmailAddress],
+
+    # object mappings
+    'nameserver': [NSRecord],
+    # FIXME add more object mappings
+    # custom types created internally for technical reasons
+    # 'rekey_value': [Unknown]
+}
+
+
+def get_misp_connection(config):
+    if config['MISP_maltego.local.misp_verify'] in ['True', 'true', 1, 'yes', 'Yes']:
+        misp_verify = True
+    else:
+        misp_verify = False
+    if config['MISP_maltego.local.misp_debug'] in ['True', 'true', 1, 'yes', 'Yes']:
+        misp_debug = True
+    else:
+        misp_debug = False
+    return PyMISP(config['MISP_maltego.local.misp_url'], config['MISP_maltego.local.misp_key'], misp_verify, 'json', misp_debug)
+
+
+def entity_obj_to_entity(entity_obj, v, t, **kwargs):
+    if entity_obj == Hash:
+        return entity_obj(v, _type=t, **kwargs)  # FIXME type is conflicting with type of Entity, Report this as bug see line 326 /usr/local/lib/python3.5/dist-packages/canari/maltego/entities.py
+
+    return entity_obj(v, **kwargs)
+
+
+def attribute_to_entity(a):
+    # prepare some attributes to a better form
+    a['data'] = None  # empty the file content as we really don't need this here  # FIXME feature request for misp.get_event() to not get attachment content
+    if a['type'] == 'malware-sample':
+        a['type'] = 'filename|md5'
+    if a['type'] == 'regkey|value':
+        a['type'] = 'regkey'
+    # FIXME regkey|value => needs to be a special non-combined object
+
+    # attribute is from an object, and a relation gives better understanding of the type of attribute
+    if a.get('object_relation') and mapping_misp_to_maltego.get(a['object_relation']):
+        entity_obj = mapping_misp_to_maltego[a['object_relation']][0]
+        yield entity_obj(a['value'], labels=[Label('comment', a['comment'])])
+
+    # combined attributes
+    elif '|' in a['type']:
+        t_1, t_2 = a['type'].split('|')
+        v_1, v_2 = a['value'].split('|')
+        if t_1 in mapping_misp_to_maltego:
+            entity_obj = mapping_misp_to_maltego[t_1][0]
+            labels = [Label('comment', a['comment'])]
+            if entity_obj == File:
+                labels.append(Label('hash', v_2))
+            yield entity_obj_to_entity(entity_obj, v_1, t_1, labels=labels)  # TODO change the comment to include the second part of the regkey
+        else:
+            yield UIMessage("Type {} of combined type {} not supported for attribute: {}".format(t_1, a['type'], a), type=UIMessageType.Inform)
+        if t_2 in mapping_misp_to_maltego:
+            entity_obj = mapping_misp_to_maltego[t_2][0]
+            labels = [Label('comment', a['comment'])]
+            if entity_obj == Hash:
+                labels.append(Label('filename', v_1))
+            yield entity_obj_to_entity(entity_obj, v_2, t_2, labels=labels)  # TODO change the comment to include the first part of the regkey
+        else:
+            yield UIMessage("Type {} of combined type {} not supported for attribute: {}".format(t_2, a['type'], a), type=UIMessageType.Inform)
+
+    # normal attributes
+    elif a['type'] in mapping_misp_to_maltego:
+        entity_obj = mapping_misp_to_maltego[a['type']][0]
+        yield entity_obj_to_entity(entity_obj, a['value'], a['type'], labels=[Label('comment', a['comment'])])
+
+    # not supported in our maltego mapping
+    else:
+        yield Unknown(a['value'], type=a['type'], labels=[Label('comment', a['comment'])])
+        yield UIMessage("Type {} not fully supported for attribute: {}".format(a['type'], a), type=UIMessageType.Inform)
+
+    if 'Galaxy' in a:
+        for g in a['Galaxy']:
+            for c in g['GalaxyCluster']:
+                yield galaxycluster_to_entity(c)
+
+    if 'Tag' in a:
+            for t in a['Tag']:
+                # ignore all misp-galaxies
+                if t['name'].startswith('misp-galaxy'):
+                    continue
+                yield Hashtag(t['name'])
+
+
+def object_to_entity(o):
+    return MISPObject(
+        o['name'],
+        uuid=o['uuid'],
+        event_id=int(o['event_id']),
+        meta_category=o.get('meta_category'),
+        description=o['description'],
+        comment=o['comment']
+    )
+
+
+def object_to_attributes(o):
+    # first process attributes from an object that belong together (eg: first-name + last-name), and remove them from the list
+    if o['name'] == 'person':
+        first_name = get_attribute_in_object(o, 'first-name', drop=True).get('value')
+        last_name = get_attribute_in_object(o, 'last-name', drop=True).get('value')
+        yield entity_obj_to_entity(Person, ' '.join([first_name, last_name]).strip(), 'person', lastname=last_name, firstnames=first_name)
+
+    # process normal attributes
+    for a in o['Attribute']:
+        for item in attribute_to_entity(a):
+            yield item
+
+
+def get_attribute_in_object(o, attribute_type, drop=False):
+    '''Gets the first attribute of a specific type within an object'''
+    found_attribute = {'value': ''}
+    for i, a in enumerate(o['Attribute']):
+        if a['type'] == attribute_type:
+            found_attribute = a.copy()
+            if drop:    # drop the attribute from the object
+                o['Attribute'].pop(i)
+            break
+    return found_attribute
+
+
+def event_to_entity(e):
+    return MISPEvent(e['Event']['id'], uuid=e['Event']['uuid'], info=e['Event']['info'])
+
+
+def galaxycluster_to_entity(c, link_label=None):
+    # print(json.dumps(c, sort_keys=True, indent=4))
+    if c['meta'].get('synonyms'):
+        synonyms = ', '.join(c['meta']['synonyms'])
+    else:
+        synonyms = ''
+    return MISPGalaxy(
+        '{}\n{}'.format(c['type'], c['value']),
+        uuid=c['uuid'],
+        description=c['description'],
+        cluster_type=c['type'],
+        cluster_value=c['value'],
+        synonyms=synonyms,
+        tag_name=c['tag_name'],
+        link_label=link_label
+    )
+
+
+# FIXME this uses the galaxies from github as the MISP web UI does not fully support the Galaxies in the webui.
+# See https://github.com/MISP/MISP/issues/3801
+galaxy_archive_url = 'https://github.com/MISP/misp-galaxy/archive/master.zip'
+local_path_root = os.path.join(tempfile.gettempdir(), 'MISP-maltego')
+local_path_uuid_mapping = os.path.join(local_path_root, 'MISP_maltego_galaxy_mapping.json')
+local_path_clusters = os.path.join(local_path_root, 'misp-galaxy-master', 'clusters')
+galaxy_cluster_uuids = None
+
+
+def galaxy_update_local_copy(force=False):
+    import io
+    import json
+    import os
+    import requests
+    from zipfile import ZipFile
+
+    # FIXME put some aging and automatic re-downloading
+    if not os.path.exists(local_path_root):
+        os.mkdir(local_path_root)
+        force = True
+
+    if force:
+        # download the latest zip of the public galaxy
+        resp = requests.get(galaxy_archive_url)
+        zf = ZipFile(io.BytesIO(resp.content))
+        zf.extractall(local_path_root)
+        zf.close()
+
+        # generate the uuid mapping and save it to a file
+        galaxies_fnames = []
+        for f in os.listdir(local_path_clusters):
+            if '.json' in f:
+                galaxies_fnames.append(f)
+        galaxies_fnames.sort()
+
+        cluster_uuids = {}
+        for galaxy_fname in galaxies_fnames:
+            fullPathClusters = os.path.join(local_path_clusters, galaxy_fname)
+            with open(fullPathClusters) as fp:
+                galaxy = json.load(fp)
+            for cluster in galaxy['values']:
+                # print(cluster['uuid'])
+                if 'uuid' not in cluster:
+                    continue
+                # keep track of the cluster, but also enhance it to look like the cluster we receive when accessing the web.
+                cluster_uuids[cluster['uuid']] = cluster
+                cluster_uuids[cluster['uuid']]['type'] = galaxy['type']
+                cluster_uuids[cluster['uuid']]['tag_name'] = 'misp-galaxy:{}="{}"'.format(galaxy['type'], cluster['value'])
+
+        with open(local_path_uuid_mapping, 'w') as f:
+            json.dump(cluster_uuids, f, sort_keys=True, indent=4)
+
+
+def galaxy_load_cluster_mapping():
+    galaxy_update_local_copy()
+    with open(local_path_uuid_mapping, 'r') as f:
+        cluster_uuids = json.load(f)
+    return cluster_uuids
+
+
+def get_galaxy_cluster(uuid):
+    global galaxy_cluster_uuids
+    if not galaxy_cluster_uuids:
+        galaxy_cluster_uuids = galaxy_load_cluster_mapping()
+
+    return galaxy_cluster_uuids.get(uuid)

build/lib/MISP_maltego/transforms/eventtoattributes.py

@@ -0,0 +1,77 @@
+from canari.maltego.entities import Hashtag
+from canari.maltego.transform import Transform
+# from canari.framework import EnableDebugWindow
+from MISP_maltego.transforms.common.entities import MISPEvent, MISPObject
+from MISP_maltego.transforms.common.util import get_misp_connection, attribute_to_entity, event_to_entity, galaxycluster_to_entity, object_to_entity, object_to_attributes
+import json
+
+__author__ = 'Christophe Vandeplas'
+__copyright__ = 'Copyright 2018, MISP_maltego Project'
+__credits__ = []
+
+__license__ = 'AGPLv3'
+__version__ = '0.1'
+__maintainer__ = 'Christophe Vandeplas'
+__email__ = 'christophe@vandeplas.com'
+__status__ = 'Development'
+
+
+# @EnableDebugWindow
+class EventToAttributes(Transform):
+    """Expands an event to attributes, objects, tags and galaxies."""
+
+    # The transform input entity type.
+    input_type = MISPEvent
+    description = 'Expands an Event to Attributes, Tags, Galaxies and related events'
+
+    def do_transform(self, request, response, config):
+        maltego_misp_event = request.entity
+        # print(dir(maltego_misp_event))
+        misp = get_misp_connection(config)
+        event_json = misp.get_event(maltego_misp_event.id)  # FIXME get it without attachments
+        # print(json.dumps(event_json, sort_keys=True, indent=4))
+        if not event_json.get('Event'):
+            return response
+        for e in event_json['Event']['RelatedEvent']:
+            response += event_to_entity(e)
+        for a in event_json['Event']["Attribute"]:
+            for entity in attribute_to_entity(a):
+                if entity:
+                    response += entity
+        for o in event_json['Event']['Object']:
+            # LATER unfortunately we cannot automatically expand the objects
+            response += object_to_entity(o)
+        for g in event_json['Event']['Galaxy']:
+            for c in g['GalaxyCluster']:
+                response += galaxycluster_to_entity(c)
+        if 'Tag' in event_json['Event']:
+            for t in event_json['Event']['Tag']:
+                # ignore all misp-galaxies
+                if t['name'].startswith('misp-galaxy'):
+                    continue
+                response += Hashtag(t['name'])
+        return response
+
+    def on_terminate(self):
+        """This method gets called when transform execution is prematurely terminated. It is only applicable for local
+        transforms. It can be excluded if you don't need it."""
+        pass
+
+
+# @EnableDebugWindow
+class ObjectToAttributes(Transform):
+    """"Expands an object to its attributes"""
+    input_type = MISPObject
+    description = 'Expands an Obect to Attributes'
+
+    def do_transform(self, request, response, config):
+        maltego_object = request.entity
+        misp = get_misp_connection(config)
+        event_json = misp.get_event(maltego_object.event_id)
+        for o in event_json['Event']['Object']:
+            if o['uuid'] == maltego_object.uuid:
+                for entity in object_to_attributes(o):
+                    if entity:
+                        response += entity
+
+        return response

build/lib/MISP_maltego/transforms/galaxytoevent.py

@@ -0,0 +1,63 @@
+from canari.maltego.transform import Transform
+# from canari.framework import EnableDebugWindow
+from MISP_maltego.transforms.common.entities import MISPEvent, MISPGalaxy
+from MISP_maltego.transforms.common.util import get_misp_connection, galaxycluster_to_entity, get_galaxy_cluster
+from canari.maltego.message import UIMessageType, UIMessage
+
+
+__author__ = 'Christophe Vandeplas'
+__copyright__ = 'Copyright 2018, MISP_maltego Project'
+__credits__ = []
+
+__license__ = 'AGPLv3'
+__version__ = '0.1'
+__maintainer__ = 'Christophe Vandeplas'
+__email__ = 'christophe@vandeplas.com'
+__status__ = 'Development'
+
+
+# @EnableDebugWindow
+class GalaxyToEvents(Transform):
+    """Expands a Galaxy to multiple MISP Events."""
+
+    # The transform input entity type.
+    input_type = MISPGalaxy
+
+    def do_transform(self, request, response, config):
+        maltego_misp_galaxy = request.entity
+        misp = get_misp_connection(config)
+        if maltego_misp_galaxy.tag_name:
+            tag_name = maltego_misp_galaxy.tag_name
+        else:
+            tag_name = maltego_misp_galaxy.value
+        events_json = misp.search(controller='events', tags=tag_name, withAttachments=False)
+        for e in events_json['response']:
+            response += MISPEvent(e['Event']['id'], uuid=e['Event']['uuid'], info=e['Event']['info'])
+        return response
+
+    def on_terminate(self):
+        """This method gets called when transform execution is prematurely terminated. It is only applicable for local
+        transforms. It can be excluded if you don't need it."""
+        pass
+
+
+# @EnableDebugWindow
+class GalaxyToRelations(Transform):
+    """Expans a Galaxy to related Galaxies and Clusters"""
+    input_type = MISPGalaxy
+
+    def do_transform(self, request, response, config):
+        maltego_misp_galaxy = request.entity
+
+        # # FIXME if not found, send message to user to update, while noting local galaxies are not supported yet
+        current_cluster = get_galaxy_cluster(maltego_misp_galaxy.uuid)
+        if not current_cluster:
+            response += UIMessage("Galaxy Cluster UUID not in local mapping. Please update local cache; or non-public UUID", type=UIMessageType.Inform)
+            return response
+
+        if 'related' in current_cluster:
+            for related in current_cluster['related']:
+                related_cluster = get_galaxy_cluster(related['dest-uuid'])
+                if related_cluster:
+                    response += galaxycluster_to_entity(related_cluster, link_label=related['type'])
+        return response

misp_domain2event.py

@@ -1,29 +0,0 @@
-#############################################
-# MISP API Domain to Event
-# 
-# Author: Emmanuel Bouillon
-# Email:  emmanuel.bouillon.sec@gmail.com
-# Date: 24/11/2015
-#############################################
-import sys
-from misp_util import *
-from pymisp import PyMISP
-import json
-
-attribute2filter = {
-    'ip':'ip-src&&ip-dst', 'domain':'domain&&hostname', 
-    'hash':'md5&&sha1&&sha256&&malware-sample', 
-    'email':'email-src&&email-dst', 'email-subject': 'email-subject'
-}
-
-if __name__ == '__main__':
-        enValue = sys.argv[1]
-        enType = sys.argv[0].split('_')[-1].split('2')[0] #misp_enType2event.py
-        mt = MaltegoTransform()
-        mt.addUIMessage("[INFO] " + enType + " to MISP Event")
-        try:
-            retrieveEvents(mt, attribute2filter[enType], enValue)
-        except Exception as e:
-            mt.addUIMessage("[Error] " + str(e))
-        mt.returnOutput()
-

misp_event2domain.py

@@ -1,38 +0,0 @@
-#############################################
-# MISP API Domain to Event
-# 
-# Author: Emmanuel Bouillon
-# Email:  emmanuel.bouillon.sec@gmail.com
-# Date: 24/11/2015
-#############################################
-import sys
-from misp_util import *
-from pymisp import PyMISP
-import json
-
-type2attribute = {'domain':('domain','hostname'), 'hostname':('hostname'), 'hash':('md5','sha1','sha256') , 'ip':('ip-src','ip-dst'), 'email':('email-src','email-dst'), 'email-subject': ('email-subject')}
-argType2enType = {'domain':'maltego.Domain', 'hostname':'maltego.Domain', 'hash':'maltego.Hash', 'ip':'maltego.IPv4Address', 'email':'maltego.EmailAddress', 'email-subject': 'maltego.Phrase'}
-filename_pipe_hash_type = ('filename|md5', 'filename|sha1', 'filename|sha256', 'malware-sample')
-
-if __name__ == '__main__':
-        event_id = sys.argv[1]
-        argType = sys.argv[0].split('.')[0].split('2')[1] # misp_event2argType.py
-        misp = init()
-        try:
-            event = misp.get_event(event_id)
-            event_json = event.json()
-            mt = MaltegoTransform()
-	    for attribute in event_json['Event']["Attribute"]:
-                value = attribute["value"]
-		aType = attribute["type"]
-                if aType in type2attribute[argType]:
-		    if aType in filename_pipe_hash_type:
-                        h = value.split('|')[1].strip()
-                        me = MaltegoEntity(argType2enType[argType], h)
-                        mt.addEntityToMessage(me);   
-                    else:
-                        me = MaltegoEntity(argType2enType[argType], value)
-		        mt.addEntityToMessage(me);
-        except Exception as e:
-	    mt.addUIMessage("[ERROR]  " + str(e))
-        mt.returnOutput()

misp_getEventInfo.py

@@ -1,30 +0,0 @@
-#############################################
-# MISP API Domain to Event
-# 
-# Author: Emmanuel Bouillon
-# Email:  emmanuel.bouillon.sec@gmail.com
-# Date: 24/11/2015
-#############################################
-import sys
-from misp_util import *
-from pymisp import PyMISP
-import json
-
-if __name__ == '__main__':
-        m = init()
-        mt = MaltegoTransform()
-        event_id = sys.argv[1]
-        try:
-            event = m.get_event(event_id)
-            event_json = event.json()
-            eid = event_json['Event']['id']
-            einfo = event_json['Event']['info']
-            eorgc = event_json['Event']['orgc']
-            me = MaltegoEntity('maltego.MISPEvent',eid);
-            me.addAdditionalFields('EventLink', 'EventLink', False, BASE_URL + '/events/view/' + eid )
-            me.addAdditionalFields('Org', 'Org', False, eorgc)
-            me.addAdditionalFields('notes#', 'notes', False, eorgc + ": " + einfo)
-            mt.addEntityToMessage(me);
-        except Exception as e:
-	    mt.addUIMessage("[ERROR]  " + str(e))
-        mt.returnOutput()

misp_util.py

@@ -1,37 +0,0 @@
-#############################################
-# MISP API miscellaneous functions.
-# 
-# Author: Emmanuel Bouillon
-# Email:  emmanuel.bouillon.sec@gmail.com
-# Date: 24/11/2015
-#############################################
-
-# MISP BASE URL
-BASE_URL = '<MISP_BASE_URL>'
-# API KEY
-API_KEY = '<YOUR_API_KEY>'
-# MISP_VERIFYCERT
-MISP_VERIFYCERT = True
-# pyMISP DEBUG
-MISP_DEBUG = False
-
-from pymisp import PyMISP
-from MaltegoTransform import *
-
-def init():
-    return PyMISP(BASE_URL, API_KEY, MISP_VERIFYCERT, 'json', MISP_DEBUG)
-
-def retrieveEvents(mt, enFilter, enValue):
-    misp = init()
-    result = misp.search(values = enValue, type_attribute = enFilter)
-    for e in result['response']:
-        eid = e['Event']['id']
-        einfo = e['Event']['info']
-        eorgc = e['Event']['Orgc']['name']
-        me = MaltegoEntity('maltego.MISPEvent',eid);
-        me.addAdditionalFields('EventLink', 'EventLink', False, BASE_URL + '/events/view/' + eid )
-        me.addAdditionalFields('Org', 'Org', False, eorgc)
-        me.addAdditionalFields('notes#', 'notes', False, eorgc + ": " + einfo)
-        mt.addEntityToMessage(me);
-    return
-

setup.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+
+from setuptools import setup, find_packages
+
+setup(
+    name='MISP_maltego',
+    author='Christophe Vandeplas',
+    version='1.0',
+    author_email='christophe@vandeplas.com',
+    description='Maltego transform for interacting with a MISP Threat Sharing community.',
+    license='AGPLv3',
+    packages=find_packages('src'),
+    package_dir={'': 'src'},
+    zip_safe=False,
+    package_data={
+        '': ['*.gif', '*.png', '*.conf', '*.mtz', '*.machine']  # list of resources
+    },
+    install_requires=[
+        'canari>=3.3.9,<4',
+        'PyMISP'
+    ],
+    dependency_links=[
+        # custom links for the install_requires
+    ]
+)

src/MISP_maltego/__init__.py

@@ -0,0 +1,9 @@
+__license__ = 'AGPLv3'
+__version__ = '0.1'
+__author__ = 'Christophe Vandeplas'
+__email__ = 'christophe@vandeplas.com'
+
+__all__ = [
+    'transforms',
+    'resources'
+]

src/MISP_maltego/resources/__init__.py

@@ -0,0 +1,4 @@
+__all__ = [
+    'etc',
+    'images'
+]

src/MISP_maltego/resources/etc/MISP_maltego.conf

@@ -0,0 +1,10 @@
+[MISP_maltego.local]
+misp_url = ''
+misp_key = ''
+
+misp_verify = True
+misp_debug = False
+
+[MISP_maltego.remote]
+
+# TODO: put remote transform options here

src/MISP_maltego/resources/external/README

@@ -0,0 +1,6 @@
+This package directory is used to store non-Canari transform code. Why would you want to use for Canari? For easy
+transform distribution. You can use Canari as a transform proxy to execute your non-Python or non-Canari transform code.
+This allows you to package up your transforms in an easy-to-use transform package and easily share the package with your
+colleagues.
+
+TODO: more explanation.

src/MISP_maltego/transforms/__init__.py

@@ -0,0 +1,3 @@
+__all__ = [
+    'common'
+]

src/MISP_maltego/transforms/attributetoevent.py

@@ -0,0 +1,84 @@
+from canari.maltego.entities import Hash, Domain, IPv4Address, URL, DNSName, AS, Website, NSRecord, PhoneNumber, EmailAddress, File
+from canari.maltego.transform import Transform
+# from canari.framework import EnableDebugWindow
+from MISP_maltego.transforms.common.entities import MISPEvent
+from MISP_maltego.transforms.common.util import get_misp_connection
+
+__author__ = 'Christophe Vandeplas'
+__copyright__ = 'Copyright 2018, MISP_maltego Project'
+__credits__ = []
+
+__license__ = 'AGPLv3'
+__version__ = '0.1'
+__maintainer__ = 'Christophe Vandeplas'
+__email__ = 'christophe@vandeplas.com'
+__status__ = 'Development'
+
+
+# @EnableDebugWindow
+class AttributeToEvent(Transform):
+    # The transform input entity type.
+    input_type = None
+
+    def do_transform(self, request, response, config):
+        maltego_misp_attribute = request.entity
+        misp = get_misp_connection(config)
+        # misp.
+        events_json = misp.search(controller='events', values=maltego_misp_attribute.value, withAttachments=False)
+        for e in events_json['response']:
+            response += MISPEvent(e['Event']['id'], uuid=e['Event']['uuid'], info=e['Event']['info'])
+        return response
+
+    def on_terminate(self):
+        """This method gets called when transform execution is prematurely terminated. It is only applicable for local
+        transforms. It can be excluded if you don't need it."""
+        pass
+
+
+class HashToEvent(AttributeToEvent):
+    input_type = Hash
+
+
+class DomainToEvent(AttributeToEvent):
+    input_type = Domain
+
+
+class IPv4AddressToEvent(AttributeToEvent):
+    display_name = 'IPv4AddressToEvent'
+    input_type = IPv4Address
+
+
+class URLToEvent(AttributeToEvent):
+    display_name = 'URLToEvent'
+    input_type = URL
+
+
+class DNSNameToEvent(AttributeToEvent):
+    display_name = 'DNSNameToEvent'
+    input_type = DNSName
+
+
+class ASToEvent(AttributeToEvent):
+    display_name = 'ASToEvent'
+    input_type = AS
+
+
+class WebsiteToEvent(AttributeToEvent):
+    input_type = Website
+
+
+class NSRecordToEvent(AttributeToEvent):
+    display_name = 'NSRecordToEvent'
+    input_type = NSRecord
+
+
+class PhoneNumberToEvent(AttributeToEvent):
+    input_type = PhoneNumber
+
+
+class EmailAddressToEvent(AttributeToEvent):
+    input_type = EmailAddress
+
+
+class FileToEvent(AttributeToEvent):
+    input_type = File

src/MISP_maltego/transforms/common/__init__.py

@@ -0,0 +1,4 @@
+__all__ = [
+    'entities',
+    'util'
+]

src/MISP_maltego/transforms/common/entities.py

@@ -0,0 +1,57 @@
+from canari.maltego.message import Entity, IntegerEntityField, StringEntityField, MatchingRule
+
+__author__ = 'Christophe Vandeplas'
+__copyright__ = 'Copyright 2018, MISP_maltego Project'
+__credits__ = []
+
+__license__ = 'AGPLv3'
+__version__ = '0.1'
+__maintainer__ = 'Christophe Vandeplas'
+__email__ = 'christophe@vandeplas.com'
+__status__ = 'Development'
+
+__all__ = [
+    'MISPEvent',
+    'MISPObject',
+    'MISPGalaxy'
+]
+
+
+class MISPEvent(Entity):
+    _category_ = 'MISP'
+    _namespace_ = 'misp'
+
+    icon_url = 'file://MISP_maltego/resources/images/MISPEvent.png'
+    uuid = StringEntityField('uuid', display_name='UUID', matching_rule=MatchingRule.Loose)
+    id = IntegerEntityField('id', display_name='id', is_value=True)
+    # date = DateEntityField('type.date', display_name='Event date')
+    info = StringEntityField('info', display_name='Event info', matching_rule=MatchingRule.Loose)
+    # threat_level = EnumEntityField('type.enum', choices=['Undefined', 'Low', 'Medium', 'High'], display_name='Threat Level')
+    # analysis = EnumEntityField('type.enum', choices=['Initial', 'Ongoing', 'Completed'])
+    # org = StringEntityField('type.str', display_name='Organisation')
+
+
+class MISPObject(Entity):
+    _category_ = 'MISP'
+    _namespace_ = 'misp'
+
+    icon_url = 'file://MISP_maltego/resources/images/MISPObject.png'
+    uuid = StringEntityField('uuid', display_name='UUID')
+    event_id = IntegerEntityField('event_id', display_name='Event ID')
+    name = StringEntityField('name', display_name='Name', is_value=True)
+    meta_category = StringEntityField('meta_category', display_name='Meta Category')
+    description = StringEntityField('description', display_name='Description')
+    comment = StringEntityField('comment', display_name='Comment')
+
+
+class MISPGalaxy(Entity):
+    _category_ = 'MISP'
+    _namespace_ = 'misp'
+
+    uuid = StringEntityField('uuid', display_name='UUID')
+    name = StringEntityField('name', display_name='Name', is_value=True)
+    description = StringEntityField('description', display_name='Description')
+    cluster_type = StringEntityField('galaxy_type', display_name='Type')
+    cluster_value = StringEntityField('value', display_name='Value')
+    synonyms = StringEntityField('synonyms', display_name='Synonyms')
+    tag_name = StringEntityField('tag_name', display_name='Tag')

src/MISP_maltego/transforms/common/util.py

@@ -0,0 +1,288 @@
+from canari.maltego.entities import Unknown, Hash, Domain, IPv4Address, URL, DNSName, AS, Website, NSRecord, PhoneNumber, EmailAddress, File, Person, Hashtag
+from MISP_maltego.transforms.common.entities import MISPEvent, MISPObject, MISPGalaxy
+from canari.maltego.message import UIMessageType, UIMessage, Label
+from pymisp import PyMISP
+import json
+import tempfile
+import os
+
+
+# mapping_maltego_to_misp = {
+#     'maltego.Hash': ['md5', 'sha1', 'sha256', 'sha224', 'sha384', 'sha512', 'sha512/224', 'sha512/256'],
+#     # 'maltego.Banner': [''],
+#     # 'maltego.WebTitle': [''],
+#     'maltego.Domain': ['domain', 'hostname'],
+#     # 'maltego.Netblock': [''],
+#     # 'maltego.MXRecord': [''],
+#     'maltego.IPv4Address': ['ip-src', 'ip-dst', 'ip'],
+#     'maltego.URL': ['url', 'uri'],
+#     'maltego.DNSName': ['domain', 'hostname'],
+#     'maltego.AS': ['AS'],
+#     # 'maltego.UniqueIdentifier': [''],
+#     'maltego.Website': ['domain', 'hostname'],
+#     'maltego.NSRecord': ['domain', 'hostname'],
+#     # 'maltego.Document': [''],
+#     'maltego.PhoneNumber': ['phone-number'],
+#     'maltego.EmailAddress': ['email-src', 'email-dst'],
+#     # 'maltego.Image': [''],  # LATER file image
+#     # 'maltego.Phrase': [''],
+#     'maltego.File': ['filename'],
+#     # 'maltego.Person': [''],
+#     # 'maltego.Sentiment': [''],
+#     # 'maltego.Alias': [''],
+#     # 'maltego.GPS': [''],
+#     # 'maltego.CircularArea': [''],
+#     # 'maltego.NominatimLocation': [''],
+#     # 'maltego.Location': [''],
+#     # 'maltego.Device': [''],
+#     # 'maltego.affiliation.Flickr': [''],
+#     # 'maltego.FacebookObject': [''],
+#     # 'maltego.hashtag': [''],
+#     # 'maltego.affiliation.Twitter': [''],
+#     # 'maltego.affiliation.Facebook': [''],
+#     # 'maltego.Twit': [''],
+#     # 'maltego.Port': [''],
+#     # 'maltego.Service': [''],
+#     # 'maltego.BuiltWithTechnology': [''],
+# }
+
+# mapping_misp_to_maltego = {}
+# for key, vals in mapping_maltego_to_misp.items():
+#     for val in vals:
+#         if val not in mapping_misp_to_maltego:
+#             mapping_misp_to_maltego[val] = []
+#         mapping_misp_to_maltego[val].append(key)
+
+mapping_misp_to_maltego = {
+    'AS': [AS],
+    'domain': [Domain, NSRecord, Website, DNSName],
+    'email-dst': [EmailAddress],
+    'email-src': [EmailAddress],
+    'filename': [File],
+    'hostname': [Website, NSRecord, Domain, DNSName],
+    'ip': [IPv4Address],
+    'ip-dst': [IPv4Address],
+    'ip-src': [IPv4Address],
+    'md5': [Hash],
+    'phone-number': [PhoneNumber],
+    'sha1': [Hash],
+    'sha224': [Hash],
+    'sha256': [Hash],
+    'sha384': [Hash],
+    'sha512': [Hash],
+    'sha512/224': [Hash],
+    'sha512/256': [Hash],
+    'uri': [URL],
+    'url': [URL],
+
+    'whois-registrant-email': [EmailAddress],
+
+    # object mappings
+    'nameserver': [NSRecord],
+    # FIXME add more object mappings
+    # custom types created internally for technical reasons
+    # 'rekey_value': [Unknown]
+}
+
+
+def get_misp_connection(config):
+    if config['MISP_maltego.local.misp_verify'] in ['True', 'true', 1, 'yes', 'Yes']:
+        misp_verify = True
+    else:
+        misp_verify = False
+    if config['MISP_maltego.local.misp_debug'] in ['True', 'true', 1, 'yes', 'Yes']:
+        misp_debug = True
+    else:
+        misp_debug = False
+    return PyMISP(config['MISP_maltego.local.misp_url'], config['MISP_maltego.local.misp_key'], misp_verify, 'json', misp_debug)
+
+
+def entity_obj_to_entity(entity_obj, v, t, **kwargs):
+    if entity_obj == Hash:
+        return entity_obj(v, _type=t, **kwargs)  # FIXME type is conflicting with type of Entity, Report this as bug see line 326 /usr/local/lib/python3.5/dist-packages/canari/maltego/entities.py
+
+    return entity_obj(v, **kwargs)
+
+
+def attribute_to_entity(a):
+    # prepare some attributes to a better form
+    a['data'] = None  # empty the file content as we really don't need this here  # FIXME feature request for misp.get_event() to not get attachment content
+    if a['type'] == 'malware-sample':
+        a['type'] = 'filename|md5'
+    if a['type'] == 'regkey|value':
+        a['type'] = 'regkey'
+    # FIXME regkey|value => needs to be a special non-combined object
+
+    # attribute is from an object, and a relation gives better understanding of the type of attribute
+    if a.get('object_relation') and mapping_misp_to_maltego.get(a['object_relation']):
+        entity_obj = mapping_misp_to_maltego[a['object_relation']][0]
+        yield entity_obj(a['value'], labels=[Label('comment', a['comment'])])
+
+    # combined attributes
+    elif '|' in a['type']:
+        t_1, t_2 = a['type'].split('|')
+        v_1, v_2 = a['value'].split('|')
+        if t_1 in mapping_misp_to_maltego:
+            entity_obj = mapping_misp_to_maltego[t_1][0]
+            labels = [Label('comment', a['comment'])]
+            if entity_obj == File:
+                labels.append(Label('hash', v_2))
+            yield entity_obj_to_entity(entity_obj, v_1, t_1, labels=labels)  # TODO change the comment to include the second part of the regkey
+        else:
+            yield UIMessage("Type {} of combined type {} not supported for attribute: {}".format(t_1, a['type'], a), type=UIMessageType.Inform)
+        if t_2 in mapping_misp_to_maltego:
+            entity_obj = mapping_misp_to_maltego[t_2][0]
+            labels = [Label('comment', a['comment'])]
+            if entity_obj == Hash:
+                labels.append(Label('filename', v_1))
+            yield entity_obj_to_entity(entity_obj, v_2, t_2, labels=labels)  # TODO change the comment to include the first part of the regkey
+        else:
+            yield UIMessage("Type {} of combined type {} not supported for attribute: {}".format(t_2, a['type'], a), type=UIMessageType.Inform)
+
+    # normal attributes
+    elif a['type'] in mapping_misp_to_maltego:
+        entity_obj = mapping_misp_to_maltego[a['type']][0]
+        yield entity_obj_to_entity(entity_obj, a['value'], a['type'], labels=[Label('comment', a['comment'])])
+
+    # not supported in our maltego mapping
+    else:
+        yield Unknown(a['value'], type=a['type'], labels=[Label('comment', a['comment'])])
+        yield UIMessage("Type {} not fully supported for attribute: {}".format(a['type'], a), type=UIMessageType.Inform)
+
+    if 'Galaxy' in a:
+        for g in a['Galaxy']:
+            for c in g['GalaxyCluster']:
+                yield galaxycluster_to_entity(c)
+
+    if 'Tag' in a:
+            for t in a['Tag']:
+                # ignore all misp-galaxies
+                if t['name'].startswith('misp-galaxy'):
+                    continue
+                yield Hashtag(t['name'])
+
+
+def object_to_entity(o):
+    return MISPObject(
+        o['name'],
+        uuid=o['uuid'],
+        event_id=int(o['event_id']),
+        meta_category=o.get('meta_category'),
+        description=o['description'],
+        comment=o['comment']
+    )
+
+
+def object_to_attributes(o):
+    # first process attributes from an object that belong together (eg: first-name + last-name), and remove them from the list
+    if o['name'] == 'person':
+        first_name = get_attribute_in_object(o, 'first-name', drop=True).get('value')
+        last_name = get_attribute_in_object(o, 'last-name', drop=True).get('value')
+        yield entity_obj_to_entity(Person, ' '.join([first_name, last_name]).strip(), 'person', lastname=last_name, firstnames=first_name)
+
+    # process normal attributes
+    for a in o['Attribute']:
+        for item in attribute_to_entity(a):
+            yield item
+
+
+def get_attribute_in_object(o, attribute_type, drop=False):
+    '''Gets the first attribute of a specific type within an object'''
+    found_attribute = {'value': ''}
+    for i, a in enumerate(o['Attribute']):
+        if a['type'] == attribute_type:
+            found_attribute = a.copy()
+            if drop:    # drop the attribute from the object
+                o['Attribute'].pop(i)
+            break
+    return found_attribute
+
+
+def event_to_entity(e):
+    return MISPEvent(e['Event']['id'], uuid=e['Event']['uuid'], info=e['Event']['info'])
+
+
+def galaxycluster_to_entity(c, link_label=None):
+    # print(json.dumps(c, sort_keys=True, indent=4))
+    if c['meta'].get('synonyms'):
+        synonyms = ', '.join(c['meta']['synonyms'])
+    else:
+        synonyms = ''
+    return MISPGalaxy(
+        '{}\n{}'.format(c['type'], c['value']),
+        uuid=c['uuid'],
+        description=c['description'],
+        cluster_type=c['type'],
+        cluster_value=c['value'],
+        synonyms=synonyms,
+        tag_name=c['tag_name'],
+        link_label=link_label
+    )
+
+
+# FIXME this uses the galaxies from github as the MISP web UI does not fully support the Galaxies in the webui.
+# See https://github.com/MISP/MISP/issues/3801
+galaxy_archive_url = 'https://github.com/MISP/misp-galaxy/archive/master.zip'
+local_path_root = os.path.join(tempfile.gettempdir(), 'MISP-maltego')
+local_path_uuid_mapping = os.path.join(local_path_root, 'MISP_maltego_galaxy_mapping.json')
+local_path_clusters = os.path.join(local_path_root, 'misp-galaxy-master', 'clusters')
+galaxy_cluster_uuids = None
+
+
+def galaxy_update_local_copy(force=False):
+    import io
+    import json
+    import os
+    import requests
+    from zipfile import ZipFile
+
+    # FIXME put some aging and automatic re-downloading
+    if not os.path.exists(local_path_root):
+        os.mkdir(local_path_root)
+        force = True
+
+    if force:
+        # download the latest zip of the public galaxy
+        resp = requests.get(galaxy_archive_url)
+        zf = ZipFile(io.BytesIO(resp.content))
+        zf.extractall(local_path_root)
+        zf.close()
+
+        # generate the uuid mapping and save it to a file
+        galaxies_fnames = []
+        for f in os.listdir(local_path_clusters):
+            if '.json' in f:
+                galaxies_fnames.append(f)
+        galaxies_fnames.sort()
+
+        cluster_uuids = {}
+        for galaxy_fname in galaxies_fnames:
+            fullPathClusters = os.path.join(local_path_clusters, galaxy_fname)
+            with open(fullPathClusters) as fp:
+                galaxy = json.load(fp)
+            for cluster in galaxy['values']:
+                # print(cluster['uuid'])
+                if 'uuid' not in cluster:
+                    continue
+                # keep track of the cluster, but also enhance it to look like the cluster we receive when accessing the web.
+                cluster_uuids[cluster['uuid']] = cluster
+                cluster_uuids[cluster['uuid']]['type'] = galaxy['type']
+                cluster_uuids[cluster['uuid']]['tag_name'] = 'misp-galaxy:{}="{}"'.format(galaxy['type'], cluster['value'])
+
+        with open(local_path_uuid_mapping, 'w') as f:
+            json.dump(cluster_uuids, f, sort_keys=True, indent=4)
+
+
+def galaxy_load_cluster_mapping():
+    galaxy_update_local_copy()
+    with open(local_path_uuid_mapping, 'r') as f:
+        cluster_uuids = json.load(f)
+    return cluster_uuids
+
+
+def get_galaxy_cluster(uuid):
+    global galaxy_cluster_uuids
+    if not galaxy_cluster_uuids:
+        galaxy_cluster_uuids = galaxy_load_cluster_mapping()
+
+    return galaxy_cluster_uuids.get(uuid)

src/MISP_maltego/transforms/eventtoattributes.py

@@ -0,0 +1,77 @@
+from canari.maltego.entities import Hashtag
+from canari.maltego.transform import Transform
+# from canari.framework import EnableDebugWindow
+from MISP_maltego.transforms.common.entities import MISPEvent, MISPObject
+from MISP_maltego.transforms.common.util import get_misp_connection, attribute_to_entity, event_to_entity, galaxycluster_to_entity, object_to_entity, object_to_attributes
+import json
+
+__author__ = 'Christophe Vandeplas'
+__copyright__ = 'Copyright 2018, MISP_maltego Project'
+__credits__ = []
+
+__license__ = 'AGPLv3'
+__version__ = '0.1'
+__maintainer__ = 'Christophe Vandeplas'
+__email__ = 'christophe@vandeplas.com'
+__status__ = 'Development'
+
+
+# @EnableDebugWindow
+class EventToAttributes(Transform):
+    """Expands an event to attributes, objects, tags and galaxies."""
+
+    # The transform input entity type.
+    input_type = MISPEvent
+    description = 'Expands an Event to Attributes, Tags, Galaxies and related events'
+
+    def do_transform(self, request, response, config):
+        maltego_misp_event = request.entity
+        # print(dir(maltego_misp_event))
+        misp = get_misp_connection(config)
+        event_json = misp.get_event(maltego_misp_event.id)  # FIXME get it without attachments
+        # print(json.dumps(event_json, sort_keys=True, indent=4))
+        if not event_json.get('Event'):
+            return response
+        for e in event_json['Event']['RelatedEvent']:
+            response += event_to_entity(e)
+        for a in event_json['Event']["Attribute"]:
+            for entity in attribute_to_entity(a):
+                if entity:
+                    response += entity
+        for o in event_json['Event']['Object']:
+            # LATER unfortunately we cannot automatically expand the objects
+            response += object_to_entity(o)
+        for g in event_json['Event']['Galaxy']:
+            for c in g['GalaxyCluster']:
+                response += galaxycluster_to_entity(c)
+        if 'Tag' in event_json['Event']:
+            for t in event_json['Event']['Tag']:
+                # ignore all misp-galaxies
+                if t['name'].startswith('misp-galaxy'):
+                    continue
+                response += Hashtag(t['name'])
+        return response
+
+    def on_terminate(self):
+        """This method gets called when transform execution is prematurely terminated. It is only applicable for local
+        transforms. It can be excluded if you don't need it."""
+        pass
+
+
+# @EnableDebugWindow
+class ObjectToAttributes(Transform):
+    """"Expands an object to its attributes"""
+    input_type = MISPObject
+    description = 'Expands an Obect to Attributes'
+
+    def do_transform(self, request, response, config):
+        maltego_object = request.entity
+        misp = get_misp_connection(config)
+        event_json = misp.get_event(maltego_object.event_id)
+        for o in event_json['Event']['Object']:
+            if o['uuid'] == maltego_object.uuid:
+                for entity in object_to_attributes(o):
+                    if entity:
+                        response += entity
+
+        return response

src/MISP_maltego/transforms/galaxytoevent.py

@@ -0,0 +1,63 @@
+from canari.maltego.transform import Transform
+# from canari.framework import EnableDebugWindow
+from MISP_maltego.transforms.common.entities import MISPEvent, MISPGalaxy
+from MISP_maltego.transforms.common.util import get_misp_connection, galaxycluster_to_entity, get_galaxy_cluster
+from canari.maltego.message import UIMessageType, UIMessage
+
+
+__author__ = 'Christophe Vandeplas'
+__copyright__ = 'Copyright 2018, MISP_maltego Project'
+__credits__ = []
+
+__license__ = 'AGPLv3'
+__version__ = '0.1'
+__maintainer__ = 'Christophe Vandeplas'
+__email__ = 'christophe@vandeplas.com'
+__status__ = 'Development'
+
+
+# @EnableDebugWindow
+class GalaxyToEvents(Transform):
+    """Expands a Galaxy to multiple MISP Events."""
+
+    # The transform input entity type.
+    input_type = MISPGalaxy
+
+    def do_transform(self, request, response, config):
+        maltego_misp_galaxy = request.entity
+        misp = get_misp_connection(config)
+        if maltego_misp_galaxy.tag_name:
+            tag_name = maltego_misp_galaxy.tag_name
+        else:
+            tag_name = maltego_misp_galaxy.value
+        events_json = misp.search(controller='events', tags=tag_name, withAttachments=False)
+        for e in events_json['response']:
+            response += MISPEvent(e['Event']['id'], uuid=e['Event']['uuid'], info=e['Event']['info'])
+        return response
+
+    def on_terminate(self):
+        """This method gets called when transform execution is prematurely terminated. It is only applicable for local
+        transforms. It can be excluded if you don't need it."""
+        pass
+
+
+# @EnableDebugWindow
+class GalaxyToRelations(Transform):
+    """Expans a Galaxy to related Galaxies and Clusters"""
+    input_type = MISPGalaxy
+
+    def do_transform(self, request, response, config):
+        maltego_misp_galaxy = request.entity
+
+        # # FIXME if not found, send message to user to update, while noting local galaxies are not supported yet
+        current_cluster = get_galaxy_cluster(maltego_misp_galaxy.uuid)
+        if not current_cluster:
+            response += UIMessage("Galaxy Cluster UUID not in local mapping. Please update local cache; or non-public UUID", type=UIMessageType.Inform)
+            return response
+
+        if 'related' in current_cluster:
+            for related in current_cluster['related']:
+                related_cluster = get_galaxy_cluster(related['dest-uuid'])
+                if related_cluster:
+                    response += galaxycluster_to_entity(related_cluster, link_label=related['type'])
+        return response