1
diff --git a/README.md b/README.md
2
index d100e2f..1759797 100644
3
--- a/README.md
4
+++ b/README.md
5
@@ -44,7 +44,7 @@ snap connect wifi-connect:network-manager network-manager:service
6
44
Note: wifi-ap and network-manager interfaces auto-connect.
44
Note: wifi-ap and network-manager interfaces auto-connect.
7
45
Note: Currently content share interface requires a reboot after connection, as described below.
45
Note: Currently content share interface requires a reboot after connection, as described below.
8
46
46
10
47
# Set NetWorkManager to control all networking
47
# Set NetworkManager to control all networking
11
48
48
12
49
Note: This is a temporary manual step before network-manager snap provides a config option for this.
49
Note: This is a temporary manual step before network-manager snap provides a config option for this.
13
50
50
14
diff --git a/daemon/daemon.go b/daemon/daemon.go
15
index 04ff59e..a888969 100644
16
--- a/daemon/daemon.go
17
+++ b/daemon/daemon.go
18
@@ -18,8 +18,11 @@
19
18
package daemon
18
package daemon
20
19
19
21
20
import (
20
import (
22
21
	"encoding/json"
23
21
	"fmt"
22
	"fmt"
24
23
	"io/ioutil"
25
22
	"os"
24
	"os"
26
25
	"path/filepath"
27
23
26
28
24
	"launchpad.net/wifi-connect/avahi"
27
	"launchpad.net/wifi-connect/avahi"
29
25
	"launchpad.net/wifi-connect/server"
28
	"launchpad.net/wifi-connect/server"
30
@@ -40,6 +43,19 @@ var waitFlagPath string
31
40
var previousState = STARTING
43
var previousState = STARTING
32
41
var state = STARTING
44
var state = STARTING
33
42
45
34
46
// PreConfigFile is the path to the file that stores the hash of the portals password
35
47
var PreConfigFile = filepath.Join(os.Getenv("SNAP_COMMON"), "pre-config.json")
36
48
37
49
// PreConfig is the struct representing a configuration
38
50
type PreConfig struct {
39
51
	Passphrase    string `json:"wifi.security-passphrase,omitempty"`
40
52
	Ssid          string `json:"wifi.ssid,omitempty"`
41
53
	Interface     string `json:"wifi.interface,omitempty"`
42
54
	Password      string `json:"portal.password,omitempty"`
43
55
	NoOperational bool   `json:"portal.no-operational,omitempty"` //whether to show the operational portal
44
56
	NoResetCreds  bool   `json:"portal.no-reset-creds,omitempty"` //whether user must reset passphrase and password on first use of mgmt portal
45
57
}
46
58
47
43
// Client is the base type for both testing and runtime
59
// Client is the base type for both testing and runtime
48
44
type Client struct {
60
type Client struct {
49
45
}
61
}
50
@@ -189,11 +205,55 @@ func (c *Client) OperationalServerDown() {
51
189
	}
205
	}
52
190
}
206
}
53
191
207
60
192
// SetDefaults sets defaults if not yet set. Currently the hash
208
// LoadPreConfig returns a PreConfig based on the pre-config.json, if present, and an error to indicate
61
193
// for the portals password is set.
209
// possible json unmarshal failure
62
194
// TODO: set default password based on MAC addr or Serial number
210
func LoadPreConfig() (*PreConfig, error) {
63
195
func (c *Client) SetDefaults() {
211
	config := &PreConfig{}
64
196
	if _, err := os.Stat(utils.HashFile); os.IsNotExist(err) {
212
	content, err := ioutil.ReadFile(PreConfigFile)
65
197
		utils.HashIt("wifi-connect")
213
	if err == nil {
66
214
		fmt.Println("== wifi-connect/daemon: preconfiguration file found")
67
215
	}
68
216
	err = json.Unmarshal(content, config)
69
217
	if err != nil {
70
218
		return config, err
71
219
	}
72
220
	return config, nil
73
221
}
74
222
75
223
// SetDefaults creates the run time configuration based on wifi-ap and the pre-config.json
76
224
// configuration file, if any. The configuration is returned with an error. PreConfig.PreConfigfile
77
225
// indicates whether a pre-config file exists.
78
226
func (c *Client) SetDefaults(cw wifiap.Operations, config *PreConfig) error {
79
227
	if err != nil {
80
228
		fmt.Println("== wifi-connect/daemon/SetDefaults: preconfig unmarshall errorr:", err)
81
229
	}
82
230
	ap, errShow := cw.Show()
83
231
	if errShow != nil {
84
232
		fmt.Println("== wifi-connect/daemon/SetDefaults: wifi-ap.Show err:", errShow)
85
233
	}
86
234
	if ap["wifi.security-passphrase"] != config.Passphrase {
87
235
		if len(config.Passphrase) > 0 {
88
236
			err = cw.SetPassphrase(config.Passphrase)
89
237
			fmt.Println("== wifi-connect/SetDefaults wifi-ap passphrase being set")
90
238
			if err != nil {
91
239
				fmt.Println("== wifi-connect/daemon/SetDefaults: passphrase err:", err)
92
240
				return err
93
241
			}
94
242
		}
95
243
	}
96
244
	if len(config.Password) > 0 {
97
245
		fmt.Println("== wifi-connect/SetDefaults portal password being set")
98
246
		_, err = utils.HashIt(config.Password)
99
247
		if err != nil {
100
248
			fmt.Println("== wifi-connect/daemon/SetDefaults: password err:", err)
101
249
			return err
102
250
		}
103
251
	}
104
252
	if config.NoOperational {
105
253
		fmt.Println("== wifi-connect/SetDefaults: operational portal is now disabled")
106
254
	}
107
255
	if config.NoResetCreds {
108
256
		fmt.Println("== wifi-connect/SetDefaults: reset creds requirement is now disabled")
109
198
	}
257
	}
110
258
	return nil
111
199
}
259
}
112
diff --git a/daemon/daemon_test.go b/daemon/daemon_test.go
113
index c6242cd..177c26b 100644
114
--- a/daemon/daemon_test.go
115
+++ b/daemon/daemon_test.go
116
@@ -18,7 +18,11 @@
117
18
package daemon
18
package daemon
118
19
19
119
20
import (
20
import (
120
21
	"fmt"
121
22
	"io/ioutil"
122
23
	"net/http"
123
21
	"os"
24
	"os"
124
25
	"strings"
125
22
	"testing"
26
	"testing"
126
23
27
127
24
	"launchpad.net/wifi-connect/utils"
28
	"launchpad.net/wifi-connect/utils"
128
@@ -94,8 +98,92 @@ func TestManualMode(t *testing.T) {
129
94
	}
98
	}
130
95
}
99
}
131
96
100
132
101
type mockWifiap struct{}
133
102
134
103
func (mock *mockWifiap) Do(req *http.Request) (*http.Response, error) {
135
104
	fmt.Println("==== MY do called")
136
105
	url := req.URL.String()
137
106
	if url != "http://unix/v1/configuration" {
138
107
		return nil, fmt.Errorf("Not valid request URL: %v", url)
139
108
	}
140
109
141
110
	if req.Method != "GET" {
142
111
		return nil, fmt.Errorf("Method is not valid. Expected GET, got %v", req.Method)
143
112
	}
144
113
145
114
	rawBody := `{"result":{
146
115
		"debug":false, 
147
116
		"dhcp.lease-time": "12h", 
148
117
		"dhcp.range-start": "10.0.60.2", 
149
118
		"dhcp.range-stop": "10.0.60.199", 
150
119
		"disabled": true, 
151
120
		"share.disabled": false, 
152
121
		"share-network-interface": "tun0", 
153
122
		"wifi-address": "10.0.60.1", 
154
123
		"wifi.channel": "6", 
155
124
		"wifi.hostapd-driver": "nl80211", 
156
125
		"wifi.interface": "wlan0", 
157
126
		"wifi.interface-mode": "direct", 
158
127
		"wifi.netmask": "255.255.255.0", 
159
128
		"wifi.operation-mode": "g", 
160
129
		"wifi.security": "
161
130
		"wifi.security-passphrase": "passphrase123", 
162
131
		"wifi.ssid": "AP"},"status":"OK","status-code":200,""sync"}`
163
132
164
133
	response := http.Response{
165
134
		StatusCode: 200,
166
135
		Status:     "200 OK",
167
136
		Body:       ioutil.NopCloser(strings.NewReader(rawBody)),
168
137
	}
169
138
170
139
	return &response, nil
171
140
}
172
141
173
142
func (mock *mockWifiap) Show() (map[string]interface{}, error) {
174
143
	wifiAp := make(map[string]interface{})
175
144
	wifiAp["wifi.security-passphrase"] = "randompassphrase"
176
145
	return wifiAp, nil
177
146
}
178
147
179
148
func (mock *mockWifiap) Enabled() (bool, error) {
180
149
	return true, nil
181
150
}
182
151
183
152
func (mock *mockWifiap) Enable() error {
184
153
	return nil
185
154
}
186
155
func (mock *mockWifiap) Disable() error {
187
156
	return nil
188
157
}
189
158
func (mock *mockWifiap) SetSsid(s string) error {
190
159
	return nil
191
160
}
192
161
193
162
func (mock *mockWifiap) SetPassphrase(p string) error {
194
163
	return nil
195
164
}
196
165
197
166
func TestLoadPreConfig(t *testing.T) {
198
167
	PreConfigFile = "../static/tests/pre-config0.json"
199
168
	config, err := LoadPreConfig()
200
169
	if err != nil {
201
170
		t.Errorf("Unexpected error using LoadPreConfig: %s", err)
202
171
	}
203
172
	if config.Passphrase != "abcdefghijklmnop" {
204
173
		t.Errorf("Passphrase of %s expected but got %s:", "abcdefghijklmnop", config.Passphrase)
205
174
	}
206
175
	if !config.NoOperational {
207
176
		t.Errorf("portal.no-operational was set to true but the loaded config is %t", config.NoOperational)
208
177
	}
209
178
	if !config.NoResetCreds {
210
179
		t.Errorf("portal.no-reset-creds was set to true but the loaded config is %t", config.NoResetCreds)
211
180
	}
212
181
213
182
}
214
183
215
97
func TestSetDefaults(t *testing.T) {
184
func TestSetDefaults(t *testing.T) {
216
98
	client := GetClient()
185
	client := GetClient()
217
186
	PreConfigFile = "../static/tests/pre-config0.json"
218
99
	hfp := "/tmp/hash"
187
	hfp := "/tmp/hash"
219
100
	if _, err := os.Stat(hfp); err == nil {
188
	if _, err := os.Stat(hfp); err == nil {
220
101
		err = os.Remove(hfp)
189
		err = os.Remove(hfp)
221
@@ -103,35 +191,48 @@ func TestSetDefaults(t *testing.T) {
222
103
			t.Errorf("Could not remove previous file version")
191
			t.Errorf("Could not remove previous file version")
223
104
		}
192
		}
224
105
	}
193
	}
225
194
	config, _ := LoadPreConfig()
226
106
	utils.SetHashFile(hfp)
195
	utils.SetHashFile(hfp)
229
107
	client.SetDefaults()
196
	client.SetDefaults(&mockWifiap{}, config)
230
108
	_, err := os.Stat(utils.HashFile)
197
	expectedPassphrase := "abcdefghijklmnop"
231
198
	expectedPassword := "qwerzxcv"
232
199
	if config.Passphrase != expectedPassphrase {
233
200
		t.Errorf("SetDefaults: Preconfig passphrase should be %s but is %s", expectedPassphrase, config.Passphrase)
234
201
	}
235
109
	if os.IsNotExist(err) {
202
	if os.IsNotExist(err) {
236
110
		t.Errorf("SetDefaults should have created %s but did not", hfp)
203
		t.Errorf("SetDefaults should have created %s but did not", hfp)
237
111
	}
204
	}
239
112
	res, _ := utils.MatchingHash("wifi-connect")
205
	res, _ := utils.MatchingHash(expectedPassword)
240
113
	if !res {
206
	if !res {
242
114
		t.Errorf("SetDefaults password match did not match")
207
		t.Errorf("SetDefaults: Preconfig password hash did not match actual")
243
208
	}
244
209
	if !config.NoOperational {
245
210
		t.Errorf("SetDefaults: Preconfig portal.no-operational should be true (set) but is %t", config.NoOperational)
246
211
	}
247
212
	if !config.NoResetCreds {
248
213
		t.Errorf("SetDefaults: Preconfig portal.no-reset-creds should be true (set) but is %t", config.NoResetCreds)
249
115
	}
214
	}
250
116
}
251
117
215
259
118
func TestSetDefaultsAlreadyExistsHashFile(t *testing.T) {
216
	if _, err := os.Stat(hfp); err == nil {
260
119
	client := GetClient()
217
		err = os.Remove(hfp)
261
120
	hfp := "/tmp/hash"
218
		if err != nil {
262
121
	// create file if not exists
219
			t.Errorf("Could not remove previous file version")
256
122
	if _, err := os.Stat(utils.HashFile); os.IsNotExist(err) {
257
123
		if _, err = os.OpenFile(hfp, os.O_CREATE, 0666); err != nil {
258
124
			t.Errorf("Error creating %v file", hfp)
263
125
		}
220
		}
264
126
	}
221
	}
270
127
	utils.SetHashFile(hfp)
222
	PreConfigFile = "../static/tests/pre-config1.json"
271
128
	client.SetDefaults()
223
	config, _ = LoadPreConfig()
272
129
	_, err := os.Stat(utils.HashFile)
224
	client.SetDefaults(&mockWifiap{}, config)
273
130
	if os.IsNotExist(err) {
225
	if len(config.Passphrase) > 0 {
274
131
		t.Errorf("SetDefaults should have created %s but did not", hfp)
226
		t.Errorf("SetDefaults: Preconfig passphrase was not set but is %s", config.Passphrase)
275
132
	}
227
	}
279
133
	res, _ := utils.MatchingHash("wifi-connect")
228
	res2, _ := utils.MatchingHash(expectedPassword)
280
134
	if !res {
229
	if res2 {
281
135
		t.Errorf("SetDefaults password match did not match")
230
		t.Errorf("SetDefaults: Preconfig password was not set, but the hash matched")
282
231
	}
283
232
	if config.NoOperational {
284
233
		t.Errorf("SetDefaults: Preconfig portal.no-operational should be false (unset) but is %t", config.NoOperational)
285
234
	}
286
235
	if config.NoResetCreds {
287
236
		t.Errorf("SetDefaults: Preconfig portal.no-reset-creds should be false (unnset) but is %t", config.NoResetCreds)
288
136
	}
237
	}
289
137
}
238
}
290
diff --git a/docs/faq.md b/docs/faq.md
291
138
new file mode 100644
239
new file mode 100644
292
index 0000000..ec8f87e
293
--- /dev/null
294
+++ b/docs/faq.md
295
@@ -0,0 +1,10 @@
296
1
---
297
2
title: "Frequently asked questions"
298
3
table_of_contents: True
299
4
---
300
5
301
6
# Restarting the wifi-connect daemon
302
7
303
8
```bash
304
9
sudo systemctl restart snap.wifi-connect.daemon.service
305
10
```
306
diff --git a/docs/index.md b/docs/index.md
307
0
new file mode 100644
11
new file mode 100644
308
index 0000000..679b180
309
--- /dev/null
310
+++ b/docs/index.md
311
@@ -0,0 +1,24 @@
312
1
---
313
2
title: "Overview"
314
3
table_of_contents: True
315
4
---
316
5
317
6
# Overview
318
7
319
8
The wifi-connect snap allows you to connect your device to an external Wi-Fi access point. It does this by putting up its own Wi-Fi AP and web page. You join the AP and the web page lists external APs, which you can then select and join. 
320
9
321
10
Wifi-connect is appropriate for simple use cases where there is no other control of networking. Wifi-connect has a daemon that takes over networking and controls device state automatically:
322
11
323
12
 * When there is no external AP connection, wifi-connect starts its own AP and the Management web page (which allows you to select and join external WiFI APs)
324
13
 * When there is an external AP connection, wifi-connect ensures its own AP is down and puts up the Operational web page (which allows you to disconnect from the external AP) 
325
14
326
15
Wifi-connect uses two other snaps:
327
16
328
17
 * wifi-ap: provides the AP function
329
18
 * network-manager: handles networking (as a part of installation, the device netplan is modified to make network-manager the renderer for all networking).
330
19
331
20
Wifi-connect can be:
332
21
333
22
 * Installed at run time
334
23
 * Integrated into an image, with options. See "Integrating into an Image" section
335
24
336
diff --git a/docs/installation.md b/docs/installation.md
337
0
new file mode 100644
25
new file mode 100644
338
index 0000000..deba1ec
339
--- /dev/null
340
+++ b/docs/installation.md
341
@@ -0,0 +1,121 @@
342
1
---
343
2
title: "Installation"
344
3
table_of_contents: True
345
4
---
346
5
347
6
# Overview
348
7
349
8
The wifi-connect snap is currently publish in edge and beta channels.
350
9
351
10
## Install snaps
352
11
353
12
```bash
354
13
snap install wifi-ap
355
14
snap install network-manager
356
15
snap install --edge|beta wifi-connect
357
16
```
358
17
359
18
## Connect interfaces
360
19
361
20
```bash
362
21
snap connect wifi-connect:control wifi-ap:control
363
22
snap connect wifi-connect:network core:network
364
23
snap connect wifi-connect:network-bind core:network-bind
365
24
snap connect wifi-connect:network-manager network-manager:service
366
25
```
367
26
368
27
## Set NetWorkManager to control all networking
369
28
370
29
**Note**: This is a temporary manual step before network-manager snap provides a config option for this.
371
30
372
31
**Note**: Depending on your environment, after this you may need to use a new IP address to connect to the device.
373
32
374
33
 1. Backup the existing /etc/netplan/00-snapd-config.yaml file 
375
34
376
35
        sudo mv /etc/netplan/00-snapd-config.yaml ~/
377
36
378
37
 1. Create a new netplan config file named /etc/netplan/00-default-nm-renderer.yaml:
379
38
380
39
        sudo vi /etc/netplan/00-default-nm-renderer.yaml
381
40
382
41
    Add the following two lines:
383
42
384
43
        network:
385
44
            renderer: NetworkManager
386
45
387
46
## Reboot
388
47
389
48
Rebooting addresses a potential content sharing interface issue. 
390
49
391
50
Rebooting also consolidates all networking into NetworkManager.
392
51
393
52
## Optionally configure wifi-ap SSID/passphrase
394
53
395
54
If you skip these steps, the wifi-AP put up by the device has an SSID of "Ubuntu" and is unsecure (with no passphrase). 
396
55
397
56
 1. Set the wifi-ap AP SSID
398
57
399
58
        sudo  wifi-connect ssid MYSSID 
400
59
401
60
 1. Set the AP passphrase:
402
61
403
62
        sudo  wifi-connect passphrase MYPASSPHRASE
404
63
405
64
## Display the AP config
406
65
407
66
```bash
408
67
sudo  wifi-connect show-ap
409
68
```
410
69
411
70
**Note** the DHCP range:
412
71
413
72
    dhcp.range-start: 10.0.60.2
414
73
    dhcp.range-stop: 10.0.60.199
415
74
416
75
## Set the portal password
417
76
418
77
The portal password must be entered to access wifi-connect web pages.
419
78
420
79
```bash
421
80
sudo  wifi-connect set-portal-password PASSWORD
422
81
```
423
82
424
83
## Join the device AP
425
84
426
85
When the device AP is up and available to you, join it.
427
86
428
87
## Open the the Management portal web page
429
88
430
89
This portal displays external wifi APs and let's you join them.
431
90
432
91
After you connect to the device AP, you can open its http portal at the .1 IP address just before the start of the DHCP range (see previous steps) using port 8080: 
433
92
434
93
    10.0.60.1:8080
435
94
436
95
You then need to enter the portal password to continue.
437
96
438
97
### Avahi and hostname
439
98
440
99
You can also connect to the device's web page using the device host name: 
441
100
442
101
    http://HOSTNAME.local:8080 
443
102
444
103
Where HOSTNAME is the hostname of the device when it booted. (Changing hostname with the hostname command at run time is not sufficient.) 
445
104
446
105
**Note**: The system trying to open the web page must support Avahi. Android systems may not, for example.
447
106
448
107
## Be patient, it takes minutes
449
108
450
109
Wifi-connect pauses for about a minute at daemon start to allow any external AP connections to complete.
451
110
452
111
## Disconnect from wifi
453
112
454
113
When connected to an external AP, the Operational portal is available on the device IP address (assigned by the external AP). Open it using IP:8080, enter the portal password, and you may then disconnect with the "Disconnect from Wifi" button.
455
114
456
115
You can also ssh to the device and:
457
116
458
117
 * Use `nmcli c` to display connections.
459
118
 * Use `nmcli c delete CONNECTION_NAME` to disconnect and delete. This puts the device into management mode, bringing up the AP and portal.
460
119
461
120
Disconnecting sets the device back in Management mode. Its AP is started and you can open the portal (as discussed above) to see external APs and connect to one.
462
121
463
diff --git a/docs/integrate.md b/docs/integrate.md
464
0
new file mode 100644
122
new file mode 100644
465
index 0000000..b1cdd4f
466
--- /dev/null
467
+++ b/docs/integrate.md
468
@@ -0,0 +1,70 @@
469
1
---
470
2
title: "Integrating into an image""
471
3
table_of_contents: True
472
4
---
473
5
474
6
# Overview
475
7
476
8
When you pre-install wifi-connect snap into an image, you can use the gadget snap's [gadget.yaml](https://forum.snapcraft.io/t/the-gadget-snap/696) file to pre-configure some options.
477
9
478
10
Here we explain the snap key and value needed to preconfigure.  Refer to the above like for details on how to set these in the gadget snap's gadget.yaml file. 
479
11
480
12
You may also set these at run time from terminal with:
481
13
482
14
```bash
483
15
$ snap set wifi-connect KEY=VALUE
484
16
```
485
17
486
18
To apply such run-time changes, see the Frequently asked questions page.
487
19
488
20
**Warning**: These changes may create security risks. Only use take these steps if you are completely aware of take responsitbility for the potential risk.
489
21
490
22
491
23
**Note** When the deamon starts, it logs any preconfigurations found and applied, for example:
492
24
493
25
```bash
494
26
Jun 20 22:07:16 thehost snap[18004]: == wifi-connect/SetDefaults portal password being set
495
27
Jun 20 22:07:16 thehost snap[18004]: == wifi-connect/SetDefaults: reset creds requirement is now disabled
496
28
```
497
29
498
30
## AP passphrase
499
31
500
32
Normally the wifi-conect AP's passphrase is randomly created by the wifi-ap snap. A normal part of the installation process is resetting this from the terminal. However, some integrators may want to preset the passphrase. 
501
33
502
34
Preset the passphrase with the following:
503
35
504
36
 * snapd key: wifi.security-passphrase
505
37
 * value: the passhrase (8-13 characters, must start with a letter)
506
38
507
39
## Portal password 
508
40
509
41
To access any wifi-connect web page you need to enter the portal password. A normal part of the installation process is setting this from the terminal. However, some integrators may want to preset the portal password.  
510
42
511
43
Preset the portal password  with the following:
512
44
513
45
 * snapd key: portal.password
514
46
 * value: the password (8-13 characters, must start with a letter)
515
47
516
48
## Disable credential resetting
517
49
518
50
Normally, the first user to access the Management portal is required to reset the wifi-connect AP passphrase and the portal password (used to access wifi-connect web pages). This is an important security feature, especially for integrators that preset these in their image because every image has the same passphrase and password. 
519
51
520
52
However, some integrators may want to disable this requirement. 
521
53
522
54
Disable the requirement to reset the AP passphrase and portal password on first use of the Management portal as follows:
523
55
 
524
56
 * snapd key: portal.no-reset-creds
525
57
 * value: true
526
58
527
59
## Disable display of the Operational Portal
528
60
529
61
The Operational portal is available when the device is connected to an external AP. It provides a button the user can click to disconnect. Display of this page can be disabled. This is a normal part of wifi-connect. When the page is disabled one must use the terminal (or some other means) to direct the device to disconnect form the external AP.
530
62
531
63
Disable the Operational portal as follows:
532
64
533
65
 * snapd key: portal.no-opertaional
534
66
 * value: true
535
67
536
68
537
69
538
70
539
diff --git a/docs/metadata.yaml b/docs/metadata.yaml
540
0
new file mode 100644
71
new file mode 100644
541
index 0000000..2fb6ea0
542
--- /dev/null
543
+++ b/docs/metadata.yaml
544
@@ -0,0 +1,12 @@
545
1
site_title: wifi-connect
546
2
site_logo_url: https://assets.ubuntu.com/v1/c5cb0f8e-picto-ubuntu.svg
547
3
navigation:
548
4
  - title: Introduction
549
5
    location: index.md
550
6
    children:
551
7
    - title: Installation
552
8
      location: installation.md
553
9
    - title: Integrating into an image
554
10
      location: integrate.md
555
11
    - title: Frequently asked questions
556
12
      location: faq.md
557
diff --git a/hooks/configure.go b/hooks/configure.go
558
0
new file mode 100644
13
new file mode 100644
559
index 0000000..601a93a
560
--- /dev/null
561
+++ b/hooks/configure.go
562
@@ -0,0 +1,111 @@
563
1
// -*- Mode: Go; indent-tabs-mode: t -*-
564
2
565
3
/*
566
4
 * Copyright (C) 2017 Canonical Ltd
567
5
 *
568
6
 * This program is free software: you can redistribute it and/or modify
569
7
 * it under the terms of the GNU General Public License version 3 as
570
8
 * published by the Free Software Foundation.
571
9
 *
572
10
 * This program is distributed in the hope that it will be useful,
573
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
574
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
575
13
 * GNU General Public License for more details.
576
14
 *
577
15
 * You should have received a copy of the GNU General Public License
578
16
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
579
17
 *
580
18
 */
581
19
582
20
package main
583
21
584
22
import (
585
23
	"encoding/json"
586
24
	"io/ioutil"
587
25
	"log"
588
26
	"os/exec"
589
27
	"strings"
590
28
591
29
	"launchpad.net/wifi-connect/daemon"
592
30
)
593
31
594
32
// Client is the base struct for runtime and testing
595
33
type Client struct {
596
34
	getter Getter
597
35
}
598
36
599
37
// Get is the test obj for overridding functions
600
38
type Get struct{}
601
39
602
40
// Getter interface is for overriding SnapGet for testing
603
41
type Getter interface {
604
42
	SnapGet(string) (string, error)
605
43
}
606
44
607
45
// GetClient returns a normal runtime client
608
46
func GetClient() *Client {
609
47
	return &Client{getter: &Get{}}
610
48
}
611
49
612
50
// ModClient returns a testing client
613
51
func ModClient(g Getter) *Client {
614
52
	return &Client{getter: g}
615
53
}
616
54
617
55
// SnapGet uses snapctrl to get a value from a key, or returns error
618
56
func (g *Get) SnapGet(key string) (string, error) {
619
57
	out, err := exec.Command("snapctl", "get", key).Output()
620
58
	if err != nil {
621
59
		return "", err
622
60
	}
623
61
	return strings.TrimSpace(string(out)), nil
624
62
625
63
}
626
64
627
65
// snapGetStr wraps SnapGet for string types and verifies the snap var is valid
628
66
func (c *Client) snapGetStr(key string, target *string) {
629
67
	val, err := c.getter.SnapGet(key)
630
68
	if err != nil {
631
69
		return
632
70
	}
633
71
	if len(val) == 0 {
634
72
		log.Printf("== wifi-connect/configure error: key %s exists but has zero length", key)
635
73
		return
636
74
	}
637
75
	*target = val
638
76
}
639
77
640
78
// snapGetBool wraps SnapGet for bool types and verifies the snap var is valid
641
79
func (c *Client) snapGetBool(key string, target *bool) {
642
80
	val, err := c.getter.SnapGet(key)
643
81
	if err != nil {
644
82
		return
645
83
	}
646
84
	if len(val) == 0 {
647
85
		log.Printf("== wifi-connect/configure error: key %s exists but has zero length", key)
648
86
		return
649
87
	}
650
88
651
89
	if val == "true" {
652
90
		*target = true
653
91
	} else {
654
92
		*target = false
655
93
	}
656
94
}
657
95
658
96
func main() {
659
97
	client := GetClient()
660
98
	preConfig := &daemon.PreConfig{}
661
99
	client.snapGetStr("wifi.security-passphrase", &preConfig.Passphrase)
662
100
	client.snapGetStr("portal.password", &preConfig.Password)
663
101
	client.snapGetBool("portal.no-operational", &preConfig.NoOperational)
664
102
	client.snapGetBool("portal.no-reset-creds", &preConfig.NoResetCreds)
665
103
666
104
	b, errJM := json.Marshal(preConfig)
667
105
	if errJM == nil {
668
106
		errWJ := ioutil.WriteFile(daemon.PreConfigFile, b, 0644)
669
107
		if errWJ != nil {
670
108
			log.Print("== wifi-connect/configure error:", errWJ)
671
109
		}
672
110
	}
673
111
}
674
diff --git a/hooks/configure_test.go b/hooks/configure_test.go
675
0
new file mode 100644
112
new file mode 100644
676
index 0000000..8aebd68
677
--- /dev/null
678
+++ b/hooks/configure_test.go
679
@@ -0,0 +1,110 @@
680
1
// -*- Mode: Go; indent-tabs-mode: t -*-
681
2
682
3
/*
683
4
 * Copyright (C) 2017 Canonical Ltd
684
5
 *
685
6
 * This program is free software: you can redistribute it and/or modify
686
7
 * it under the terms of the GNU General Public License version 3 as
687
8
 * published by the Free Software Foundation.
688
9
 *
689
10
 * This program is distributed in the hope that it will be useful,
690
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
691
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
692
13
 * GNU General Public License for more details.
693
14
 *
694
15
 * You should have received a copy of the GNU General Public License
695
16
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
696
17
 *
697
18
 */
698
19
699
20
package main
700
21
701
22
import (
702
23
	"fmt"
703
24
	"testing"
704
25
)
705
26
706
27
type mock0 struct{}
707
28
708
29
func (mock *mock0) SnapGet(s string) (string, error) {
709
30
	return "snapgetreturn", nil
710
31
}
711
32
712
33
type Config struct {
713
34
	AString string
714
35
	ABool   bool
715
36
}
716
37
717
38
func TestSnapGetStr0(t *testing.T) {
718
39
	c := ModClient(&mock0{})
719
40
	config := &Config{}
720
41
	config.AString = "defaultstring"
721
42
	c.snapGetStr("key", &config.AString)
722
43
	if config.AString != "snapgetreturn" {
723
44
		t.Errorf("snapGetStr expected snapgetreturn but got %s", config.AString)
724
45
	}
725
46
}
726
47
727
48
type mock1 struct{}
728
49
729
50
func (mock *mock1) SnapGet(s string) (string, error) {
730
51
	return "", fmt.Errorf("intentional error 1")
731
52
}
732
53
733
54
func TestSnapGetStr1(t *testing.T) {
734
55
	c := ModClient(&mock1{})
735
56
	config := &Config{}
736
57
	config.AString = "defaultstring"
737
58
	c.snapGetStr("key", &config.AString)
738
59
	if config.AString != "defaultstring" {
739
60
		t.Errorf("snapGetStr expected defaultstring but got %s", config.AString)
740
61
	}
741
62
}
742
63
743
64
type mock2 struct{}
744
65
745
66
func (mock *mock2) SnapGet(s string) (string, error) {
746
67
	return "true", nil
747
68
}
748
69
749
70
func TestSnapGetBool0(t *testing.T) {
750
71
	c := ModClient(&mock2{})
751
72
	config := &Config{}
752
73
	config.ABool = false
753
74
	c.snapGetBool("key", &config.ABool)
754
75
	if !config.ABool {
755
76
		t.Errorf("snapGetBool should be true but is %t", config.ABool)
756
77
	}
757
78
}
758
79
759
80
type mock3 struct{}
760
81
761
82
func (mock *mock3) SnapGet(s string) (string, error) {
762
83
	return "false", nil
763
84
}
764
85
765
86
func TestSnapGetBool1(t *testing.T) {
766
87
	c := ModClient(&mock3{})
767
88
	config := &Config{}
768
89
	config.ABool = true
769
90
	c.snapGetBool("key", &config.ABool)
770
91
	if config.ABool {
771
92
		t.Errorf("snapGetBool should be false but is %t", config.ABool)
772
93
	}
773
94
}
774
95
775
96
type mock4 struct{}
776
97
777
98
func (mock *mock4) SnapGet(s string) (string, error) {
778
99
	return "", nil
779
100
}
780
101
781
102
func TestSnapGetBool2(t *testing.T) {
782
103
	c := ModClient(&mock4{})
783
104
	config := &Config{}
784
105
	config.ABool = true
785
106
	c.snapGetBool("key", &config.ABool)
786
107
	if !config.ABool {
787
108
		t.Errorf("snapGetBool should be true but is %t", config.ABool)
788
109
	}
789
110
}
790
diff --git a/service/service.go b/service/service.go
791
index ec39f5f..c988f55 100644
792
--- a/service/service.go
793
+++ b/service/service.go
794
@@ -29,16 +29,22 @@ import (
795
29
)
29
)
796
30
30
797
31
func main() {
31
func main() {
799
32
32
	c := netman.DefaultClient()
800
33
	cw := wifiap.DefaultClient()
801
33
	client := daemon.GetClient()
34
	client := daemon.GetClient()
803
34
	client.SetDefaults()
35
804
36
	config, err := daemon.LoadPreConfig()
805
37
	if err != nil {
806
38
		fmt.Println("== wifi-connect/daemon: preconfiguration error:", err)
807
39
	}
808
40
	err = client.SetDefaults(cw, config)
809
41
	if err != nil {
810
42
		fmt.Println("== wifi-connect/daemon: SetDetaults error:", err)
811
43
	}
812
35
	first := true
44
	first := true
813
36
	client.SetWaitFlagPath(os.Getenv("SNAP_COMMON") + "/startingApConnect")
45
	client.SetWaitFlagPath(os.Getenv("SNAP_COMMON") + "/startingApConnect")
814
37
	client.SetManualFlagPath(os.Getenv("SNAP_COMMON") + "/manualMode")
46
	client.SetManualFlagPath(os.Getenv("SNAP_COMMON") + "/manualMode")
815
38
47
816
39
	c := netman.DefaultClient()
817
40
	cw := wifiap.DefaultClient()
818
41
819
42
	client.ManagementServerDown()
48
	client.ManagementServerDown()
820
43
	client.OperationalServerDown()
49
	client.OperationalServerDown()
821
44
50
822
@@ -95,7 +101,9 @@ func main() {
823
95
			if client.GetPreviousState() == daemon.MANAGING {
101
			if client.GetPreviousState() == daemon.MANAGING {
824
96
				client.ManagementServerDown()
102
				client.ManagementServerDown()
825
97
			}
103
			}
827
98
			client.OperationalServerUp()
104
			if !config.NoOperational {
828
105
				client.OperationalServerUp()
829
106
			}
830
99
			continue
107
			continue
831
100
		}
108
		}
832
101
109
833
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
834
index 8bd7f04..c5fb86e 100644
835
--- a/snap/snapcraft.yaml
836
+++ b/snap/snapcraft.yaml
837
@@ -1,8 +1,8 @@
838
1
name: wifi-connect 
1
name: wifi-connect 
840
2
version: 0.10-1
2
version: 0.10-2-dev
841
3
summary: Connect your device to external wifi over temp wifi AP
3
summary: Connect your device to external wifi over temp wifi AP
842
4
description: |
4
description: |
844
5
  A solution to enable your device to connect to ian external
5
  A solution to enable your device to connect to an external
845
6
  wifi AP using a temporary wifi AP the device puts up and then
6
  wifi AP using a temporary wifi AP the device puts up and then
846
7
  opening its web portal. Note that wifi-connect daemon assumes
7
  opening its web portal. Note that wifi-connect daemon assumes
847
8
  control of device network management and other management solutions
8
  control of device network management and other management solutions
848
@@ -21,6 +21,10 @@ apps:
849
21
    daemon: simple
21
    daemon: simple
850
22
    plugs: [network-manager, control, network-bind]
22
    plugs: [network-manager, control, network-bind]
851
23
23
852
24
hooks:
853
25
   configure:
854
26
     plugs: [network]
855
27
 
856
24
plugs:
28
plugs:
857
25
  control:
29
  control:
858
26
    interface: content
30
    interface: content
859
@@ -46,9 +50,10 @@ parts:
860
46
      export GOPATH=$PWD/../go
50
      export GOPATH=$PWD/../go
861
47
      cd $GOPATH/src/launchpad.net/wifi-connect
51
      cd $GOPATH/src/launchpad.net/wifi-connect
862
48
      ./run-checks all
52
      ./run-checks all
863
53
      mkdir -p $SNAPCRAFT_PART_INSTALL/snap/hooks
864
54
      mv $SNAPCRAFT_PART_INSTALL/bin/hooks $SNAPCRAFT_PART_INSTALL/snap/hooks/configure
865
49
  assets:
55
  assets:
866
50
    plugin: dump
56
    plugin: dump
867
51
    source: .
57
    source: .
868
52
    stage:
58
    stage:
869
53
      - static
59
      - static
870
54
871
diff --git a/static/tests/pre-config0.json b/static/tests/pre-config0.json
872
55
new file mode 100644
60
new file mode 100644
873
index 0000000..ad904cd
874
--- /dev/null
875
+++ b/static/tests/pre-config0.json
876
@@ -0,0 +1,7 @@
877
1
{
878
2
    "wifi.security-passphrase": "abcdefghijklmnop",
879
3
    "portal.password": "qwerzxcv",
880
4
    "portal.no-operational": true,
881
5
    "portal.no-reset-creds": true
882
6
}
883
7
884
diff --git a/static/tests/pre-config1.json b/static/tests/pre-config1.json
885
0
new file mode 100644
8
new file mode 100644
886
index 0000000..f28c4ae
887
--- /dev/null
888
+++ b/static/tests/pre-config1.json
889
@@ -0,0 +1,5 @@
890
1
{
891
2
    "portal.no-operational": false,
892
3
    "portal.no-reset-creds": false
893
4
}
894
5
895
diff --git a/wifiap/wifiap.go b/wifiap/wifiap.go
896
index b609a55..faf0c15 100644
897
--- a/wifiap/wifiap.go
898
+++ b/wifiap/wifiap.go
899
@@ -25,6 +25,11 @@ import (
900
25
	"time"
25
	"time"
901
26
)
26
)
902
27
27
903
28
const (
904
29
	minPassphraseLen int = 8
905
30
	maxPassphraseLen int = 63
906
31
)
907
32
908
28
// Client struct exposing wifi-ap operations
33
// Client struct exposing wifi-ap operations
909
29
type Client struct {
34
type Client struct {
910
30
	restClient *RestClient
35
	restClient *RestClient
911
@@ -40,6 +45,16 @@ func DefaultClient() *Client {
912
40
	return &Client{restClient: defaultRestClient()}
45
	return &Client{restClient: defaultRestClient()}
913
41
}
46
}
914
42
47
915
48
// Operations interface enables mock testing
916
49
type Operations interface {
917
50
	Show() (map[string]interface{}, error)
918
51
	Enabled() (bool, error)
919
52
	Enable() error
920
53
	Disable() error
921
54
	SetSsid(string) error
922
55
	SetPassphrase(string) error
923
56
}
924
57
925
43
func defaultServiceURI() string {
58
func defaultServiceURI() string {
926
44
	return fmt.Sprintf("http://unix%s", filepath.Join(versionURI, configurationURI))
59
	return fmt.Sprintf("http://unix%s", filepath.Join(versionURI, configurationURI))
927
45
}
60
}
928
@@ -163,8 +178,11 @@ func (client *Client) SetSsid(ssid string) error {
929
163
178
930
164
// SetPassphrase sets the credential to access the wifi ap
179
// SetPassphrase sets the credential to access the wifi ap
931
165
func (client *Client) SetPassphrase(passphrase string) error {
180
func (client *Client) SetPassphrase(passphrase string) error {
934
166
	if len(passphrase) < 13 {
181
	if len(passphrase) < minPassphraseLen {
935
167
		return fmt.Errorf("Passphrase must be at least 13 chars in length. Please try again")
182
		return fmt.Errorf("Passphrase must be at least 8 chars in length. Please try again")
936
183
	}
937
184
	if len(passphrase) > maxPassphraseLen {
938
185
		return fmt.Errorf("Passphrase must be less than 64 long. Please try again")
939
168
	}
186
	}
940
169
187
941
170
	params := map[string]string{
188
	params := map[string]string{
Status:	Merged
Approved by:	Roberto Mier Escandon on 2017-06-29
Approved revision:	174a30c8d126a5c65dd79770c04e9561a52b0c16
Merged at revision:	d8fe23b5e46dd61a32c597d146aa434feb2958cd
Proposed branch:	~knitzsche/snappy-hwe-snaps/+git/wifi-connect:defaults
Merge into:	~snappy-hwe-team/snappy-hwe-snaps/+git/wifi-connect:master
Diff against target:	941 lines (+700/-38) 15 files modified README.md (+1/-1) daemon/daemon.go (+66/-6) daemon/daemon_test.go (+121/-20) docs/faq.md (+10/-0) docs/index.md (+24/-0) docs/installation.md (+121/-0) docs/integrate.md (+70/-0) docs/metadata.yaml (+12/-0) hooks/configure.go (+111/-0) hooks/configure_test.go (+110/-0) service/service.go (+14/-6) snap/snapcraft.yaml (+8/-3) static/tests/pre-config0.json (+7/-0) static/tests/pre-config1.json (+5/-0) wifiap/wifiap.go (+20/-2)
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Roberto Mier Escandon (community)			Approve on 2017-06-29
Konrad Zapałowicz (community)	code		Approve on 2017-06-28
System Enablement Bot	continuous-integration	2017-06-22	Approve on 2017-06-28
Review via email: mp+326172@code.launchpad.net