Skip to content

Commit

Permalink
Update directory structure and update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
giladreich committed May 24, 2021
1 parent e6b3616 commit 4546b75
Show file tree
Hide file tree
Showing 20 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Gilad Reich
Copyright (c) 2020-present Gilad Reich

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
30 changes: 15 additions & 15 deletions README.md → docs/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@

<p align="center"><img src="images/ida_migrator.png" width=700 height=200></p>
<p align="center"><img src="/media/ida_migrator.png" width=700 height=200></p>

# IDA Migrator Plugin

IDA Migrator plugin makes the job of migrating symbols and type informations from one IDA database instance to another. It will help migrating function names, structures and enums.
IDA Migrator plugin aids migrating function names, structures and enums from one database instance to another.

This comes in handy when:
* Moving to a newer version of IDA that does better analysis and you don't want to change in the new instance type information or variable names of the decompiled functions.
* The current idb instance fails to decompile a function or the decompilation looks wrong in comparison to another idb instance of the same binary.
* Experimenting on another idb instance before making major changes on the current instance.
* A lightweight easy way of creating small backups of the current work.
* A lightweight easy way of creating small incremental backups from the current work.
* For w/e reason, the current idb instance you're working on gets corrupted.


Expand All @@ -19,42 +19,42 @@ IDA Migrator plugin developed using PyQt, hence should work on all platforms.

Download links can be found [here](https://github.com/giladreich/ida_migrator/releases).

Copy the files under the `src` directory and put them under IDA installation `plugins` directory.
Copy the files under the `source` directory and put them under your IDA installation `plugins` directory.

Start your current IDA instance you want to migrate from and then press `CTRL+SHIFT+D` to start the plugin. Alternative; open it through the `Edit -> Plugins -> IDA Migrator` menu:
Start your current IDA instance you want to migrate from and then press `CTRL+SHIFT+D` to show the plugin's UI. Alternative; open it through the `Edit -> Plugins -> IDA Migrator` menu:

![Intro](/images/intro.png)
![Intro](/media/intro.png)


### Step 1 - Exporting Data

Click the `Export` button to load current instance functions:
Clicking the `Export` button will show all functions of the current database instance:

![Exporter UI](/images/exporter_1.png)
![Exporter UI](/media/exporter_1.png)

Hint: You can uncheck any functions you don't want to be exported.
Hint: You can uncheck any functions you want to exclude from exporting.

Once you click the `Start Export` button, it will ask you where would you like to export the files; One is the `*symbols*.json` storing addresses and function names and the other is `*types*.idc` having all the structures and enums information:

![Exporter Files](/images/exporter_2.png)
![Exporter Files](/media/exporter_2.png)


### Step 2 - Importing Data

In the new idb instance, open the plugin again and click on the `Import` button, which will then ask you to provide the `*symbols*.json` file:

![Importer UI](/images/importer_1.png)
![Importer UI](/media/importer_1.png)

Same procedure from here, just that once you click the `Start Import` button, it will ask you if you would like to import structures and enums as well from the exported `*types*.idc` file, so it's up to you to decide.
Same procedure from here, just that once you click the `Start Import` button, it will ask you if you would like to import structures and enums as well from the exported `*types*.idc` file, that's optional for you to choose.

Note that it will only rename functions that does not have the same name and will output what functions has been affected:
Note that it will only rename functions that does not have the same name and will output what functions has been affected in IDA's console:

![Importer Results](/images/importer_2.png)
![Importer Results](/media/importer_2.png)


## Contributing

Pull-Requests are greatly appreciated should you like to contribute to the project.
Pull-Requests are greatly appreciated should you like to contribute to the project.

Same goes for opening issues; if you have any suggestions, feedback or you found any bugs, please do not hesitate to open an [issue](https://github.com/giladreich/ida_migrator/issues).

Expand Down
Binary file removed images/intro.png
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
Binary file added media/intro.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 4546b75

Please sign in to comment.