Add all previous pages, with broken images

binsync · Sep 30, 2024 · 558bba9 · 558bba9
1 parent fd6d49d
commit 558bba9
Show file tree

Hide file tree

Showing 45 changed files with 573 additions and 668 deletions.
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
diff --git a/blog/2022-11-13-binsync-lives.md b/blog/2022-11-13-binsync-lives.md
@@ -0,0 +1,8 @@
+---
+slug: binsync-lives
+title:  "BinSync Lives!"
+authors: mahaloz
+tags: [hello]
+---
+
+Today, the BinSync docs and front page are made public! Let's hope we get some awesome features and fixes before 2023.
diff --git a/blog/authors.yml b/blog/authors.yml
@@ -1,23 +1,9 @@
-yangshun:
-  name: Yangshun Tay
-  title: Front End Engineer @ Facebook
-  url: https://github.com/yangshun
-  image_url: https://github.com/yangshun.png
+mahaloz:
+  name: Zion Basque (mahaloz)
+  title: Lead Developer
+  url: https://github.com/mahaloz
+  image_url: https://github.com/mahaloz.png
   page: true
   socials:
-    x: yangshunz
-    github: yangshun
-
-slorber:
-  name: Sébastien Lorber
-  title: Docusaurus maintainer
-  url: https://sebastienlorber.com
-  image_url: https://github.com/slorber.png
-  page:
-    # customize the url of the author page at /blog/authors/<permalink>
-    permalink: '/all-sebastien-lorber-articles'
-  socials:
-    x: sebastienlorber
-    linkedin: sebastienlorber
-    github: slorber
-    newsletter: https://thisweekinreact.com
+    x: mahal0z
+    github: mahaloz
diff --git a/blog/tags.yml b/blog/tags.yml
@@ -1,19 +1,4 @@
-facebook:
-  label: Facebook
-  permalink: /facebook
-  description: Facebook tag description
-
 hello:
   label: Hello
   permalink: /hello
   description: Hello tag description
-
-docusaurus:
-  label: Docusaurus
-  permalink: /docusaurus
-  description: Docusaurus tag description
-
-hola:
-  label: Hola
-  permalink: /hola
-  description: Hola tag description
diff --git a/docs/decompilers/_category_.json b/docs/decompilers/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Decompilers",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "Extra info on supported decompilers in BinSync."
+  }
+}
diff --git a/docs/decompilers/angr.md b/docs/decompilers/angr.md
@@ -0,0 +1,16 @@
+---
+sidebar_position: 5
+---
+
+# angr
+
+## Support Progress
+<!--              Func Headers,             Stack Vars,               Global Vars,                   Structs,            Enums,                    Comments-->
+
+| Operations&nbsp;&nbsp;&nbsp;&nbsp; | Function Headers&nbsp;&nbsp;&nbsp;&nbsp; | Stack Vars&nbsp;&nbsp;&nbsp;&nbsp; | Global Vars&nbsp;&nbsp;&nbsp;&nbsp; | Structs&nbsp;&nbsp;&nbsp;&nbsp; | Enums&nbsp;&nbsp;&nbsp;&nbsp; | Comments&nbsp;&nbsp;&nbsp;&nbsp; |
+|-----------	|--------------------	|-----------------------	| --------------------	|--------------------	|--------------------	|--------------------	|
+| Symbols   	| :heavy_check_mark: 	| :heavy_check_mark:    	| :x: 					| :x: 					| :x: 					| :heavy_check_mark: 	|
+| Types     	| :heavy_check_mark: 	| :heavy_check_mark:    	| :x: 					| :x: 					| :x: 					| :heavy_check_mark: 	|
+| Pull      	| :heavy_check_mark: 	| :heavy_check_mark:    	| :x: 					| :x: 					| :x: 					| :heavy_check_mark: 	|
+| Push      	| :heavy_check_mark:    | :heavy_check_mark:		| :x:					| :x:					| :x: 					| :heavy_check_mark: 					|
+| Auto Push 	| :heavy_check_mark:    | :heavy_check_mark:		| :x:					| :x:					| :x: 					| :heavy_check_mark: 					|
diff --git a/docs/decompilers/binja.md b/docs/decompilers/binja.md
@@ -0,0 +1,23 @@
+---
+sidebar_position: 4
+---
+
+# Binary Ninja
+
+## Extra Install Steps
+Since Binja may be running a custom Python interpreter, please manually set or verify that your Python
+for Binja is set to the same python as `python3` in your terminal. To do that:
+1. Open Binja
+2. Click `Settings->Python`
+3. Select the correct Python interpreter for `Python Interpreter`
+4. Restart Binja
+
+## Support Progress
+
+| Operations&nbsp;&nbsp;&nbsp;&nbsp; | Function Headers&nbsp;&nbsp;&nbsp;&nbsp; | Stack Vars&nbsp;&nbsp;&nbsp;&nbsp; | Global Vars&nbsp;&nbsp;&nbsp;&nbsp; | Structs&nbsp;&nbsp;&nbsp;&nbsp; | Enums&nbsp;&nbsp;&nbsp;&nbsp; | Comments&nbsp;&nbsp;&nbsp;&nbsp; |
+|------------------------------------|------------------------------------------|------------------------------------|-------------------------------------|---------------------------------|-------------------------------|----------------------------------|
+| Symbols   	                        | :heavy_check_mark: 	                     | :heavy_check_mark:    	            | :heavy_check_mark: 					            | :heavy_check_mark:   					      | :heavy_check_mark: 					      | :heavy_check_mark: 	             |
+| Types     	                        | :heavy_check_mark: 	                     | :heavy_check_mark:    	            | :heavy_check_mark: 					            | :heavy_check_mark:   					      | :heavy_check_mark: 					      | :heavy_check_mark: 	             |
+| Pull      	                        | :heavy_check_mark: 	                     | :heavy_check_mark:    	            | :heavy_check_mark: 					            | :heavy_check_mark:   					      | :heavy_check_mark: 					      | :heavy_check_mark: 	             |
+| Push      	                        | :heavy_check_mark:                       | :heavy_check_mark:		               | :heavy_check_mark:					             | :heavy_check_mark:			           | :heavy_check_mark: 					      | :heavy_check_mark: 					         |
+| Auto Push 	                        | :heavy_check_mark:                       | :heavy_check_mark:		               | :heavy_check_mark:					             | :heavy_check_mark:			           | :heavy_check_mark: 					      | :heavy_check_mark: 					         |
diff --git a/docs/decompilers/dec-introduction.md b/docs/decompilers/dec-introduction.md
@@ -0,0 +1,25 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+BinSync supports all the decompilers shown in this section, but not every decompiler is supported to the same level. 
+In each decompiler section, you will find a table with support progress. The support operations are as follows:
+
+- **Symbols**: the literal name of the artifact is supported for either pulling or pushing. This would be names for things
+like stack vars and function headers
+
+- **Types**: artifact types, including user created types, are supported for either pulling or pushing. This would be the
+C-type associated to the artifact. In stack vars this could be something like `int[32]`. In function headers it's the return type.
+
+- **Pull**: though a user does not request BinSync to pull, this operation refers to the ability to bring changes into your 
+decompiler given a BS repo. As an example, pull support allows you to take changes from a BinSync project set by another user,
+but you may not be able to push changes.
+
+- **Push**: though a user does not request BinSync to push, this operation refers to the ability to take changes from your decompiler
+and save them to a BS project. As an example, push support allows you to change the name of a function in your decompiler, which would then
+save that change into your BinSync project. This push level requires users to request the push. 
+
+- **Auto Push**: this operation is an upgraded option of the _push_ operation. This support means your decompiler can detect when you make
+changes to an artifact locally and automatically can stage and push these changes without the user asking to push. 
diff --git a/docs/decompilers/ghidra.md b/docs/decompilers/ghidra.md
@@ -0,0 +1,24 @@
+---
+sidebar_position: 3
+---
+
+# Ghidra
+
+## Extra Info
+BinSync is written in Python 3, however, Ghidra only has a Python 2 backend. 
+To deal with this, we use a vendored version of [ghidra_bridge](https://github.com/justfoxing/ghidra_bridge).
+We copy a BinSync stub, along with Ghidra Bridge code, into the `ghidra_scripts` folder, which is Python 2. 
+Inside Ghidra, when you start BinSync, we use the Python 2 side to start the Python 3 GUI in another thread. 
+We use Ghidra Bridge to make change requests to the Ghidra UI.
+
+## Support Progress
+
+| Operations&nbsp;&nbsp;&nbsp;&nbsp; | Function Headers&nbsp;&nbsp;&nbsp;&nbsp; | Stack Vars&nbsp;&nbsp;&nbsp;&nbsp; | Global Vars&nbsp;&nbsp;&nbsp;&nbsp; | Structs&nbsp;&nbsp;&nbsp;&nbsp; | Enums&nbsp;&nbsp;&nbsp;&nbsp; | Comments&nbsp;&nbsp;&nbsp;&nbsp; |
+|------------------------------------|------------------------------------------|------------------------------------|-------------------------------------|---------------------------------|-------------------------------|----------------------------------|
+| Symbols   	                        | :heavy_check_mark: 	                     | :heavy_check_mark:    	            | :heavy_check_mark: 					            | :heavy_check_mark: 	 					      | :x: 					                     | :heavy_check_mark: 	             |
+| Types     	                        | :heavy_check_mark: 	                     | :heavy_check_mark:    	            | :heavy_check_mark: 					            | :heavy_check_mark: 	 					      | :x: 					                     | :heavy_check_mark: 	             |
+| Pull      	                        | :heavy_check_mark: 	                     | :heavy_check_mark:    	            | :heavy_check_mark:					             | :x: 					                       | :x: 					                     | :heavy_check_mark: 	             |
+| Push      	                        | :heavy_check_mark: 					                 | :heavy_check_mark:						           | :heavy_check_mark:				              | :heavy_check_mark: 						       | :x: 					                     | :x: 					                        |
+| Auto Push 	                        | :x: 					                                | :x:						                          | :x:					                            | :x:					                        | :x: 					                     | :x: 					                        |
+
+
diff --git a/docs/decompilers/ida.md b/docs/decompilers/ida.md
@@ -0,0 +1,17 @@
+---
+sidebar_position: 2
+---
+
+# IDA Pro
+
+
+## Support Progress
+<!--              Func Headers,             Stack Vars,               Global Vars,          Structs,            Enums,                    Comments-->
+
+| Operations&nbsp;&nbsp;&nbsp;&nbsp; | Function Headers&nbsp;&nbsp;&nbsp;&nbsp; | Stack Vars&nbsp;&nbsp;&nbsp;&nbsp; | Global Vars&nbsp;&nbsp;&nbsp;&nbsp; | Structs&nbsp;&nbsp;&nbsp;&nbsp; | Enums&nbsp;&nbsp;&nbsp;&nbsp; | Comments&nbsp;&nbsp;&nbsp;&nbsp; |
+|-----------	|--------------------	|-----------------------	| --------------------  |--------------------	|--------------------	|--------------------	|
+| Symbols   	| :heavy_check_mark: 	| :heavy_check_mark:    	| :heavy_check_mark: 	| :heavy_check_mark: 	| :heavy_check_mark: 	| :heavy_check_mark: 	|
+| Types     	| :heavy_check_mark: 	| :heavy_check_mark:    	| :heavy_check_mark: 	| :heavy_check_mark: 	| :heavy_check_mark: 	| :heavy_check_mark: 	|
+| Pull      	| :heavy_check_mark: 	| :heavy_check_mark:    	| :heavy_check_mark: 	| :heavy_check_mark: 	| :heavy_check_mark: 	| :heavy_check_mark: 	|
+| Push      	| :heavy_check_mark: 	| :heavy_check_mark: 	    | :heavy_check_mark: 	| :heavy_check_mark: 	| :heavy_check_mark: 	| :heavy_check_mark: 	|
+| Auto Push     | :heavy_check_mark: 	| :heavy_check_mark:    	| :heavy_check_mark: 	| :heavy_check_mark: 	| :heavy_check_mark: 	| :heavy_check_mark: 	|
diff --git a/docs/hacking/_category_.json b/docs/hacking/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Hacking",
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "description": "Learn how to modify and fix BinSync."
+  }
+}
diff --git a/docs/hacking/add-decompiler.md b/docs/hacking/add-decompiler.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 2
+---
+
+# Adding a Decompiler
+
+Work in progress...