Merge lp:~kyrofa/go-trust-store/add_request_parameters into lp:go-trust-store

[Kyle Fazzari]

Add RequestParameters type and shim, for trust prompting.

Add RequestParameters type and shim, for trust prompting.

[lp:~kyrofa/go-trust-store/add_request_parameters]

4. By Kyle Fazzari on 2015-10-01

Add RequestParameters type and shim, for trust prompting.

Signed-off-by: Kyle Fazzari <email address hidden>

[dobey (dobey)]

review: Approve

=== added file 'trust/request_parameters.go'
--- trust/request_parameters.go	1970-01-01 00:00:00 +0000
+++ trust/request_parameters.go	2015-10-01 18:48:45 +0000
@@ -0,0 +1,80 @@
+/* Copyright (C) 2015 Canonical Ltd.
+ *
+ * This file is part of go-trust-store.
+ *
+ * go-trust-store is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3, as
+ * published by the Free Software Foundation.
+ *
+ * go-trust-store is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with go-trust-store. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Kyle Fazzari <[e-mail]>
+ */
+
+package trust
+
+// #include <stdlib.h>
+// #include "request_parameters_shim.h"
+import "C"
+
+import (
+	"runtime"
+	"unsafe"
+)
+
+// Application represents an application that is requesting access to a feature
+// via the trust store.
+type Application struct {
+	Uid int    // The user under which the application is running
+	Pid int    // The PID of the application
+	Id  string // The appid of the application
+}
+
+// RequestParameters contains the information necessary to prompt the user
+// for permission via the trust store.
+type RequestParameters struct {
+	Application Application // The application requesting access
+	Feature     Feature     // The feature the application wants to access
+	Description string      // The description to use for prompting the user
+}
+
+// FromShim converts from shim request parameters to RequestParameters.
+func (parameters *RequestParameters) FromShim(shimPointer unsafe.Pointer) {
+	shim := (*C.RequestParameters)(shimPointer)
+
+	parameters.Application.Uid = int(shim.application.uid)
+	parameters.Application.Pid = int(shim.application.pid)
+	parameters.Application.Id = C.GoString(shim.application.id)
+
+	parameters.Feature = Feature(shim.feature)
+	parameters.Description = C.GoString(shim.description)
+}
+
+// ToShim converts RequestParameters to shim request parameters.
+func (parameters RequestParameters) ToShim() unsafe.Pointer {
+	shim := new(C.RequestParameters)
+
+	shim.application.uid = C.int(parameters.Application.Uid)
+	shim.application.pid = C.int(parameters.Application.Pid)
+	shim.application.id = C.CString(parameters.Application.Id)
+
+	shim.feature = C.uint64_t(parameters.Feature)
+	shim.description = C.CString(parameters.Description)
+
+	runtime.SetFinalizer(shim, destroyRequestParametersShim)
+
+	return unsafe.Pointer(shim)
+}
+
+// destroyRequestParametersShim frees the resources of shim request
+// parameters.
+func destroyRequestParametersShim(shim *C.RequestParameters) {
+	C.free(unsafe.Pointer(shim.application.id))
+	C.free(unsafe.Pointer(shim.description))
+}

=== added file 'trust/request_parameters_shim.h'
--- trust/request_parameters_shim.h	1970-01-01 00:00:00 +0000
+++ trust/request_parameters_shim.h	2015-10-01 18:48:45 +0000
@@ -0,0 +1,51 @@
+/* Copyright (C) 2015 Canonical Ltd.
+ *
+ * This file is part of go-trust-store.
+ *
+ * go-trust-store is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3, as
+ * published by the Free Software Foundation.
+ *
+ * go-trust-store is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with go-trust-store. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Kyle Fazzari <[e-mail]>
+ */
+
+#ifndef GO_TRUST_STORE_REQUEST_PARAMETERS_SHIM_H
+#define GO_TRUST_STORE_REQUEST_PARAMETERS_SHIM_H
+
+#include <inttypes.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Represents an application that is requesting access to a feature via the
+// trust store.
+typedef struct
+{
+	int uid;
+	int pid;
+	char *id;
+} Application;
+
+// Contains the information necessary to prompt the user for permission via the
+// trust store.
+typedef struct
+{
+	Application application;
+	uint64_t feature;
+	char *description;
+} RequestParameters;
+
+#ifdef __cplusplus
+} // extern "C"
+#endif
+
+#endif // GO_TRUST_STORE_REQUEST_PARAMETERS_SHIM_H

=== added file 'trust/request_parameters_test.go'
--- trust/request_parameters_test.go	1970-01-01 00:00:00 +0000
+++ trust/request_parameters_test.go	2015-10-01 18:48:45 +0000
@@ -0,0 +1,32 @@
+/* Copyright (C) 2015 Canonical Ltd.
+ *
+ * This file is part of go-trust-store.
+ *
+ * go-trust-store is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3, as
+ * published by the Free Software Foundation.
+ *
+ * go-trust-store is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with go-trust-store. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Kyle Fazzari <[e-mail]>
+ */
+
+package trust
+
+import (
+	"testing"
+)
+
+func TestRequestParameters_FromShim(t *testing.T) {
+	testRequestParameters_FromShim(t)
+}
+
+func TestRequestParameters_ToShim(t *testing.T) {
+	testRequestParameters_ToShim(t)
+}

=== added file 'trust/test_request_parameters.go'
--- trust/test_request_parameters.go	1970-01-01 00:00:00 +0000
+++ trust/test_request_parameters.go	2015-10-01 18:48:45 +0000
@@ -0,0 +1,126 @@
+/* Copyright (C) 2015 Canonical Ltd.
+ *
+ * This file is part of go-trust-store.
+ *
+ * go-trust-store is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3, as
+ * published by the Free Software Foundation.
+ *
+ * go-trust-store is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with go-trust-store. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Kyle Fazzari <[e-mail]>
+ */
+
+// Since cgo cannot be used within Go test files, this file holds the actual
+// tests and the corresponding test file calls them (i.e. the tests contained
+// within this file are not run directly, but are called from other tests).
+package trust
+
+// #include <stdlib.h>
+// #include "request_parameters_shim.h"
+import "C"
+
+import (
+	"testing"
+	"unsafe"
+)
+
+// Test typical ToShim usage.
+func testRequestParameters_ToShim(t *testing.T) {
+	// First, create a trust.RequestParameters with known values
+	parameters := RequestParameters{
+		Application: Application{
+			Uid: 1,
+			Pid: 2,
+			Id:  "foo",
+		},
+		Feature:     3,
+		Description: "bar",
+	}
+
+	// Now convert it to a shim instance
+	shim := (*C.RequestParameters)(parameters.ToShim())
+	if shim == nil {
+		t.Fatal("Shim was unexpectedly nil")
+	}
+
+	id := C.GoString(shim.application.id)
+	description := C.GoString(shim.description)
+
+	// Verify that the values are still the known values
+	if shim.application.uid != 1 {
+		t.Errorf("Application Uid was %d, expected 1",
+			shim.application.uid)
+	}
+
+	if shim.application.pid != 2 {
+		t.Errorf("Application Uid was %d, expected 2",
+			shim.application.pid)
+	}
+
+	if id != "foo" {
+		t.Errorf(`Application Id was "%s", expected "foo"`, id)
+	}
+
+	if shim.feature != 3 {
+		t.Errorf("Feature was %d, expected 3",
+			shim.feature)
+	}
+
+	if description != "bar" {
+		t.Errorf(`Description was "%s", expected "bar"`, description)
+	}
+}
+
+// Test typical FromShim usage.
+func testRequestParameters_FromShim(t *testing.T) {
+	fooCstring := C.CString("foo")
+	defer C.free(unsafe.Pointer(fooCstring))
+
+	barCstring := C.CString("bar")
+	defer C.free(unsafe.Pointer(barCstring))
+
+	// First, create shim with known values
+	shim := new(C.RequestParameters)
+	shim.application.uid = 1
+	shim.application.pid = 2
+	shim.application.id = fooCstring
+	shim.feature = 3
+	shim.description = barCstring
+
+	// Now convert it to a trust.RequestParameters instance
+	var parameters RequestParameters
+	parameters.FromShim(unsafe.Pointer(shim))
+
+	// Verify that the values are still the known values
+	if parameters.Application.Uid != 1 {
+		t.Errorf("Application Uid was %d, expected 1",
+			parameters.Application.Uid)
+	}
+
+	if parameters.Application.Pid != 2 {
+		t.Errorf("Application Pid was %d, expected 2",
+			parameters.Application.Pid)
+	}
+
+	if parameters.Application.Id != "foo" {
+		t.Errorf(`Application Id was "%s", expected "foo"`,
+			parameters.Application.Id)
+	}
+
+	if parameters.Feature != 3 {
+		t.Errorf("Feature was %d, expected 3",
+			parameters.Feature)
+	}
+
+	if parameters.Description != "bar" {
+		t.Errorf(`Description was "%s", expected "bar"`,
+			parameters.Description)
+	}
+}