OLD | NEW |
| (Empty) |
1 // Copyright (c) 2013 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 [ | |
6 { | |
7 "namespace":"networkingPrivate", | |
8 "description": "none", | |
9 "compiler_options": { | |
10 "implemented_in": "chrome/browser/extensions/api/networking_private/networ
king_private_api.h" | |
11 }, | |
12 "platforms": ["chromeos", "win", "mac", "linux"], | |
13 "types" : [ | |
14 { | |
15 "id": "NetworkProperties", | |
16 "type": "object", | |
17 "additionalProperties": { "type": "any" } | |
18 }, | |
19 { | |
20 "id": "ManagedNetworkProperties", | |
21 "type": "object", | |
22 "additionalProperties": { "type": "any" } | |
23 }, | |
24 { | |
25 "id": "VerificationProperties", | |
26 "type": "object", | |
27 "properties": { | |
28 "certificate": { | |
29 "type": "string", | |
30 "description": "A string containing a PEM-encoded (including the \"B
EGIN CERTIFICATE\" header and \"END CERTIFICATE\" footer) X.509 certificate for
use in verifying the signed data." | |
31 }, | |
32 "intermediateCertificates": { | |
33 "type": "array", | |
34 "items": { "type": "string" }, | |
35 "optional": true, | |
36 "description": "An array of PEM-encoded X.509 intermediate certifica
te authority certificates. Each PEM-encoded certificate is expected to have the
\"BEGIN CERTIFICATE\" header and \"END CERTIFICATE\" footer." | |
37 }, | |
38 "publicKey": { | |
39 "type": "string", | |
40 "description": "A string containing a Base64-encoded RSAPublicKey AS
N.1 structure, representing the public key to be used by verifyAndEncryptCredent
ials and verifyAndEncryptData methods." | |
41 }, | |
42 "nonce": { | |
43 "type": "string", | |
44 "description": "A string containing a base64-encoded random binary d
ata for use in verifying the signed data." | |
45 }, | |
46 "signedData": { | |
47 "type": "string", | |
48 "description": "A string containing the identifying data string sign
ed by the device." | |
49 }, | |
50 "deviceSerial": { | |
51 "type": "string", | |
52 "description": "A string containing the serial number of the device.
" | |
53 }, | |
54 "deviceSsid": { | |
55 "type": "string", | |
56 "description": "A string containing the SSID of the device. Only se
t if the device has already been setup once." | |
57 }, | |
58 "deviceBssid": { | |
59 "type": "string", | |
60 "description": "A string containing the BSSID of the device. Only s
et if the device has already been setup." | |
61 } | |
62 } | |
63 }, | |
64 { | |
65 "id": "NetworkType", | |
66 "type": "string", | |
67 "enum": ["All", "Bluetooth", "Cellular", "Ethernet", "VPN", "Wireless",
"WiFi", "Wimax"] | |
68 }, | |
69 { | |
70 "id": "CaptivePortalStatus", | |
71 "type": "string", | |
72 "enum": ["Unknown", "Offline", "Online", "Portal", "ProxyAuthRequired"] | |
73 } | |
74 ], | |
75 "functions": [ | |
76 { | |
77 "name": "getProperties", | |
78 "description": "Gets all the properties of the network with id networkGu
id. Includes all properties of the network (read-only and read/write values).", | |
79 "parameters": [ | |
80 { | |
81 "name": "networkGuid", | |
82 "type": "string", | |
83 "description": "The unique identifier of the network to get properti
es from." | |
84 }, | |
85 { | |
86 "name": "callback", | |
87 "type": "function", | |
88 "parameters": [ | |
89 { | |
90 "name": "properties", | |
91 "$ref": "NetworkProperties", | |
92 "description": "Results of the query for network properties." | |
93 } | |
94 ] | |
95 } | |
96 ] | |
97 }, | |
98 { | |
99 "name": "getManagedProperties", | |
100 "description": "Gets the merged properties of the network with id networ
kGuid from the sources: User settings, shared settings, user policy, device poli
cy and the currently active settings.", | |
101 "parameters": [ | |
102 { | |
103 "name": "networkGuid", | |
104 "type": "string", | |
105 "description": "The unique identifier of the network to get properti
es from." | |
106 }, | |
107 { | |
108 "name": "callback", | |
109 "type": "function", | |
110 "parameters": [ | |
111 { | |
112 "name": "properties", | |
113 "$ref": "ManagedNetworkProperties", | |
114 "description": "Results of the query for managed network propert
ies." | |
115 } | |
116 ] | |
117 } | |
118 ] | |
119 }, | |
120 { | |
121 "name": "getState", | |
122 "description": "Gets the cached read-only properties of the network with
id networkGuid. This is meant to be a higher performance function than getPrope
rties, which requires a round trip to query the networking subsystem. The follo
wing properties are returned for all networks: GUID, Type, Name, WiFi.Security.
Additional properties are provided for visible networks: ConnectionState, ErrorS
tate, WiFi.SignalStrength, Cellular.NetworkTechnology, Cellular.ActivationState,
Cellular.RoamingState, Cellular.OutOfCredits.", | |
123 "parameters": [ | |
124 { | |
125 "name": "networkGuid", | |
126 "type": "string", | |
127 "description": "The unique identifier of the network to set properti
es on." | |
128 }, | |
129 { | |
130 "name": "callback", | |
131 "type": "function", | |
132 "parameters": [ | |
133 { | |
134 "name": "properties", | |
135 "$ref": "NetworkProperties", | |
136 "description": "Results of the query for network state propertie
s." | |
137 } | |
138 ] | |
139 } | |
140 ] | |
141 }, | |
142 { | |
143 "name": "setProperties", | |
144 "description": "Sets the properties of the network with id networkGuid."
, | |
145 "parameters": [ | |
146 { | |
147 "name": "networkGuid", | |
148 "type": "string", | |
149 "description": "The unique identifier of the network to set properti
es on." | |
150 }, | |
151 { | |
152 "name": "properties", | |
153 "$ref": "NetworkProperties", | |
154 "description": "The properties to set on the network." | |
155 }, | |
156 { | |
157 "name": "callback", | |
158 "type": "function", | |
159 "parameters": [] | |
160 } | |
161 ] | |
162 }, | |
163 { | |
164 "name": "createNetwork", | |
165 "description": "Creates a new network configuration from properties. If
a matching configured network already exists, this will fail. Otherwise returns
the guid of the new network.", | |
166 "parameters": [ | |
167 { | |
168 "name": "shared", | |
169 "type": "boolean", | |
170 "description": "If true, share this network configuration with other
users." | |
171 }, | |
172 { | |
173 "name": "properties", | |
174 "$ref": "NetworkProperties", | |
175 "description": "The properties to configure the new network with." | |
176 }, | |
177 { | |
178 "name": "callback", | |
179 "type": "function", | |
180 "parameters": [ | |
181 { | |
182 "name": "networkGuid", | |
183 "type": "string" | |
184 } | |
185 ] | |
186 } | |
187 ] | |
188 }, | |
189 { | |
190 "name": "getNetworks", | |
191 "description": "Returns a list of network objects with the same properti
es provided by getState. A filter is provided to specify the type of networks re
turned and to limit the number of networks. Networks are ordered by the system b
ased on their priority, with connected or connecting networks listed first.", | |
192 "parameters": [ | |
193 { | |
194 "name": "filter", | |
195 "type": "object", | |
196 "properties": { | |
197 "networkType": { | |
198 "$ref": "NetworkType", | |
199 "description": "The type of networks to return." | |
200 }, | |
201 "visible": { | |
202 "type": "boolean", | |
203 "optional": true, | |
204 "description": "If true, only include visible (physically connec
ted or in-range) networks. Defaults to 'false'." | |
205 }, | |
206 "configured": { | |
207 "type": "boolean", | |
208 "optional": true, | |
209 "description": "If true, only include configured (saved) network
s. Defaults to 'false'." | |
210 }, | |
211 "limit": { | |
212 "type": "integer", | |
213 "optional": true, | |
214 "description": "Maximum number of networks to return. Defaults t
o 1000. Use 0 for no limit." | |
215 } | |
216 } | |
217 }, | |
218 { | |
219 "name": "callback", | |
220 "type": "function", | |
221 "optional": true, | |
222 "parameters": [ | |
223 { | |
224 "name": "networkList", | |
225 "type": "array", | |
226 "items": { "$ref": "NetworkProperties" } | |
227 } | |
228 ] | |
229 } | |
230 ] | |
231 }, | |
232 { | |
233 "name": "getVisibleNetworks", | |
234 "deprecated": "Please use $(ref:networkingPrivate.getNetworks) with filt
er.visble = true.", | |
235 "description": "Returns a list of visible network objects with the same
properties provided by getState.", | |
236 "parameters": [ | |
237 { | |
238 "name": "networkType", | |
239 "$ref": "NetworkType", | |
240 "description": "The type of networks to return." | |
241 }, | |
242 { | |
243 "name": "callback", | |
244 "type": "function", | |
245 "optional": true, | |
246 "parameters": [ | |
247 { | |
248 "name": "networkList", | |
249 "type": "array", | |
250 "items": { "$ref": "NetworkProperties" } | |
251 } | |
252 ] | |
253 } | |
254 ] | |
255 }, | |
256 { | |
257 "name": "getEnabledNetworkTypes", | |
258 "description": "Returns a list of the enabled network types. Note: this
only returns discrete types that can be enabled or disabled: Cellular, Ethernet,
WiFi, Wimax.", | |
259 "parameters": [ | |
260 { | |
261 "name": "callback", | |
262 "type": "function", | |
263 "optional": true, | |
264 "parameters": [ | |
265 { | |
266 "name": "enabledTypes", | |
267 "type": "array", | |
268 "items": { "$ref": "NetworkType" } | |
269 } | |
270 ] | |
271 } | |
272 ] | |
273 }, | |
274 { | |
275 "name": "enableNetworkType", | |
276 "description": "Enable the specified network type. Note, the type might
represent multiple network types (e.g. 'Wireless').", | |
277 "parameters": [ | |
278 { | |
279 "name": "networkType", | |
280 "$ref": "NetworkType" | |
281 } | |
282 ] | |
283 }, | |
284 { | |
285 "name": "disableNetworkType", | |
286 "description": "Disable the specified network type. See note for $(ref:n
etworkingPrivate.enableNetworkType).", | |
287 "parameters": [ | |
288 { | |
289 "name": "networkType", | |
290 "$ref": "NetworkType" | |
291 } | |
292 ] | |
293 }, | |
294 { | |
295 "name": "requestNetworkScan", | |
296 "description": "Requests that the networking subsystem scan for new netw
orks and update the list returned by getVisibleNetworks. This is only a request
: the network subsystem can choose to ignore it. If the list is updated, then t
he onNetworkListChanged event will be fired.", | |
297 "parameters": [] | |
298 }, | |
299 { | |
300 "name": "startConnect", | |
301 "description": "Starts a connection to the network with networkGuid.", | |
302 "parameters": [ | |
303 { | |
304 "name": "networkGuid", | |
305 "type": "string", | |
306 "description": "The unique identifier of the network to connect to." | |
307 }, | |
308 { | |
309 "name": "callback", | |
310 "type": "function", | |
311 "optional": true, | |
312 "parameters": [], | |
313 "description": "A callback function that indicates that a connection
has been initiated." | |
314 } | |
315 ] | |
316 }, | |
317 { | |
318 "name": "startDisconnect", | |
319 "description": "Starts a disconnect from the network with networkGuid.", | |
320 "parameters": [ | |
321 { | |
322 "name": "networkGuid", | |
323 "type": "string", | |
324 "description": "The unique identifier of the network to disconnect f
rom." | |
325 }, | |
326 { | |
327 "name": "callback", | |
328 "type": "function", | |
329 "optional": true, | |
330 "parameters": [], | |
331 "description": "A callback function that indicates that a disconnect
has been initiated." | |
332 } | |
333 ] | |
334 }, | |
335 { | |
336 "name": "verifyDestination", | |
337 "description": "Verifies that the device is a trusted device.", | |
338 "parameters": [ | |
339 { | |
340 "name": "properties", | |
341 "$ref": "VerificationProperties", | |
342 "description": "Properties of the destination to use in verifying th
at it is a trusted device." | |
343 }, | |
344 { | |
345 "name": "callback", | |
346 "type": "function", | |
347 "parameters": [ | |
348 { | |
349 "name": "verified", | |
350 "type": "boolean" | |
351 } | |
352 ], | |
353 "description": "A callback function that indicates whether or not th
e device is a trusted device." | |
354 } | |
355 ] | |
356 }, | |
357 { | |
358 "name": "verifyAndEncryptCredentials", | |
359 "description": "Verifies that the device is a trusted device and retriev
es encrypted network credentials.", | |
360 "parameters": [ | |
361 { | |
362 "name": "properties", | |
363 "$ref": "VerificationProperties", | |
364 "description": "Properties of the destination to use in verifying th
at it is a trusted device." | |
365 }, | |
366 { | |
367 "name": "networkGuid", | |
368 "type": "string", | |
369 "description": "A string containing the unique identifier of the net
work to get credentials for." | |
370 }, | |
371 { | |
372 "name": "callback", | |
373 "type": "function", | |
374 "parameters": [ | |
375 { | |
376 "name": "credentials", | |
377 "type": "string" | |
378 } | |
379 ], | |
380 "description": "A callback function that receives base64-encoded enc
rypted credential data to send to a trusted device." | |
381 } | |
382 ] | |
383 }, | |
384 { | |
385 "name": "verifyAndEncryptData", | |
386 "description": "Verifies that the device is a trusted device and encrypt
s supplied data with device public key.", | |
387 "parameters": [ | |
388 { | |
389 "name": "properties", | |
390 "$ref": "VerificationProperties", | |
391 "description": "Properties of the destination to use in verifying th
at it is a trusted device." | |
392 }, | |
393 { | |
394 "name": "data", | |
395 "type": "string", | |
396 "description": "A string containing the base64-encoded data to encry
pt." | |
397 }, | |
398 { | |
399 "name": "callback", | |
400 "type": "function", | |
401 "parameters": [ | |
402 { | |
403 "name": "encryptedData", | |
404 "type": "string" | |
405 } | |
406 ], | |
407 "description": "A callback function that receives base64-encoded enc
rypted data to send to a trusted device." | |
408 } | |
409 ] | |
410 }, | |
411 { | |
412 "name": "setWifiTDLSEnabledState", | |
413 "description": "Enables TDLS for wifi traffic with a specified peer if a
vailable.", | |
414 "parameters": [ | |
415 { | |
416 "name": "ip_or_mac_address", | |
417 "type": "string", | |
418 "description": "The IP or MAC address of the peer with which to enab
le a TDLS connection." | |
419 }, | |
420 { | |
421 "name": "enabled", | |
422 "type": "boolean", | |
423 "description": "If true, enable TDLS, otherwise disable TDLS." | |
424 }, | |
425 { | |
426 "name": "callback", | |
427 "type": "function", | |
428 "parameters": [ | |
429 { | |
430 "name": "status", | |
431 "type": "string" | |
432 } | |
433 ], | |
434 "description": "A callback function that receives a string with an e
rror or the current TDLS status. 'Failed' indicates that the request failed (e.g
. MAC address lookup failed). 'Timeout' indicates that the lookup timed out. Oth
erwise a valid status is returned (see getWifiTDLSStatus)." | |
435 } | |
436 ] | |
437 }, | |
438 { | |
439 "name": "getWifiTDLSStatus", | |
440 "description": "Returns the current TDLS status for the specified peer."
, | |
441 "parameters": [ | |
442 { | |
443 "name": "ip_or_mac_address", | |
444 "type": "string", | |
445 "description": "The IP or MAC address of the peer." | |
446 }, | |
447 { | |
448 "name": "callback", | |
449 "type": "function", | |
450 "parameters": [ | |
451 { | |
452 "name": "status", | |
453 "type": "string" | |
454 } | |
455 ], | |
456 "description": "A callback function that receives a string with the
current TDLS status which can be 'Connected', 'Disabled', 'Disconnected', 'Nonex
istent', or 'Unknown'" | |
457 } | |
458 ] | |
459 }, | |
460 { | |
461 "name": "getCaptivePortalStatus", | |
462 "description": "Returns captive portal status for the network matching '
guid'.", | |
463 "parameters": [ | |
464 { | |
465 "name": "networkGuid", | |
466 "type": "string", | |
467 "description": "The guid of the network to get captive portal status
." | |
468 }, | |
469 { | |
470 "name": "callback", | |
471 "type": "function", | |
472 "parameters": [ | |
473 { | |
474 "name": "status", | |
475 "$ref": "CaptivePortalStatus", | |
476 "description": "Results of the query for network captive portal
status." | |
477 } | |
478 ] | |
479 } | |
480 ] | |
481 } | |
482 ], | |
483 "events": [ | |
484 { | |
485 "name": "onNetworksChanged", | |
486 "type": "function", | |
487 "description": "Fired when the properties change on any of the networks.
Sends a list of identifiers for networks whose properties have changed.", | |
488 "parameters": [ | |
489 { | |
490 "name": "changes", | |
491 "type": "array", | |
492 "items": { "type": "string" } | |
493 } | |
494 ] | |
495 }, | |
496 { | |
497 "name": "onNetworkListChanged", | |
498 "type": "function", | |
499 "description": "Fired when the list of networks has changed. Sends a co
mplete list of identifiers for all the current networks.", | |
500 "parameters": [ | |
501 { | |
502 "name": "changes", | |
503 "type": "array", | |
504 "items": { "type": "string" } | |
505 } | |
506 ] | |
507 }, | |
508 { | |
509 "name": "onPortalDetectionCompleted", | |
510 "type": "function", | |
511 "description": "Fired when a portal detection for a network completes. S
ends the guid of the network and the corresponding captive portal status.", | |
512 "parameters": [ | |
513 { | |
514 "name": "networkGuid", | |
515 "type": "string" | |
516 }, | |
517 { | |
518 "name": "status", | |
519 "$ref": "CaptivePortalStatus" | |
520 } | |
521 ] | |
522 } | |
523 ] | |
524 } | |
525 ] | |
OLD | NEW |