mobiletto 1.2.1 → 2.0.1

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 (124) hide show
  1. package/lib/cjs/index.d.ts +2 -0
  2. package/lib/cjs/index.js +30 -0
  3. package/lib/cjs/package.json +16 -0
  4. package/lib/esm/index.d.ts +2 -0
  5. package/lib/esm/index.js +12 -0
  6. package/package.json +27 -13
  7. package/.babelrc +0 -5
  8. package/.eslintrc.js +0 -14
  9. package/docs/README.md +0 -113
  10. package/docs/af/README.md +0 -481
  11. package/docs/am/README.md +0 -481
  12. package/docs/ar/README.md +0 -481
  13. package/docs/az/README.md +0 -481
  14. package/docs/be/README.md +0 -481
  15. package/docs/bg/README.md +0 -481
  16. package/docs/bn/README.md +0 -481
  17. package/docs/bs/README.md +0 -481
  18. package/docs/ca/README.md +0 -481
  19. package/docs/ceb/README.md +0 -481
  20. package/docs/co/README.md +0 -481
  21. package/docs/cs/README.md +0 -481
  22. package/docs/cy/README.md +0 -481
  23. package/docs/da/README.md +0 -481
  24. package/docs/de/README.md +0 -481
  25. package/docs/el/README.md +0 -481
  26. package/docs/eo/README.md +0 -481
  27. package/docs/es/README.md +0 -481
  28. package/docs/et/README.md +0 -481
  29. package/docs/eu/README.md +0 -481
  30. package/docs/fa/README.md +0 -481
  31. package/docs/fi/README.md +0 -481
  32. package/docs/fr/README.md +0 -481
  33. package/docs/fy/README.md +0 -481
  34. package/docs/ga/README.md +0 -481
  35. package/docs/gd/README.md +0 -481
  36. package/docs/gl/README.md +0 -481
  37. package/docs/gu/README.md +0 -481
  38. package/docs/ha/README.md +0 -481
  39. package/docs/haw/README.md +0 -481
  40. package/docs/he/README.md +0 -481
  41. package/docs/hi/README.md +0 -481
  42. package/docs/hmn/README.md +0 -481
  43. package/docs/hr/README.md +0 -481
  44. package/docs/ht/README.md +0 -481
  45. package/docs/hu/README.md +0 -481
  46. package/docs/hy/README.md +0 -481
  47. package/docs/id/README.md +0 -481
  48. package/docs/ig/README.md +0 -481
  49. package/docs/is/README.md +0 -481
  50. package/docs/it/README.md +0 -481
  51. package/docs/iw/README.md +0 -481
  52. package/docs/ja/README.md +0 -481
  53. package/docs/jv/README.md +0 -481
  54. package/docs/ka/README.md +0 -481
  55. package/docs/kk/README.md +0 -481
  56. package/docs/km/README.md +0 -481
  57. package/docs/kn/README.md +0 -481
  58. package/docs/ko/README.md +0 -481
  59. package/docs/ku/README.md +0 -481
  60. package/docs/ky/README.md +0 -481
  61. package/docs/la/README.md +0 -481
  62. package/docs/lb/README.md +0 -481
  63. package/docs/lo/README.md +0 -481
  64. package/docs/lt/README.md +0 -481
  65. package/docs/lv/README.md +0 -481
  66. package/docs/mg/README.md +0 -481
  67. package/docs/mi/README.md +0 -481
  68. package/docs/mk/README.md +0 -481
  69. package/docs/ml/README.md +0 -481
  70. package/docs/mn/README.md +0 -481
  71. package/docs/mr/README.md +0 -481
  72. package/docs/ms/README.md +0 -481
  73. package/docs/mt/README.md +0 -481
  74. package/docs/my/README.md +0 -481
  75. package/docs/ne/README.md +0 -481
  76. package/docs/nl/README.md +0 -481
  77. package/docs/no/README.md +0 -481
  78. package/docs/ny/README.md +0 -481
  79. package/docs/or/README.md +0 -481
  80. package/docs/pa/README.md +0 -481
  81. package/docs/pl/README.md +0 -481
  82. package/docs/ps/README.md +0 -481
  83. package/docs/pt/README.md +0 -481
  84. package/docs/ro/README.md +0 -481
  85. package/docs/ru/README.md +0 -481
  86. package/docs/rw/README.md +0 -481
  87. package/docs/sd/README.md +0 -481
  88. package/docs/si/README.md +0 -481
  89. package/docs/sk/README.md +0 -481
  90. package/docs/sl/README.md +0 -481
  91. package/docs/sm/README.md +0 -481
  92. package/docs/sn/README.md +0 -481
  93. package/docs/so/README.md +0 -481
  94. package/docs/sq/README.md +0 -481
  95. package/docs/sr/README.md +0 -481
  96. package/docs/st/README.md +0 -481
  97. package/docs/su/README.md +0 -481
  98. package/docs/sv/README.md +0 -481
  99. package/docs/sw/README.md +0 -481
  100. package/docs/ta/README.md +0 -481
  101. package/docs/te/README.md +0 -481
  102. package/docs/tg/README.md +0 -481
  103. package/docs/th/README.md +0 -481
  104. package/docs/tk/README.md +0 -481
  105. package/docs/tl/README.md +0 -481
  106. package/docs/tr/README.md +0 -481
  107. package/docs/tt/README.md +0 -481
  108. package/docs/ug/README.md +0 -481
  109. package/docs/uk/README.md +0 -481
  110. package/docs/ur/README.md +0 -481
  111. package/docs/uz/README.md +0 -481
  112. package/docs/vi/README.md +0 -481
  113. package/docs/xh/README.md +0 -481
  114. package/docs/yi/README.md +0 -481
  115. package/docs/yo/README.md +0 -481
  116. package/docs/zh/README.md +0 -481
  117. package/docs/zu/README.md +0 -481
  118. package/drivers/b2/index.js +0 -451
  119. package/drivers/local/index.js +0 -315
  120. package/drivers/s3/index.js +0 -316
  121. package/hokey.json +0 -16
  122. package/index.js +0 -29
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
package/docs/fr/README.md DELETED
@@ -1,481 +0,0 @@
1
- Mobiletto
2
- =========
3
-
4
- Mobileto est une couche d'abstraction de stockage JavaScript, avec un chiffrement transparent côté client en option.
5
-
6
- # Contenu
7
- * [Pourquoi Mobiletto ?](#Pourquoi-Mobiletto ?)
8
- * [Démarrage rapide](#Démarrage rapide)
9
- * [Mobiletto CLI](#mobiletto-cli)
10
- * [Source](#Source)
11
- * [Installation](#Installation)
12
- * [Soutien et financement](#Soutien-et-Financement)
13
- * [Utilisation de base](#Basic-usage)
14
- * [Métadonnées](#Métadonnées)
15
- * [Style d'importation alternatif](#Alternate-import-style)
16
- * [Mise en cache](#Mise en cache)
17
- * [Mise en miroir](#Mise en miroir)
18
- * [Cryptage transparent](#Transparent-encryption)
19
- * [Rotation des clés](#Rotation des clés)
20
- * [Interface pilote](#Interface pilote)
21
- * [Journalisation](#Journalisation)
22
-
23
- # Lire ceci dans une autre langue
24
- Ce document README.md a été traduit, via [hokeylization](https://github.com/cobbzilla/hokeylization), en
25
- **[toutes les langues prises en charge par Google Translate](https://cloud.google.com/translate/docs/languages) !**
26
-
27
- Je suis certain que ce n'est pas parfait, mais j'espère que c'est mieux que rien !
28
-
29
- [🇸🇦 Arabe](../ar/README.md)
30
- [🇧🇩 bengali](../bn/README.md)
31
- [🇩🇪 allemand](../de/README.md)
32
- [🇺🇸 Anglais](../en/README.md)
33
- [🇪🇸 Espagnol](../es/README.md)
34
- [🇫🇷 Français](../fr/README.md)
35
- [🇹🇩 Haoussa](../ha/README.md)
36
- [🇮🇳 Hindi](../hi/README.md)
37
- [🇮🇩 Indonésien](../id/README.md)
38
- [🇮🇹 Italien](../it/README.md)
39
- [🇯🇵 japonais](../ja/README.md)
40
- [🇰🇷 coréen](../ko/README.md)
41
- [🇮🇳 Marathi](../mr/README.md)
42
- [🇵🇱 polonais](../pl/README.md)
43
- [🇧🇷 portugais](../pt/README.md)
44
- [🇷🇺 russe](../ru/README.md)
45
- [🇰🇪 Swahili](../sw/README.md)
46
- [🇵🇭 Tagalog](../tl/README.md)
47
- [🇹🇷 Turc](../tr/README.md)
48
- [🇵🇰 Ourdou](../ur/README.md)
49
- [🇻🇳 Vietnamien](../vi/README.md)
50
- [🇨🇳 chinois](../zh/README.md)
51
-
52
-
53
- **[📚 ... Toutes les langues ...](../README.md)**
54
- ----
55
-
56
- ### Y a-t-il un problème avec cette traduction du README ?
57
- Cette traduction particulière de l'original [README](https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- peut être défectueux -- *les corrections sont les bienvenues !* Veuillez envoyer une [pull request on GitHub](https://github.com/cobbzilla/mobiletto/pulls),
59
- ou si vous n'êtes pas à l'aise pour le faire, [ouvrez un problème](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- Lorsque vous créez un nouveau ticket GitHub à propos d'une traduction, veuillez faire :
62
- * inclure l'URL de la page (copier/coller depuis la barre d'adresse du navigateur)
63
- * inclure le texte exact qui est erroné (copier/coller depuis le navigateur)
64
- * veuillez décrire ce qui ne va pas -- la traduction est-elle incorrecte ? le formatage est-il cassé d'une manière ou d'une autre ?
65
- * veuillez suggérer une meilleure traduction, ou comment le texte doit être correctement formaté
66
- * **Merci!**
67
-
68
- ## Pourquoi Mobiletto ?
69
-
70
- ### Adieu la dépendance vis-à-vis des fournisseurs !
71
- Les différents fournisseurs de stockage cloud ont des API incompatibles. Même ceux qui aspirent à la "compatibilité S3"
72
- ont des comportements idiosyncratiques.
73
-
74
- Lorsque vous choisissez un fournisseur de stockage particulier pour votre application, si vous codez directement dans son API, votre application
75
- dépend maintenant de ce service. Au fur et à mesure que le temps passe et que le code s'accumule, changer de fournisseur devient
76
- de plus en plus intenable. Bienvenue dans le monde amusant du verrouillage des fournisseurs !
77
-
78
- Mobileto a été conçu pour résoudre ce problème. En codant votre application avec l'API de mobiletto, vous pouvez facilement
79
- changez de fournisseur de stockage et sachez que la couche de stockage de votre application se comportera de manière identique.
80
-
81
- ### Tests approfondis
82
- Tous les pilotes sont testés pour un comportement identique avec plus de 60 tests pour chaque pilote.
83
- Nous testons tous les pilotes avec chaque combinaison de :
84
- * Cryptage : activé et désactivé
85
- * Cache Redis : activé et désactivé
86
-
87
- Cette approche nous donne la tranquillité d'esprit que mobiletto se comportera de la même manière quel que soit le pilote que vous utilisez,
88
- et que vous activiez ou non la mise en cache et/ou le chiffrement.
89
-
90
- ### Prise en charge des pilotes
91
- Pilotes de stockage Mobileto actuels :
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : système de fichiers local
95
-
96
- *Les contributions pour soutenir plus de fournisseurs de stockage cloud sont les bienvenues !*
97
-
98
- ## mobiletto-cli
99
- Mobileto est destiné à être utilisé comme bibliothèque par d'autres codes JavaScript.
100
-
101
- Pour travailler avec mobiletto en ligne de commande, utilisez [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## La source
104
- * [mobiletto sur GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto sur npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## Soutien et financement
108
- J'essaie d'être un développeur professionnel de logiciels open source. j'ai travaillé dans
109
- l'industrie du logiciel depuis de nombreuses années, j'ai lancé des entreprises prospères et les ai vendues à des sociétés ouvertes.
110
- Récemment, j'ai perdu mon emploi et je n'ai pas vraiment d'autre travail en vue
111
-
112
- Je vais donc essayer d'écrire un logiciel utile et voir si cela fonctionne
113
-
114
- Si vous aimez utiliser ce logiciel, je serais très reconnaissant même pour le
115
- la plus petite [contribution mensuelle via Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *Merci!*
118
-
119
- ## Installation
120
- Installez en utilisant `npm` ou `yarn` . Vous voulez probablement la version `lite` qui n'inclut pas tous les
121
- fichiers README traduits :
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- Si vous voulez vraiment les fichiers README dans toutes les langues, installez la version complète :
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## Démarrage rapide
132
- Un court exemple utilisant le pilote mobiletto `s3` .
133
-
134
- Ce code fonctionnerait de la même manière si le pilote était `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
- ## Utilisation de base
165
- Un exemple beaucoup plus complet, montrant la plupart des fonctionnalités offertes :
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
- ## Métadonnées
267
- La commande `metadata` renvoie des métadonnées sur une seule entrée de système de fichiers.
268
- De même, la valeur de retour de la commande `list` est un tableau d'objets de métadonnées.
269
-
270
- Un objet de métadonnées ressemble à ceci :
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
- La propriété `type` peut être `file` , `dir` , `link` ou `special` .
281
-
282
- Selon le type de pilote, une commande `list` peut ne pas renvoyer tous les champs. Les propriétés `name` name` et `type`
283
- doit toujours être présent. Une commande `metadata` ultérieure renverra toutes les propriétés disponibles.
284
-
285
- ## Style d'importation alternatif
286
- Importez le module complet et utilisez la fonction `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
- ## Mise en cache
294
- Mobileto fonctionne mieux avec un cache <a href="https://redis.io">Redis</a> .
295
-
296
- Mobileto tentera de se connecter à une instance redis sur 127.0.0.1:6379
297
-
298
- Vous pouvez remplacer l'un ou l'autre :
299
- * Définissez la `MOBILETTO_REDIS_HOST` , mobiletto se connecte ici au lieu de localhost
300
- * Définissez la `MOBILETTO_REDIS_PORT` , ce port sera utilisé
301
-
302
- Mobileto stockera toutes ses clés redis avec le préfixe `_mobiletto__` . Vous pouvez changer cela
303
- en définissant la variable d'environnement `MOBILETTO_REDIS_PREFIX` .
304
-
305
- Vous pouvez également définir la mise en cache par connexion avec l'objet `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
- ### Vous ne voulez pas de mise en cache Redis ?
317
- Pour désactiver : passez `enabled: false` dans votre objet `opts.redisConfig` lorsque vous établissez votre connexion.
318
-
319
- Comme indiqué ci-dessous, la désactivation de la mise en cache aura un effet négatif sur les performances et entraînera davantage de requêtes
320
- au stockage dont vous avez vraiment besoin.
321
-
322
- ### Conseils de mise en cache
323
- **Stockage crypté** : la lecture/écriture du stockage crypté n'est qu'un peu plus lente que la normale,
324
- mais naviguer dans les répertoires (ce que font certaines choses) est assez coûteux. Utiliser un cache Redis
325
- vous donnera une amélioration significative des performances.
326
-
327
- Le cache par défaut est sûr, mais ne fonctionne pas bien si vous avez beaucoup d'opérations d'écriture/suppression.
328
- Toute opération d'écriture ou de suppression invalide l'intégralité du cache, garantissant que les lectures suivantes verront le
329
- dernières modifications.
330
-
331
- ### Outils CLI
332
- Si vous utilisez un outil CLI tel que [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
333
- vous voudrez certainement que le cache redis soit activé, car il dure à travers les invocations de la commande `mo` .
334
-
335
- ## Mise en miroir
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
- La commande `mirror` effectue une copie unique de tous les fichiers d'un mobiletto à un autre.
344
- Il n'exécute aucun processus pour maintenir le miroir dans le temps. Exécutez à nouveau la commande `mirror`
345
- pour synchroniser les fichiers manquants.
346
-
347
- La valeur de retour de `mirror` est un objet simple avec des compteurs pour le nombre de fichiers réussis
348
- mis en miroir et combien de fichiers avaient des erreurs :
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- AVERTISSEMENT : la mise en miroir de grands ensembles de données peut prendre beaucoup de temps et consommer beaucoup de bande passante
356
-
357
- Avec la sémantique d'appel `mirror` il peut parfois être déroutant de comprendre qui est le
358
- lecteur et qui est l'auteur. Imaginez-le comme une déclaration d'affectation : le "mobiletto de gauche"
359
- est la chose assignée (données en miroir écrites), et le "mobiletto de droite" (le
360
- argument de la méthode `mirror` ) est la valeur assignée (les données en miroir sont lues).
361
-
362
- ## Cryptage transparent
363
- Activez le chiffrement transparent côté client :
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 ce passe-t-il? Un répertoire séparé "d'entrée de répertoire" (dirent) (crypté) suit les fichiers qui se trouvent dans ce
383
- répertoire (alias le répertoire dirent).
384
- * La commande `list` lit les fichiers d'entrée de répertoire, décrypte chaque chemin répertorié ; renvoie ensuite les métadonnées de chaque fichier
385
- * Les commandes `list` sont plus inefficaces, en particulier pour les répertoires contenant un grand nombre de fichiers
386
- * La commande `write` écrit des fichiers directs dans le répertoire direct de chaque parent, de manière récursive ; puis écrit le fichier
387
- * Les commandes `write` entraîneront O(N) écritures, avec N = profondeur dans la hiérarchie des répertoires
388
- * La commande `remove` supprime le fichier dirent correspondant, et son parent s'il est vide, de manière récursive ; puis supprime le fichier
389
- * Les commandes de `remove` non récursives entraîneront O (N) lectures et potentiellement autant de suppressions, avec N = profondeur dans la hiérarchie des répertoires
390
- * Les commandes récursives `remove` sur des systèmes de fichiers volumineux et profonds peuvent être coûteuses
391
-
392
- Notez que même avec le chiffrement côté client activé, un adversaire avec une visibilité totale sur votre côté serveur chiffré
393
- le stockage, même sans la clé, peut toujours voir le nombre total de répertoires et le nombre de fichiers dans chacun, et avec
394
- quelques efforts, découvrir tout ou partie de la structure globale de la hiérarchie des répertoires.
395
- *Remarque : Utilisez une structure relativement plate pour une meilleure sécurité.*
396
- L'adversaire ne connaîtrait pas les noms des répertoires/fichiers à moins qu'il ne connaisse également votre cryptage
397
- clé ou avait autrement réussi à casser le cryptage. Tous les paris sont ouverts alors !
398
-
399
- ### Performances et mise en cache
400
- Les opérations sur le stockage chiffré peuvent être lentes. Les listes et les suppressions récursives peuvent être très lentes.
401
- La mise en cache via redis aide énormément, mais notez que le cache est vidé lors de toute écriture ou suppression.
402
-
403
- ## Rotation des clés
404
- Créez un mobiletto avec votre nouvelle clé, puis copiez-y les anciennes données :
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 pilote
417
- Un pilote est un fichier JS qui exporte une fonction 'storageClient' avec cette signature :
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : une chaîne, votre clé API (pour le pilote `local` c'est le répertoire de base)
422
- * `secret` : une chaîne, votre secret d'API (peut être omis pour le pilote `local` )
423
- * `opts` : un objet, les propriétés sont par pilote :
424
- * Pour `local` , les propriétés `fileMode` et `dirMode` déterminent comment les nouveaux fichiers et répertoires sont créés
425
- * Pour `s3` , la propriété `bucket` est requise. Les propriétés facultatives sont :
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
- L'objet renvoyé par la fonction storageClient doit définir ces fonctions :
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
- ## Journalisation
457
- Mobileto utilise la bibliothèque de journalisation [winston](https://www.npmjs.com/package/winston).
458
-
459
- Les journaux **contiendront** les chemins d'accès aux fichiers et les messages d'erreur, mais ne contiendront **jamais** de clés, de secrets,
460
- ou toute autre information de configuration de connexion.
461
-
462
- ### Niveau de journalisation
463
- Utilisez la variable d'environnement `MOBILETTO_LOG_LEVEL` pour définir le niveau de journalisation, en utilisant un
464
- des niveaux `npm` définis dans [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- Le niveau par défaut est `error` . Le niveau le plus verbeux est `silly` , bien qu'actuellement mobiletto
467
- ne se connecte pas aux niveaux inférieurs à `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### Fichier journal
472
- Par défaut, le logger écrit sur la console. Pour envoyer les journaux vers un fichier, définissez le `MOBILETTO_LOG_FILE`
473
- variables d'environnement. Lors de la connexion à un fichier, les journaux ne seront plus écrits sur la console.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- Pour désactiver la journalisation :
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>