Skip to content

Commit 73ce284

Browse files
committed
Edit readme re: wiki creation
1 parent 2d8d301 commit 73ce284

File tree

1 file changed

+3
-55
lines changed

1 file changed

+3
-55
lines changed

readme.md

Lines changed: 3 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ As of current date, the tool is focused around testing the [Precision Feedback P
88
API, but more APIs can be configured as targets in future releases.
99

1010
Continue reading for details on making use of LDT to test APIs.
11+
1112
# Leakdown Tester User Manual
13+
Here are listed the currently implemented user commands, environmental variables, and instructions for use.
1214
## Environmental Variables
1315
1) `CSVPATH` - Filepath to a local CSV file.
1416
The script checks for this on startup, as JSON content to send as a POST request is currently required. You can specify this filepath with the csv argument, or you can set the env var and specify a different filepath with the csv argument which will override the environment variable. A filepath must be specified if not using the `useGit` argument.
@@ -119,58 +121,4 @@ Options for configuring the JSON payload pulled from a user-specified CSV file.
119121
`--servAcc` `string`
120122
- Default: None
121123
- Enter the filepath to the Service Account file used to read from for OAuth2.0 authenticating POST requests to IAP-protected APIs.
122-
- When specified, overwrites 'SAPATH' environmental variable.
123-
124-
125-
## Setup
126-
1) Download the entire Leakdown Testing folder from this Github repository (use a git clone or manual download)
127-
2) Find the folder in your file browser
128-
3) That's all! (for now...)
129-
130-
### Setting up Environment Variables
131-
Env Var declaration is OS dependent, and can be rather meddlesome, so detailed instructions are below for the novice to command line tools and using shells.
132-
For my windows warriors:
133-
- Use this to set a temporary env var in this command prompt instance only:
134-
```shell
135-
set VARNAME="content"
136-
```
137-
- With admin priviledges, you can set a **persistant** env var:
138-
```shell
139-
setx VARNAME "content"
140-
```
141-
Verify the changes took, which might require reloading your command prompt. Check with the following:
142-
```shell
143-
echo $ENV:VARNAME
144-
```
145-
Verify that it reads back correctly.
146-
147-
---
148-
Mac users, you can do pretty much the same thing by a different method:
149-
```bash
150-
export VARNAME=content
151-
```
152-
There is a way to make it persist, though it requires changing the config of your shell, which should be somwhere like `/bin/bash`, etc.
153-
Use:
154-
```bash
155-
echo $SHELL
156-
```
157-
Then we edit the profile of your terminal of choice (generally zsh or bash, directions below are for bash):
158-
```zsh
159-
nano ~/.bash_profile
160-
export export VARNAME=/content/you/want
161-
```
162-
Then reload your console, you can use a console prompt for that:
163-
```bash
164-
source ~/.bash_profile
165-
```
166-
Whatever works for you!
167-
## Setting up Google Cloud Authentication
168-
1) Contact the developers to get access to the client secret details (service account and target audience)
169-
2) Create your service account file
170-
- Make sure to save it as a .json file, with the proper encoding
171-
- Copy the file as a path with right click, or any way you like.
172-
3) Set your SAPATH environmental variable
173-
- Use the guidance in the above section on setting env vars if you get confused
174-
- Set SAPATH to "path\to\service_acccount_details.json"
175-
4) Set your TARGET_AUDIENCE environmental variable
176-
- Using the target audience string you recieved by asking for it from someone who knows it, set the env var TARGET_AUDIENCE to "target audience string details"
124+
- When specified, overwrites 'SAPATH' environmental variable.

0 commit comments

Comments
 (0)