Skip to content

Commit bb298c7

Browse files
author
Laegel
authored
fix: kamikaze=>lockdown,whitelist=>permlist (tauri-apps#97)
1 parent d168462 commit bb298c7

File tree

16 files changed

+22
-409
lines changed

16 files changed

+22
-409
lines changed

docs/about/book.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ This is an early outline of the contents that we expect to publish. Contents sub
253253
- Bridge
254254
- Cloudish
255255
- Cloudbridge
256-
- Kamikaze
256+
- Lockdown
257257
- Multiwin
258258
- GLUI
259259
2. Advanced Patterns

docs/about/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Hashing important messages with a OTP salt, you are able to encrypt messages bet
5353

5454
## System Features
5555

56-
### API Whitelisting
56+
### Allowing API
5757

5858
You have the ability to pick and choose which API functions are available to the UI and to Rust. If they are not enabled, the code will not be shipped with your app, which reduces binary size and attack surface. They are opt-in, so you have to consciously choose to progressively enhance your application.
5959

docs/api/config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,8 +178,8 @@ It's composed of the following properties:
178178
]} />
179179
},
180180
{
181-
property: "whitelist", type: "object",
182-
child: <Properties anchorRoot="tauri.whitelist" rows={[
181+
property: "permlist", type: "object",
182+
child: <Properties anchorRoot="tauri.permlist" rows={[
183183
{ property: "all", type: "boolean", description: `Use this flag to enable all API features.` },
184184
{ property: "createDir", optional: true, type: "boolean", description: `Copy file from local filesystem.` },
185185
{ property: "copyFile", optional: true, type: "boolean", description: `Create directory from local filesystem.` },
@@ -303,7 +303,7 @@ Instead of launching the app directly, we configure the bundled app to run a scr
303303
},
304304
"exceptionDomain": ""
305305
},
306-
"whitelist": {
306+
"permlist": {
307307
"all": true
308308
},
309309
"window": {

docs/api/js.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import Alert from '@theme/Alert'
77

88
Here is the JS API, exposed by the <a href="https://www.npmjs.com/package/tauri" target="_blank">Tauri package</a> in the "api" directory.
99

10-
Note that you can either enable or disable these APIs in your [tauri.conf.json](/docs/api/config). Please refer to the "whitelist" section.
10+
Note that you can either enable or disable these APIs in your [tauri.conf.json](/docs/api/config). Please refer to the "permlist" section.
1111

1212
If you haven't done it so far, add the package _locally_ to your project:
1313

docs/getting-started/setup-windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Download and install the proper variant for your computer's architecture.
6060

6161
## 4. Enable Loopback&nbsp;<Icon title="control-skip-forward" color="warning"/>
6262

63-
Microsoft disables the loopback interface - you need to whitelist it if you intend to use the dev-server:
63+
Microsoft disables the loopback interface - you need to allow it if you intend to use the dev-server:
6464

6565
Open an administrative console and enter:
6666

docs/usage/detailed-flow.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ $ tauri dev
5858
Runner.run:
5959
-> get paths
6060
-> inline assets if needed
61-
-> transform tauri.conf.js:conf.whitelist to toml
62-
-> manipulate Cargo.toml for API whitelist features
61+
-> transform tauri.conf.js:conf.permlist to toml
62+
-> manipulate Cargo.toml for API allow features
6363
-> start chokidar filewatcher (to restart dev-service on changes)
6464
-> spawn cargo run with dev-server arg (if needed ?)
6565
cargo run -features [dev-server]
@@ -96,8 +96,8 @@ $ tauri build
9696
Runner.build:
9797
-> get paths
9898
-> inline assets if needed
99-
-> transform tauri.conf.js:conf.whitelist to toml
100-
-> manipulate Cargo.toml for API whitelist features
99+
-> transform tauri.conf.js:conf.permlist to toml
100+
-> manipulate Cargo.toml for API allow features
101101
-> spawns cargo 'module' `tauri-cli` (using /cli/tauri.js/helpers/spawn.js)
102102
- feature 'embedded-server' : 'no-server'
103103
- --release (or debug)

docs/usage/patterns/bridge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Here's what you need to add to your tauri.conf.json file:
8787
"embeddedServer": {
8888
"active": false // do not use a localhost server
8989
},
90-
"whitelist": { // all whitelist values are default false
90+
"permlist": { // all API values are default false
9191
"all": false, // use this flag to enable all API features
9292
"answer": true, // enable rust to direct the UI
9393
"event": true, // enable binding to message

docs/usage/patterns/cloudbridge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Here's what you need to add to your tauri.conf.json file:
9999
"embeddedServer": {
100100
"active": true // ship with a localhost server
101101
},
102-
"whitelist": {
102+
"permlist": {
103103
"all": true // enable entire API
104104
}
105105
}

docs/usage/patterns/cloudish.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Here's what you need to add to your tauri.conf.json file:
8585
"embeddedServer": {
8686
"active": true // ship with a localhost server
8787
},
88-
"whitelist": {
88+
"permlist": {
8989
"all": false // disable entire API
9090
}
9191
}

docs/usage/patterns/glui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Here's what you need to add to your tauri.conf.json file:
8484
"embeddedServer": {
8585
"active": false // do not use a localhost server
8686
},
87-
"whitelist": { // all API endpoints are default false
87+
"permlist": { // all API endpoints are default false
8888
"all": false, // disable the api
8989
},
9090
"window": { // not yet normative

0 commit comments

Comments
 (0)