Explain code and usage in readme

This commit is contained in:
Daniel Gultsch 2016-03-28 13:01:49 +02:00
parent 5821895ae9
commit a52c874bda
1 changed files with 10 additions and 0 deletions

10
README.md Normal file
View File

@ -0,0 +1,10 @@
# ImageDownloader
When [Conversations](https://conversations.im) uploads an encrypted image with [XEP-0363: HTTP Upload](http://xmpp.org/extensions/xep-0363.html) it appends the encryption key as an anchor to the URL.
The anchor is made of 96 characters which represent 48 bytes in HEX. The first 16 bytes are the IV the last 32 bytes are the key.
The encryption mode is ```aes-gcm```. The authentcation tag of 16 bytes is appended to the file.
This Java project provides sample code on how to download and dercypt a file. Output is to stdout. Redirect to file or pipe to image viewer.
Usage: ```java -jar ImageDownloader.jar http://host.tld/path/to/file.jpg#theivandkey```