Sfoglia il codice sorgente

Add readme and license to amiitool in lib folder

Eric Betts 8 mesi fa
parent
commit
477b14225f
2 ha cambiato i file con 50 aggiunte e 0 eliminazioni
  1. 21 0
      lib/amiitool/LICENSE
  2. 29 0
      lib/amiitool/README.md

+ 21 - 0
lib/amiitool/LICENSE

@@ -0,0 +1,21 @@
+(c) 2015-2017 Marcos Del Sol Vives
+(c) 2016      javiMaD
+(c) 2016      Michael Armbruster
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

+ 29 - 0
lib/amiitool/README.md

@@ -0,0 +1,29 @@
+amiitool
+========
+amiibo™ encryption/decryption/copy tool
+
+Usage
+=====
+**amiitool expects a binary dump. It will not work with XMLs or hexadecimal text files**. Aside from this, amiitool is very easy to use and has a very simple syntax.
+
+First, you have to specify an operation, either ```-e``` (encrypt and sign), ```-d``` (decrypt and check), ```-c``` (2 decrypt and check, copy appdata, encrypt)
+
+You need also to specify a file using ```-k [keys]``` switch, indicating which file contains the cryptographic master keys. The key is the concatenation of unfixed infos and locked secret keys.
+
+Optionally, you may also specify input and output files using ```-i [input]``` and ```-o [output]```. If input or output are unspecified, amiitool will default to stdin and stdout, respectively. This lets you pipe amiitool inputs and outputs with standard shell tools such as xxd.
+
+When decrypting, by default amiitool will be in strict mode, and will abort and raise an error if the cryptographic signature embedded in the encrypted dump is not valid. If you want to disable checking, use ```-l``` switch to put amiitool in lenient mode.
+
+The copy function permit to copy saved data from one amiibo™ to another one.
+
+Examples
+--------
+
+- Decryption "mario.bin" and displaying hex to terminal:
+   > amiitool -d -k retail.bin -i "mario.bin" | xxd
+
+- Encryption "modified.bin" to "signed.bin":
+   > amiitool -e -k retail.bin -i "modified.bin" -o "signed.bin"
+
+- Copy "mario2.bin" Saves (AppData) into "mario1.bin" and save to "mario3.bin"
+  > amiitool -c -k retail.bin -i "mario1.bin" -s "mario2.bin" -o "mario3.bin"