OLD | NEW |
1 <!DOCTYPE html> | 1 <!DOCTYPE html> |
2 <html> | 2 <html> |
3 <head> | 3 <head> |
4 <meta charset="utf-8"> | 4 <meta charset="utf-8"> |
5 <link rel="stylesheet" href="onc_spec.css" > | 5 <link rel="stylesheet" href="onc_spec.css" > |
6 <script src="onc_spec.js"></script> | 6 <script src="onc_spec.js"></script> |
7 <title>Open Network Configuration Format</title> | 7 <title>Open Network Configuration Format</title> |
8 </head> | 8 </head> |
9 <body> | 9 <body> |
10 | 10 |
11 <section id="root" class="not_in_toc"> | 11 <section id="root" class="not_in_toc"> |
12 <h1>Open Network Configuration Format</h1> | 12 <h1>Open Network Configuration Format</h1> |
13 | 13 |
14 <section class="not_in_toc"> | 14 <section class="not_in_toc"> |
15 <h1>Outline</h1> | 15 <h1>Outline</h1> |
16 <div id="outline"></div> | 16 <div id="outline"></div> |
17 </section> | 17 </section> |
18 | 18 |
19 <section> | 19 <section> |
20 <h1>Objective</h1> | 20 <h1>Objective</h1> |
21 <p> | 21 <p> |
22 We would like to create a simple, open, but complete format to describe | 22 We would like to create a simple, open, but complete format to describe |
23 multiple network configurations for Wi-Fi, Ethernet, Cellular, | 23 multiple network configurations for WiFi, Ethernet, Cellular, |
24 Bluetooth/WiFi-Direct, and VPN connections in a single file format, in order | 24 Bluetooth/WiFi-Direct, and VPN connections in a single file format, in order |
25 to simplify and automate network configuration for users. | 25 to simplify and automate network configuration for users. |
26 </p> | 26 </p> |
27 </section> | 27 </section> |
28 | 28 |
29 <section> | 29 <section> |
30 <h1>Background</h1> | 30 <h1>Background</h1> |
31 <p> | 31 <p> |
32 Configuring networks is a painful and error-prone experience for users. It | 32 Configuring networks is a painful and error-prone experience for users. It |
33 is a problem shared across desktop, laptop, tablet, and phone users of all | 33 is a problem shared across desktop, laptop, tablet, and phone users of all |
34 operating system types. It is exacerbated in business and schools which | 34 operating system types. It is exacerbated in business and schools which |
35 often have complex network configurations (VPNs and 802.1X networking) that | 35 often have complex network configurations (VPNs and 802.1X networking) that |
36 change often and have many connected devices. Configuration of Wi-Fi is | 36 change often and have many connected devices. Configuration of WiFi is |
37 still done manually, often by administrators physically standing next to | 37 still done manually, often by administrators physically standing next to |
38 users working on devices. Certificate distribution is particularly painful | 38 users working on devices. Certificate distribution is particularly painful |
39 which often results in admins instead using passphrases to protect networks | 39 which often results in admins instead using passphrases to protect networks |
40 or using protocols without client certificates that instead use LDAP | 40 or using protocols without client certificates that instead use LDAP |
41 passwords for authentication. Even after networks are configured, updates to | 41 passwords for authentication. Even after networks are configured, updates to |
42 the network configuration require another round of manual changes, and | 42 the network configuration require another round of manual changes, and |
43 accidental changes by a user or malicious changes by an attacker can break | 43 accidental changes by a user or malicious changes by an attacker can break |
44 connectivity or make connections less private or secure. | 44 connectivity or make connections less private or secure. |
45 </p> | 45 </p> |
46 | 46 |
(...skipping 148 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
195 </span> | 195 </span> |
196 Must be <span class="value">UnencryptedConfiguration</span>. | 196 Must be <span class="value">UnencryptedConfiguration</span>. |
197 </dd> | 197 </dd> |
198 | 198 |
199 <dt class="field">NetworkConfigurations</dt> | 199 <dt class="field">NetworkConfigurations</dt> |
200 <dd> | 200 <dd> |
201 <span class="field_meta"> | 201 <span class="field_meta"> |
202 (optional) | 202 (optional) |
203 <span class="type">array of NetworkConfiguration</span> | 203 <span class="type">array of NetworkConfiguration</span> |
204 </span> | 204 </span> |
205 Describes Wi-Fi, Ethernet, VPN, and wireless connections. | 205 Describes WiFi, Ethernet, VPN, and wireless connections. |
206 </dd> | 206 </dd> |
207 | 207 |
208 <dt class="field">Certificates</dt> | 208 <dt class="field">Certificates</dt> |
209 <dd> | 209 <dd> |
210 <span class="field_meta"> | 210 <span class="field_meta"> |
211 (optional) | 211 (optional) |
212 <span class="type">array of Certificate</span> | 212 <span class="type">array of Certificate</span> |
213 </span> | 213 </span> |
214 Contains certificates stored in X.509 or PKCS#12 format. | 214 Contains certificates stored in X.509 or PKCS#12 format. |
215 </dd> | 215 </dd> |
(...skipping 151 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
367 VPN settings. | 367 VPN settings. |
368 </dd> | 368 </dd> |
369 | 369 |
370 <dt class="field">WiFi</dt> | 370 <dt class="field">WiFi</dt> |
371 <dd> | 371 <dd> |
372 <span class="field_meta"> | 372 <span class="field_meta"> |
373 (required if <span class="field">Type</span> is | 373 (required if <span class="field">Type</span> is |
374 <span class="value">WiFi</span>, otherwise ignored) | 374 <span class="value">WiFi</span>, otherwise ignored) |
375 <span class="type">WiFi</span> | 375 <span class="type">WiFi</span> |
376 </span> | 376 </span> |
377 Wi-Fi settings. | 377 WiFi settings. |
378 </dd> | 378 </dd> |
379 | 379 |
380 <dt class="field">WiMAX</dt> | 380 <dt class="field">WiMAX</dt> |
381 <dd> | 381 <dd> |
382 <span class="field_meta"> | 382 <span class="field_meta"> |
383 (required if <span class="field">Type</span> is | 383 (required if <span class="field">Type</span> is |
384 <span class="value">WiMAX</span>, otherwise ignored) | 384 <span class="value">WiMAX</span>, otherwise ignored) |
385 <span class="type">WiMAX</span> | 385 <span class="type">WiMAX</span> |
386 </span> | 386 </span> |
387 WiMAX settings. | 387 WiMAX settings. |
(...skipping 254 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
642 (optional if part of <span class="field">IPConfigs</span>, read-only) | 642 (optional if part of <span class="field">IPConfigs</span>, read-only) |
643 <span class="type">string</span> | 643 <span class="type">string</span> |
644 </span> | 644 </span> |
645 The Web Proxy Auto-Discovery URL for this network as reported over DHCP. | 645 The Web Proxy Auto-Discovery URL for this network as reported over DHCP. |
646 </dd> | 646 </dd> |
647 | 647 |
648 </dl> | 648 </dl> |
649 </section> | 649 </section> |
650 | 650 |
651 <section> | 651 <section> |
652 <h1>Wi-Fi networks</h1> | 652 <h1>WiFi networks</h1> |
653 <p> | 653 <p> |
654 For Wi-Fi connections, <span class="field">Type</span> must be set to | 654 For WiFi connections, <span class="field">Type</span> must be set to |
655 <span class="value">WiFi</span> and the | 655 <span class="value">WiFi</span> and the |
656 field <span class="field">WiFi</span> must be set to an object of | 656 field <span class="field">WiFi</span> must be set to an object of |
657 type <span class="type">WiFi</span> containing the following fields: | 657 type <span class="type">WiFi</span> containing the following fields: |
658 </p> | 658 </p> |
659 | 659 |
660 <dl class="field_list"> | 660 <dl class="field_list"> |
661 <dt class="field">AllowGatewayARPPolling</dt> | 661 <dt class="field">AllowGatewayARPPolling</dt> |
662 <dd> | 662 <dd> |
663 <span class="field_meta"> | 663 <span class="field_meta"> |
664 (optional, defaults to <span class="value">true</span>) | 664 (optional, defaults to <span class="value">true</span>) |
(...skipping 1632 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2297 | 2297 |
2298 <dt class="field">NetworkTechnology</dt> | 2298 <dt class="field">NetworkTechnology</dt> |
2299 <dd> | 2299 <dd> |
2300 <span class="field_meta">(optional, read-only) | 2300 <span class="field_meta">(optional, read-only) |
2301 <span class="type">string</span> | 2301 <span class="type">string</span> |
2302 </span> | 2302 </span> |
2303 If the modem is registered on a network, then this is set to the | 2303 If the modem is registered on a network, then this is set to the |
2304 network technology currently in use. | 2304 network technology currently in use. |
2305 <span class="rule"><span class="rule_id"></span> | 2305 <span class="rule"><span class="rule_id"></span> |
2306 Allowed values are | 2306 Allowed values are |
2307 <span class="value">1xRTT</span>, <span class="value">EVDO</span>, | 2307 <span class="value">CDMA1XRTT</span>, |
2308 <span class="value">GPRS</span>, <span class="value">EDGE</span>, | 2308 <span class="value">EDGE</span>, |
| 2309 <span class="value">EVDO</span>, |
| 2310 <span class="value">GPRS</span>, |
| 2311 <span class="value">GSM</span>, |
| 2312 <span class="value">HSPA</span>, |
| 2313 <span class="value">HSPAPlus</span>, |
| 2314 <span class="value">LTE</span>, |
| 2315 <span class="value">LTEAdvanced</span> |
2309 <span class="value">UMTS</span>, | 2316 <span class="value">UMTS</span>, |
2310 <span class="value">HSPA</span>, <span class="value">HSPA+</span>, | |
2311 <span class="value">LTE</span>, <span class="value">LTE Advanced</span> | |
2312 </span> | 2317 </span> |
2313 </dd> | 2318 </dd> |
2314 | 2319 |
2315 <dt class="field">PRLVersion</dt> | 2320 <dt class="field">PRLVersion</dt> |
2316 <dd> | 2321 <dd> |
2317 <span class="field_meta">(optional, read-only) | 2322 <span class="field_meta">(optional, read-only) |
2318 <span class="type">integer</span> | 2323 <span class="type">integer</span> |
2319 </span> | 2324 </span> |
2320 The revision of the Preferred Roaming List that is loaded in the modem. | 2325 The revision of the Preferred Roaming List that is loaded in the modem. |
2321 </dd> | 2326 </dd> |
(...skipping 218 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2540 be necessary to unlock the SIM (and <span class="field">LockType</span> | 2545 be necessary to unlock the SIM (and <span class="field">LockType</span> |
2541 changes to <span class="value">sim-puk</span>). | 2546 changes to <span class="value">sim-puk</span>). |
2542 </dd> | 2547 </dd> |
2543 </dl> | 2548 </dl> |
2544 | 2549 |
2545 </section> | 2550 </section> |
2546 | 2551 |
2547 <section> | 2552 <section> |
2548 <h1>Bluetooth / WiFi Direct Networks</h1> | 2553 <h1>Bluetooth / WiFi Direct Networks</h1> |
2549 <p> | 2554 <p> |
2550 This format will eventually also cover configuration of Bluetooth and Wi-Fi | 2555 This format will eventually also cover configuration of Bluetooth and WiFi |
2551 Direct network technologies, however they are currently not supported. | 2556 Direct network technologies, however they are currently not supported. |
2552 </p> | 2557 </p> |
2553 </section> | 2558 </section> |
2554 | 2559 |
2555 </section> | 2560 </section> |
2556 | 2561 |
2557 <section> | 2562 <section> |
2558 <h1>Certificates</h1> | 2563 <h1>Certificates</h1> |
2559 <p> | 2564 <p> |
2560 Certificate data is stored in a separate section. Each certificate may be | 2565 Certificate data is stored in a separate section. Each certificate may be |
(...skipping 516 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
3077 is transmitted or saved to disk should be secure. On client device, when | 3082 is transmitted or saved to disk should be secure. On client device, when |
3078 user names for connections that are user-specific are persisted to disk, | 3083 user names for connections that are user-specific are persisted to disk, |
3079 they should be stored in a location that is encrypted. Users can also opt in | 3084 they should be stored in a location that is encrypted. Users can also opt in |
3080 these cases to not save their user credentials in the config file and will | 3085 these cases to not save their user credentials in the config file and will |
3081 instead be prompted when they are needed. | 3086 instead be prompted when they are needed. |
3082 </p> | 3087 </p> |
3083 </section> | 3088 </section> |
3084 </section> | 3089 </section> |
3085 </body> | 3090 </body> |
3086 </html> | 3091 </html> |
OLD | NEW |