diff --git a/docs/src/usage/index.md b/docs/src/usage/index.md index ce08de2..1031492 100644 --- a/docs/src/usage/index.md +++ b/docs/src/usage/index.md @@ -13,3 +13,16 @@ I am not going to provide you with a ton of awesome scripts that will leverage t That is on you. With that in mind, I would highly recommend you become familiar with the [Plugins](./plugins/index.md) provided and apply your own ingenuity to come up with your own scripts. + +## Authentication + +The first time you try to do anything which requires authentication, you will be automatically prompted for your credentials. +This prompt will expect the `Synack Email` and `Synack Password`, which are fairly self explanitory, but it also asks for the `Synack OTP Secret`. + +The `Synack OTP Secret` is NOT the 8 digit code you pull out of Authy. +Instead, it is a string that you must extract from Authy via a method similar to the one found [here](https://gist.github.com/gboudreau/94bb0c11a6209c82418d01a59d958c93). + +Use the above instructions at your own discression. +I TAKE NO RESPONSIBILITY IF SOMETHING BAD HAPPENS AS A RESULT. + +Once you complete these steps, your credentials are stored in a SQLiteDB at `~/.config/synack/synackapi.db`.