aboutsummaryrefslogtreecommitdiff
path: root/files/fr/mozilla/add-ons/webextensions/native_manifests/index.md
blob: 38ef5ea5d69498d939f19557a31157208841726b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
---
title: manifests Natif
slug: Mozilla/Add-ons/WebExtensions/Native_manifests
tags:
  - Extensions
  - WebExtensions
translation_of: Mozilla/Add-ons/WebExtensions/Native_manifests
original_slug: Mozilla/Add-ons/WebExtensions/manifests_native
---
{{AddonSidebar}}

Les manifests natifs sont des fichiers JSON spécialement formatés qui sont provisionnés sur l'ordinateur de l'utilisateur par un autre moyen que le processus d'installation de l'extension. Par exemple, un manifest natif peut être fourni par un administrateur de périphérique ou par un programme d'installation d'application natif.

Il existe trois types différents de manifest natif :

<table class="standard-table">
  <tbody>
    <tr>
      <td style="width: 40%">
        <a href="#Native_messaging_manifests"
          >Les manifests de messagerie natif</a
        >
      </td>
      <td>
        Activez une fonctionnalité appelée
        <a href="/fr/Add-ons/WebExtensions/Native_messaging">native messaging</a
        >, dans laquelle une extension peut communiquer avec une application
        native installée sur l'appareil.
      </td>
    </tr>
    <tr>
      <td>
        <a href="#Managed_storage_manifests">Manifest de gestion de stockage</a>
      </td>
      <td>
        Définissez les données en lecture seule auxquelles une extension peut
        accéder à l'aide de l'API
        {{WebExtAPIRef("storage.managed")}}.
      </td>
    </tr>
    <tr>
      <td><a href="#PKCS_11_manifests">PKCS #11 manifests</a></td>
      <td>
        Activez une extension pour utiliser l'API
        {{WebExtAPIRef("pkcs11")}} afin d'énumérer les modules de
        sécurité PKCS #11 et installez-les dans Firefox.
      </td>
    </tr>
  </tbody>
</table>

Pour tous les manifests natifs, vous devez arranger les choses afin que le navigateur puisse trouver le manifest. La section sur l'[emplacement du manifest](#Manifest_location) décrit ces règles.

## Les manifests de messagerie natif

Le manifest de messagerie natif contient un seul objet JSON avec les propriétés suivantes :

<table class="standard-table">
  <thead>
    <tr>
      <th scope="col">Name</th>
      <th scope="col">Type</th>
      <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>name</code></td>
      <td>String</td>
      <td>
        <p>Nom de l'application native.</p>
        <p>
          Cela doit correspondre au nom passé dans
          {{WebExtAPIRef("runtime.connectNative()")}} ou
          {{WebExtAPIRef("runtime.sendNativeMessage()")}} par
          l'extension.
        </p>
        <p>
          Sur OS X et Linux, il doit également correspondre au nom de fichier du
          manifest de messagerie natif (à l'exclusion de l'extension ".json").
        </p>
        <p>
          Sous Windows, il doit correspondre au nom de la clé de registre que
          vous créez, qui contient l'emplacement du manifest de messagerie
          natif.
        </p>
        <p>
          Le nom doit correspondre à l'expression régulière suivante :
          "^\w+(\.\w+)*$". Cela signifie qu'il ne peut contenir que des
          caractères alphanumériques (minuscules ou majuscules), des traits de
          soulignement et des points. Il ne peut pas commencer ou se terminer
          par un point, et un point ne peut pas être suivi d'un autre point.
        </p>
      </td>
    </tr>
    <tr>
      <td><code>description</code></td>
      <td>String</td>
      <td>Description de l'application native.</td>
    </tr>
    <tr>
      <td><code>path</code></td>
      <td>String</td>
      <td>
        <p>Chemin vers l'application native.</p>
        <p>
          Sous Windows, cela peut être relatif au manifest lui-même. Sur OS X et
          Linux, il doit être absolu.
        </p>
      </td>
    </tr>
    <tr>
      <td><code>type</code></td>
      <td>String</td>
      <td>
        <p>
          Décrit la méthode utilisée pour connecter l'extension à l'application.
        </p>
        <p>
          Actuellement, une seule valeur peut être donnée ici, "stdio", qui
          indique que les messages sont reçus par l'application en utilisant
          l'entrée standard (stdin) et envoyés en utilisant la sortie standard
          (stdout).
        </p>
      </td>
    </tr>
    <tr>
      <td><code>allowed_extensions</code></td>
      <td>Array of String</td>
      <td>
        <p>
          Un tableau de valeurs d'<a
            href="/fr/Add-ons/WebExtensions/WebExtensions_and_the_Add-on_ID"
            >ID d'extensions</a
          >. Chaque valeur représente une extension qui est autorisée à
          communiquer avec cette application native.
        </p>
        <p>
          Notez que cela signifie que vous voudrez probablement inclure la clé
          des
          <a
            href="/fr/Add-ons/WebExtensions/manifest.json/browser_specific_settings"
            >browser_specific_settings</a
          >
          dans le fichier manifest.json de votre extension, afin de pouvoir
          définir un identifiant explicite lors du développement..
        </p>
      </td>
    </tr>
  </tbody>
</table>

Par exemple, voici un manifest pour l'application native "ping_pong":

```json
{
  "name": "ping_pong",
  "description": "Example host for native messaging",
  "path": "/path/to/native-messaging/app/ping_pong.py",
  "type": "stdio",
  "allowed_extensions": [ "ping_pong@example.org" ]
}
```

This allows the extension whose ID is "ping_pong\@example.org" to connect, by passing the name "ping_pong" into the relevant {{WebExtAPIRef("runtime")}} API function. The application itself is at "/path/to/native-messaging/app/ping_pong.py".

## Manifest de gestion de stockage

Le manifest de stockage géré contient un seul objet JSON avec les propriétés suivantes :

<table class="standard-table">
  <thead>
    <tr>
      <th scope="col">Name</th>
      <th scope="col">Type</th>
      <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>name</code></td>
      <td>String</td>
      <td>
        <p>
          ID de l'extension pouvant accéder à ce stockage, donné comme ID que
          vous avez spécifié dans la clé d'<a
            href="/fr/Add-ons/WebExtensions/manifest.json/applications"
            >application</a
          >
          de l'extension.
        </p>
      </td>
    </tr>
    <tr>
      <td><code>description</code></td>
      <td>String</td>
      <td>Description lisible par l'homme, ignorée par Firefox</td>
    </tr>
    <tr>
      <td><code>type</code></td>
      <td>String</td>
      <td><p>Cela doit être "storage".</p></td>
    </tr>
    <tr>
      <td><code>data</code></td>
      <td>Object</td>
      <td>
        <p>
          Un objet JSON pouvant contenir des valeurs JSON valides, y compris des
          chaînes, des nombres, des booléens, des tableaux ou des objets. This
          will become the data in the
          <code>browser.storage.managed</code> storage area.
        </p>
      </td>
    </tr>
  </tbody>
</table>

Par exemple :

```json
{
  "name": "favourite-colour-examples@mozilla.org",
  "description": "ignored",
  "type": "storage",
  "data":
  {
    "colour": "management thinks it should be blue!"
  }
}
```

Etant donné ce manifest JSON, l'extension "favourite-colour-examples\@mozilla.org" pourrait accéder aux données en utilisant un code comme celui-ci:

```js
var storageItem = browser.storage.managed.get('colour');
storageItem.then((res) => {
  console.log(`Managed colour is: ${res.colour}`);
});
```

## PKCS #11 manifests

Le manifest PKCS #11 est un fichier contenant un objet JSON avec les propriétés suivantes :

<table class="standard-table">
  <thead>
    <tr>
      <th scope="col">Name</th>
      <th scope="col">Type</th>
      <th scope="col">Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>name</code></td>
      <td>String</td>
      <td>
        <p>Nom du module PKCS #11.</p>
        <p>
          Cela doit correspondre au nom utilisé dans l'API <code>pkcs11</code> .
        </p>
        <p>
          Sur OS X et Linux, il doit également correspondre au nom de fichier du
          manifest (à l'exclusion de l'extension).
        </p>
        <p>
          Sous Windows, il doit correspondre au nom de la clé de registre que
          vous créez, qui contient l'emplacement du manifest.
        </p>
        <p>
          Le nom doit correspondre à l'expression régulière suivante :
          "^\w+(\.\w+)*$". Cela signifie qu'il ne peut contenir que des
          caractères alphanumériques minuscules, des traits de soulignement et
          des points. Il ne peut pas commencer ou se terminer par un point, et
          un point ne peut pas être suivi d'un autre point.
        </p>
      </td>
    </tr>
    <tr>
      <td><code>description</code></td>
      <td>String</td>
      <td>
        <p>Description du module.</p>
        <p>
          Ceci est utilisé pour définir le nom convivial du module dans
          l'interface utilisateur du navigateur (par exemple, la boîte de
          dialogue "Security Devices" dans Firefox).
        </p>
      </td>
    </tr>
    <tr>
      <td><code>path</code></td>
      <td>String</td>
      <td>
        <p>Chemin d'accès au module.</p>
        <p>
          Sous Windows, cela peut être relatif au manifest lui-même. Sur OS X et
          Linux, il doit être absolu
        </p>
      </td>
    </tr>
    <tr>
      <td><code>type</code></td>
      <td>String</td>
      <td>Cela doit être "pkcs11".</td>
    </tr>
    <tr>
      <td><code>allowed_extensions</code></td>
      <td>Array of String</td>
      <td>
        <p>
          Un tableau de valeurs d'<a
            href="/fr/Add-ons/WebExtensions/WebExtensions_and_the_Add-on_ID"
            >ID de l'extension</a
          >. Chaque valeur représente une extension qui est autorisée à
          interagir avec le module.
        </p>
        <p>
          Notez que cela signifie que vous voudrez probablement inclure la clé
          des
          <a href="/fr/Add-ons/WebExtensions/manifest.json/applications"
            >applications</a
          >
          dans le fichier manifest.json de votre extension, afin de pouvoir
          définir un identifiant explicite lors du développement.
        </p>
      </td>
    </tr>
  </tbody>
</table>

Par exemple :

```json
{
  "name": "my_module",
  "description": "My test module",
  "type": "pkcs11",
  "path": "/path/to/libpkcs11testmodule.dylib",
  "allowed_extensions": ["my-extension@mozilla.org"]
}
```

Compte tenu de ce manifest JSON, enregistré sous le nom ""my_module.json", l'extension "my-extension\@mozilla.org" pourrait installer le module de sécurité dans "/path/to/libpkcs11testmodule.dylib" en utilisant le code suivant :

```js
browser.pkcs11.installModule("my_module");
```

## Emplacement du manifest

Sous Linux et Mac OS X, vous devez stocker le manifest dans un endroit particulier. Sous Windows, vous devez créer une clé de registre qui pointe vers l'emplacement du manifest.

Les règles détaillées sont les mêmes pour tous les types de manifest, sauf que l'avant-dernier composant du chemin identifie le type de manifest. Les exemples ci-dessous montrent la forme pour chacun des trois types différents. Dans tous les exemples, _\<name>_ est la valeur de la propriété `name` dans le manifest.

### Windows

Pour une visibilité globale, créez une clé de registre avec le nom suivant :

    HKEY_LOCAL_MACHINE\SOFTWARE\Mozilla\NativeMessagingHosts\<name>
    HKEY_LOCAL_MACHINE\SOFTWARE\Mozilla\ManagedStorage\<name>
    HKEY_LOCAL_MACHINE\SOFTWARE\Mozilla\PKCS11Modules\<name>

La clé doit avoir une seule valeur par défaut, qui est le chemin d'accès au manifest.

A partir de Firefox 64, la vue registre 32 bits ([Wow6432Node) ](https://en.wikipedia.org/wiki/WoW64#Registry_and_file_system)sera d'abord vérifiée pour ces clés, puis la vue registre "native". Utilisez celui qui convient le mieux à votre application.

Pour Firefox 63 et les versions antérieures, cette clé ne doit pas être créée sous [Wow6432Node](https://en.wikipedia.org/wiki/WoW64#Registry_and_file_system), même si l'application est en 32 bits. Les versions précédentes du navigateur chercheront toujours la clé dans la vue "native" du registre, et non dans l'émulation 32 bits. Pour vous assurer que la clé est créée dans la vue "native", vous pouvez passer les indicateurs KEY_WOW64_64KEY ou KEY_WOW64_32KEY dans RegCreateKeyEx. Voir [Accès à une autre vue de registre](<https://msdn.microsoft.com/en-us/library/windows/desktop/aa384129(v=vs.85).aspx>).

Pour une visibilité par utilisateur, créez une clé de registre avec le nom suivant :

    HKEY_CURRENT_USER\SOFTWARE\Mozilla\NativeMessagingHosts\<name>
    HKEY_CURRENT_USER\SOFTWARE\Mozilla\ManagedStorage\<name>
    HKEY_CURRENT_USER\SOFTWARE\Mozilla\PKCS11Modules\<name>

La clé doit avoir une seule valeur par défaut, qui est le chemin d'accès au manifest.

### Mac OS X

Pour une visibilité globale, stockez le manifest dans :

    /Library/Application Support/Mozilla/NativeMessagingHosts/<name>.json
    /Library/Application Support/Mozilla/ManagedStorage/<name>.json
    /Library/Application Support/Mozilla/PKCS11Modules/<name>.json

Pour la visibilité par utilisateur, stockez le manifest dans :

    ~/Library/Application Support/Mozilla/NativeMessagingHosts/<name>.json
    ~/Library/Application Support/Mozilla/ManagedStorage/<name>.json
    ~/Library/Application Support/Mozilla/PKCS11Modules/<name>.json

### Linux

Pour une visibilité globale, stockez le manifest dans :

    /usr/lib/mozilla/native-messaging-hosts/<name>.json
    /usr/lib/mozilla/managed-storage/<name>.json
    /usr/lib/mozilla/pkcs11-modules/<name>.json

ou :

    /usr/lib64/mozilla/native-messaging-hosts/<name>.json
    /usr/lib64/mozilla/managed-storage/<name>.json
    /usr/lib64/mozilla/pkcs11-modules/<name>.json

Pour la visibilité par utilisateur, stockez le manifest dans :

    ~/.mozilla/native-messaging-hosts/<name>.json
    ~/.mozilla/managed-storage/<name>.json
    ~/.mozilla/pkcs11-modules/<name>.json