mobiletto 1.1.10 → 1.1.13

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 (116) hide show
  1. package/README.md +74 -0
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +481 -0
  4. package/docs/am/README.md +481 -0
  5. package/docs/ar/README.md +481 -0
  6. package/docs/az/README.md +481 -0
  7. package/docs/be/README.md +481 -0
  8. package/docs/bg/README.md +481 -0
  9. package/docs/bn/README.md +481 -0
  10. package/docs/bs/README.md +481 -0
  11. package/docs/ca/README.md +481 -0
  12. package/docs/ceb/README.md +481 -0
  13. package/docs/co/README.md +481 -0
  14. package/docs/cs/README.md +481 -0
  15. package/docs/cy/README.md +481 -0
  16. package/docs/da/README.md +481 -0
  17. package/docs/de/README.md +481 -0
  18. package/docs/el/README.md +481 -0
  19. package/docs/eo/README.md +481 -0
  20. package/docs/es/README.md +481 -0
  21. package/docs/et/README.md +481 -0
  22. package/docs/eu/README.md +481 -0
  23. package/docs/fa/README.md +481 -0
  24. package/docs/fi/README.md +481 -0
  25. package/docs/fr/README.md +481 -0
  26. package/docs/fy/README.md +481 -0
  27. package/docs/ga/README.md +481 -0
  28. package/docs/gd/README.md +481 -0
  29. package/docs/gl/README.md +481 -0
  30. package/docs/gu/README.md +481 -0
  31. package/docs/ha/README.md +481 -0
  32. package/docs/haw/README.md +481 -0
  33. package/docs/he/README.md +481 -0
  34. package/docs/hi/README.md +481 -0
  35. package/docs/hmn/README.md +481 -0
  36. package/docs/hr/README.md +481 -0
  37. package/docs/ht/README.md +481 -0
  38. package/docs/hu/README.md +481 -0
  39. package/docs/hy/README.md +481 -0
  40. package/docs/id/README.md +481 -0
  41. package/docs/ig/README.md +481 -0
  42. package/docs/is/README.md +481 -0
  43. package/docs/it/README.md +481 -0
  44. package/docs/iw/README.md +481 -0
  45. package/docs/ja/README.md +481 -0
  46. package/docs/jv/README.md +481 -0
  47. package/docs/ka/README.md +481 -0
  48. package/docs/kk/README.md +481 -0
  49. package/docs/km/README.md +481 -0
  50. package/docs/kn/README.md +481 -0
  51. package/docs/ko/README.md +481 -0
  52. package/docs/ku/README.md +481 -0
  53. package/docs/ky/README.md +481 -0
  54. package/docs/la/README.md +481 -0
  55. package/docs/lb/README.md +481 -0
  56. package/docs/lo/README.md +481 -0
  57. package/docs/lt/README.md +481 -0
  58. package/docs/lv/README.md +481 -0
  59. package/docs/mg/README.md +481 -0
  60. package/docs/mi/README.md +481 -0
  61. package/docs/mk/README.md +481 -0
  62. package/docs/ml/README.md +481 -0
  63. package/docs/mn/README.md +481 -0
  64. package/docs/mr/README.md +481 -0
  65. package/docs/ms/README.md +481 -0
  66. package/docs/mt/README.md +481 -0
  67. package/docs/my/README.md +481 -0
  68. package/docs/ne/README.md +481 -0
  69. package/docs/nl/README.md +481 -0
  70. package/docs/no/README.md +481 -0
  71. package/docs/ny/README.md +481 -0
  72. package/docs/or/README.md +481 -0
  73. package/docs/pa/README.md +481 -0
  74. package/docs/pl/README.md +481 -0
  75. package/docs/ps/README.md +481 -0
  76. package/docs/pt/README.md +481 -0
  77. package/docs/ro/README.md +481 -0
  78. package/docs/ru/README.md +481 -0
  79. package/docs/rw/README.md +481 -0
  80. package/docs/sd/README.md +481 -0
  81. package/docs/si/README.md +481 -0
  82. package/docs/sk/README.md +481 -0
  83. package/docs/sl/README.md +481 -0
  84. package/docs/sm/README.md +481 -0
  85. package/docs/sn/README.md +481 -0
  86. package/docs/so/README.md +481 -0
  87. package/docs/sq/README.md +481 -0
  88. package/docs/sr/README.md +481 -0
  89. package/docs/st/README.md +481 -0
  90. package/docs/su/README.md +481 -0
  91. package/docs/sv/README.md +481 -0
  92. package/docs/sw/README.md +481 -0
  93. package/docs/ta/README.md +481 -0
  94. package/docs/te/README.md +481 -0
  95. package/docs/tg/README.md +481 -0
  96. package/docs/th/README.md +481 -0
  97. package/docs/tk/README.md +481 -0
  98. package/docs/tl/README.md +481 -0
  99. package/docs/tr/README.md +481 -0
  100. package/docs/tt/README.md +481 -0
  101. package/docs/ug/README.md +481 -0
  102. package/docs/uk/README.md +481 -0
  103. package/docs/ur/README.md +481 -0
  104. package/docs/uz/README.md +481 -0
  105. package/docs/vi/README.md +481 -0
  106. package/docs/xh/README.md +481 -0
  107. package/docs/yi/README.md +481 -0
  108. package/docs/yo/README.md +481 -0
  109. package/docs/zh/README.md +481 -0
  110. package/docs/zu/README.md +481 -0
  111. package/drivers/b2/index.js +25 -6
  112. package/hokey.json +16 -0
  113. package/index.js +7 -2
  114. package/package.json +1 -1
  115. package/test/api.spec.js +13 -9
  116. package/util/redis.js +2 -2
@@ -0,0 +1,481 @@
1
+ Mobiletto
2
+ =========
3
+
4
+ Mobiletto je vrstva abstrakce úložiště JavaScript s volitelným transparentním šifrováním na straně klienta.
5
+
6
+ # Obsah
7
+ * [Proč Mobiletto?](#Proč-Mobiletto?)
8
+ * [Rychlý start](#Rychlý start)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Zdroj](#Source)
11
+ * [Instalace](#Instalace)
12
+ * [Support and Funding](#Support-and-Funding)
13
+ * [Základní použití](#Basic-usage)
14
+ * [Metadata](#Metadata)
15
+ * [Alternativní styl importu](#Alternate-import-style)
16
+ * [Caching](#Caching)
17
+ * [Mirroring](#Mirroring)
18
+ * [Transparentní šifrování](#Transparentní šifrování)
19
+ * [Otočení klíče](#Otočení klíče)
20
+ * [Rozhraní ovladače](#Rozhraní ovladače)
21
+ * [Logging](#Logging)
22
+
23
+ # Přečtěte si to v jiném jazyce
24
+ Tento dokument README.md byl přeložen prostřednictvím [hokeylizace](https://github.com/cobbzilla/hokeylization) do
25
+ **[každý jazyk podporovaný Překladačem Google](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Jsem si jistý, že to není dokonalé, ale doufám, že je to lepší než nic!
28
+
29
+ [🇸🇦 arabština](../ar/README.md)
30
+ [🇧🇩 bengálština](../bn/README.md)
31
+ [🇩🇪 němčina](../de/README.md)
32
+ [🇺🇸 angličtina](../en/README.md)
33
+ [🇪🇸 španělština](../es/README.md)
34
+ [🇫🇷 francouzština](../fr/README.md)
35
+ [🇹🇩 Hausa](../ha/README.md)
36
+ [🇮🇳 hindština](../hi/README.md)
37
+ [🇮🇩 indonéština](../id/README.md)
38
+ [🇮🇹 italština](../it/README.md)
39
+ [🇯🇵 japonština](../ja/README.md)
40
+ [🇰🇷 korejština](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 polština](../pl/README.md)
43
+ [🇧🇷 portugalština](../pt/README.md)
44
+ [🇷🇺 ruština](../ru/README.md)
45
+ [🇰🇪 svahilština](../sw/README.md)
46
+ [🇵🇭 tagalština](../tl/README.md)
47
+ [🇹🇷 turečtina](../tr/README.md)
48
+ [🇵🇰 urdština](../ur/README.md)
49
+ [🇻🇳 vietnamština](../vi/README.md)
50
+ [🇨🇳 čínština](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Všechny jazyky ...](../README.md)**
54
+ ----
55
+
56
+ ### Je problém s tímto překladem souboru README?
57
+ Tento konkrétní překlad originálu [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ může být chyba -- *opravy jsou velmi vítány!* Odešlete [žádost o stažení na GitHubu](https://github.com/cobbzilla/mobiletto/pulls),
59
+ nebo pokud se vám to nelíbí, [otevřete problém](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Když vytvoříte nový problém na GitHubu o překladu, proveďte prosím:
62
+ * zahrňte adresu URL stránky (zkopírujte/vložte z adresního řádku prohlížeče)
63
+ * uveďte přesný text, který je nesprávný (zkopírujte/vložte z prohlížeče)
64
+ * popište prosím, co je špatně - je překlad nesprávný? je formátování nějak narušené?
65
+ * laskavě nabídněte návrh lepšího překladu nebo jak by měl být text správně naformátován
66
+ * **Děkuji!**
67
+
68
+ ## Proč Mobiletto?
69
+
70
+ ### Sbohem vendor lock-in!
71
+ Různí poskytovatelé cloudového úložiště mají nekompatibilní rozhraní API. Dokonce i ti, kteří usilují o "kompatibilitu S3"
72
+ mají idiosynkratické chování.
73
+
74
+ Když si vyberete konkrétního dodavatele úložiště pro svou aplikaci, pokud kódujete přímo do jejich API, vaše aplikace
75
+ je nyní na této službě závislý. Jak čas plyne a kód se hromadí, mění se dodavatelé
76
+ čím dál neudržitelnější. Vítejte v zábavném světě vendor lock-in!
77
+
78
+ Mobiletto bylo navrženo k vyřešení tohoto problému. Nakódováním vaší aplikace do API mobiletto to můžete snadno
79
+ změnit poskytovatele úložiště a vědět, že vrstva úložiště vaší aplikace se bude chovat identicky.
80
+
81
+ ### Rozsáhlé testování
82
+ Všechny ovladače jsou testovány na identické chování s 60+ testy pro každý ovladač.
83
+ Testujeme všechny ovladače s každou kombinací:
84
+ * Šifrování: povoleno i zakázáno
85
+ * Mezipaměť Redis: povolena i zakázána
86
+
87
+ Tento přístup nám dává jistotu, že mobiletto se bude chovat stejně bez ohledu na to, jaký ovladač používáte,
88
+ a bez ohledu na to, zda povolíte ukládání do mezipaměti a/nebo šifrování.
89
+
90
+ ### Podpora ovladačů
91
+ Aktuální ovladače úložiště Mobiletto:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : místní souborový systém
95
+
96
+ *Příspěvky na podporu více poskytovatelů cloudových úložišť jsou velmi vítány!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto je určeno k použití jako knihovna jiným kódem JavaScript.
100
+
101
+ Chcete-li pracovat s mobiletto na příkazovém řádku, použijte [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Zdroj
104
+ * [mobiletto na GitHubu](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto na npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Podpora a financování
108
+ Snažím se být profesionálním vývojářem open source softwaru. Pracoval jsem v
109
+ v softwarovém průmyslu jsem zakládal úspěšné společnosti a prodal je veřejným společnostem.
110
+ Nedávno jsem přišel o práci a vlastně žádnou jinou práci nemám
111
+
112
+ Takže zkusím napsat užitečný software a uvidím, jestli to funguje
113
+
114
+ Pokud rádi používáte tento software, byl bych za něj velmi vděčný
115
+ nejmenší [měsíční příspěvek přes Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Děkuji!*
118
+
119
+ ## Instalace
120
+ Nainstalujte pomocí `npm` nebo `yarn` . Pravděpodobně budete chtít `lite` verzi, která nezahrnuje všechny
121
+ přeložené soubory README:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Pokud opravdu chcete soubory README v každém jazyce, nainstalujte si plnou verzi:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Rychlý start
132
+ Krátký příklad použití ovladače mobiletto `s3` .
133
+
134
+ Tento kód by běžel stejně, kdyby byl ovladač `b2` nebo `local` .
135
+
136
+ const storage = require('mobiletto')
137
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
138
+
139
+ // list objects: returns array of metadata objects
140
+ const listing = await bucket.list()
141
+ const dirList = await bucket.list('some/dir/')
142
+ const everything = await bucket.list('', {recursive: true})
143
+
144
+ // write an entire file
145
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
146
+
147
+ // write a file from a stream/generator
148
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
149
+
150
+ // read an entire file
151
+ // returns null if an exception would otherwise be thrown
152
+ const bufferOrNull = await bucket.safeReadFile('some/path')
153
+
154
+ // stream-read a file, passing data to callback
155
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
156
+
157
+ // remove a file, returns the path removed
158
+ let removed = await bucket.remove('some/path') // removed is a string
159
+
160
+ // remove a directory, returns array of paths removed
161
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
162
+
163
+ ----
164
+ ## Základní použití
165
+ Mnohem rozsáhlejší příklad ukazující většinu nabízených funkcí:
166
+
167
+ const { mobiletto } = require('mobiletto')
168
+
169
+ // General usage
170
+ const api = await mobiletto(driverName, key, secret, opts)
171
+
172
+ // To use 'local' driver:
173
+ // * key: base directory
174
+ // * secret: ignored, can be null
175
+ // * opts object:
176
+ // * readOnly: optional, never change anything on the filesystem; default is false
177
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
178
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
179
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
180
+
181
+ // To use 's3' driver:
182
+ // * key: AWS Access Key ID
183
+ // * secret: AWS Secret Key
184
+ // * opts object:
185
+ // * readOnly: optional, never change anything on the bucket; default is false
186
+ // * bucket: required, name of the S3 bucket
187
+ // * region: optional, the AWS region to communicate with, default is us-east-1
188
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
189
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
190
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
191
+
192
+ // To use 'b2' driver:
193
+ // * key: Backblaze Key ID
194
+ // * secret: Backblaze Application Key
195
+ // * opts object:
196
+ // * readOnly: optional, never change anything on the bucket; default is false
197
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
198
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
199
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
200
+ // * partSize: optional, large files will be split into chunks of this size when uploading
201
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
202
+
203
+ // List files
204
+ api.list() // --> returns an array of metadata objects
205
+
206
+ // List files recursively
207
+ api.list({ recursive: true })
208
+
209
+ // List files in a directory
210
+ const path = 'some/path'
211
+ api.list(path)
212
+ api.list(path, { recursive: true }) // also supports recursive flag
213
+
214
+ // Visit files in a directory -- visitor function must be async
215
+ api.list(path, { visitor: myAsyncFunc })
216
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
217
+
218
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
219
+ // When you call `safeList` on a non-existent path, it returns an empty array
220
+ api.safeList('/path/that/does/not/exist') // returns []
221
+
222
+ // Read metadata for a file
223
+ api.metadata(path) // returns metadata object
224
+
225
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
226
+ // When you call `safeMetadata` on a non-existent path, it returns null
227
+ api.safeMetadata('/tmp/does_not_exist') // returns null
228
+
229
+ // Read a file
230
+ // Provide a callback that writes the data someplace
231
+ const callback = (chunk) => { ... write chunk somewhere ... }
232
+ api.read(path, callback) // returns count of bytes read
233
+
234
+ // Read an entire file at once
235
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
236
+
237
+ // Read an entire file at once
238
+ // returns null if an exception would otherwise be thrown
239
+ const bufferOrNull = await bucket.safeReadFile('some/path')
240
+
241
+ // Write a file
242
+ // Provide a generator function that yields chunks of data
243
+ const generator = function* () {
244
+ while ( ... more-data-to-return ... ) {
245
+ data = ... load-data ...
246
+ yield data
247
+ }
248
+ }
249
+ local.api(path, generator) // returns count of bytes written
250
+
251
+ // Write an entire file at once (convenience method)
252
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
253
+
254
+ // Delete a file
255
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
256
+ // Always returns a value or throws an error.
257
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
258
+ const quiet = true
259
+ api.remove(path, {quiet}) // returns single path removed
260
+
261
+ // Recursively delete a directory and do it quietly (do not report errors)
262
+ const recursive = true
263
+ const quiet = true
264
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
265
+
266
+ ## Metadata
267
+ Příkaz `metadata` vrací metadata o jedné položce souborového systému.
268
+ Podobně vrácená hodnota z příkazu `list` je pole objektů metadat.
269
+
270
+ Objekt metadat vypadá takto:
271
+
272
+ {
273
+ "name": "fully/qualified/path/to/file",
274
+ "type": "entry-type",
275
+ "size": size-in-bytes,
276
+ "ctime": creation-time-epoch-millis,
277
+ "mtime": modification-time-epoch-millis
278
+ }
279
+
280
+ Vlastnost `type` type` může být `file` , `dir` , `link` nebo `special` .
281
+
282
+ V závislosti na typu ovladače nemusí příkaz `list` vrátit všechna pole. Vlastnosti `name` a `type` type`
283
+ by měl být vždy přítomen. Následující příkaz `metadata` vrátí všechny dostupné vlastnosti.
284
+
285
+ ## Alternativní styl importu
286
+ Importujte modul s plným rozsahem a použijte funkci `connect` :
287
+
288
+ const storage = require('mobiletto')
289
+ const opts = {bucket: 'bk', region: 'us-east-1'}
290
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
291
+ const objectData = await s3.readFile('some/path')
292
+
293
+ ## Ukládání do mezipaměti
294
+ Mobiletto funguje nejlépe s <a href="https://redis.io">redis</a> cache.
295
+
296
+ Mobiletto se pokusí připojit k instanci redis na 127.0.0.1:6379
297
+
298
+ Můžete přepsat kteroukoli z těchto možností:
299
+ * Nastavte env var `MOBILETTO_REDIS_HOST` , mobilet, abyste se připojili sem místo localhost
300
+ * Nastavte env var `MOBILETTO_REDIS_PORT` , tento port bude použit
301
+
302
+ Mobiletto uloží všechny své redis klíče s předponou `_mobiletto__` . Můžete to změnit
303
+ nastavením `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Můžete také nastavit ukládání do mezipaměti pro jednotlivá připojení pomocí objektu `opts.redisConfig` :
306
+
307
+ const redisConfig = {
308
+ enabled: true, // optional, default is true. if false other props are ignored
309
+ host: '127.0.0.1',
310
+ port: 6379,
311
+ prefix: '_mobiletto__'
312
+ }
313
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
314
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
315
+
316
+ ### Nechcete znovu ukládat do mezipaměti?
317
+ Zakázání: předejte `enabled: false` ve vašem objektu `opts.redisConfig` při navazování spojení.
318
+
319
+ Jak je uvedeno níže, zakázání ukládání do mezipaměti bude mít nepříznivý vliv na výkon a vyvolá více požadavků
320
+ úložiště, které opravdu potřebujete.
321
+
322
+ ### Pokyny pro ukládání do mezipaměti
323
+ **Šifrované úložiště**: čtení/zápis šifrovaného úložiště je jen o něco pomalejší než normálně,
324
+ ale procházení adresářů (což některé věci dělají) je poměrně drahé. Použití mezipaměti redis
325
+ vám poskytne výrazné zvýšení výkonu.
326
+
327
+ Výchozí mezipaměť je bezpečná, ale nefunguje dobře, pokud máte mnoho operací zápisu/odebírání.
328
+ Jakákoli operace zápisu nebo odstranění zneplatní celou mezipaměť a zajistí, že následná čtení uvidí soubor
329
+ nejnovější změny.
330
+
331
+ ### Nástroje CLI
332
+ Pokud používáte nástroj CLI, jako je [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ určitě budete chtít povolenou mezipaměť redis, protože trvá při vyvolání příkazu `mo` .
334
+
335
+ ## Zrcadlení
336
+
337
+ // Copy a local filesystem mobiletto to S3
338
+ s3.mirror(local)
339
+
340
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
341
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
342
+
343
+ Příkaz `mirror` provede jednorázovou kopii všech souborů z jednoho mobiletto do druhého.
344
+ Nespouští žádný proces pro udržování zrcadla v průběhu času. Spusťte znovu příkaz `mirror`
345
+ pro synchronizaci chybějících souborů.
346
+
347
+ Vrácená hodnota z `mirror` je jednoduchý objekt s počítadly, kolik souborů bylo úspěšně dokončeno
348
+ zrcadleno a kolik souborů mělo chyby:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ VAROVÁNÍ: Zrcadlení velkých souborů dat může být velmi časově náročné a náročné na šířku pásma
356
+
357
+ Se sémantikou volání `mirror` může být někdy matoucí pochopit, kdo je
358
+ čtenář a kdo je autorem. Představte si to jako příkaz k zadání: „levé mobiltto“
359
+ je věc, které je přiřazena (zapsána zrcadlená data), a "pravé mobilnítto" (
360
+ argument k metodě `mirror` ) je přiřazovaná hodnota (přečtou se zrcadlená data).
361
+
362
+ ## Transparentní šifrování
363
+ Povolit transparentní šifrování na straně klienta:
364
+
365
+ // Pass encryption parameters
366
+ const encryption = {
367
+ // key is required, must be >= 16 chars
368
+ key: randomstring.generate(128),
369
+
370
+ // optional, the default is to derive IV from key
371
+ // when set, IV must be >= 16 chars
372
+ iv: randomstring.generate(128),
373
+
374
+ // optional, the default is aes-256-cbc
375
+ algo: 'aes-256-cbc'
376
+ }
377
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
378
+
379
+ // Subsequent write operations will encrypt data (client side) when writing
380
+ // Subsequent read operations will decrypt data (client side) when reading
381
+
382
+ Co se děje? Samostatný adresář „položka adresáře“ (přímý) (zašifrovaný) sleduje, jaké soubory se v něm nacházejí
383
+ adresář (neboli dirent adresář).
384
+ * Příkaz `list` čte soubory záznamů adresáře, dešifruje každou uvedenou cestu; pak vrátí metadata pro každý soubor
385
+ * Příkazy `list` jsou neefektivnější, zvláště pro adresáře s velkým počtem souborů
386
+ * Příkaz `write` zapisuje dirent soubory do adresáře dirent každého rodiče rekurzivně; pak zapíše soubor
387
+ * Příkazy `write` budou mít O(N) zápisů, přičemž N = hloubka v hierarchii adresářů
388
+ * Příkaz `remove` odstraní odpovídající soubor dirent a jeho rodič, pokud je prázdný; poté soubor odstraní
389
+ * Nerekurzivní příkazy `remove` způsobí O(N) čtení a potenciálně tolik mazání, přičemž N = hloubka v hierarchii adresářů
390
+ * Rekurzivní příkazy `remove` na velkých a hlubokých souborových systémech mohou být drahé
391
+
392
+ Všimněte si, že i když je povoleno šifrování na straně klienta, protivník s plnou viditelností na vaší šifrované straně serveru
393
+ úložiště, i bez klíče, stále vidí celkový počet adresářů a kolik souborů je v každém a s
394
+ nějaké úsilí, objevit některé nebo všechny celkové struktury hierarchie adresářů.
395
+ *Poznámka: Pro lepší zabezpečení použijte relativně plochou strukturu.*
396
+ Protivník by neznal názvy adresářů/souborů, pokud by neznal také vaše šifrování
397
+ klíč nebo jinak úspěšně prolomil šifrování. Pak jsou všechny sázky pryč!
398
+
399
+ ### Výkon a ukládání do mezipaměti
400
+ Operace na šifrovaném úložišti mohou být pomalé. Rekurzivní výpisy a odstraňování mohou být velmi pomalé.
401
+ Ukládání do mezipaměti přes redis ohromně pomáhá, ale mějte na paměti, že mezipaměť se vyprázdní při každém zápisu nebo odstranění.
402
+
403
+ ## Rotace klíče
404
+ Vytvořte mobiletto se svým novým klíčem a poté do něj zrcadlte stará data:
405
+
406
+ const storage = require('mobiletto')
407
+
408
+ const oldEncryption = { key: .... }
409
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
410
+
411
+ const newEncryption = { key: .... }
412
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
413
+
414
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
415
+
416
+ ## Rozhraní ovladače
417
+ Ovladač je jakýkoli soubor JS, který exportuje funkci „storageClient“ s tímto podpisem:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : řetězec, váš klíč API (pro `local` ovladač je to základní adresář)
422
+ * `secret` : řetězec, vaše tajemství API (může být vynecháno pro `local` ovladač)
423
+ * `opts` : objekt, vlastnosti jsou pro každý ovladač:
424
+ * Pro `local` určují vlastnosti `fileMode` a `dirMode` způsob vytváření nových souborů a adresářů
425
+ * Pro `s3` je vyžadována vlastnost `bucket` . Volitelné vlastnosti jsou:
426
+ * `region`: the S3 region, default is us-east-1
427
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
428
+ * `delimiter`: the directory delimiter, default is '/'
429
+
430
+ Objekt, který funkce storageClient vrací, musí definovat tyto funkce:
431
+
432
+ // Test the driver before using, ensure proper configuration
433
+ async testConfig ()
434
+
435
+ // List files in path (or from base-directory)
436
+ // If recursive is true, list recursively
437
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
438
+ // Otherwise, perform the listing and return an array of objects
439
+ async list (path, recursive = false, visitor = null) // path may be omitted
440
+
441
+ // Read metadata for a path
442
+ async metadata (path)
443
+
444
+ // Read a file
445
+ // callback receives a chunk of data. endCallback is called at end-of-stream
446
+ async read (path, callback, endCallback = null)
447
+
448
+ // Write a file
449
+ // driver must be able to handle a generator or a stream
450
+ async write (path, generatorOrReadableStream)
451
+
452
+ // Remove a file, or recursively delete a directory
453
+ // returns a string of a single path removed, or an array of multiple paths removed
454
+ async remove (path, recursive = false, quiet = false)
455
+
456
+ ## Protokolování
457
+ Mobiletto používá protokolovací knihovnu [winston](https://www.npmjs.com/package/winston).
458
+
459
+ Protokoly **budou** obsahovat cesty k souborům a chybové zprávy, ale **nikdy** nebudou obsahovat klíče, tajemství,
460
+ nebo jakékoli jiné informace o konfiguraci připojení.
461
+
462
+ ### Úroveň protokolu
463
+ K nastavení úrovně protokolu použijte proměnnou prostředí `MOBILETTO_LOG_LEVEL`
464
+ z úrovní `npm` definovaných v [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ Výchozí úroveň je `error` . Nejpodrobnější úroveň je `silly` , i když momentálně mobiletto
467
+ se nepřihlásí na úrovních pod `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Log soubor
472
+ Ve výchozím nastavení zapisovač zapisuje do konzoly. Chcete-li odeslat protokoly do souboru, nastavte `MOBILETTO_LOG_FILE`
473
+ proměnná prostředí. Při přihlašování do souboru se již protokoly nebudou zapisovat do konzole.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ Postup vypnutí protokolování:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>