webconf service for the initial configuration of a device #143

dbarth · 2017-01-30T17:28:10Z

Webconf provides a web UI for creating an initial administrative user on a device, similar to console-conf.

This initial implementation provides only the "create-user" part. Network configuration will come next.

A few words on the general architecture.

Webconf is implemented as a separate service, distinct from snapweb. Webconf runs only to turn an un-managed / embryonic device into a managed one. Once done, webconf is of no use on the device. At least, not until the device gets reset to its factory defaults.

Webconf is separated as a second safety measure over snapd's own guarantees against attempts at creating other admin users. In effect, snapd is protected by console access, whereas Snapweb only has the access token for it. Further, webconf is not protected by a token, and has to be available without preliminary console access, as its role is to open up console access for legit users. Hence the need to separate webconf and snapweb in distinct services.

Once webconf is done with the initial user creation, it stops and frees the HTTP socket for use by Snapweb. The handover is done by way of unix signals. Safety checks are placed at the start of both the webconf and snapweb services to ensure they won't run in the wrong context.

The UI for webconf, and its minimal daemon are implemented by re-using and re-packaging code from snapweb, since they both live in the same project space. Some further separation could be done at some point, in particular on the Web UI which is probably too complex for what it does. But i tried to stop when that was not helping anymore with the security of the implementation.

This branch also contains an initial set of spread tests verifying that webconf only runs on unmanaged devices. The tests also verify that snapweb doesn't start on an unmanaged device, and verify the transition between the 2 states.

AlexandreAbreu

As a general comment it would be nice to have some sort of a finer grained split of the common bits between plain snapweb & webconf to avoid all that dup

AlexandreAbreu · 2017-01-30T21:11:25Z

cmd/snapweb/state.go

@@ -0,0 +1,38 @@
+/*
+ * Copyright (C) 2014-2016 Canonical Ltd


AlexandreAbreu · 2017-01-30T21:11:59Z

cmd/snapweb/state.go

+
+	sysInfo, err := client.SysInfo()
+	if err != nil {
+		panic(err)


panic or return false? I would go for the latter, the failure logic being the responsibility of the caller

return false is better, indeed

AlexandreAbreu · 2017-01-30T22:39:27Z

cmd/web-conf/main.go

@@ -0,0 +1,182 @@
+/*
+ * Copyright (C) 2014-2017 Canonical Ltd


AlexandreAbreu · 2017-01-30T22:39:46Z

cmd/web-conf/main.go

+
+const (
+	httpAddr  string = ":4200"
+	// httpsAddr string = ":4201"


AlexandreAbreu · 2017-01-30T22:40:19Z

cmd/web-conf/main.go

+}
+
+// IsDeviceManaged determines if the device is in the 'managed' state
+func IsDeviceManaged() bool {


why the duplication?

AlexandreAbreu · 2017-01-30T22:40:49Z

cmd/web-conf/main.go

+			Transport: &http.Transport{Dial: unixDialer(socketPath)},
+		}
+
+		log.Println(r.Method, r.URL.Path)


remove debug

AlexandreAbreu · 2017-01-30T22:43:54Z

run-spread-tests.sh

+	echo "INFO: Creating new qemu test image(2) ..."
+	(cd spread/image ; sudo ./create-image-embryonic.sh $channel)
+	mkdir -p $SPREAD_QEMU_PATH
+	mv -f spread/image/ubuntu-core-16-embryonic.img $SPREAD_QEMU_PATH/$image_name2


$image_name2 instead of ubuntu-core-16-embryonic.img

AlexandreAbreu · 2017-01-30T22:44:31Z

spread/image/create-image-embryonic.sh

@@ -0,0 +1,132 @@
+#!/bin/bash
+#
+# Copyright (C) 2016 Canonical Ltd


AlexandreAbreu · 2017-02-02T15:49:25Z

www/src/js/models/create-user.js

@@ -5,7 +5,7 @@ var Marionette = require('backbone.marionette');
 var CONFIG = require('../config.js');

 module.exports = Backbone.Model.extend({
-  url: CONFIG.CREATE_USER,
+  url: '/api/v2/create-user',


why the change?

chipaca · 2017-02-21T16:02:41Z

cmd/webconf/main.go

+
+func initURLHandlers(log *log.Logger, server net.Listener) {
+	// API
+	http.Handle("/api/", snappy.MakePassthroughHandler(dirs.SnapdSocket, "/api/"))


This makes all of snapd available on the network.

No.

right, totally : we only need /api/v2/create-user, as used in www/src/js/models/create-user.js

chipaca · 2017-02-21T16:10:18Z

snappy/helpers.go

+		<-sigchan
+		waiter.Done()
+	}()
+	waiter.Wait()


this seems awfully contrived. You don't need the WaitGroup nor the goroutine at all; the whole function could just as well be

sigchan := make(chan os.Signal, 1) signal.Notify(sigchan, syscall.SIGHUP) <-sigchan

or am I missing something?

uh, well thanks: my go-fu will get better as a result

sorry if I was harsh in the review; I meant it all kindly

oh no, no worries really ;)

chipaca · 2017-02-21T16:17:55Z

snappy/helpers.go

+}
+
+// MakePassthroughHandler maps a snapd API to a snapweb HTTP handler
+func MakePassthroughHandler(socketPath string, prefix string) http.HandlerFunc {


this looks like a terrible idea. Could you explain what you're trying to achieve?

This is a general mechanism used in snapweb, and re-used as such in webconf, to map an HTTP call to the equivalent snapd API call. Instead of having a dedicated handler for each API in snapweb, and then linking the snapd client code to generate the unix call, Michael proposed to use this passthru, and minimize code duplication.
Note that In snapweb, this is only accessible if the access control token is sent along with the request.

chipaca · 2017-02-21T16:28:51Z

spread/webconf/transition-to-snapweb/task.yaml

+    sleep 2
+
+    echo "Verifying that snapweb now serves on port 4200"
+    printf "GET / HTTP/1.1\nHost:localhost\nUser-Agent:nc\n\n" | nc localhost 4201


chipaca · 2017-02-21T16:29:04Z

spread/webconf/transition-to-snapweb/task.yaml

+    printf "GET / HTTP/1.1\nHost:localhost\nUser-Agent:nc\n\n" | nc localhost 4201
+
+    # echo "The system should be managed now"
+    # test `snap managed` = 'false'


chipaca · 2017-02-21T16:30:10Z

spread/webconf/webconf-runs/task.yaml

+    test `snap managed` = 'false'
+
+    echo "Verifying that webconf is running"
+    test `ps ax | grep -- -linux-gnu/webconf | grep -v grep | wc -l` -eq 1


I'd have to test, but I'd imagine ps h -C webconf would work instead of ps | grep | grep

dbarth · 2017-03-02T20:37:04Z

I think I addressed all comments. I have refactored the code a bit more to improve the test coverage.

…em is already managed

…fault

…fc script

AlexandreAbreu reviewed Feb 2, 2017

View reviewed changes

dbarth requested a review from chipaca February 20, 2017 15:42

chipaca reviewed Feb 21, 2017

View reviewed changes

David Barth added 26 commits March 21, 2017 19:14

spread test infrastructure, and initial installation test

16b5c0c

check if the system is managed

8e763cb

simplify

7a5b68a

optimize spread test suite

d466cea

use 1G image; this should be sufficient

f7576b9

2G it is

41a5ded

add support for new firstboot test suite

e042012

compat with kvm

c72de1b

create 2nd image properly

124a536

ok, 4G per image then

5de0330

restore-each for the firstboot test suite

0828110

initial firstboot code

1701016

initial implementation of a separate service for firstboot

9fd16dc

start firstboot as a normal service; just exit gracefully if the syst…

736e9d1

…em is already managed

serve a specific JS code for firstboot

ff26e7c

rename to web-conf, same as console-conf

967522b

simplify templates; let w-c run on managed for now

4fc8bd7

initial view

0bddf2c

re-establish the create-user feature in the new webconf module

164dcbe

lock down web-conf again; update spread tests

b3e7c5b

add missing wrapper for starting webconf; adjust command names

61a8590

don't panic, just wait for a signal from webconf

a6518a4

gofmt

d8d6f01

webconf now signals snapweb when it is done

202e1fd

send signal to snapweb, send /done url; build webconf with gulp by de…

b9f8bfb

…fault

stop webconf and let snapweb resume

7ec6d53

David Barth added 29 commits March 21, 2017 19:15

verify the transition from webconf to snapweb

4341aae

rename leftover bits to webconf, no dash

f8f9644

simplify run-checks by offloading all the npm setup to a travis-speci…

dbfbdc2

…fc script

do the same for godeps

755c640

refactor common functions into a helper module; add tests for it

e6c31c8

refactor code shared between webconf and snapweb; add more tests

ea4b776

gofmt

31820d5

init.js has been renamed

3c38c44

update js unit test suite

58b06b1

fix spread test use of a variable

c6ccf0b

fix copyright date

90e5d7c

fix copyright date

9a5063b

gofmt again

0234f25

adjust kvm utils

c0af22c

improve spread tests

11f528c

only expose the create-user API

ddcdcee

rebase with master; improve function name for creating a cert if needed

47b236e

improve unit tests; address review remarks

f8e7d65

gofmt/lint et al

1e22c95

gulp and build.sh support for optional webconf build option

635e5b5

adjust packages and tests after master rebase

0ae6319

ensure systemd won't try to restart the webconf service

ea4e8de

adjust spread tests

947266d

move the default filter handler to the shared snappy package

4cb3664

add support for the new netfilter; accept local networks by default

6b41e6f

gofmt

f077af8

verify that webconf is protected by the netfilter feature

a54570d

add spread test to verify if the netfilter feature protects snapweb

9d69fe6

add a timer to de-activate webconf after 2 minutes

6d7d2c5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

webconf service for the initial configuration of a device #143

webconf service for the initial configuration of a device #143

dbarth commented Jan 30, 2017 •

edited

Loading

AlexandreAbreu left a comment

AlexandreAbreu Jan 30, 2017

AlexandreAbreu Jan 30, 2017

dbarth Feb 16, 2017

AlexandreAbreu Jan 30, 2017

AlexandreAbreu Jan 30, 2017

AlexandreAbreu Jan 30, 2017

AlexandreAbreu Jan 30, 2017

AlexandreAbreu Jan 30, 2017

AlexandreAbreu Jan 30, 2017

AlexandreAbreu Feb 2, 2017

chipaca Feb 21, 2017

dbarth Feb 21, 2017

chipaca Feb 21, 2017

chipaca Feb 21, 2017

dbarth Feb 21, 2017

chipaca Feb 21, 2017

dbarth Feb 21, 2017

chipaca Feb 21, 2017

dbarth Feb 21, 2017

chipaca Feb 21, 2017

chipaca Feb 21, 2017

chipaca Feb 21, 2017

dbarth commented Mar 2, 2017

webconf service for the initial configuration of a device #143

Are you sure you want to change the base?

webconf service for the initial configuration of a device #143

Conversation

dbarth commented Jan 30, 2017 • edited Loading

AlexandreAbreu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbarth commented Mar 2, 2017

dbarth commented Jan 30, 2017 •

edited

Loading