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 é uma camada de abstração de armazenamento JavaScript, com criptografia opcional transparente do lado do cliente.
5
+
6
+ # Conteúdo
7
+ * [Por que Mobiletto?](#Why-Mobiletto?)
8
+ * [Início rápido](#Início rápido)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Fonte](#Fonte)
11
+ * [Uso básico](#Uso básico)
12
+ * [Metadados](#Metadados)
13
+ * [Estilo de importação alternativo](#Estilo de importação alternativo)
14
+ * [Caching](#Caching)
15
+ * [Espelhamento](#Espelhamento)
16
+ * [Criptografia transparente](#Transparent-encryption)
17
+ * [Rotação de chave](#Rotação de chave)
18
+ * [Interface de driver](#Driver-interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Leia isso em outro idioma
22
+ Este documento README.md foi traduzido, via [hokeylization](https://github.com/cobbzilla/hokeylization), para
23
+ **[todos os idiomas suportados pelo Google Tradutor](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Tenho certeza que não é perfeito, mas espero que seja melhor que nada!
26
+
27
+ [🇸🇦 Árabe](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 Alemão](../de/README.md)
30
+ [🇺🇸 Inglês](../en/README.md)
31
+ [🇪🇸 Espanhol](../es/README.md)
32
+ [🇫🇷 francês](../fr/README.md)
33
+ [🇹🇩 Hauçá](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 indonésio](../id/README.md)
36
+ [🇮🇹 Italiano](../it/README.md)
37
+ [🇯🇵 Japonês](../ja/README.md)
38
+ [🇰🇷 coreano](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 polonês](../pl/README.md)
41
+ [🇧🇷 Português](../pt/README.md)
42
+ [🇷🇺 russo](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalo](../tl/README.md)
45
+ [🇹🇷 Turco](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamita](../vi/README.md)
48
+ [🇨🇳 chinês](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Todos os Idiomas ...](../README.md)**
52
+ ----
53
+
54
+ ### Existe algum problema com esta tradução do README?
55
+ Esta tradução específica do original [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ pode estar com defeito -- *correções são muito bem-vindas!* Envie uma [solicitação de pull no GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ ou se você não se sentir à vontade para fazer isso, [abra um problema](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Ao criar um novo problema no GitHub sobre uma tradução, faça:
60
+ * inclua o URL da página (copiar/colar da barra de endereços do navegador)
61
+ * inclua o texto exato que está errado (copiar/colar do navegador)
62
+ * por favor descreva o que está errado -- a tradução está incorreta? a formatação está quebrada de alguma forma?
63
+ * gentilmente oferecer uma sugestão de uma tradução melhor, ou como o texto deve ser formatado corretamente
64
+ * **Obrigada!**
65
+
66
+ ## Por que Mobiletto?
67
+
68
+ ### Adeus bloqueio de fornecedor!
69
+ Os vários provedores de armazenamento em nuvem possuem APIs incompatíveis. Mesmo aqueles que buscam "compatibilidade com S3"
70
+ têm comportamentos idiossincráticos.
71
+
72
+ Ao escolher um fornecedor de armazenamento específico para seu aplicativo, se você codificar diretamente para a API dele, seu aplicativo
73
+ agora depende desse serviço. À medida que o tempo passa e o código se acumula, a mudança de fornecedor torna-se
74
+ cada vez mais insustentável. Bem-vindo ao mundo divertido do aprisionamento de fornecedores!
75
+
76
+ Mobiletto foi projetado para resolver este problema. Ao codificar seu aplicativo para a API do mobiletto, você pode facilmente
77
+ altere os provedores de armazenamento e saiba que a camada de armazenamento do seu aplicativo se comportará de forma idêntica.
78
+
79
+ ### Testes extensivos
80
+ Todos os drivers são testados para comportamento idêntico com mais de 60 testes para cada driver.
81
+ Testamos todos os drivers com todas as combinações de:
82
+ * Criptografia: habilitada e desabilitada
83
+ * Cache Redis: ativado e desativado
84
+
85
+ Essa abordagem nos dá a tranquilidade de que o mobiletto se comportará da mesma forma, independentemente de qual driver você usar,
86
+ e independentemente de você habilitar o cache e/ou a criptografia.
87
+
88
+ ### Suporte ao motorista
89
+ Drivers de armazenamento Mobiletto atuais:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : sistema de arquivos local
93
+
94
+ *Contribuições para dar suporte a mais provedores de armazenamento em nuvem são muito bem-vindas!*
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto destina-se a ser usado como uma biblioteca por outro código JavaScript.
98
+
99
+ Para trabalhar com mobiletto na linha de comando, use [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Fonte
102
+ * [mobiletto no GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto no npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Começo rápido
106
+ Um pequeno exemplo usando o driver mobiletto `s3` .
107
+
108
+ Este código seria executado da mesma forma se o driver fosse `b2` ou `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
+ ## Uso básico
139
+ Um exemplo muito mais extenso, mostrando a maioria dos recursos oferecidos:
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
+ ## Metadados
241
+ O comando `metadata` retorna metadados sobre uma única entrada do sistema de arquivos.
242
+ Da mesma forma, o valor de retorno do comando `list` é uma matriz de objetos de metadados.
243
+
244
+ Um objeto de metadados se parece com isso:
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
+ A propriedade `type` type` pode ser `file` , `dir` `link` ou `special` .
255
+
256
+ Dependendo do tipo de driver, um comando `list` pode não retornar todos os campos. As `name` e `type` type`
257
+ deve estar sempre presente. Um comando `metadata` subsequente retornará todas as propriedades disponíveis.
258
+
259
+ ## Estilo de importação alternativo
260
+ Importe o módulo com escopo completo e use a função `connect` :
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
+ ## Cache
268
+ O Mobiletto funciona melhor com um cache <a href="https://redis.io">redis</a> .
269
+
270
+ O Mobiletto tentará se conectar a uma instância redis em 127.0.0.1:6379
271
+
272
+ Você pode substituir qualquer um destes:
273
+ * Defina o env var `MOBILETTO_REDIS_HOST` , mobileto conectar aqui em vez de localhost
274
+ * Defina o env var `MOBILETTO_REDIS_PORT` , esta porta será usada
275
+
276
+ O Mobiletto armazenará todas as suas chaves redis com o prefixo `_mobiletto__` . Você pode mudar isso
277
+ definindo o ambiente `MOBILETTO_REDIS_PREFIX` var.
278
+
279
+ Você também pode definir o cache por conexão com o objeto `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
+ ### Não quer cache de redis?
291
+ Para desabilitar: passe `enabled: false` em seu objeto `opts.redisConfig` quando você estabelecer sua conexão.
292
+
293
+ Conforme discutido abaixo, desabilitar o cache terá um efeito adverso no desempenho e incorrerá em mais solicitações
294
+ ao armazenamento que você realmente precisa.
295
+
296
+ ### Orientação de cache
297
+ **Armazenamento criptografado**: a leitura/gravação do armazenamento criptografado é apenas um pouco mais lenta que o normal,
298
+ mas navegar pelos diretórios (o que algumas coisas fazem) é bastante caro. Usando um cache redis
299
+ lhe dará um aumento significativo de desempenho.
300
+
301
+ O cache padrão é seguro, mas não funciona bem se você tiver muitas operações de gravação/remoção.
302
+ Qualquer operação de gravação ou remoção invalida todo o cache, garantindo que as leituras subsequentes vejam o
303
+ últimas mudanças.
304
+
305
+ ### Ferramentas CLI
306
+ Se você estiver usando uma ferramenta CLI como [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ você definitivamente desejará que o cache redis esteja ativado, pois ele dura entre as invocações do comando `mo` .
308
+
309
+ ## Espelhamento
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
+ O comando `mirror` executa uma cópia única de todos os arquivos de um mobiletto para outro.
318
+ Ele não executa nenhum processo para manter o espelho ao longo do tempo. Execute o comando `mirror` novamente
319
+ para sincronizar quaisquer arquivos ausentes.
320
+
321
+ O valor de retorno de `mirror` é um objeto simples com contadores para quantos arquivos foram
322
+ espelhado e quantos arquivos tiveram erros:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ AVISO: espelhar grandes conjuntos de dados pode consumir muito tempo e consumir muita largura de banda
330
+
331
+ Com a semântica da chamada `mirror` às vezes pode ser confuso entender quem é o
332
+ leitor e quem é o escritor. Imagine isso como uma declaração de atribuição: o "mobiletto da mão esquerda"
333
+ é a coisa que está sendo atribuída (dados espelhados escritos), e o "mobiletto da mão direita" (o
334
+ argumento para o método `mirror` ) é o valor que está sendo atribuído (os dados espelhados são lidos).
335
+
336
+ ## Criptografia transparente
337
+ Habilite a criptografia transparente do lado do cliente:
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
+ O que está acontecendo? Um diretório separado de "entrada de diretório" (direto) (criptografado) rastreia quais arquivos estão nesse
357
+ diretório (também conhecido como diretório dirent).
358
+ * O comando `list` lê os arquivos de entrada do diretório, descriptografa cada caminho listado; em seguida, retorna metadados para cada arquivo
359
+ * Comandos `list` são mais ineficientes, especialmente para diretórios com um grande número de arquivos
360
+ * O comando `write` escreve arquivos dirent no diretório dirent de cada pai, recursivamente; então escreve o arquivo
361
+ * Comandos `write` incorrerão em gravações O(N), com N = profundidade na hierarquia de diretórios
362
+ * O comando `remove` remove o arquivo dirent correspondente, e seu pai se estiver vazio, recursivamente; em seguida, remove o arquivo
363
+ * Comandos `remove` não recursivos incorrerão em O(N) leituras e potencialmente tantas exclusões, com N = profundidade na hierarquia de diretórios
364
+ * Comandos recursivos `remove` em sistemas de arquivos grandes e profundos podem ser caros
365
+
366
+ Observe que, mesmo com a criptografia do lado do cliente habilitada, um adversário com visibilidade total do seu lado do servidor criptografado
367
+ armazenamento, mesmo sem a chave, ainda pode ver o número total de diretórios e quantos arquivos estão em cada um, e com
368
+ algum esforço, descubra parte ou toda a estrutura geral da hierarquia de diretórios.
369
+ *Observação: use uma estrutura relativamente plana para maior segurança.*
370
+ O adversário não saberia os nomes dos diretórios/arquivos a menos que também conhecesse sua criptografia
371
+ chave ou de outra forma quebrou a criptografia com sucesso. Todas as apostas estão fora então!
372
+
373
+ ### Desempenho e cache
374
+ As operações no armazenamento criptografado podem ser lentas. Listagens e remoções recursivas podem ser muito lentas.
375
+ O armazenamento em cache via redis ajuda tremendamente, mas observe que o cache é liberado em qualquer gravação ou remoção.
376
+
377
+ ## Rotação de chave
378
+ Crie um mobiletto com sua nova chave e espelhe os dados antigos nele:
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
+ ## Interface do driver
391
+ Um driver é qualquer arquivo JS que exporta uma função 'storageClient' com esta assinatura:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : uma string, sua chave de API (para o driver `local` este é o diretório base)
396
+ * `secret` : uma string, seu segredo de API (pode ser omitido para o driver `local` )
397
+ * `opts` : um objeto, as propriedades são por driver:
398
+ * Para `local` , as `fileMode` e `dirMode` determinam como os novos arquivos e diretórios de criação são criados
399
+ * Para `s3` , a propriedade `bucket` é necessária. As propriedades opcionais são:
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
+ O objeto que a função storageClient retorna deve definir estas funções:
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
+ ## Exploração madeireira
431
+ Mobiletto usa a biblioteca de log [winston](https://www.npmjs.com/package/winston).
432
+
433
+ Os registros **conterão** caminhos de arquivo e mensagens de erro, mas **nunca** conterão chaves, segredos,
434
+ ou qualquer outra informação de configuração de conexão.
435
+
436
+ ### Nível de registro
437
+ Use a variável de ambiente `MOBILETTO_LOG_LEVEL` para definir o nível de log, usando um
438
+ dos níveis `npm` definidos em [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ O nível padrão é `error` . O nível mais detalhado é `silly` , embora atualmente mobiletto
441
+ não loga em níveis abaixo `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### Arquivo de log
446
+ Por padrão, o registrador grava no console. Para enviar logs para um arquivo, defina o `MOBILETTO_LOG_FILE`
447
+ variável de ambiente. Ao fazer login em um arquivo, os logs não serão mais gravados no console.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Para desativar o registro:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>