Skip to content

Commit ad80245

Browse files
author
Anciety
committed
restructure the project
1 parent 793c028 commit ad80245

27 files changed

+6
-1349
lines changed

.gitignore

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,4 @@ bindings/python/dist
1717
__pycache__/
1818

1919
# so should never be uploaded
20-
*.so
21-
22-
# submodule
23-
sleighcraft/src/ghidra
20+
*.so

.gitmodules

Lines changed: 0 additions & 4 deletions
This file was deleted.

DEV.md

Lines changed: 0 additions & 85 deletions
This file was deleted.

README.md

Lines changed: 5 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,6 @@
1+
# SleighCraft
12

2-
![logo](./images/logo.jpeg)
3-
4-
# BinCraft - Binary Analysis Craft
5-
6-
BinCraft is the future binary analysis tool based on Ghidra, or a Ghidra release version.
7-
8-
Features:
9-
10-
- Modernized UI (Dark Theme)
11-
- More aggressive bug fixes and features
12-
- Out of the box Ghidra, useful extensions included
13-
- Useful tools based on Ghidra
14-
- Ghidra original power included
15-
16-
NOTE: Current under active development.
17-
18-
UI preview:
19-
20-
![preview](./images/dark_theme_preview.png)
21-
22-
## Why?
23-
24-
[Ghidra](https://github.com/NationalSecurityAgency/ghidra) is a nice project.
25-
But it is huge already.
26-
The maintainance is hard and although they are trying their best to advance it, the procedure is still quite slow.
27-
Many PRs are given in early 2019 but remains no reply, and they might be useful to people.
28-
29-
Thus, we decide to maintain a faster Ghidra.
30-
Our thought is to maintain a Ghidra release, which will still trace upstream ghidra fixes but modify the code in our way to modernize some of the parts.
31-
32-
For quite a long time, we will not maintain a "forked" Ghidra (means that we will still track upstream fixes and do not tend to modify the code structure).
33-
Unless, the value of it is proved.
34-
35-
## Organize
36-
37-
Each functionality is called a "craft", currently we are planning crafts like:
38-
39-
- SleighCraft: A Rust crate with Python/NodeJs (and maybe more!) bindings that export Ghidra Sleigh Engine to disassemble binary and lift them to Pcode IR
40-
- GhidraCraft: A collection of bincraft-maintained Ghidra extensions that may make your life easier when using Ghidra
41-
42-
### SleighCraft
3+
SleighCraft is one of the [BinCraft](https://github.com/StarCrossPortal/bincraft) project.
434

445
`SleighCraft` is a decoder (or, linear disassembler) based on ghidra's decompiler implementation. Sleighcraft can be used in Rust or Python, with both high-level and low-level API.
456

@@ -94,14 +55,14 @@ Architectures comparision with capstone (according to [capstone arch list](https
9455
|System Z||✔️|
9556
|xCore||✔️|
9657

97-
#### How to install
58+
## How to install
9859

9960
Rust
10061

10162
Use cargo:
10263

10364
```toml
104-
sleighcraft = { git = "https://github.com/StarCrossPortal/bincraft" }
65+
sleighcraft = { git = "https://github.com/StarCrossPortal/sleighcraft" }
10566
```
10667

10768
The repo is a bit large to submit on crates-io (because of predefined sla files), but save you the complex of compiling sleigh files yourself.
@@ -134,7 +95,7 @@ $ npm install -g neon-cli
13495
$ neon build
13596
```
13697

137-
### How to Use
98+
## How to Use
13899

139100
One could refer to doc.rs to see how Rust binding can be used.
140101

ghidra

Lines changed: 0 additions & 1 deletion
This file was deleted.

ghidracraft/.gitignore

Lines changed: 0 additions & 16 deletions
This file was deleted.

ghidracraft/Module.manifest

Whitespace-only changes.

ghidracraft/README.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

ghidracraft/build.gradle

Lines changed: 0 additions & 18 deletions
This file was deleted.

ghidracraft/extension.properties

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)