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
Copy file name to clipboardExpand all lines: docs/guide/drivers/Crypt.md
+39-42Lines changed: 39 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,64 +22,60 @@ star: true
22
22
23
23
What is `Crypt`?
24
24
25
-
It is equivalent to a two -layer password -encrypted safe. No one else can be opened except you have the key to open it. The password and salt value in the configuration are equivalent to the key
25
+
In simple words, it's a two-password-protected safe. No one can be open it without the key. The password and salt value in the configuration form the key.
26
26
27
-
Of course, you have to remember the password and salt value. If you lose it yourself, you can't open it yourself, unless you are poor or guess the correct password.
27
+
::: Tips
28
28
29
-
::: tip Use reminder
29
+
1. If you don’t know how to use this encryption/decryption driver, please read this guide carefully
30
+
2. Please test it locally to understand it before use it in the production environment.
31
+
3. The data loss is 100% caused by configuration change. If data has been stored within Crypt, change configuration won't re-encrypt data!
30
32
31
-
1. If you don’t know how to use this plus/decryption driver, please check carefully each text
32
-
2. Please use it locally to understand and then move to the production environment to deploy and use it, otherwise the data will be lost!
33
-
3. The data loss is 100%because the configuration file is modified. If the file has been uploaded, please do not modify the configuration file, otherwise the data will be lost!
34
-
35
-
==Remind again, please read the document carefully, otherwise the data will be lost and bear the loss！==
33
+
==Remind again, please read the document carefully, otherwise the data will be lost！==
36
34
37
35
:::
38
36
39
37
40
38
41
-
## **Instructions for use**
39
+
## **Instruction**
42
40
43
-
We only need to build a new **blank folder** in the driver (network disk) that has been mounted now.
41
+
We need to build a new **empty folder** in the driver (network disk) that has been mounted now.
44
42
45
-
Then fill in the name of our new blank folder to the `Remote path``Crypt`drive configuration
43
+
Then fill in the name of our new empty folder to the `Remote path``Crypt`driver configuration
46
44
47
45
E.g:
48
46
49
-
- Our original driving path was `/123`, we built a new `air`blank folder in the 123 directory
50
-
-We are going to `Remote Path`options driven by`Crypt`,Fill in`/123/air`
51
-
- To encrypt files, you need to upload them to the newly created "Crypt" drive. Encryption will only be applied when files are uploaded to this drive.
52
-
-Crypto files We go to**`remote path`**can see the encrypted file, unable to open it normally
53
-
- If you want to open it, you need to view it at the `Crypt`Drive Folder
47
+
- Our original driving path was `/123`, we built a new `air`empty folder in the '123' directory
48
+
-Fill `Remote Path`option in `Crypt` config page with`/123/air`
49
+
- To encrypt files, you need to upload them to the newly created "Crypt" drive. Encryption will only be applied when files are uploaded to this driver.
50
+
-Encrypted files are stored in**`remote path`**, and they can't be opened normally due to the encryption
51
+
- If you want to open them, you need to view them in the `Crypt`Driver Folder
54
52
55
53
56
54
57
55
58
-
## **Fill in the example**
56
+
## **Config Example**
59
57
60
-
If you do n’t know how to configure, you can use the simpler default configuration as follows. The role of each configuration will be explained in detail below
58
+
If you don’t know how to configure, you can use the simpler default configuration as follows. The role of each configuration will be explained in detail below
:::danger Please read the precautions carefully --- very important
67
65
68
-
State again, please do not think you are
69
-
70
-
Once the configuration is filled in storage, do not modify it, do not modify it, do not modify it! Emphasized things three times
66
+
Once the configuration is filled and started using, do not modify it, do not modify it, do not modify it!
71
67
72
-
[**Password**](#password) 和 [**Salt**](#salt)Must remember，After clicking, these two options will be encrypted and unable to display (the text above shows that it has not been stored)
68
+
[**Password**](#password) 和 [**Salt**](#salt)Keep in mind，after saving config, these two options will be encrypted and can't be reveled (the text above shows that it has not been stored)
73
69
74
-
-**If you forget the password before uploading the file, you can modify and fill in the password configuration**
70
+
-**If you forget the password before uploading any file, you can modify and re-fill in the password configuration**
75
71
76
72
-----
77
73
78
74
If you have not uploaded files in the Crypt drive, you can modify the configuration, otherwise do not modify it!!!
79
75
80
-
Because different encryption methods will appear in different configuration methods, `Crypt` will not display (filtering) illegal files
76
+
If you have data in Crypt, and changed the configuration, `Crypt` will try to filter out illegal files/folders, but the illegal data still exist in the remote storage
81
77
82
-
-**Illegal files are encrypted files generated by different configurations and no encryption files**
78
+
-**Illegal means data that is encrypted by another config**
83
79
84
80
:::
85
81
@@ -88,11 +84,11 @@ Because different encryption methods will appear in different configuration meth
88
84
There are 5 methods for the encryption combination, (in fact 6 types) Because only the **folder encryption is turned on, the file name is not encrypted** and the configuration does not take effect (the first one of the example below)
@@ -111,11 +107,11 @@ If you don’t understand, you can use the default configuration
111
107
- Standard encryption safety level high^(recommended)^
112
108
113
109
- 3.**Simple Obfuscate**
114
-
- The security level is very low, and the name of the long file is friendly, but for the Chinese file name, special characters will be generated. Some network disk storage does not support special characters.
110
+
- The security level is very low, but friendly to long file name. Note: for the Chinese file name, special characters will be generated. Some network disk storage may not support them
115
111
116
112
- The left side of the figure below is encrypted [**Remote path**](#remote-path)，On the right is the decrypted 'crypt` driver to view the file
117
-
- If not open<Badgetext="Filename"type="tip"vertical="middle" />encryption，It will be displayed<Badgetext="Upper left corner"color="rgb(216,100,69)"vertical="middle" /> A new encrypted suffix is added behind the source file（xxxxx\.xxx **.bin** ）(The suffix name can be customized, not necessarily .bin)
118
-
- If you open<Badgetext="Filename"type="tip"vertical="middle" />encryption，It will be displayed<Badgetext="Lower left corner"color="rgb(78,130,184)"vertical="middle" />In this way, the file name is also confused with encryption, no suffix and the original file name，Others can't know what it is, but it can be driven by`crypt`（<Badgetext="The folder displayed on the right"color="rgb(0.0.0.0)"vertical="middle" />）View the complete decryption and transparent file name
113
+
- If not enabled <Badgetext="Filename"type="tip"vertical="middle" />encryption，It will be like <Badgetext="Upper left corner pic"color="rgb(216,100,69)"vertical="middle" /> A new encrypted suffix is added behind the source file（xxxxx\.xxx **.bin** ）(The suffix name can be customized)
114
+
- If you enabled <Badgetext="Filename"type="tip"vertical="middle" />encryption，It will be like <Badgetext="Lower left corner pic"color="rgb(78,130,184)"vertical="middle" />In this way, the file name is also confused with encryption, no suffix and the original file name，others can't know what it is, but it can be viewed in`crypt`（<Badgetext="The folder displayed on the right"color="rgb(0.0.0.0)"vertical="middle" />）
@@ -125,13 +121,13 @@ If you don’t understand, you can use the default configuration
125
121
126
122
### <iclass="fa-solid fa-folder-open"style="color: #409eff;"></i> **Directory name encryption**
127
123
128
-
Use the enable folder to encrypt, the default `false` is not enabled, if you don’t understand, you can choose not to use it
124
+
default is `false`, i.e disabled. don't use it if you don't understand below description
129
125
130
-
When you turn on the folder encryption, you must select a **filename encryption**. Otherwise, the folder encryption will not take effect
126
+
When you turn on the folder encryption, you must select a **filename encryption** type. Otherwise, the folder encryption will not take effect
131
127
132
128
- The left side of the figure below is encrypted [**Remote path**](#remote-path)，On the right is the decrypted 'crypt` driver to view the file
133
-
- If not open<Badgetext="Directory"type="tip"vertical="middle" />encryption，It will be displayed<Badgetext="Upper left corner"color="rgb(216,100,69)"vertical="middle" />That kind of folder without any change
134
-
- If you open<Badgetext="Directory"type="tip"vertical="middle" />encryption，It will be displayed<Badgetext="Lower left corner"color="rgb(78,130,184)"vertical="middle" />In that way, the folder name is also confused by encryption
129
+
- If disabled <Badgetext="Directory"type="tip"vertical="middle" />encryption，It will be like<Badgetext="Upper left corner pic"color="rgb(216,100,69)"vertical="middle" /> No change to folder name
130
+
- If enabled <Badgetext="Directory"type="tip"vertical="middle" />encryption，It will be displayed<Badgetext="Lower left corner pic"color="rgb(78,130,184)"vertical="middle" />folder name is encrypted
It can be treated as the second password if you don't understand it
157
153
158
154
<br/>
159
155
@@ -163,9 +159,7 @@ It can also be understood as the second password
163
159
164
160
The default is `.bin`, the custom must start with` .`, such as .abc .aaa .Psd.
165
161
166
-
If the file name is encrypted, the encryption suffix `will not be displayed (but still have to be configured)
167
-
168
-
- The high -level gameplay is to manually change the suffix to the suffix in the configuration file to display the access (provided that it is consistent with the **`password`** and **`Salt`** when encrypted
162
+
If the file name is encrypted, the encryption suffix `will not be used
169
163
170
164
<br/>
171
165
@@ -175,8 +169,11 @@ If the file name is encrypted, the encryption suffix `will not be displayed (but
175
169
176
170
Advanced usage is only applicable to those who know about **`rclone`**
177
171
178
-
If you know the **`rclone`** very well, you can view :point_right:[**rclone crypt document **] (https://rclont.org/crypt) Currently, completely compatible
172
+
If you know the **`rclone`** very well, you can check :point_right:[**rclone crypt document **](https://rclone.org/crypt) Currently fully compatible
173
+
174
+
Note: `Alist Crypt` used `filename_encoding = base64` in default. If you want to use Rclone, please config it in the advanced config. (Reason: more friendly to long filename)
179
175
176
+
since Alist does not consider any case-insensitive internally, you may encounter problems when remote storage is case-insensitive. e.g.: use alist local driver on Windows, then use Crypt on it.
0 commit comments