forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathonc_spec.html
3169 lines (2852 loc) · 105 KB
/
onc_spec.html
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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<link rel="stylesheet" href="onc_spec.css" >
<script src="onc_spec.js"></script>
<title>Open Network Configuration Format</title>
</head>
<body>
<section id="root" class="not_in_toc">
<h1>Open Network Configuration Format</h1>
<section class="not_in_toc">
<h1>Outline</h1>
<div id="outline"></div>
</section>
<section>
<h1>Objective</h1>
<p>
We would like to create a simple, open, but complete format to describe
multiple network configurations for WiFi, Ethernet, Cellular,
Bluetooth/WiFi-Direct, and VPN connections in a single file format, in order
to simplify and automate network configuration for users.
</p>
</section>
<section>
<h1>Background</h1>
<p>
Configuring networks is a painful and error-prone experience for users. It
is a problem shared across desktop, laptop, tablet, and phone users of all
operating system types. It is exacerbated in business and schools which
often have complex network configurations (VPNs and 802.1X networking) that
change often and have many connected devices. Configuration of WiFi is
still done manually, often by administrators physically standing next to
users working on devices. Certificate distribution is particularly painful
which often results in admins instead using passphrases to protect networks
or using protocols without client certificates that instead use LDAP
passwords for authentication. Even after networks are configured, updates to
the network configuration require another round of manual changes, and
accidental changes by a user or malicious changes by an attacker can break
connectivity or make connections less private or secure.
</p>
<section>
<h1>Overview</h1>
<p>
We propose a single-file format for network configuration that is
human-readable, can describe all of the common kinds of network
configurations, supports integrity checking, certificate and key
provisioning, and updating. The file can be encrypted with a single
passphrase so that upon entering the passphrase the entire configuration is
loaded. The format can be described as an open format to enable multiple OS
vendors to interoperate and share configuration editors.
</p>
<p>
This format neither supports configuring browser settings nor allows setting
other types of system policies.
</p>
</section>
<section>
<h1>Infrastructure</h1>
<p>
A standalone configuration editor will be created, downloadable as a Chrome
app. This editor will allow creating, modifying, and encrypting an open
network configuration file in a way that is intuitive for a system
administrator.
</p>
<p>
This file format may be delivered to a user and manually imported into a
device.
</p>
<p>
This file format may be created by an administrator, stored in a policy
repository, and automatically pushed to a device.
</p>
</section>
</section>
<section>
<h1>Detailed Design</h1>
<p>
We use JSON format for the files. The fields in a JSON file are always
case-sensitive, so the exact case of the fields in this section must be
matched. In addition, the values that are called out as explicit constants
must also match the case specified (e.g. WiFi must not be written as wifi,
etc.). This document describes a minimum set of required fields and optional
fields. Other fields may be created, however, see the
implementation-specific fields for guidelines for these fields.
</p>
<p>
The JSON consists of a top level dictionary containing
a <span class="field">Type</span> field which must have either the
value <span class="value">EncryptedConfiguration</span>
or <span class="value">UnencryptedConfiguration</span>.
</p>
<p>
For a description of the <span class="type">EncryptedConfiguration</span>
type, see the section on Encrypted Configuration
below. The <span class="type">EncryptedConfiguration</span> format encrypts
an unencrypted JSON object.
</p>
<section>
<h1>GUIDs and Updating</h1>
<p>
This format allows for importing updated network configurations and
certificates by providing GUIDs to each network configuration and
certificate so they can be modified or even removed in future updates.
</p>
<p>
GUIDs are non-empty strings that are meant to be stable and unique. When
they refer to the same entity, they should be the same between ONC files. No
two different networks or certificates should have the same GUID, similarly
a network and certificate should not have the same GUID. A single ONC file
should not contain the same entity twice (with the same GUID). Failing any
of these tests indicates the ONC file is not valid.
</p>
<p>
Any GUID referred to in an ONC file must be present in the same ONC file. In
particular, it is an error to create a certificate in one ONC file and refer
to it in a NetworkConfiguration in another ONC file and not define it there,
even if the previous ONC file has been imported.
</p>
</section>
<section>
<h1>Implementation-specific fields</h1>
<p>
As there are many different kinds of connections and some that are not yet
anticipated may require new fields. This format allows arbitrary other
fields to be added.
</p>
<p>
Fields and values should follow these general guidelines:
</p>
<ul>
<li>
Certificates (with and without keys) should always be placed in the
certificate section - specifically certificate contents should not be
placed in fields directly. Referring to certificates should be done using
a field whose name ends in Ref and whose value is the GUID of the
certificate, or if the certificate is not contained in this file, its
pattern can be described using a field ending in Pattern of
<span class="type">CertificatePattern</span> type.
</li>
<li>
Fields should exist in the most-specific object in the hierarchy and
should be named CamelCase style.
</li>
<li>
Booleans and integers should be used directly instead of using a
stringified version of the type.
</li>
</ul>
<p>
Any editor of network configuration information should allows the user to
modify any fields that are implementation-specific. It may not be present
directly in the UI but it should be able to import files with such settings
and leave preserve these settings on export.
</p>
</section>
<section>
<h1>Unencrypted Configuration</h1>
<p>
When the top level <span class="field">Type</span> field
is <span class="value">UnencryptedConfiguration</span>, the top level JSON
has the <span class="type">UnencryptedConfiguration</span>
type. <span class="type">UnencryptedConfiguration</span> type contains the
following:
</p>
<dl class="field_list">
<dt class="field">Type</dt>
<dd>
<span class="field_meta">
(optional, defaults to <span class="value">UnencryptedConfiguration
</span>)
<span class="type">string</span>
</span>
Must be <span class="value">UnencryptedConfiguration</span>.
</dd>
<dt class="field">NetworkConfigurations</dt>
<dd>
<span class="field_meta">
(optional)
<span class="type">array of NetworkConfiguration</span>
</span>
Describes WiFi, Ethernet, VPN, and wireless connections.
</dd>
<dt class="field">Certificates</dt>
<dd>
<span class="field_meta">
(optional)
<span class="type">array of Certificate</span>
</span>
Contains certificates stored in X.509 or PKCS#12 format.
</dd>
</dl>
At least one actual configuration field
(<span class="field">NetworkConfigurations</span> or
<span class="field">Certificates</span>) should be present, however it should
not be considered an error if no such field is present.
<section>
<h1>Network Configuration</h1>
<p>
Field <span class="field">NetworkConfigurations</span> is an array
of <span class="type">NetworkConfiguration</span> typed
objects. The <span class="type">NetworkConfiguration</span> type contains
the following:
</p>
<dl class="field_list">
<dt class="field">Ethernet</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Type</span> is
<span class="value">Ethernet</span>, otherwise ignored)
<span class="type">Ethernet</span>
</span>
Ethernet settings.
</dd>
<dt class="field">GUID</dt>
<dd>
<span class="field_meta">
(required)
<span class="type">string</span>
</span>
A unique identifier for this network connection, which exists to make it
possible to update previously imported configurations. Must be a non-empty
string.
</dd>
<dt class="field">IPAddressConfigType</dt>
<dd>
<span class="field_meta">
(optional if <span class="field">Remove</span> is
<span class="value">false</span>, otherwise ignored. Defaults to
<span class="value">DHCP</span> if
<span class="field">NameServersConfigType</span> is specified)
<span class="type">string</span>
</span>
<span class="rule">
<span class="rule_id"></span>
Allowed values are <span class="value">DHCP</span> and
<span class="value">Static</span>.
</span>
Determines whether the IP Address configuration is statically configured,
see <span class="field">StaticIPConfig</span>, or automatically configured
using DHCP.
</dd>
<dt class="field">NameServersConfigType</dt>
<dd>
<span class="field_meta">
(optional if <span class="field">Remove</span> is
<span class="value">false</span>, otherwise ignored. Defaults to
<span class="value">DHCP</span> if
<span class="field">IPAddressConfigType</span> is specified)
<span class="type">string</span>
</span>
<span class="rule">
<span class="rule_id"></span>
Allowed values are <span class="value">DHCP</span> and
<span class="value">Static</span>.
</span>
Determines whether the NameServers configuration is statically configured,
see <span class="field">StaticIPConfig</span>, or automatically configured
using DHCP.
</dd>
<dt class="field">IPConfigs</dt>
<dd>
<span class="field_meta">
(optional for connected networks, read-only)
<span class="type">array of IPConfig</span>
</span>
Array of IPConfig properties associated with this connection.
</dd>
<dt class="field">StaticIPConfig</dt>
<dd>
<span class="field_meta">
(required if <span class="field">IPAddressConfigType</span> or
<span class="field">NameServersConfigType</span> is set to
<span class="value">Static</span>)
<span class="type">IPConfig</span>
</span>
Each property set in this IPConfig object overrides the respective
parameter received over DHCP.
If <span class="field">IPAddressConfigType</span> is set to
<span class="value">Static</span>, <span class="field">IPAddress</span>
and <span class="field">Gateway</span> are required.
If <span class="field">NameServersConfigType</span> is set to
<span class="value">Static</span>, <span class="field">NameServers</span>
is required.
</dd>
<dt class="field">SavedIPConfig</dt>
<dd>
<span class="field_meta">
(optional for connected networks, read-only)
<span class="type">IPConfig</span>
</span>
IPConfig property containing the configuration that was received from the
DHCP server prior to applying any StaticIPConfig parameters.
</dd>
<dt class="field">Name</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Remove</span> is
<span class="value">false</span>, otherwise ignored)
<span class="type">string</span>
</span>
A user-friendly description of this connection. This name will not be used
for referencing and may not be unique. Instead it may be used for
describing the network to the user.
</dd>
<dt class="field">Remove</dt>
<dd>
<span class="field_meta">
(optional, defaults to <span class="value">false</span>)
<span class="type">boolean</span>
</span>
If set, remove this network configuration (only GUID should be set).
</dd>
<dt class="field">ProxySettings</dt>
<dd>
<span class="field_meta">
(optional if <span class="field">Remove</span> is
<span class="value">false</span>, otherwise ignored)
<span class="type">ProxySettings</span>
</span>
Proxy settings for this network
</dd>
<dt class="field">VPN</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Type</span> is
<span class="value">VPN</span>, otherwise ignored)
<span class="type">VPN</span>
</span>
VPN settings.
</dd>
<dt class="field">WiFi</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Type</span> is
<span class="value">WiFi</span>, otherwise ignored)
<span class="type">WiFi</span>
</span>
WiFi settings.
</dd>
<dt class="field">WiMAX</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Type</span> is
<span class="value">WiMAX</span>, otherwise ignored)
<span class="type">WiMAX</span>
</span>
WiMAX settings.
</dd>
<dt class="field">Cellular</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Type</span> is
<span class="value">Cellular</span>, otherwise ignored)
<span class="type">Cellular</span>
</span>
Cellular settings.
</dd>
<dt class="field">Type</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Remove</span> is
<span class="value">false</span>, otherwise ignored)
<span class="type">string</span>
</span>
<span class="rule">
<span class="rule_id"></span>
Allowed values are <span class="value">Cellular</span>,
<span class="value">Ethernet</span>, <span class="value">WiFi</span>,
<span class="value">Cellular</span> and <span class="value">VPN</span>.
</span>
Indicates which kind of connection this is.
</dd>
<dt class="field">ConnectionState</dt>
<dd>
<span class="field_meta">
(optional, read-only)
<span class="type">string</span>
</span>
The current connection state for this network, provided by the system.
<span class="rule">
<span class="rule_id"></span>
Allowed values are:
<span class="value">Connected</span>,
<span class="value">Connecting</span>,
<span class="value">NotConnected</span>
</span>
</dd>
<dt class="field">RestrictedConnectivity</dt>
<dd>
<span class="field_meta">
(optional, defaults to <span class="value">false</span>, read-only)
<span class="type">boolean</span>
</span>
True if a connnected network has limited connectivity to the Internet,
e.g. a connection is behind a portal or a cellular network is not
activated or requires payment.
</dd>
<dt class="field">Connectable</dt>
<dd>
<span class="field_meta">
(optional, read-only)
<span class="type">boolean</span>
</span>
True if the system indicates that the network can be connected to without
any additional configuration.
</dd>
<dt class="field">ErrorState</dt>
<dd>
<span class="field_meta">
(optional, read-only)
<span class="type">string</span>
</span>
The current error state for this network, if any. Error states are
provided by the system and are not explicitly defined here. They may or
may not be human-readable. This field will be empty or absent if the
network is not in an error state.
</dd>
<dt class="field">MacAddress</dt>
<dd>
<span class="field_meta">
(optional, read-only)
<span class="type">string</span>
</span>
The MAC address for the network. Only applies to connected non-virtual
networks. The format is 00:11:22:AA:BB:CC.
</dd>
<dt class="field">Source</dt>
<dd>
<span class="field_meta">
(optional, read-only)
<span class="type">string</span>
</span>
Indicates whether the network is configured and how it is configured:
<ul>
<li><span class="value">User</span>: Configured for the active
user only, i.e. an unshared configuration.</li>
<li><span class="value">Device</span>: Configured for all users of the
device (e.g laptop), i.e. a shared configuration.</li>
<li><span class="value">UserPolicy</span>: Configured by the user
policy for the active user.</li>
<li><span class="value">DevicePolicy</span>: Configured by the device
policy for the device.</li>
<li><span class="value">None</span>: Not configured, e.g. a visible
but unconfigured WiFi network.</li>
</ul>
<span class="rule">
<span class="rule_id"></span>
Allowed values are:
<span class="value">User</span>,
<span class="value">Device</span>,
<span class="value">UserPolicy</span>,
<span class="value">DevicePolicy</span>,
<span class="value">None</span>
</span>
</dd>
<dt class="field">Priority</dt>
<dd>
<span class="field_meta">
(optional)
<span class="type">integer</span>
</span>
Provides a suggested priority value for this network. May be used by the
system to determine which network to connect to when multiple configured
networks are available (or may be ignored).
</dd>
</dl>
<section>
<h1>Ethernet networks</h1>
<p>
For Ethernet connections, <span class="field">Type</span> must be set to
<span class="value">Ethernet</span> and the
field <span class="field">Ethernet</span> must be set to an object of
type <span class="type">Ethernet</span> containing the following fields:
</p>
<dl class="field_list">
<dt class="field">Authentication</dt>
<dd>
<span class="field_meta">
(optional)
<span class="type">string</span>
</span>
<span class="rule">
<span class="rule_id"></span>
Allowed values are <span class="value">None</span> and
<span class="value">8021X</span>.
</span>
</dd>
<dt class="field">EAP</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Authentication</span> is
<span class="value">8021X</span>, otherwise ignored)
<span class="type">EAP</span>
</span>
EAP settings.
</dd>
</dl>
</section>
<section>
<h1>IPConfig</h1>
<p>
Objects of type <span class="type">IPConfig</span> are used to report the
actual IP configuration of a connected network (see
<span class="field">IPConfigs</span>), the IP configuration received from
DHCP (see <span class="field">SavedIPConfig</span>) and to configure a
static IP configuration (see <span class="field">StaticIPConfig</span>).
</p>
<dl class="field_list">
<dt class="field">Type</dt>
<dd>
<span class="field_meta">
(required)
<span class="type">string</span>
</span>
<span class="rule">
<span class="rule_id"></span>
Allowed values are <span class="value">IPv4</span>
and <span class="value">IPv6</span>
</span>
Describes the type of configuration this is.
</dd>
<dt class="field">IPAddress</dt>
<dd>
<span class="field_meta">
(optional)
<span class="type">string</span>
</span>
Describes the IPv4 or IPv6 address of a connection, depending on the value
of <span class="field">Type</span> field. It should not contain the
routing prefix (i.e. should not end in something like /64).
</dd>
<dt class="field">RoutingPrefix</dt>
<dd>
<span class="field_meta">
(required if <span class="field">IPAddress</span> is set. Otherwise
ignored.)
<span class="type">integer</span>
</span>
<span class="rule">
<span class="rule_id"></span>
Must be a number in the range [1, 32] for IPv4 and [1, 128] for IPv6
addresses.
</span>
Describes the routing prefix.
</dd>
<dt class="field">Gateway</dt>
<dd>
<span class="field_meta">
(required if <span class="field">IPAddress</span> is set. Otherwise
ignored.)
<span class="type">string</span>
</span>
Describes the gateway address to use for the configuration. Must match
address type specified in <span class="field">Type</span> field. If not
specified, DHCP values will be used.
</dd>
<dt class="field">NameServers</dt>
<dd>
<span class="field_meta">
(optional)
<span class="type">array of string</span>
</span>
Array of addresses to use for name servers. Address format must match that
specified in the <span class="field">Type</span> field. If not specified,
DHCP values will be used.
</dd>
<dt class="field">SearchDomains</dt>
<dd>
<span class="field_meta">
(optional)
<span class="type">array of string</span>
</span>
Array of strings to append to names for resolution. Items in this array
should not start with a dot. Example: <span class="snippet">[
"corp.acme.org", "acme.org" ]</span>. If not specified, DHCP values will
be used.
</dd>
<dt class="field">WebProxyAutoDiscoveryUrl</dt>
<dd>
<span class="field_meta">
(optional if part of <span class="field">IPConfigs</span>, read-only)
<span class="type">string</span>
</span>
The Web Proxy Auto-Discovery URL for this network as reported over DHCP.
</dd>
</dl>
</section>
<section>
<h1>WiFi networks</h1>
<p>
For WiFi connections, <span class="field">Type</span> must be set to
<span class="value">WiFi</span> and the
field <span class="field">WiFi</span> must be set to an object of
type <span class="type">WiFi</span> containing the following fields:
</p>
<dl class="field_list">
<dt class="field">AllowGatewayARPPolling</dt>
<dd>
<span class="field_meta">
(optional, defaults to <span class="value">true</span>)
<span class="type">boolean</span>
</span>
Indicaties if ARP polling of default gateway is allowed.
When it is allowed, periodic ARP messages will be sent to
the default gateway. This is used for monitoring the status
of the current connection.
</dd>
<dt class="field">AutoConnect</dt>
<dd>
<span class="field_meta">
(optional, defaults to <span class="value">false</span>)
<span class="type">boolean</span>
</span>
Indicating that the network should be connected to automatically when in
range.
</dd>
<dt class="field">EAP</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Security</span> is
<span class="value">WEP-8021X</span> or
<span class="value">WPA-EAP</span>, otherwise ignored)
<span class="type">EAP</span>
</span>
EAP settings.
</dd>
<dt class="field">HexSSID</dt>
<dd>
<span class="field_meta">
(optional if <span class="field">SSID</span> is set, if so defaults to
a hex representation of <span class="field">SSID</span>)
<span class="type">string</span>
</span>
Hex representation of the network's SSID.
</dd>
<dt class="field">HiddenSSID</dt>
<dd>
<span class="field_meta">
(optional, defaults to <span class="value">false</span>)
<span class="type">boolean</span>
</span>
Indicating if the SSID will be broadcast.
</dd>
<dt class="field">Passphrase</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Security</span> is
<span class="value">WEP-PSK</span> or
<span class="value">WPA-PSK</span>, otherwise ignored)
<span class="type">string</span>
</span>
Describes the passphrase for WEP/WPA/WPA2
connections. If <span class="value">WEP-PSK</span> is used, the passphrase
must be of the format 0x<hex-number>, where <hex-number> is
40, 104, 128, or 232 bits.
</dd>
<dt class="field">RoamThreshold</dt>
<dd>
<span class="field_meta">
(optional)
<span class="type">integer</span>
</span>
The roam threshold for this network, which is the signal-to-noise value
(in dB) below which we will attempt to roam to a new network. If this
value is not set, the default value will be used.
</dd>
<dt class="field">Security</dt>
<dd>
<span class="field_meta">
(required)
<span class="type">string</span>
</span>
<span class="rule">
<span class="rule_id"></span>
Allowed values are <span class="value">None</span>,
<span class="value">WEP-PSK</span>,
<span class="value">WEP-8021X</span>,
<span class="value">WPA-PSK</span>, and
<span class="value">WPA-EAP</span>.
</span>
</dd>
<dt class="field">SSID</dt>
<dd>
<span class="field_meta">
(optional if <span class="field">HexSSID</span> is set, otherwise
ignored)
<span class="type">string</span>
</span>
Property to access the decoded SSID of a network.<br/>
If this field is set, but <span class="field">HexSSID</span> is not,
its value will be UTF-8 encoded and the hex representation will be
assigned to <span class="field">HexSSID</span>. To configure a non-UTF-8
SSID, field <span class="field">HexSSID</span> must be used.<br/>
When reading the configuration of a network, both this field and
<span class="field">HexSSID</span> might be set. Then this field is the
decoding of <span class="field">HexSSID</span>. If possible the HexSSID is
decoded using UTF-8, otherwise an encoding is guessed on a best effort
basis.
</dd>
<dt class="field">SignalStrength</dt>
<dd>
<span class="field_meta">
(optional, read-only)
<span class="type">integer</span>
</span>
The current signal strength for this network in the range [0, 100],
provided by the system. If the network is not in range this field will
be set to '0' or not present.
</dd>
</dl>
<span class="rule">
<span class="rule_id"></span>
At least one of the fields <span class="field">HexSSID</span> or
<span class="field">SSID</span> must be present. If both
<span class="field">HexSSID</span> and <span class="field">SSID</span>
are set, the values must be consistent.
</span>
</span>
</section>
<section>
<h1>VPN networks</h1>
<p>
There are many kinds of VPNs with widely varying configuration options. We
offer standard configuration options for a few common configurations at this
time, and may add more later. For all others, implementation specific fields
should be used.
</p>
<p>
For VPN connections, <span class="field">Type</span> must be set
to <span class="value">VPN</span> and the
field <span class="field">VPN</span> must be set to an object of
type <span class="type">VPN</span> containing the following fields:
</p>
<dl class="field_list">
<dt class="field">AutoConnect</dt>
<dd>
<span class="field_meta">
(optional, defaults to <span class="value">false</span>)
<span class="type">boolean</span>
</span>
Indicating that the network should be connected to automatically.
</dd>
<dt class="field">Host</dt>
<dd>
<span class="field_meta">
(optional)
<span class="type">string</span>
</span>
Host name or IP address of server to connect to. The only scenario that
does not require a host is a VPN that encrypts but does not tunnel
traffic. Standalone IPsec (v1 or v2, cert or PSK based -- this is not the
same as L2TP over IPsec) is one such setup. For all other types of VPN,
the <span class="field">Host</span> field is required.
</dd>
<dt class="field">IPsec</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Type</span> is
<span class="value">IPsec</span> or
<span class="value">L2TP-IPsec</span>, otherwise ignored)
<span class="type">IPsec</span>
</span>
IPsec layer settings.
</dd>
<dt class="field">L2TP</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Type</span> is
<span class="value">L2TP-IPsec</span>, otherwise ignored)
<span class="type">L2TP</span>
</span>
L2TP layer settings.
</dd>
<dt class="field">OpenVPN</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Type</span> is
<span class="value">OpenVPN</span>, otherwise ignored)
<span class="type">OpenVPN</span>
</span>
OpenVPN settings.
</dd>
<dt class="field">ThirdPartyVPN</dt>
<dd>
<span class="field_meta">
(required if <span class="field">Type</span> is
<span class="value">ThirdPartyVPN</span>, otherwise ignored)
<span class="type">ThirdPartyVPN</span>
</span>
Third-party VPN provider settings.
</dd>
<dt class="field">Type</dt>
<dd>
<span class="field_meta">
(required)
<span class="type">string</span>
</span>
<span class="rule">
<span class="rule_id"></span>
Allowed values are <span class="value">IPsec</span>,
<span class="value">L2TP-IPsec</span>,
<span class="value">OpenVPN</span>, and
<span class="value">ThirdPartyVPN</span>.
</span>
Type of the VPN.
</dd>
</dl>
<section>
<h1>IPsec-based VPN types</h1>
<p>
The <span class="type">IPsec</span> type contains the following:
</p>
<dl class="field_list">
<dt class="field">AuthenticationType</dt>
<dd>
<span class="field_meta">
(required)
<span class="type">string</span>
</span>
<span class="rule">
<span class="rule_id"></span>
Allowed values are <span class="value">PSK</span> and
<span class="value">Cert</span>. If <span class="value">Cert</span> is used, <span class="field">ClientCertType</span> and <span class="field">ServerCARefs</span> (or the deprecated <span class="field">ServerCARef</span>) must be set.
</span>
</dd>
<dt class="field">ClientCertPattern</dt>
<dd>
<span class="field_meta">
(required if <span class="field">ClientCertType</span>
is <span class="value">Pattern</span>, otherwise ignored)
<span class="type">CertificatePattern</span>
</span>
Pattern describing the client certificate.
</dd>
<dt class="field">ClientCertRef</dt>
<dd>
<span class="field_meta">
(required if <span class="field">ClientCertType</span>
is <span class="value">Ref</span>, otherwise ignored)
<span class="type">string</span>
</span>
Reference to client certificate stored in certificate section.
</dd>
<dt class="field">ClientCertType</dt>
<dd>
<span class="field_meta">
(required if <span class="field">AuthenticationType</span>
is <span class="value">Cert</span>, otherwise ignored)
<span class="type">string</span>
</span>
<span class="rule">
<span class="rule_id"></span>
Allowed values are <span class="value">Ref</span> and
<span class="value">Pattern</span>
</span>
</dd>
<dt class="field">EAP</dt>
<dd>
<span class="field_meta">
(optional if <span class="field">IKEVersion</span> is 2, otherwise
ignored)
<span class="type">EAP</span>
</span>
Indicating that EAP authentication should be used with the provided
parameters.
</dd>
<dt class="field">Group</dt>
<dd>
<span class="field_meta">
(optional if <span class="field">IKEVersion</span> is 1, otherwise
ignored)
<span class="type">string</span>
</span>
Group name used for machine authentication.
</dd>
<dt class="field">IKEVersion</dt>
<dd>
<span class="field_meta">
(required)
<span class="type">integer</span>
</span>
Version of IKE protocol to use.
</dd>
<dt class="field">PSK</dt>
<dd>
<span class="field_meta">
(optional if <span class="field">AuthenticationType</span>
is <span class="value">PSK</span>, otherwise ignored)
<span class="type">string</span>
</span>
Pre-Shared Key. If not specified, user is prompted at time of
connection.
</dd>
<dt class="field">SaveCredentials</dt>
<dd>
<span class="field_meta">
(optional if <span class="field">AuthenticationType</span>
is <span class="value">PSK</span>, otherwise ignored, defaults
to <span class="value">false</span>)
<span class="type">boolean</span>
</span>
If <span class="value">false</span>, require user to enter credentials
(PSK) each time they connect.
</dd>
<dt class="field">ServerCARefs</dt>
<dd>
<span class="field_meta">