mobiletto 1.2.0 → 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 -10
- package/test/api.spec.js +0 -512
- package/test/crypt.spec.js +0 -67
- package/util/crypt.js +0 -80
- package/util/logger.js +0 -27
- package/util/redis.js +0 -233
package/docs/gl/README.md
DELETED
|
@@ -1,481 +0,0 @@
|
|
|
1
|
-
Mobiletto
|
|
2
|
-
=========
|
|
3
|
-
|
|
4
|
-
Mobiletto é unha capa de abstracción de almacenamento de JavaScript, con cifrado transparente do lado do cliente opcional.
|
|
5
|
-
|
|
6
|
-
# Contidos
|
|
7
|
-
* [Por que Mobiletto?](#Why-Mobiletto?)
|
|
8
|
-
* [Inicio rápido](#Inicio rápido)
|
|
9
|
-
* [Mobiletto CLI](#mobiletto-cli)
|
|
10
|
-
* [Fonte](#Fonte)
|
|
11
|
-
* [Instalación](#Instalación)
|
|
12
|
-
* [Apoio e financiamento](#Support-and-Funding)
|
|
13
|
-
* [Uso básico](#Uso básico)
|
|
14
|
-
* [Metadatos](#Metadatos)
|
|
15
|
-
* [Estilo de importación alternativo](#Estilo de importación alternativo)
|
|
16
|
-
* [Almacenamento na caché](#Almacenamento na caché)
|
|
17
|
-
* [Replicación](#Replicación)
|
|
18
|
-
* [Cifrado transparente](#Transparent-encryption)
|
|
19
|
-
* [Rotación da tecla](#Rotación da tecla)
|
|
20
|
-
* [Interface do controlador](#Interfaz do controlador)
|
|
21
|
-
* [Rexistro](#Rexistro)
|
|
22
|
-
|
|
23
|
-
# Le isto noutro idioma
|
|
24
|
-
Este documento README.md foi traducido, a través de [hokeylization](https://github.com/cobbzilla/hokeylization), a
|
|
25
|
-
**[todos os idiomas admitidos por Google Translate](https://cloud.google.com/translate/docs/languages)!**
|
|
26
|
-
|
|
27
|
-
Estou seguro de que non é perfecto, pero espero que sexa mellor que nada!
|
|
28
|
-
|
|
29
|
-
[🇸🇦 árabe](../ar/README.md)
|
|
30
|
-
[🇧🇩 bengalí](../bn/README.md)
|
|
31
|
-
[🇩🇪 Alemán](../de/README.md)
|
|
32
|
-
[🇺🇸 inglés](../en/README.md)
|
|
33
|
-
[🇪🇸 Español](../es/README.md)
|
|
34
|
-
[🇫🇷 Francés](../fr/README.md)
|
|
35
|
-
[🇹🇩 Hausa](../ha/README.md)
|
|
36
|
-
[🇮🇳 Hindi](../hi/README.md)
|
|
37
|
-
[🇮🇩 indonesio](../id/README.md)
|
|
38
|
-
[🇮🇹 italiano](../it/README.md)
|
|
39
|
-
[🇯🇵 xaponés](../ja/README.md)
|
|
40
|
-
[🇰🇷 Coreano](../ko/README.md)
|
|
41
|
-
[🇮🇳 Marathi](../mr/README.md)
|
|
42
|
-
[🇵🇱 Polaco](../pl/README.md)
|
|
43
|
-
[🇧🇷 Portugués](../pt/README.md)
|
|
44
|
-
[🇷🇺 Ruso](../ru/README.md)
|
|
45
|
-
[🇰🇪 suahili](../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
|
-
### Hai algún problema con esta tradución do README?
|
|
57
|
-
Esta tradución particular do orixinal [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
|
|
58
|
-
pode ser defectuoso -- *¡As correccións son moi benvidas!* Envía unha [solicitude de extracción en GitHub](https://github.com/cobbzilla/mobiletto/pulls),
|
|
59
|
-
ou se non estás cómodo facendo iso, [abre un problema](https://github.com/cobbzilla/mobiletto/issues)
|
|
60
|
-
|
|
61
|
-
Cando crees un novo problema de GitHub sobre unha tradución, fai:
|
|
62
|
-
* inclúa o URL da páxina (copiar/pegar da barra de enderezos do navegador)
|
|
63
|
-
* inclúa o texto exacto incorrecto (copiar/pegar desde o navegador)
|
|
64
|
-
* Describe o que está mal: a tradución é incorrecta? o formato está roto dalgún xeito?
|
|
65
|
-
* Ofrecer amablemente unha suxestión dunha mellor tradución, ou como o texto debe estar formateado correctamente
|
|
66
|
-
* **Grazas!**
|
|
67
|
-
|
|
68
|
-
## Por que Mobiletto?
|
|
69
|
-
|
|
70
|
-
### Adeus bloqueo de vendedores!
|
|
71
|
-
Os distintos provedores de almacenamento na nube teñen API incompatibles. Incluso aqueles que se esforzan pola "compatibilidade S3"
|
|
72
|
-
teñen comportamentos idiosincráticos.
|
|
73
|
-
|
|
74
|
-
Cando escolles un provedor de almacenamento concreto para a túa aplicación, se codificas directamente na súa API, a túa aplicación
|
|
75
|
-
agora depende dese servizo. A medida que pasa o tempo e o código se acumula, cambian de provedores
|
|
76
|
-
cada vez máis insostible. Benvido ao divertido mundo do bloqueo de vendedores!
|
|
77
|
-
|
|
78
|
-
Mobiletto foi deseñado para resolver este problema. Ao codificar a túa aplicación na API de mobiletto, podes facilmente
|
|
79
|
-
cambia os provedores de almacenamento e sabe que a capa de almacenamento da túa aplicación se comportará de forma idéntica.
|
|
80
|
-
|
|
81
|
-
### Probas extensas
|
|
82
|
-
Todos os condutores son probados para un comportamento idéntico con máis de 60 probas para cada condutor.
|
|
83
|
-
Probamos todos os controladores con cada combinación de:
|
|
84
|
-
* Cifrado: tanto activado como desactivado
|
|
85
|
-
* Caché Redis: activada e desactivada
|
|
86
|
-
|
|
87
|
-
Este enfoque dános a tranquilidade de que o mobiletto se comportará igual independentemente do controlador que utilices.
|
|
88
|
-
e independentemente de se activa o caché e/ou o cifrado.
|
|
89
|
-
|
|
90
|
-
### Soporte ao controlador
|
|
91
|
-
Controladores de almacenamento de Mobiletto actuais:
|
|
92
|
-
* `s3` : Amazon S3
|
|
93
|
-
* `b2` : Backblaze B2
|
|
94
|
-
* `local` : sistema de ficheiros local
|
|
95
|
-
|
|
96
|
-
*As contribucións para apoiar máis provedores de almacenamento na nube son moi benvidas!*
|
|
97
|
-
|
|
98
|
-
## mobiletto-cli
|
|
99
|
-
Mobiletto está pensado para ser usado como biblioteca por outro código JavaScript.
|
|
100
|
-
|
|
101
|
-
Para traballar con mobiletto na liña de comandos, use [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
|
|
102
|
-
|
|
103
|
-
## Fonte
|
|
104
|
-
* [mobiletto en GitHub](https://github.com/cobbzilla/mobiletto)
|
|
105
|
-
* [mobiletto en npm](https://www.npmjs.com/package/mobiletto)
|
|
106
|
-
|
|
107
|
-
## Apoio e financiamento
|
|
108
|
-
Estou tentando ser un programador profesional de software de código aberto. Estiven traballando
|
|
109
|
-
da industria do software durante moitos anos, comecei empresas exitosas e vendínllas a empresas públicas.
|
|
110
|
-
Recentemente perdín o meu traballo, e realmente non teño ningún outro traballo preparado
|
|
111
|
-
|
|
112
|
-
Entón, vou tentar escribir un software útil e ver se funciona
|
|
113
|
-
|
|
114
|
-
Se che gusta usar este software, estaríalle moi agradecido
|
|
115
|
-
máis pequena [contribución mensual a través de Patreon](https://www.patreon.com/cobbzilla)
|
|
116
|
-
|
|
117
|
-
*Grazas!*
|
|
118
|
-
|
|
119
|
-
## Instalación
|
|
120
|
-
Instale usando `npm` ou `yarn` . Probablemente queira a versión `lite` que non inclúa todos os
|
|
121
|
-
ficheiros README traducidos:
|
|
122
|
-
|
|
123
|
-
npm install mobiletto-lite
|
|
124
|
-
yarn add mobiletto-lite
|
|
125
|
-
|
|
126
|
-
Se realmente queres os ficheiros README en todos os idiomas, instala a versión completa:
|
|
127
|
-
|
|
128
|
-
npm install mobiletto
|
|
129
|
-
yarn add mobiletto
|
|
130
|
-
|
|
131
|
-
## Inicio rápido
|
|
132
|
-
Un pequeno exemplo usando o controlador mobiletto `s3` .
|
|
133
|
-
|
|
134
|
-
Este código funcionaría igual se o controlador fose `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
|
-
Un exemplo moito máis extenso, que mostra a maioría das funcións ofrecidas:
|
|
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
|
-
## Metadatos
|
|
267
|
-
O comando `metadata` devolve metadatos sobre unha única entrada do sistema de ficheiros.
|
|
268
|
-
Do mesmo xeito, o valor de retorno do comando `list` é unha matriz de obxectos de metadatos.
|
|
269
|
-
|
|
270
|
-
Un obxecto de metadatos ten o seguinte aspecto:
|
|
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 propiedade `type` pode ser `file` , `dir` , `link` ou `special` .
|
|
281
|
-
|
|
282
|
-
Dependendo do tipo de controlador, un comando `list` pode non devolver todos os campos. As propiedades `name` nome` e `type`
|
|
283
|
-
debe estar sempre presente. Un comando `metadata` posterior devolverá todas as propiedades dispoñibles.
|
|
284
|
-
|
|
285
|
-
## Estilo de importación alternativo
|
|
286
|
-
Importe o módulo de ámbito completo e use a función `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
|
-
## Almacenamento en caché
|
|
294
|
-
Mobiletto funciona mellor cunha caché <a href="https://redis.io">redis</a> .
|
|
295
|
-
|
|
296
|
-
Mobiletto tentará conectarse a unha instancia de redis en 127.0.0.1:6379
|
|
297
|
-
|
|
298
|
-
Podes anular calquera destes:
|
|
299
|
-
* Establece a var env `MOBILETTO_REDIS_HOST` , mobile para conectarse aquí en lugar de localhost
|
|
300
|
-
* Establece a var env `MOBILETTO_REDIS_PORT` , usarase este porto
|
|
301
|
-
|
|
302
|
-
Mobiletto almacenará todas as súas claves redis co prefixo `_mobiletto__` . Podes cambiar isto
|
|
303
|
-
configurando o env var `MOBILETTO_REDIS_PREFIX`
|
|
304
|
-
|
|
305
|
-
Tamén pode configurar a caché por conexión co obxecto `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
|
-
### Non queres almacenar en caché Redis?
|
|
317
|
-
Para desactivar: pase `enabled: false` no seu obxecto `opts.redisConfig` cando estableza a súa conexión.
|
|
318
|
-
|
|
319
|
-
Como se comenta a continuación, desactivar o caché terá un efecto adverso no rendemento e producirá máis solicitudes
|
|
320
|
-
ao almacenamento que realmente necesitas.
|
|
321
|
-
|
|
322
|
-
### Guía de almacenamento en caché
|
|
323
|
-
**Almacenamento cifrado**: a lectura/escritura do almacenamento cifrado é só un pouco máis lento do normal,
|
|
324
|
-
pero navegar polos directorios (o que fan algunhas cousas) é bastante caro. Usando unha caché de redis
|
|
325
|
-
darache un aumento significativo de rendemento.
|
|
326
|
-
|
|
327
|
-
A caché predeterminada é segura, pero non funciona ben se tes moitas operacións de escritura/eliminación.
|
|
328
|
-
Calquera operación de escritura ou eliminación invalida toda a caché, garantindo que as lecturas posteriores vexan o
|
|
329
|
-
últimos cambios.
|
|
330
|
-
|
|
331
|
-
### Ferramentas da CLI
|
|
332
|
-
Se está a usar unha ferramenta CLI como [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
|
|
333
|
-
definitivamente quererá habilitar a caché de redis, xa que dura durante as invocacións do comando `mo` .
|
|
334
|
-
|
|
335
|
-
## Espello
|
|
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` realiza unha copia única de todos os ficheiros dun móbil a outro.
|
|
344
|
-
Non executa ningún proceso para manter o espello ao longo do tempo. Execute o comando `mirror` novo
|
|
345
|
-
para sincronizar os ficheiros que faltan.
|
|
346
|
-
|
|
347
|
-
O valor de retorno de `mirror` é un obxecto sinxelo con contadores de cantos ficheiros se realizaron correctamente
|
|
348
|
-
espello e cantos ficheiros tiveron erros:
|
|
349
|
-
|
|
350
|
-
{
|
|
351
|
-
success: count-of-files-mirrored,
|
|
352
|
-
errors: count-of-files-with-errors
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
ADVERTENCIA: duplicar grandes conxuntos de datos pode levar moito tempo e consumir moito ancho de banda
|
|
356
|
-
|
|
357
|
-
Coa semántica da chamada `mirror` ás veces pode resultar confuso entender quen é
|
|
358
|
-
lector e quen é o escritor. Imaxínao como unha declaración de asignación: o "mobiletto da man esquerda"
|
|
359
|
-
é a cousa que se está asignando (datos reflectidos escritos) e o "mobiletto da man dereita" (o
|
|
360
|
-
argumento ao método `mirror` ) é o valor que se está asignando (léanse os datos reflectidos).
|
|
361
|
-
|
|
362
|
-
## Cifrado transparente
|
|
363
|
-
Activa o cifrado 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
|
-
Que pasa? Un directorio separado de "entrada de directorio" (directorio) (cifrado) rastrexa os ficheiros que hai nel
|
|
383
|
-
directorio (tamén coñecido como o directorio dirent).
|
|
384
|
-
* O comando `list` le os ficheiros de entrada do directorio, descifra cada ruta listada; despois devolve os metadatos para cada ficheiro
|
|
385
|
-
* Os comandos `list` son máis ineficientes, especialmente para directorios con gran número de ficheiros
|
|
386
|
-
* O comando `write` escribe ficheiros dirent no directorio dirent de cada pai, de forma recursiva; despois escribe o ficheiro
|
|
387
|
-
* Os comandos `write` incorrerán en escrituras O(N), con N = profundidade na xerarquía de directorios
|
|
388
|
-
* O comando `remove` elimina o ficheiro dirent correspondente, e o seu pai se está baleiro, de forma recursiva; entón elimina o ficheiro
|
|
389
|
-
* Os comandos `remove` non recursivos provocarán lecturas O(N) e potencialmente tantas eliminacións, con N = profundidade na xerarquía de directorios
|
|
390
|
-
* Os comandos recursivos `remove` en sistemas de ficheiros grandes e profundos poden ser caros
|
|
391
|
-
|
|
392
|
-
Teña en conta que aínda que teña activado o cifrado do lado do cliente, un adversario con visibilidade total no lado do servidor cifrado
|
|
393
|
-
almacenamento, aínda sen a chave, aínda pode ver o número total de directorios e cantos ficheiros hai en cada un, e con
|
|
394
|
-
algún esforzo, descubra parte ou toda a estrutura xeral da xerarquía de directorios.
|
|
395
|
-
*Nota: use unha estrutura relativamente plana para mellorar a seguridade.*
|
|
396
|
-
O adversario non coñecería os nomes dos directorios/ficheiros a non ser que coñeza tamén o seu cifrado
|
|
397
|
-
clave ou rompera con éxito o cifrado. ¡Todas as apostas están desactivadas!
|
|
398
|
-
|
|
399
|
-
### Rendemento e caché
|
|
400
|
-
As operacións de almacenamento cifrado poden ser lentas. As listaxes e eliminacións recursivas poden ser moi lentas.
|
|
401
|
-
O almacenamento na caché a través de redis axuda enormemente, pero teña en conta que a caché bótase en calquera escritura ou eliminación.
|
|
402
|
-
|
|
403
|
-
## Rotación de teclas
|
|
404
|
-
Crea un mobiletto coa túa nova clave e, a continuación, reflicte os datos antigos nel:
|
|
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 controlador
|
|
417
|
-
Un controlador é calquera ficheiro JS que exporta unha función 'storageClient' con esta sinatura:
|
|
418
|
-
|
|
419
|
-
function storageClient (key, secret, opts)
|
|
420
|
-
|
|
421
|
-
* `key` : unha cadea, a túa clave API (para o controlador `local` este é o directorio base)
|
|
422
|
-
* `secret` : unha cadea, o seu segredo da API (pódese omitir para o controlador `local` )
|
|
423
|
-
* `opts` : un obxecto, as propiedades son por controlador:
|
|
424
|
-
* Para `local` , as `fileMode` e `dirMode` determinan como se crean novos ficheiros e directorios de creación
|
|
425
|
-
* Para `s3` , é necesaria a propiedade `bucket` . As propiedades opcionais son:
|
|
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 obxecto que devolve a función storageClient debe definir estas funcións:
|
|
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
|
-
## Rexistro
|
|
457
|
-
Mobiletto usa a biblioteca de rexistro [winston](https://www.npmjs.com/package/winston).
|
|
458
|
-
|
|
459
|
-
Os rexistros **conterán** camiños de ficheiros e mensaxes de erro, pero **nunca** conterán chaves, segredos,
|
|
460
|
-
ou calquera outra información de configuración de conexión.
|
|
461
|
-
|
|
462
|
-
### Nivel de rexistro
|
|
463
|
-
Use a variable de ambiente `MOBILETTO_LOG_LEVEL` para establecer o nivel de rexistro, usando un
|
|
464
|
-
dos niveis `npm` definidos en [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
|
|
465
|
-
|
|
466
|
-
O nivel predeterminado é `error` . O nivel máis detallado é `silly` , aínda que actualmente mobiletto
|
|
467
|
-
non rexistra en niveis inferiores a `debug`
|
|
468
|
-
|
|
469
|
-
MOBILETTO_LOG_LEVEL=silly # maximum logs!
|
|
470
|
-
|
|
471
|
-
### Ficheiro de rexistro
|
|
472
|
-
Por defecto, o rexistrador escribe na consola. Para enviar rexistros a un ficheiro, configure o `MOBILETTO_LOG_FILE`
|
|
473
|
-
variable de ambiente. Ao iniciar sesión nun ficheiro, os rexistros xa non se escribirán na consola.
|
|
474
|
-
|
|
475
|
-
MOBILETTO_LOG_FILE=/var/my_mobiletto_log
|
|
476
|
-
|
|
477
|
-
Para desactivar o rexistro:
|
|
478
|
-
|
|
479
|
-
MOBILETTO_LOG_FILE=/dev/null
|
|
480
|
-
|
|
481
|
-
</pre>
|