/ README.md
README.md
 1  # CCHmacLogger
 2  
 3  > A cute tweak to log CCHmac functions in iOS apps.
 4  
 5  ## Supported functions
 6  
 7  - `CCHmac`
 8  - `CCHmacInit`
 9  - `CCHmacUpdate`
10  - `CCHmacFinal`
11  
12  Inputs, outputs and key are logged in the file to help you debug the HMAC functions.
13  
14  ## Usage
15  
16  ```bash
17  make package
18  mv .theos/obj/debug/CCHmacLogger.dylib .
19  ```
20  
21  Now you have `CCHmacLogger.dylib` in the current directory.
22  Inject the `dylib` using any tool you want, for me it'll be **Sideloadly**.
23  
24  Open Sideloadly, open any `.ipa` file, go into Advanced Options and in the "Signing Mode" section, select "Export IPA".
25  Next, in the "Tweak injection" section, select "Inject dylibs/frameworks" and add a "dylib/deb/bundle" and select the `CCHmacLogger.dylib` file you just compiled.
26  Start the injection process and you're good to go.
27  
28  ## Where to find the logs?
29  
30  The logs are stored in `/path/to/app/data/Documents/CCHmacLogger.log` directory.
31  
32  ## Contributing
33  
34  Feel free to contribute to this project by opening an issue or a pull request.
35  I would love to hear suggestions to improve this tweak - since it's my first tweak, I'm sure there are a lot of things that can be improved.
36  
37  ## License
38  
39  This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.