mobiletto 1.1.8 → 1.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/README.md +56 -4
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +33 -17
  114. package/package.json +3 -2
  115. package/test/api.spec.js +319 -306
  116. package/util/logger.js +1 -1
  117. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto ir JavaScript krātuves abstrakcijas slānis ar papildu caurspīdīgu klienta puses šifrēšanu.
5
+
6
+ # Saturs
7
+ * [Kāpēc Mobiletto?](#Kāpēc-Mobiletto?)
8
+ * [Ātrais sākums](#Quick-start)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Avots](#Avots)
11
+ * [Pamata lietojums](#Basic-usage)
12
+ * [Metadati](#Metadata)
13
+ * [Alternatīvais importēšanas stils](#Alternate-import-style)
14
+ * [Kešatmiņa](#Caching)
15
+ * [Spoguļošana](#Spoguļošana)
16
+ * [Caurspīdīga šifrēšana](#Transparent-encryption)
17
+ * [Taustiņu pagriešana](#Key-rotation)
18
+ * [Draivera saskarne](#Driver-interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Lasiet to citā valodā
22
+ Šis README.md dokuments ir tulkots, izmantojot [hokeylization](https://github.com/cobbzilla/hokeylization)
23
+ **[Visas valodas, ko atbalsta Google tulkotājs](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Esmu pārliecināts, ka tas nav ideāls, bet es ceru, ka tas ir labāk nekā nekas!
26
+
27
+ [🇸🇦 arābu](../ar/README.md)
28
+ [🇧🇩 bengāļu](../bn/README.md)
29
+ [🇩🇪 vācu valodā](../de/README.md)
30
+ [🇺🇸 angļu valodā](../en/README.md)
31
+ [🇪🇸 spāņu](../es/README.md)
32
+ [🇫🇷 franču valoda](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonēziešu](../id/README.md)
36
+ [🇮🇹 itāļu valoda](../it/README.md)
37
+ [🇯🇵 japāņu](../ja/README.md)
38
+ [🇰🇷 korejiešu](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 poļu](../pl/README.md)
41
+ [🇧🇷 portugāļu](../pt/README.md)
42
+ [🇷🇺 krievu valodā](../ru/README.md)
43
+ [🇰🇪 Svahili](../sw/README.md)
44
+ [🇵🇭 Tagalogs](../tl/README.md)
45
+ [🇹🇷 turku](../tr/README.md)
46
+ [🇵🇰 urdu](../ur/README.md)
47
+ [🇻🇳 vjetnamiešu](../vi/README.md)
48
+ [🇨🇳 ķīniešu](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Visas valodas ...](../README.md)**
52
+ ----
53
+
54
+ ### Vai ir problēma ar šo README tulkojumu?
55
+ Šis konkrētais oriģināla [README] tulkojums (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ var būt kļūdains — *labojumi ir ļoti apsveicami!* Lūdzu, nosūtiet [izvilkšanas pieprasījumu vietnē GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ vai, ja nevēlaties to darīt, [atveriet problēmu](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Kad veidojat jaunu GitHub problēmu par tulkojumu, lūdzu, rīkojieties šādi:
60
+ * iekļaujiet lapas URL (kopējiet/ielīmējiet no pārlūkprogrammas adreses joslas)
61
+ * iekļaujiet precīzu nepareizo tekstu (kopējiet/ielīmējiet no pārlūkprogrammas)
62
+ * Lūdzu, aprakstiet, kas ir nepareizi — vai tulkojums ir nepareizs? vai formatējums ir kaut kā bojāts?
63
+ * laipni piedāvājiet ieteikumu par labāku tulkojumu vai kā pareizi formatēt tekstu
64
+ * **Paldies!**
65
+
66
+ ## Kāpēc Mobiletto?
67
+
68
+ ### Ardievu pārdevēja bloķēšana!
69
+ Dažādiem mākoņu krātuves nodrošinātājiem ir nesaderīgas API. Pat tie, kas cenšas panākt "S3 saderību"
70
+ piemīt savdabīga uzvedība.
71
+
72
+ Kad izvēlaties konkrētu krātuves pakalpojumu sniedzēju savai lietotnei, ja kodējat tieši uz viņa API, jūsu lietotni
73
+ tagad ir atkarīgs no šī pakalpojuma. Laikam ejot un kodam uzkrājoties, pārdevēji mainās
74
+ arvien neizturamāks. Laipni lūdzam pārdevēju bloķēšanas jautrajā pasaulē!
75
+
76
+ Mobiletto tika izstrādāts, lai atrisinātu šo problēmu. Kodējot savu lietotni Mobiletto API, varat to viegli izdarīt
77
+ mainiet krātuves nodrošinātājus un ziniet, ka jūsu lietotnes krātuves slānis darbosies identiski.
78
+
79
+ ### Plaša pārbaude
80
+ Visiem vadītājiem tiek pārbaudīta identiska uzvedība, katram vadītājam veicot 60+ testus.
81
+ Mēs pārbaudām visus draiverus ar katru kombināciju:
82
+ * Šifrēšana: gan iespējota, gan atspējota
83
+ * Redis kešatmiņu: gan iespējots, gan atspējots
84
+
85
+ Šī pieeja sniedz mums sirdsmieru, ka Mobiletto darbosies vienādi neatkarīgi no tā, kuru draiveri izmantojat,
86
+ un neatkarīgi no tā, vai iespējojat kešatmiņu un/vai šifrēšanu.
87
+
88
+ ### Vadītāja atbalsts
89
+ Pašreizējie Mobiletto krātuves draiveri:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : lokālā failu sistēma
93
+
94
+ *Ieguldījums vairāku mākoņkrātuvju nodrošinātāju atbalstam ir ļoti apsveicams!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto ir paredzēts izmantot kā bibliotēku ar citu JavaScript kodu.
98
+
99
+ Lai strādātu ar mobiletto komandrindā, izmantojiet [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Avots
102
+ * [mobiletto vietnē GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Ātrs sākums
106
+ Īss piemērs, izmantojot mobiletto `s3` draiveri.
107
+
108
+ Šis kods darbotos tāpat, ja draiveris būtu `b2` vai `local` .
109
+
110
+ const storage = require('mobiletto')
111
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
112
+
113
+ // list objects: returns array of metadata objects
114
+ const listing = await bucket.list()
115
+ const dirList = await bucket.list('some/dir/')
116
+ const everything = await bucket.list('', {recursive: true})
117
+
118
+ // write an entire file
119
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
120
+
121
+ // write a file from a stream/generator
122
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
123
+
124
+ // read an entire file
125
+ // returns null if an exception would otherwise be thrown
126
+ const bufferOrNull = await bucket.safeReadFile('some/path')
127
+
128
+ // stream-read a file, passing data to callback
129
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
130
+
131
+ // remove a file, returns the path removed
132
+ let removed = await bucket.remove('some/path') // removed is a string
133
+
134
+ // remove a directory, returns array of paths removed
135
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
136
+
137
+ ----
138
+ ## Pamata lietošana
139
+ Daudz plašāks piemērs, kurā parādīta lielākā daļa piedāvāto funkciju:
140
+
141
+ const { mobiletto } = require('mobiletto')
142
+
143
+ // General usage
144
+ const api = await mobiletto(driverName, key, secret, opts)
145
+
146
+ // To use 'local' driver:
147
+ // * key: base directory
148
+ // * secret: ignored, can be null
149
+ // * opts object:
150
+ // * readOnly: optional, never change anything on the filesystem; default is false
151
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
152
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
153
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
154
+
155
+ // To use 's3' driver:
156
+ // * key: AWS Access Key ID
157
+ // * secret: AWS Secret Key
158
+ // * opts object:
159
+ // * readOnly: optional, never change anything on the bucket; default is false
160
+ // * bucket: required, name of the S3 bucket
161
+ // * region: optional, the AWS region to communicate with, default is us-east-1
162
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
163
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
164
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
165
+
166
+ // To use 'b2' driver:
167
+ // * key: Backblaze Key ID
168
+ // * secret: Backblaze Application Key
169
+ // * opts object:
170
+ // * readOnly: optional, never change anything on the bucket; default is false
171
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
172
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
173
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
174
+ // * partSize: optional, large files will be split into chunks of this size when uploading
175
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
176
+
177
+ // List files
178
+ api.list() // --> returns an array of metadata objects
179
+
180
+ // List files recursively
181
+ api.list({ recursive: true })
182
+
183
+ // List files in a directory
184
+ const path = 'some/path'
185
+ api.list(path)
186
+ api.list(path, { recursive: true }) // also supports recursive flag
187
+
188
+ // Visit files in a directory -- visitor function must be async
189
+ api.list(path, { visitor: myAsyncFunc })
190
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
191
+
192
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
193
+ // When you call `safeList` on a non-existent path, it returns an empty array
194
+ api.safeList('/path/that/does/not/exist') // returns []
195
+
196
+ // Read metadata for a file
197
+ api.metadata(path) // returns metadata object
198
+
199
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
200
+ // When you call `safeMetadata` on a non-existent path, it returns null
201
+ api.safeMetadata('/tmp/does_not_exist') // returns null
202
+
203
+ // Read a file
204
+ // Provide a callback that writes the data someplace
205
+ const callback = (chunk) => { ... write chunk somewhere ... }
206
+ api.read(path, callback) // returns count of bytes read
207
+
208
+ // Read an entire file at once
209
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
210
+
211
+ // Read an entire file at once
212
+ // returns null if an exception would otherwise be thrown
213
+ const bufferOrNull = await bucket.safeReadFile('some/path')
214
+
215
+ // Write a file
216
+ // Provide a generator function that yields chunks of data
217
+ const generator = function* () {
218
+ while ( ... more-data-to-return ... ) {
219
+ data = ... load-data ...
220
+ yield data
221
+ }
222
+ }
223
+ local.api(path, generator) // returns count of bytes written
224
+
225
+ // Write an entire file at once (convenience method)
226
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
227
+
228
+ // Delete a file
229
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
230
+ // Always returns a value or throws an error.
231
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
232
+ const quiet = true
233
+ api.remove(path, {quiet}) // returns single path removed
234
+
235
+ // Recursively delete a directory and do it quietly (do not report errors)
236
+ const recursive = true
237
+ const quiet = true
238
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
239
+
240
+ ## Metadati
241
+ Komanda `metadata` atgriež metadatus par vienu failu sistēmas ierakstu.
242
+ Tāpat atgriešanas vērtība no komandas `list` ir metadatu objektu masīvs.
243
+
244
+ Metadatu objekts izskatās šādi:
245
+
246
+ {
247
+ "name": "fully/qualified/path/to/file",
248
+ "type": "entry-type",
249
+ "size": size-in-bytes,
250
+ "ctime": creation-time-epoch-millis,
251
+ "mtime": modification-time-epoch-millis
252
+ }
253
+
254
+ Rekvizīts `type` type" var būt `file` " , `dir` " , `link` vai `special` .
255
+
256
+ Atkarībā no draivera veida komanda `list` var neatgriezt visus laukus. `name` ” un “type `type` .
257
+ vienmēr jābūt klāt. Nākamā `metadata` komanda atgriezīs visus pieejamos rekvizītus.
258
+
259
+ ## Alternatīvs importēšanas stils
260
+ Importējiet pilnībā aptverto moduli un izmantojiet `connect` funkciju:
261
+
262
+ const storage = require('mobiletto')
263
+ const opts = {bucket: 'bk', region: 'us-east-1'}
264
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
265
+ const objectData = await s3.readFile('some/path')
266
+
267
+ ## Kešatmiņa
268
+ Mobiletto vislabāk darbojas ar <a href="https://redis.io">redis</a> kešatmiņu.
269
+
270
+ Mobiletto mēģinās izveidot savienojumu ar redis instanci vietnē 127.0.0.1:6379
271
+
272
+ Varat ignorēt kādu no šiem:
273
+ * Iestatiet `MOBILETTO_REDIS_HOST` env var, mobile lai izveidotu savienojumu šeit, nevis localhost
274
+ * Iestatiet `MOBILETTO_REDIS_PORT` env var, šis ports tiks izmantots
275
+
276
+ Mobiletto saglabās visas savas redis atslēgas ar prefiksu `_mobiletto__` . Jūs varat to mainīt
277
+ iestatot `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Varat arī iestatīt kešatmiņu katram savienojumam, izmantojot objektu `opts.redisConfig` :
280
+
281
+ const redisConfig = {
282
+ enabled: true, // optional, default is true. if false other props are ignored
283
+ host: '127.0.0.1',
284
+ port: 6379,
285
+ prefix: '_mobiletto__'
286
+ }
287
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
288
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
289
+
290
+ ### Vai nevēlaties atkārtotu kešatmiņu?
291
+ Lai atspējotu: izveidojot savienojumu, objektā `opts.redisConfig` `enabled: false` false'.
292
+
293
+ Kā minēts tālāk, kešatmiņas atspējošana negatīvi ietekmēs veiktspēju un radīs vairāk pieprasījumu
294
+ uz krātuvi, kas jums patiešām ir nepieciešama.
295
+
296
+ ### Kešatmiņas norādījumi
297
+ **Šifrēta krātuve**: šifrētās atmiņas lasīšana/rakstīšana ir tikai nedaudz lēnāka nekā parasti,
298
+ bet navigācija pa direktorijiem (ko dažas lietas dara) ir diezgan dārga. Redis kešatmiņas izmantošana
299
+ sniegs jums ievērojamu veiktspējas pieaugumu.
300
+
301
+ Noklusējuma kešatmiņa ir droša, taču tā nedarbojas labi, ja jums ir daudz rakstīšanas/noņemšanas darbību.
302
+ Jebkura rakstīšanas vai noņemšanas darbība padara nederīgu visu kešatmiņu, nodrošinot, ka turpmākajos lasījumos tiks parādīta
303
+ jaunākās izmaiņas.
304
+
305
+ ### CLI rīki
306
+ Ja izmantojat CLI rīku, piemēram, [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ noteikti vēlēsities, lai `mo` kešatmiņa būtu iespējota, jo tā ilgst, kad tiek izsaukta komanda “mo”.
308
+
309
+ ## Spoguļošana
310
+
311
+ // Copy a local filesystem mobiletto to S3
312
+ s3.mirror(local)
313
+
314
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
315
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
316
+
317
+ Komanda `mirror` veic visu failu vienreizēju kopiju no viena mobilā tālruņa uz citu.
318
+ Tas neveic nekādus procesus, lai laika gaitā uzturētu spoguli. Vēlreiz palaidiet komandu `mirror` .
319
+ lai sinhronizētu visus trūkstošos failus.
320
+
321
+ Atgriešanas vērtība no `mirror` ir vienkāršs objekts ar skaitītājiem, kas norāda, cik daudz failu bija veiksmīgi
322
+ atspoguļots un cik failos bija kļūdas:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ BRĪDINĀJUMS: lielu datu kopu spoguļošana var būt ļoti laikietilpīga un joslas platums.
330
+
331
+ Izmantojot `mirror` izsaukuma semantiku, dažreiz var būt mulsinoši saprast, kas ir
332
+ lasītājs un kas ir rakstnieks. Iedomājieties to kā uzdevuma paziņojumu: "kreisās puses mobilais telefons"
333
+ ir lieta, kurai tiek piešķirta (rakstīti atspoguļotie dati), un "labās puses mobilais tālrunis" (
334
+ arguments metodei `mirror` spogulis") ir piešķirtā vērtība (tiek nolasīti spoguļattēlu dati).
335
+
336
+ ## Caurspīdīga šifrēšana
337
+ Iespējot caurspīdīgu klienta puses šifrēšanu:
338
+
339
+ // Pass encryption parameters
340
+ const encryption = {
341
+ // key is required, must be >= 16 chars
342
+ key: randomstring.generate(128),
343
+
344
+ // optional, the default is to derive IV from key
345
+ // when set, IV must be >= 16 chars
346
+ iv: randomstring.generate(128),
347
+
348
+ // optional, the default is aes-256-cbc
349
+ algo: 'aes-256-cbc'
350
+ }
351
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
352
+
353
+ // Subsequent write operations will encrypt data (client side) when writing
354
+ // Subsequent read operations will decrypt data (client side) when reading
355
+
356
+ Kas notiek? Atsevišķs "direktorija ieraksts" (tiešais) direktorijs (šifrēts) izseko tajā esošos failus
357
+ direktorijs (aka dirent direktorijs).
358
+ * Komanda `list` nolasa direktoriju ievades failus, atšifrē katru norādīto ceļu; pēc tam atgriež metadatus katram failam
359
+ * `list` komandas ir neefektīvākas, īpaši direktorijiem ar lielu failu skaitu
360
+ * Komanda `write` ieraksta dirent failus katra vecāka dirent direktorijā; pēc tam raksta failu
361
+ * komandas `write` radīs O(N) ierakstus, kur N = dziļums direktoriju hierarhijā
362
+ * Komanda `remove` noņem atbilstošo dirent failu un tā vecāku, ja tas ir tukšs; pēc tam noņem failu
363
+ * `remove` komandas izraisīs O(N) nolasījumu un, iespējams, tikpat daudz dzēšanas, un N = dziļums direktoriju hierarhijā
364
+ * Rekursīvas `remove` komandas lielās un dziļās failu sistēmās var būt dārgas
365
+
366
+ Ņemiet vērā, ka pat tad, ja ir iespējota klienta puses šifrēšana, pretinieks ar pilnu redzamību jūsu šifrētajā servera pusē
367
+ krātuve, pat bez atslēgas, joprojām var redzēt kopējo direktoriju skaitu un to, cik failu ir katrā, un ar
368
+ dažas pūles, atklājiet daļu vai visu direktoriju hierarhijas vispārējo struktūru.
369
+ *Piezīme. Labākai drošībai izmantojiet salīdzinoši plakanu struktūru.*
370
+ Pretinieks nezinātu direktoriju/failu nosaukumus, ja vien viņi nezinātu arī jūsu šifrēšanu
371
+ atslēgu vai citādi veiksmīgi uzlauzis šifrēšanu. Tad visas likmes ir izslēgtas!
372
+
373
+ ### Veiktspēja un kešatmiņa
374
+ Darbības ar šifrētu krātuvi var būt lēnas. Rekursīvi saraksti un noņemšana var būt ļoti lēna.
375
+ Kešatmiņa, izmantojot redis, palīdz ārkārtīgi, taču ņemiet vērā, ka kešatmiņa tiek izskalota pēc rakstīšanas vai noņemšanas.
376
+
377
+ ## Taustiņu pagriešana
378
+ Izveidojiet mobilo tālruni ar savu jauno atslēgu un pēc tam atspoguļojiet tajā vecos datus:
379
+
380
+ const storage = require('mobiletto')
381
+
382
+ const oldEncryption = { key: .... }
383
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
384
+
385
+ const newEncryption = { key: .... }
386
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
387
+
388
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
389
+
390
+ ## Draivera interfeiss
391
+ Draiveris ir jebkurš JS fails, kas eksportē funkciju "storageClient" ar šādu parakstu:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : virkne, jūsu API atslēga ( `local` draiverim tas ir bāzes direktorijs)
396
+ * `secret` : virkne, jūsu API noslēpums (var izlaist `local` draiverim)
397
+ * `opts` : objekts, rekvizīti ir katram draiverim:
398
+ * `local` rekvizītam `fileMode` un `dirMode` nosaka, kā tiek izveidoti jauni izveides faili un direktoriji.
399
+ * `s3` `bucket` ir nepieciešams. Izvēles rekvizīti ir:
400
+ * `region`: the S3 region, default is us-east-1
401
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
402
+ * `delimiter`: the directory delimiter, default is '/'
403
+
404
+ Objektam, ko atgriež funkcija storageClient, ir jādefinē šādas funkcijas:
405
+
406
+ // Test the driver before using, ensure proper configuration
407
+ async testConfig ()
408
+
409
+ // List files in path (or from base-directory)
410
+ // If recursive is true, list recursively
411
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
412
+ // Otherwise, perform the listing and return an array of objects
413
+ async list (path, recursive = false, visitor = null) // path may be omitted
414
+
415
+ // Read metadata for a path
416
+ async metadata (path)
417
+
418
+ // Read a file
419
+ // callback receives a chunk of data. endCallback is called at end-of-stream
420
+ async read (path, callback, endCallback = null)
421
+
422
+ // Write a file
423
+ // driver must be able to handle a generator or a stream
424
+ async write (path, generatorOrReadableStream)
425
+
426
+ // Remove a file, or recursively delete a directory
427
+ // returns a string of a single path removed, or an array of multiple paths removed
428
+ async remove (path, recursive = false, quiet = false)
429
+
430
+ ## Mežizstrāde
431
+ Mobiletto izmanto [winston](https://www.npmjs.com/package/winston) reģistrēšanas bibliotēku.
432
+
433
+ Žurnāli **būs** saturēs failu ceļus un kļūdu ziņojumus, bet **nekad** nesaturēs atslēgas, noslēpumus,
434
+ vai jebkura cita savienojuma konfigurācijas informācija.
435
+
436
+ ### Žurnāla līmenis
437
+ Izmantojiet vides mainīgo `MOBILETTO_LOG_LEVEL` , lai iestatītu žurnāla līmeni, izmantojot vienu
438
+ no `npm` līmeņiem, kas definēti vietnē [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ Noklusējuma līmenis ir `error` . Plašākais līmenis ir `silly` , lai gan pašlaik mobilais
441
+ nereģistrējas zemākā līmenī par `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Žurnāla fails
446
+ Pēc noklusējuma reģistrētājs raksta uz konsoli. Lai nosūtītu žurnālus uz failu, iestatiet `MOBILETTO_LOG_FILE`
447
+ vides mainīgais. Piesakoties failā, žurnāli vairs netiks rakstīti konsolē.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Lai izslēgtu reģistrēšanu:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>