mobiletto 1.2.1 → 2.0.0
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.
- package/lib/cjs/index.d.ts +2 -0
- package/lib/cjs/index.js +30 -0
- package/lib/cjs/package.json +16 -0
- package/lib/esm/index.d.ts +2 -0
- package/lib/esm/index.js +12 -0
- package/package.json +27 -13
- package/.babelrc +0 -5
- package/.eslintrc.js +0 -14
- package/docs/README.md +0 -113
- package/docs/af/README.md +0 -481
- package/docs/am/README.md +0 -481
- package/docs/ar/README.md +0 -481
- package/docs/az/README.md +0 -481
- package/docs/be/README.md +0 -481
- package/docs/bg/README.md +0 -481
- package/docs/bn/README.md +0 -481
- package/docs/bs/README.md +0 -481
- package/docs/ca/README.md +0 -481
- package/docs/ceb/README.md +0 -481
- package/docs/co/README.md +0 -481
- package/docs/cs/README.md +0 -481
- package/docs/cy/README.md +0 -481
- package/docs/da/README.md +0 -481
- package/docs/de/README.md +0 -481
- package/docs/el/README.md +0 -481
- package/docs/eo/README.md +0 -481
- package/docs/es/README.md +0 -481
- package/docs/et/README.md +0 -481
- package/docs/eu/README.md +0 -481
- package/docs/fa/README.md +0 -481
- package/docs/fi/README.md +0 -481
- package/docs/fr/README.md +0 -481
- package/docs/fy/README.md +0 -481
- package/docs/ga/README.md +0 -481
- package/docs/gd/README.md +0 -481
- package/docs/gl/README.md +0 -481
- package/docs/gu/README.md +0 -481
- package/docs/ha/README.md +0 -481
- package/docs/haw/README.md +0 -481
- package/docs/he/README.md +0 -481
- package/docs/hi/README.md +0 -481
- package/docs/hmn/README.md +0 -481
- package/docs/hr/README.md +0 -481
- package/docs/ht/README.md +0 -481
- package/docs/hu/README.md +0 -481
- package/docs/hy/README.md +0 -481
- package/docs/id/README.md +0 -481
- package/docs/ig/README.md +0 -481
- package/docs/is/README.md +0 -481
- package/docs/it/README.md +0 -481
- package/docs/iw/README.md +0 -481
- package/docs/ja/README.md +0 -481
- package/docs/jv/README.md +0 -481
- package/docs/ka/README.md +0 -481
- package/docs/kk/README.md +0 -481
- package/docs/km/README.md +0 -481
- package/docs/kn/README.md +0 -481
- package/docs/ko/README.md +0 -481
- package/docs/ku/README.md +0 -481
- package/docs/ky/README.md +0 -481
- package/docs/la/README.md +0 -481
- package/docs/lb/README.md +0 -481
- package/docs/lo/README.md +0 -481
- package/docs/lt/README.md +0 -481
- package/docs/lv/README.md +0 -481
- package/docs/mg/README.md +0 -481
- package/docs/mi/README.md +0 -481
- package/docs/mk/README.md +0 -481
- package/docs/ml/README.md +0 -481
- package/docs/mn/README.md +0 -481
- package/docs/mr/README.md +0 -481
- package/docs/ms/README.md +0 -481
- package/docs/mt/README.md +0 -481
- package/docs/my/README.md +0 -481
- package/docs/ne/README.md +0 -481
- package/docs/nl/README.md +0 -481
- package/docs/no/README.md +0 -481
- package/docs/ny/README.md +0 -481
- package/docs/or/README.md +0 -481
- package/docs/pa/README.md +0 -481
- package/docs/pl/README.md +0 -481
- package/docs/ps/README.md +0 -481
- package/docs/pt/README.md +0 -481
- package/docs/ro/README.md +0 -481
- package/docs/ru/README.md +0 -481
- package/docs/rw/README.md +0 -481
- package/docs/sd/README.md +0 -481
- package/docs/si/README.md +0 -481
- package/docs/sk/README.md +0 -481
- package/docs/sl/README.md +0 -481
- package/docs/sm/README.md +0 -481
- package/docs/sn/README.md +0 -481
- package/docs/so/README.md +0 -481
- package/docs/sq/README.md +0 -481
- package/docs/sr/README.md +0 -481
- package/docs/st/README.md +0 -481
- package/docs/su/README.md +0 -481
- package/docs/sv/README.md +0 -481
- package/docs/sw/README.md +0 -481
- package/docs/ta/README.md +0 -481
- package/docs/te/README.md +0 -481
- package/docs/tg/README.md +0 -481
- package/docs/th/README.md +0 -481
- package/docs/tk/README.md +0 -481
- package/docs/tl/README.md +0 -481
- package/docs/tr/README.md +0 -481
- package/docs/tt/README.md +0 -481
- package/docs/ug/README.md +0 -481
- package/docs/uk/README.md +0 -481
- package/docs/ur/README.md +0 -481
- package/docs/uz/README.md +0 -481
- package/docs/vi/README.md +0 -481
- package/docs/xh/README.md +0 -481
- package/docs/yi/README.md +0 -481
- package/docs/yo/README.md +0 -481
- package/docs/zh/README.md +0 -481
- package/docs/zu/README.md +0 -481
- package/drivers/b2/index.js +0 -451
- package/drivers/local/index.js +0 -315
- package/drivers/s3/index.js +0 -316
- package/hokey.json +0 -16
- package/index.js +0 -29
- package/test/api.spec.js +0 -512
- package/test/crypt.spec.js +0 -67
package/docs/pt/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
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
|
-
* [Instalação](#Instalação)
|
|
12
|
-
* [Suporte e Financiamento](#Suporte-e-Financiamento)
|
|
13
|
-
* [Uso básico](#Uso básico)
|
|
14
|
-
* [Metadados](#Metadados)
|
|
15
|
-
* [Estilo de importação alternativo](#Estilo de importação alternativo)
|
|
16
|
-
* [Caching](#Caching)
|
|
17
|
-
* [Espelhamento](#Espelhamento)
|
|
18
|
-
* [Criptografia transparente](#Transparent-encryption)
|
|
19
|
-
* [Rotação de chave](#Rotação de chave)
|
|
20
|
-
* [Interface de driver](#Driver-interface)
|
|
21
|
-
* [Logging](#Logging)
|
|
22
|
-
|
|
23
|
-
# Leia isso em outro idioma
|
|
24
|
-
Este documento README.md foi traduzido, via [hokeylization](https://github.com/cobbzilla/hokeylization), para
|
|
25
|
-
**[todos os idiomas suportados pelo Google Tradutor](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
-
|
|
27
|
-
Tenho certeza que não é perfeito, mas espero que seja melhor que nada!
|
|
28
|
-
|
|
29
|
-
[🇸🇦 Árabe](../ar/README.md)
|
|
30
|
-
[🇧🇩 Bengali](../bn/README.md)
|
|
31
|
-
[🇩🇪 Alemão](../de/README.md)
|
|
32
|
-
[🇺🇸 Inglês](../en/README.md)
|
|
33
|
-
[🇪🇸 Espanhol](../es/README.md)
|
|
34
|
-
[🇫🇷 francês](../fr/README.md)
|
|
35
|
-
[🇹🇩 Hauçá](../ha/README.md)
|
|
36
|
-
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
-
[🇮🇩 indonésio](../id/README.md)
|
|
38
|
-
[🇮🇹 Italiano](../it/README.md)
|
|
39
|
-
[🇯🇵 Japonês](../ja/README.md)
|
|
40
|
-
[🇰🇷 coreano](../ko/README.md)
|
|
41
|
-
[🇮🇳 Marathi](../mr/README.md)
|
|
42
|
-
[🇵🇱 polonês](../pl/README.md)
|
|
43
|
-
[🇧🇷 Português](../pt/README.md)
|
|
44
|
-
[🇷🇺 russo](../ru/README.md)
|
|
45
|
-
[🇰🇪 Swahili](../sw/README.md)
|
|
46
|
-
[🇵🇭 Tagalo](../tl/README.md)
|
|
47
|
-
[🇹🇷 Turco](../tr/README.md)
|
|
48
|
-
[🇵🇰 Urdu](../ur/README.md)
|
|
49
|
-
[🇻🇳 Vietnamita](../vi/README.md)
|
|
50
|
-
[🇨🇳 chinês](../zh/README.md)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
**[📚 ... Todos os Idiomas ...](../README.md)**
|
|
54
|
-
----
|
|
55
|
-
|
|
56
|
-
### Existe algum problema com esta tradução do README?
|
|
57
|
-
Esta tradução específica do original [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
-
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),
|
|
59
|
-
ou se você não se sentir à vontade para fazer isso, [abra um problema](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
-
|
|
61
|
-
Ao criar um novo problema no GitHub sobre uma tradução, faça:
|
|
62
|
-
* inclua o URL da página (copiar/colar da barra de endereços do navegador)
|
|
63
|
-
* inclua o texto exato que está errado (copiar/colar do navegador)
|
|
64
|
-
* por favor descreva o que está errado -- a tradução está incorreta? a formatação está quebrada de alguma forma?
|
|
65
|
-
* gentilmente oferecer uma sugestão de uma tradução melhor, ou como o texto deve ser formatado corretamente
|
|
66
|
-
* **Obrigada!**
|
|
67
|
-
|
|
68
|
-
## Por que Mobiletto?
|
|
69
|
-
|
|
70
|
-
### Adeus bloqueio de fornecedor!
|
|
71
|
-
Os vários provedores de armazenamento em nuvem possuem APIs incompatíveis. Mesmo aqueles que buscam "compatibilidade com S3"
|
|
72
|
-
têm comportamentos idiossincráticos.
|
|
73
|
-
|
|
74
|
-
Ao escolher um fornecedor de armazenamento específico para seu aplicativo, se você codificar diretamente para a API dele, seu aplicativo
|
|
75
|
-
agora depende desse serviço. À medida que o tempo passa e o código se acumula, a mudança de fornecedor torna-se
|
|
76
|
-
cada vez mais insustentável. Bem-vindo ao mundo divertido do aprisionamento de fornecedores!
|
|
77
|
-
|
|
78
|
-
Mobiletto foi projetado para resolver este problema. Ao codificar seu aplicativo para a API do mobiletto, você pode facilmente
|
|
79
|
-
altere os provedores de armazenamento e saiba que a camada de armazenamento do seu aplicativo se comportará de forma idêntica.
|
|
80
|
-
|
|
81
|
-
### Testes extensivos
|
|
82
|
-
Todos os drivers são testados para comportamento idêntico com mais de 60 testes para cada driver.
|
|
83
|
-
Testamos todos os drivers com todas as combinações de:
|
|
84
|
-
* Criptografia: habilitada e desabilitada
|
|
85
|
-
* Cache Redis: ativado e desativado
|
|
86
|
-
|
|
87
|
-
Essa abordagem nos dá a tranquilidade de que o mobiletto se comportará da mesma forma, independentemente de qual driver você usar,
|
|
88
|
-
e independentemente de você habilitar o cache e/ou a criptografia.
|
|
89
|
-
|
|
90
|
-
### Suporte ao motorista
|
|
91
|
-
Drivers de armazenamento Mobiletto atuais:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : Backblaze B2
|
|
94
|
-
* `local` : sistema de arquivos local
|
|
95
|
-
|
|
96
|
-
*Contribuições para dar suporte a mais provedores de armazenamento em nuvem são muito bem-vindas!*
|
|
97
|
-
|
|
98
|
-
## mobiletto-cli
|
|
99
|
-
Mobiletto destina-se a ser usado como uma biblioteca por outro código JavaScript.
|
|
100
|
-
|
|
101
|
-
Para trabalhar com mobiletto na linha de comando, use [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
-
|
|
103
|
-
## Fonte
|
|
104
|
-
* [mobiletto no GitHub](https://github.com/cobbzilla/mobiletto)
|
|
105
|
-
* [mobiletto no npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
-
|
|
107
|
-
## Apoio e Financiamento
|
|
108
|
-
Estou tentando ser um desenvolvedor profissional de software de código aberto. eu tenho trabalhado em
|
|
109
|
-
na indústria de software por muitos anos, criei empresas de sucesso e as vendi para empresas públicas.
|
|
110
|
-
Recentemente eu perdi meu emprego, e eu realmente não tenho nenhum outro trabalho alinhado
|
|
111
|
-
|
|
112
|
-
Então, vou tentar escrever um software útil e ver se isso funciona
|
|
113
|
-
|
|
114
|
-
Se você gosta de usar este software, eu ficaria muito grato até mesmo pelo
|
|
115
|
-
menor [contribuição mensal via Patreon](https://www.patreon.com/cobbzilla)
|
|
116
|
-
|
|
117
|
-
*Obrigada!*
|
|
118
|
-
|
|
119
|
-
## Instalação
|
|
120
|
-
Instale usando `npm` ou `yarn` . Você provavelmente quer a versão `lite` que não inclui todos os
|
|
121
|
-
arquivos README traduzidos:
|
|
122
|
-
|
|
123
|
-
npm install mobiletto-lite
|
|
124
|
-
yarn add mobiletto-lite
|
|
125
|
-
|
|
126
|
-
Se você realmente deseja os arquivos README em todos os idiomas, instale a versão completa:
|
|
127
|
-
|
|
128
|
-
npm install mobiletto
|
|
129
|
-
yarn add mobiletto
|
|
130
|
-
|
|
131
|
-
## Começo rápido
|
|
132
|
-
Um pequeno exemplo usando o driver mobiletto `s3` .
|
|
133
|
-
|
|
134
|
-
Este código seria executado da mesma forma se o driver fosse `b2` ou `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
|
-
## Uso básico
|
|
165
|
-
Um exemplo muito mais extenso, mostrando a maioria dos recursos oferecidos:
|
|
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
|
-
## Metadados
|
|
267
|
-
O comando `metadata` retorna metadados sobre uma única entrada do sistema de arquivos.
|
|
268
|
-
Da mesma forma, o valor de retorno do comando `list` é uma matriz de objetos de metadados.
|
|
269
|
-
|
|
270
|
-
Um objeto de metadados se parece com isso:
|
|
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
|
-
A propriedade `type` type` pode ser `file` , `dir` `link` ou `special` .
|
|
281
|
-
|
|
282
|
-
Dependendo do tipo de driver, um comando `list` pode não retornar todos os campos. As `name` e `type` type`
|
|
283
|
-
deve estar sempre presente. Um comando `metadata` subsequente retornará todas as propriedades disponíveis.
|
|
284
|
-
|
|
285
|
-
## Estilo de importação alternativo
|
|
286
|
-
Importe o módulo com escopo completo e use a função `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
|
-
## Cache
|
|
294
|
-
O Mobiletto funciona melhor com um cache <a href="https://redis.io">redis</a> .
|
|
295
|
-
|
|
296
|
-
O Mobiletto tentará se conectar a uma instância redis em 127.0.0.1:6379
|
|
297
|
-
|
|
298
|
-
Você pode substituir qualquer um destes:
|
|
299
|
-
* Defina o env var `MOBILETTO_REDIS_HOST` , mobileto conectar aqui em vez de localhost
|
|
300
|
-
* Defina o env var `MOBILETTO_REDIS_PORT` , esta porta será usada
|
|
301
|
-
|
|
302
|
-
O Mobiletto armazenará todas as suas chaves redis com o prefixo `_mobiletto__` . Você pode mudar isso
|
|
303
|
-
definindo o ambiente `MOBILETTO_REDIS_PREFIX` var.
|
|
304
|
-
|
|
305
|
-
Você também pode definir o cache por conexão com o objeto `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
|
-
### Não quer cache de redis?
|
|
317
|
-
Para desabilitar: passe `enabled: false` em seu objeto `opts.redisConfig` quando você estabelecer sua conexão.
|
|
318
|
-
|
|
319
|
-
Conforme discutido abaixo, desabilitar o cache terá um efeito adverso no desempenho e incorrerá em mais solicitações
|
|
320
|
-
ao armazenamento que você realmente precisa.
|
|
321
|
-
|
|
322
|
-
### Orientação de cache
|
|
323
|
-
**Armazenamento criptografado**: a leitura/gravação do armazenamento criptografado é apenas um pouco mais lenta que o normal,
|
|
324
|
-
mas navegar pelos diretórios (o que algumas coisas fazem) é bastante caro. Usando um cache redis
|
|
325
|
-
lhe dará um aumento significativo de desempenho.
|
|
326
|
-
|
|
327
|
-
O cache padrão é seguro, mas não funciona bem se você tiver muitas operações de gravação/remoção.
|
|
328
|
-
Qualquer operação de gravação ou remoção invalida todo o cache, garantindo que as leituras subsequentes vejam o
|
|
329
|
-
últimas mudanças.
|
|
330
|
-
|
|
331
|
-
### Ferramentas CLI
|
|
332
|
-
Se você estiver usando uma ferramenta CLI como [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
-
você definitivamente desejará que o cache redis esteja ativado, pois ele dura entre as invocações do comando `mo` .
|
|
334
|
-
|
|
335
|
-
## Espelhamento
|
|
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
|
-
O comando `mirror` executa uma cópia única de todos os arquivos de um mobiletto para outro.
|
|
344
|
-
Ele não executa nenhum processo para manter o espelho ao longo do tempo. Execute o comando `mirror` novamente
|
|
345
|
-
para sincronizar quaisquer arquivos ausentes.
|
|
346
|
-
|
|
347
|
-
O valor de retorno de `mirror` é um objeto simples com contadores para quantos arquivos foram
|
|
348
|
-
espelhado e quantos arquivos tiveram erros:
|
|
349
|
-
|
|
350
|
-
{
|
|
351
|
-
success: count-of-files-mirrored,
|
|
352
|
-
errors: count-of-files-with-errors
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
AVISO: espelhar grandes conjuntos de dados pode consumir muito tempo e consumir muita largura de banda
|
|
356
|
-
|
|
357
|
-
Com a semântica da chamada `mirror` às vezes pode ser confuso entender quem é o
|
|
358
|
-
leitor e quem é o escritor. Imagine isso como uma declaração de atribuição: o "mobiletto da mão esquerda"
|
|
359
|
-
é a coisa que está sendo atribuída (dados espelhados escritos), e o "mobiletto da mão direita" (o
|
|
360
|
-
argumento para o método `mirror` ) é o valor que está sendo atribuído (os dados espelhados são lidos).
|
|
361
|
-
|
|
362
|
-
## Criptografia transparente
|
|
363
|
-
Habilite a criptografia transparente do lado do cliente:
|
|
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
|
-
O que está acontecendo? Um diretório separado de "entrada de diretório" (direto) (criptografado) rastreia quais arquivos estão nesse
|
|
383
|
-
diretório (também conhecido como diretório dirent).
|
|
384
|
-
* O comando `list` lê os arquivos de entrada do diretório, descriptografa cada caminho listado; em seguida, retorna metadados para cada arquivo
|
|
385
|
-
* Comandos `list` são mais ineficientes, especialmente para diretórios com um grande número de arquivos
|
|
386
|
-
* O comando `write` escreve arquivos dirent no diretório dirent de cada pai, recursivamente; então escreve o arquivo
|
|
387
|
-
* Comandos `write` incorrerão em gravações O(N), com N = profundidade na hierarquia de diretórios
|
|
388
|
-
* O comando `remove` remove o arquivo dirent correspondente, e seu pai se estiver vazio, recursivamente; em seguida, remove o arquivo
|
|
389
|
-
* Comandos `remove` não recursivos incorrerão em O(N) leituras e potencialmente tantas exclusões, com N = profundidade na hierarquia de diretórios
|
|
390
|
-
* Comandos recursivos `remove` em sistemas de arquivos grandes e profundos podem ser caros
|
|
391
|
-
|
|
392
|
-
Observe que, mesmo com a criptografia do lado do cliente habilitada, um adversário com visibilidade total do seu lado do servidor criptografado
|
|
393
|
-
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
|
|
394
|
-
algum esforço, descubra parte ou toda a estrutura geral da hierarquia de diretórios.
|
|
395
|
-
*Observação: use uma estrutura relativamente plana para maior segurança.*
|
|
396
|
-
O adversário não saberia os nomes dos diretórios/arquivos a menos que também conhecesse sua criptografia
|
|
397
|
-
chave ou de outra forma quebrou a criptografia com sucesso. Todas as apostas estão fora então!
|
|
398
|
-
|
|
399
|
-
### Desempenho e cache
|
|
400
|
-
As operações no armazenamento criptografado podem ser lentas. Listagens e remoções recursivas podem ser muito lentas.
|
|
401
|
-
O armazenamento em cache via redis ajuda tremendamente, mas observe que o cache é liberado em qualquer gravação ou remoção.
|
|
402
|
-
|
|
403
|
-
## Rotação de chave
|
|
404
|
-
Crie um mobiletto com sua nova chave e espelhe os dados antigos nele:
|
|
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
|
-
## Interface do driver
|
|
417
|
-
Um driver é qualquer arquivo JS que exporta uma função 'storageClient' com esta assinatura:
|
|
418
|
-
|
|
419
|
-
function storageClient (key, secret, opts)
|
|
420
|
-
|
|
421
|
-
* `key` : uma string, sua chave de API (para o driver `local` este é o diretório base)
|
|
422
|
-
* `secret` : uma string, seu segredo de API (pode ser omitido para o driver `local` )
|
|
423
|
-
* `opts` : um objeto, as propriedades são por driver:
|
|
424
|
-
* Para `local` , as `fileMode` e `dirMode` determinam como os novos arquivos e diretórios de criação são criados
|
|
425
|
-
* Para `s3` , a propriedade `bucket` é necessária. As propriedades opcionais são:
|
|
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
|
-
O objeto que a função storageClient retorna deve definir estas funções:
|
|
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
|
-
## Exploração madeireira
|
|
457
|
-
Mobiletto usa a biblioteca de log [winston](https://www.npmjs.com/package/winston).
|
|
458
|
-
|
|
459
|
-
Os registros **conterão** caminhos de arquivo e mensagens de erro, mas **nunca** conterão chaves, segredos,
|
|
460
|
-
ou qualquer outra informação de configuração de conexão.
|
|
461
|
-
|
|
462
|
-
### Nível de registro
|
|
463
|
-
Use a variável de ambiente `MOBILETTO_LOG_LEVEL` para definir o nível de log, usando um
|
|
464
|
-
dos níveis `npm` definidos em [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
-
|
|
466
|
-
O nível padrão é `error` . O nível mais detalhado é `silly` , embora atualmente mobiletto
|
|
467
|
-
não loga em níveis abaixo `debug`
|
|
468
|
-
|
|
469
|
-
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
-
|
|
471
|
-
### Arquivo de log
|
|
472
|
-
Por padrão, o registrador grava no console. Para enviar logs para um arquivo, defina o `MOBILETTO_LOG_FILE`
|
|
473
|
-
variável de ambiente. Ao fazer login em um arquivo, os logs não serão mais gravados no console.
|
|
474
|
-
|
|
475
|
-
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
-
|
|
477
|
-
Para desativar o registro:
|
|
478
|
-
|
|
479
|
-
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
-
|
|
481
|
-
</pre>
|