You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
CloudFuzz is a command-line tool for easily running cloud-based fuzzing jobs on DigitalOcean. Start, manage and pull the results of fuzzing jobs from your terminal.
3
+
CloudExec is a command-line tool for easily running cloud-based jobs on DigitalOcean. Start, manage and pull the results of jobs from your terminal.
4
4
5
5
## Getting Started
6
6
@@ -10,57 +10,57 @@ CloudFuzz is a command-line tool for easily running cloud-based fuzzing jobs on
10
10
11
11
```bash
12
12
brew tap trailofbits/tools
13
-
brew install cloudfuzz
13
+
brew install cloudexec
14
14
```
15
15
16
16
#### Upgrade with Brew
17
17
18
18
```bash
19
-
brew update && brew upgrade cloudfuzz
19
+
brew update && brew upgrade cloudexec
20
20
```
21
21
22
22
alternatively, you can install from a GitHub release:
23
23
24
24
### Install from a GitHub release
25
25
26
-
Download the latest release for your platform from the [releases page](https://github.com/trailofbits/cloudfuzz/releases).
26
+
Download the latest release for your platform from the [releases page](https://github.com/crytic/cloudexec/releases).
27
27
28
28
#### Release verification
29
29
30
30
Releases are signed with sigstore. You can verify using [`cosign`](https://github.com/sigstore/cosign) with the following example command:
Running the command below will build the CLI tool from source with a binary named `cloudfuzz` in a `dist` folder:
49
+
Running the command below will build the CLI tool from source with a binary named `cloudexec` in a `dist` folder:
50
50
51
51
```bash
52
52
make build
53
53
```
54
54
55
-
Then, move the resulting binary from `./dist/cloufuzz` into your `PATH`.
55
+
Then, move the resulting binary from `./dist/clouexec` into your `PATH`.
56
56
57
-
Nix users can run `nix build` and then `nix profile install ./result` to install `cloudfuzz`. A helper command `make nix-install` is available which performs these steps for you and also upgrades an existing version of `cloudfuzz` that might already be installed.
57
+
Nix users can run `nix build` and then `nix profile install ./result` to install `cloudexec`. A helper command `make nix-install` is available which performs these steps for you and also upgrades an existing version of `cloudexec` that might already be installed.
58
58
59
59
### Configure credentials
60
60
61
-
CloudFuzz requires DigitalOcean API credentials to manage droplets, and Spaces credentials to store state and job data. The recommended method for storing and providing your credentials securely is by using the 1Password CLI.
61
+
CloudExec requires DigitalOcean API credentials to manage droplets, and Spaces credentials to store state and job data. The recommended method for storing and providing your credentials securely is by using the 1Password CLI.
62
62
63
-
CloudFuzz supports natively integrating with 1Password, allowing you to reference your credentials stored in your 1Password vault. However, you can also choose to provide plaintext credentials using the `cloudfuzz configure` command. Additionally, you can override individual values or the entire configuration by setting the corresponding environment variables.
63
+
CloudExec supports natively integrating with 1Password, allowing you to reference your credentials stored in your 1Password vault. However, you can also choose to provide plaintext credentials using the `cloudexec configure` command. Additionally, you can override individual values or the entire configuration by setting the corresponding environment variables.
64
64
65
65
#### Get credentials from DigitalOcean
66
66
@@ -82,14 +82,14 @@ brew install --cask 1password/tap/1password-cli # see the link above for install
82
82
eval$(op signin)
83
83
```
84
84
85
-
Note what your [1Password secret references](https://developer.1password.com/docs/cli/secret-references/) are and use them in place of your actual secret values during the `cloudfuzz configure` or env var setup steps described in the next section.
85
+
Note what your [1Password secret references](https://developer.1password.com/docs/cli/secret-references/) are and use them in place of your actual secret values during the `cloudexec configure` or env var setup steps described in the next section.
86
86
87
87
These references generally follow the format: `op://<vault-name>/<item-name>/<field-name>`. For example, if you saved your keys to a vault called `Private`, in an item called `DigitalOcean` and the api key field is called `ApiKey`, then the secret reference to use is `op://Private/DigitalOcean/ApiKey`.
88
88
89
-
#### Configure CloudFuzz
89
+
#### Configure CloudExec
90
90
91
91
```bash
92
-
cloudfuzz configure
92
+
cloudexec configure
93
93
```
94
94
95
95
or set environment variables:
@@ -103,95 +103,95 @@ DIGITALOCEAN_SPACES_REGION
103
103
104
104
Remember, if you save secret values to a `.env` file, never commit it to any version control system. Add such `.env` files to your project's `.gitignore` file to help prevent making such mistakes.
105
105
106
-
### Check CloudFuzz access
106
+
### Check CloudExec access
107
107
108
-
Confirm `cloudfuzz` has access to DigitalOcean.
108
+
Confirm `cloudexec` has access to DigitalOcean.
109
109
110
110
```bash
111
-
cloudfuzz check
111
+
cloudexec check
112
112
```
113
113
114
-
### Initialize your CloudFuzz environment
114
+
### Initialize your CloudExec environment
115
115
116
116
```bash
117
-
cloudfuzz init
117
+
cloudexec init
118
118
```
119
119
120
-
### Launch a new remote fuzzing job
120
+
### Launch a new remote job
121
121
122
-
Generate a cloudfuzz.toml configuration file in the current directory.
122
+
Generate a cloudexec.toml configuration file in the current directory.
123
123
124
124
```bash
125
-
cloudfuzz launch init
125
+
cloudexec launch init
126
126
```
127
127
128
-
Update the `cloudfuzz.toml` as needed.
128
+
Update the `cloudexec.toml` as needed.
129
129
130
130
```bash
131
-
# default nyc3 region and c-2 size droplet, using a cloudfuzz.toml file in the current directory
132
-
cloudfuzz launch
131
+
# default nyc3 region and c-2 size droplet, using a cloudexec.toml file in the current directory
132
+
cloudexec launch
133
133
# custom region and droplet size
134
-
cloudfuzz launch --size c-4 --region sfo2
134
+
cloudexec launch --size c-4 --region sfo2
135
135
```
136
136
137
137
### Stream logs from the provisioning script
138
138
139
139
```bash
140
-
cloudfuzz logs
140
+
cloudexec logs
141
141
```
142
142
143
143
Note that the `logs` subcommand will continue to stream logs until you stop with ctrl-c, even after the job is finished and stops producing new logs. This is a read-only command and it is safe to kill it at any point.
144
144
145
145
### Get logs from a previous run
146
146
147
147
```bash
148
-
cloudfuzz logs --job 1
148
+
cloudexec logs --job 1
149
149
```
150
150
151
151
### Attach to the running job
152
152
153
153
```bash
154
-
cloudfuzz attach
154
+
cloudexec attach
155
155
156
156
# or
157
-
ssh -t cloudfuzz tmux attach -s cloudfuzz
157
+
ssh -t cloudexec tmux attach -s cloudexec
158
158
```
159
159
160
160
### SSH to your droplet
161
161
162
162
```bash
163
-
ssh cloudfuzz
163
+
ssh cloudexec
164
164
```
165
165
166
166
### Check on the status of your jobs
167
167
168
168
```bash
169
169
# show only runnning jobs, and the last completed job
170
-
cloudfuzz status
170
+
cloudexec status
171
171
# show all jobs
172
-
cloudfuzz status --all
172
+
cloudexec status --all
173
173
```
174
174
175
175
### Sync files from a completed job to a local path
176
176
177
177
```bash
178
178
# pull from the latest successful job
179
-
cloudfuzz pull example/output
179
+
cloudexec pull example/output
180
180
# pull from any job ID
181
-
cloudfuzz pull --job 1 example/output
181
+
cloudexec pull --job 1 example/output
182
182
183
183
```
184
184
185
185
### Cancel any in progress jobs
186
186
187
187
```bash
188
-
cloudfuzz cancel
188
+
cloudexec cancel
189
189
```
190
190
191
191
### Cleanup all bucket contents and reset state (destructive)
192
192
193
193
```bash
194
-
cloudfuzz clean
194
+
cloudexec clean
195
195
```
196
196
197
197
Note that there is often a delay while deleting files from Digital Ocean Spaces buckets.
0 commit comments