Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sandermvanvliet/protobufdecoder

A Google Protocol Buffers (Protobuf) payload decoder/analyzer
https://github.com/sandermvanvliet/protobufdecoder

dotnet dotnet-core netcore protobuf protocol-buffers reverse-engineering

Last synced: 19 days ago
JSON representation

A Google Protocol Buffers (Protobuf) payload decoder/analyzer

Awesome Lists containing this project

README 

        
# ProtobufDecoder



This application helps with analyzing [Google Protocol Buffers](https://developers.google.com/protocol-buffers) payloads where you don't have a corresponding `.proto` file.



Scenarios where you might want to use this is to inspect the result of serialization or when you need to interoperate with a system talking Protobuf but which does not provide a `.proto` file. 

It can be used for _reverse engineering_ but bear in mind that this may not be legal in your jurisdiction.



ProtobufDecoder will read and decode binary data that you capture from either a debugger or a tool like Wireshark and parses the tags from the data.

You can then analyze the payload to see which tags are present, what their types are (number, strings etc) and if there are embedded messages.



A changelog can be found [here](Changelog.md)



## Features



- List fields in the captured payload and display information on:

  - Tag index

  - Wire type

  - Contents (raw bytes, values) 

- Display the location and size of a specific tag in the binary payload (select a tag in the tree view and it highlights the bytes)

- Generate a Protobuf spec from the decoded payload (work in progress)

- Save the generated Protobuf spec to a `.proto` file

- Copy the value of a tag as a C# byte array



![animated application demo](./app-demo.gif)



## Usage



Download the latest installer from the [Releases page](https://github.com/sandermvanvliet/ProtobufDecoder/releases).



When the application starts, open a file that contains a Protobuf payload either via File -> Open or using the keyboard shortcut Ctrl + O.



Please note that at this time the ProtobufDecoder only supports the a file that contains _only_ a single raw Protobuf message. If the file contains a length prefix it will be automatically stripped (since version 0.4.0).



For the keyboard warriors: shortcut keys are available throughout the app and they are hinted in the menu items.



### Integrating with other tools



ProtobufDecoder supports opening a file directly by passing in a command line argument:



```PowerShell

C:\users\johndoe> ProtobufDecoder.Application.Wpf.exe 

```



This will start ProtobufDecoder and immediately opens the specified file. If the file does not exist or can't be opened the error will be displayed in the status bar.



## Building



Currently there is no packaged release of the application which means you will need to compile the application yourself.



1. Clone this repository

2. `cd` into the cloned directory

3. `cd src/ProtobufDecoder.Application.Wpf`

4. `dotnet run -c Release`



That will restore the necessary packages, build the application and start it.



To make running the application easier after step 3 run:



4. `dotnet publish -c Release`

5. Double-click the executable `ProtobufDecoder.Application.Wpf.exe` in the `src/ProtobufDecoder.Application.Wpf/bin/Release/net5.0-windows/publish` folder



You can create a shortcut to that executable in the Start Menu or wherever you wish.



## Todo



- [X] ~~Decode length-delimited tag values that could be strings, packed repeated values or embedded messages~~

- [ ] Generate `.proto` file from decoded payload

  - [x] ~~Single tags~~

  - [x] ~~Optional vs required tags~~

  - [ ] Nested messages **(work in progress)**

  - [ ] Length-delimited tag type hinting (is it a string or a message?) **(work in progress)**

  - [x] ~~Repeated value tags~~

- [x] ~~Package application for download~~

- [x] ~~Set up release build for git tags~~

- [ ] Load a `.proto` file and apply it to the decoded payload (to verify the `.proto` file and payload match)

- [ ] Decode groups



## License



See [LICENSE](./LICENSE).



## Acknowledgements



This application uses:



- [topas/VarintBitConverter/](https://github.com/topas/VarintBitConverter/) for Varint decoding from the Protobuf payloads. (See [VarintValue](./src/ProtobufDecoder/VarintValue.cs))

- [WPF:HexEditor](https://github.com/abbaye/WPFHexEditorControl) to display the raw payload and tag highlighting

- String detection tricks from [mildsunrise/protobuf-inspector](https://github.com/mildsunrise/protobuf-inspector)