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
+ Мобилето
2
+ =========
3
+
4
+ Mobiletto е абстрактен слой за съхранение на JavaScript с незадължително прозрачно криптиране от страна на клиента.
5
+
6
+ # Съдържание
7
+ * [Защо Mobiletto?](#Защо-Mobiletto?)
8
+ * [Бърз старт](#Бърз старт)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Източник](#Източник)
11
+ * [Инсталация](#Инсталация)
12
+ * [Подкрепа и финансиране](#Support-and-Funding)
13
+ * [Основно използване](#Основно използване)
14
+ * [Метаданни](#Метаданни)
15
+ * [Алтернативен стил на импортиране](#Alternate-import-style)
16
+ * [Кеширане](#Кеширане)
17
+ * [Огледално отразяване](#Огледално отразяване)
18
+ * [Прозрачно криптиране](#Transparent-encryption)
19
+ * [Ключ ротация](#Ключ ротация)
20
+ * [Интерфейс на драйвер](#Driver-интерфейс)
21
+ * [Регистриране](#Регистриране)
22
+
23
+ # Прочетете това на друг език
24
+ Този документ README.md е преведен чрез [hokeylization](https://github.com/cobbzilla/hokeylization) на
25
+ **[всеки език, поддържан от Google Translate](https://cloud.google.com/translate/docs/languages)!**
26
+
27
+ Сигурен съм, че не е перфектно, но се надявам да е по-добре от нищо!
28
+
29
+ [🇸🇦 арабски](../ar/README.md)
30
+ [🇧🇩 бенгалски](../bn/README.md)
31
+ [🇩🇪 немски](../de/README.md)
32
+ [🇺🇸 английски](../en/README.md)
33
+ [🇪🇸 испански](../es/README.md)
34
+ [🇫🇷 френски](../fr/README.md)
35
+ [🇹🇩 Хауса](../ha/README.md)
36
+ [🇮🇳 хинди](../hi/README.md)
37
+ [🇮🇩 индонезийски](../id/README.md)
38
+ [🇮🇹 италиански](../it/README.md)
39
+ [🇯🇵 японски](../ja/README.md)
40
+ [🇰🇷 корейски](../ko/README.md)
41
+ [🇮🇳 Maranthi](../mr/README.md)
42
+ [🇵🇱 полски](../pl/README.md)
43
+ [🇧🇷 португалски](../pt/README.md)
44
+ [🇷🇺 руски](../ru/README.md)
45
+ [🇰🇪 суахили](../sw/README.md)
46
+ [🇵🇭 Тагалог](../tl/README.md)
47
+ [🇹🇷 турски](../tr/README.md)
48
+ [🇵🇰 урду](../ur/README.md)
49
+ [🇻🇳 виетнамски](../vi/README.md)
50
+ [🇨🇳 китайски](../zh/README.md)
51
+
52
+
53
+ **[📚 ... Всички езици ...](../README.md)**
54
+ ----
55
+
56
+ ### Има ли проблем с този превод на README?
57
+ Този конкретен превод на оригинала [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
+ може да има недостатъци -- *корекциите са добре дошли!* Моля, изпратете [заявка за изтегляне в GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
+ или ако не ви е удобно да правите това, [отворете проблем](https://github.com/cobbzilla/mobiletto/issues)
60
+
61
+ Когато създавате нов проблем в GitHub относно превод, моля, направете следното:
62
+ * включете URL адреса на страницата (копирайте/поставете от адресната лента на браузъра)
63
+ * включете точния грешен текст (копирайте/поставете от браузъра)
64
+ * моля, опишете какво не е наред -- преводът неправилен ли е? форматирането повредено ли е по някакъв начин?
65
+ * любезно предложете предложение за по-добър превод или как текстът да бъде правилно форматиран
66
+ * **Благодаря ти!**
67
+
68
+ ## Защо Mobiletto?
69
+
70
+ ### Довиждане, блокиране на доставчика!
71
+ Различните доставчици на облачно хранилище имат несъвместими API. Дори тези, които се стремят към "S3 съвместимост"
72
+ имат идиосинкратично поведение.
73
+
74
+ Когато изберете конкретен доставчик на хранилище за вашето приложение, ако кодирате директно към неговия API, вашето приложение
75
+ сега зависи от тази услуга. С течение на времето и кодът се натрупва, смяната на доставчиците става
76
+ все по-несъстоятелни. Добре дошли в забавния свят на блокиране на продавача!
77
+
78
+ Mobiletto е проектиран да реши този проблем. Като кодирате приложението си към API на mobiletto, можете лесно
79
+ сменете доставчиците на съхранение и знайте, че слоят за съхранение на вашето приложение ще се държи по същия начин.
80
+
81
+ ### Обстойно тестване
82
+ Всички драйвери са тествани за идентично поведение с 60+ теста за всеки драйвер.
83
+ Тестваме всички драйвери с всяка комбинация от:
84
+ * Шифроване: както активирано, така и деактивирано
85
+ * Кеш на Redis: както активиран, така и деактивиран
86
+
87
+ Този подход ни дава спокойствие, че mobiletto ще се държи по същия начин, независимо кой драйвер използвате,
88
+ и независимо дали активирате кеширане и/или криптиране.
89
+
90
+ ### Поддръжка на драйвери
91
+ Текущи драйвери за съхранение на Mobiletto:
92
+ * `s3` : Amazon S3
93
+ * `b2` : Backblaze B2
94
+ * `local` : локална файлова система
95
+
96
+ *Приносът за поддръжка на повече доставчици на облачно хранилище е добре дошъл!*
97
+
98
+ ## mobiletto-cli
99
+ Mobiletto е предназначен да се използва като библиотека от друг JavaScript код.
100
+
101
+ За да работите с mobiletto в командния ред, използвайте [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
+
103
+ ## Източник
104
+ * [mobiletto в GitHub](https://github.com/cobbzilla/mobiletto)
105
+ * [mobiletto на npm](https://www.npmjs.com/package/mobiletto)
106
+
107
+ ## Подкрепа и финансиране
108
+ Опитвам се да бъда професионален разработчик на софтуер с отворен код. Работил съм в
109
+ в софтуерната индустрия в продължение на много години, основах успешни компании и ги продадох на публични компании.
110
+ Наскоро загубих работата си и всъщност нямам никаква друга работа
111
+
112
+ Така че ще се опитам да напиша полезен софтуер и да видя дали работи
113
+
114
+ Ако обичате да използвате този софтуер, ще съм много благодарен дори за
115
+ най-малката [месечна вноска чрез Patreon](https://www.patreon.com/cobbzilla)
116
+
117
+ *Благодаря ти!*
118
+
119
+ ## Инсталация
120
+ Инсталирайте с помощта на `npm` или `yarn` . Вероятно искате `lite` версия, която не включва всички
121
+ преведени README файлове:
122
+
123
+ npm install mobiletto-lite
124
+ yarn add mobiletto-lite
125
+
126
+ Ако наистина искате файловете README на всеки език, инсталирайте пълната версия:
127
+
128
+ npm install mobiletto
129
+ yarn add mobiletto
130
+
131
+ ## Бърз старт
132
+ Кратък пример за използване на драйвера mobiletto `s3` .
133
+
134
+ Този код ще работи по същия начин, ако драйверът е `b2` или `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
+ ## Основна употреба
165
+ Много по-обширен пример, показващ повечето от предлаганите функции:
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
+ ## Метаданни
267
+ Командата `metadata` връща метаданни за един запис във файловата система.
268
+ По същия начин върнатата стойност от командата `list` е масив от обекти с метаданни.
269
+
270
+ Обект на метаданни изглежда така:
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
+ Свойството `type` type` може да бъде `file` , `dir` , `link` или `special` .
281
+
282
+ В зависимост от типа драйвер, командата `list` може да не върне всички полета. `name` и `type` type`
283
+ винаги трябва да присъства. Следваща команда `metadata` ще върне всички налични свойства.
284
+
285
+ ## Алтернативен стил на импортиране
286
+ Импортирайте модула с пълен обхват и използвайте функцията `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
+ ## Кеширане
294
+ Mobiletto работи най-добре с <a href="https://redis.io">Redis</a> кеш.
295
+
296
+ Mobiletto ще се опита да се свърже с екземпляр на redis на 127.0.0.1:6379
297
+
298
+ Можете да отмените едно от следните:
299
+ * Задайте `MOBILETTO_REDIS_HOST` env променлива, мобилно да се свързва тук вместо localhost
300
+ * Задайте env `MOBILETTO_REDIS_PORT` , този порт ще се използва
301
+
302
+ Mobiletto ще съхранява всички свои redis ключове с префикса `_mobiletto__` . Можете да промените това
303
+ като зададете `MOBILETTO_REDIS_PREFIX` env var.
304
+
305
+ Можете също да зададете кеширане за всяка връзка с обекта `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
+ ### Не искате redis кеширане?
317
+ За да деактивирате: подайте `enabled: false` във вашия обект `opts.redisConfig` , когато установите вашата връзка.
318
+
319
+ Както е обсъдено по-долу, деактивирането на кеширането ще има неблагоприятен ефект върху производителността и ще доведе до повече заявки
320
+ за съхранение, от което наистина се нуждаете.
321
+
322
+ ### Указания за кеширане
323
+ **Шифровано хранилище**: четенето/записването на криптирано хранилище е само малко по-бавно от нормалното,
324
+ но навигирането из директории (което някои неща правят) е доста скъпо. Използване на redis кеш
325
+ ще ви даде значително повишаване на производителността.
326
+
327
+ Кешът по подразбиране е безопасен, но не работи добре, ако имате много операции за запис/премахване.
328
+ Всяка операция за запис или премахване обезсилва целия кеш, като гарантира, че следващите четения ще видят
329
+ последни промени.
330
+
331
+ ### CLI инструменти
332
+ Ако използвате CLI инструмент като [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
+ определено ще искате redis кеша да е активиран, тъй като той продължава при извиквания на командата `mo` .
334
+
335
+ ## Отразяване
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
+ Командата `mirror` извършва еднократно копиране на всички файлове от едно мобилно устройство на друго.
344
+ Не изпълнява никакъв процес за поддържане на огледалото във времето. Изпълнете отново командата `mirror`
345
+ за синхронизиране на всички липсващи файлове.
346
+
347
+ Върнатата стойност от `mirror` е прост обект с броячи за това колко файла са били успешно извършени
348
+ огледален и колко файла са имали грешки:
349
+
350
+ {
351
+ success: count-of-files-mirrored,
352
+ errors: count-of-files-with-errors
353
+ }
354
+
355
+ ПРЕДУПРЕЖДЕНИЕ: Дублирането на големи набори от данни може да отнеме много време и интензивно на честотната лента
356
+
357
+ Със семантиката на повикването `mirror` понякога може да е объркващо да разберете кой е
358
+ читател и кой е писателят. Представете си го като декларация за присвояване: "лявата мобилно устройство"
359
+ е нещото, към което се присвоява (записани огледални данни) и „мобилното устройство отдясно“ (the
360
+ аргумент на метода `mirror` ) е стойността, която се присвоява (огледалните данни се четат).
361
+
362
+ ## Прозрачно криптиране
363
+ Активирайте прозрачно криптиране от страна на клиента:
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
+ Какво се случва? Отделна директория "запис в директория" (dirent) (криптирана) проследява какви файлове има в нея
383
+ директория (известна още като директория dirent).
384
+ * Командата `list` чете файловете за въвеждане на директория, дешифрира всеки изброен път; след това връща метаданни за всеки файл
385
+ * Командите `list` са по-неефективни, особено за директории с голям брой файлове
386
+ * Командата `write` записва dirent файлове във всяка родителска dirent директория, рекурсивно; след това записва файла
387
+ * Командите `write` ще предизвикат O(N) записвания, с N = дълбочина в йерархията на директорията
388
+ * Командата `remove` премахва съответния дирентен файл и неговия родител, ако е празен, рекурсивно; след това премахва файла
389
+ * `remove` команди за премахване ще доведат до O(N) четения и потенциално толкова много изтривания, с N = дълбочина в йерархията на директорията
390
+ * Рекурсивните команди `remove` на големи и дълбоки файлови системи могат да бъдат скъпи
391
+
392
+ Обърнете внимание, че дори с активирано криптиране от страна на клиента, противник с пълна видимост във вашата криптирана страна на сървъра
393
+ съхранение, дори и без ключа, пак може да види общия брой директории и колко файла има във всяка, и с
394
+ известно усилие, открийте част или цялата цялостна структура на йерархията на директорията.
395
+ *Забележка: Използвайте сравнително плоска структура за по-добра сигурност.*
396
+ Противникът няма да знае имената на директориите/файловете, освен ако не знае и вашето криптиране
397
+ ключ или по друг начин успешно е разбил криптирането. Тогава всички залози отпадат!
398
+
399
+ ### Производителност и кеширане
400
+ Операциите върху криптирано хранилище може да са бавни. Рекурсивните списъци и премахвания могат да бъдат много бавни.
401
+ Кеширането чрез redis помага изключително много, но имайте предвид, че кешът се изчиства при всякакви записи или премахвания.
402
+
403
+ ## Ключова ротация
404
+ Създайте mobiletto с вашия нов ключ, след което огледайте старите данни в него:
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
+ ## Интерфейс на драйвера
417
+ Драйвер е всеки JS файл, който експортира функция „storageClient“ с този подпис:
418
+
419
+ function storageClient (key, secret, opts)
420
+
421
+ * `key` : низ, вашият API ключ (за `local` драйвера това е основната директория)
422
+ * `secret` : низ, вашата API тайна (може да бъде пропусната за `local` драйвера)
423
+ * `opts` : обект, свойствата са за всеки драйвер:
424
+ * За `local` , свойствата `fileMode` и `dirMode` определят как се създават нови файлове и директории
425
+ * За `s3` се изисква свойството `bucket` . Незадължителните свойства са:
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
+ Обектът, който функцията storageClient връща, трябва да дефинира тези функции:
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
+ ## Регистриране
457
+ Mobiletto използва [winston](https://www.npmjs.com/package/winston) библиотеката за регистриране.
458
+
459
+ Регистрационните файлове **ще** съдържат пътеки към файлове и съобщения за грешки, но **никога** няма да съдържат ключове, тайни,
460
+ или друга информация за конфигурация на връзката.
461
+
462
+ ### Ниво на регистър
463
+ Използвайте променливата на средата `MOBILETTO_LOG_LEVEL` , за да зададете нивото на регистрационния файл, използвайки едно
464
+ на нивата `npm` , дефинирани в [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
+
466
+ Нивото по подразбиране е `error` . Най-подробното ниво е `silly` , въпреки че в момента е mobiletto
467
+ не се регистрира на нива под `debug`
468
+
469
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
+
471
+ ### Регистрационен файл
472
+ По подразбиране регистраторът записва в конзолата. За да изпратите регистрационни файлове към файл, задайте `MOBILETTO_LOG_FILE`
473
+ променлива на средата. Когато влизате във файл, регистрационните файлове вече няма да се записват в конзолата.
474
+
475
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
+
477
+ За да изключите регистрирането:
478
+
479
+ MOBILETTO_LOG_FILE=/dev/null
480
+
481
+ </pre>