Version 0.2 #232

cdecker · 2023-08-15T16:17:03Z

This is the preparatory branch for the next version of the client bindings. Adding it as a PR to make it more visible here.

nepet · 2023-09-14T11:04:11Z

Rebased

nepet · 2023-09-30T11:11:43Z

Rebased

cdecker · 2023-11-23T17:15:23Z

I just pushed all crates and the python package, so we should soon be able to merge this, hopefully without breaking any users due to API changes.

nepet · 2023-11-26T13:24:50Z

Rebased

cdecker · 2024-01-08T10:53:43Z

Rebased on top of main, prepping all things for the switch to the
new API with the AuthBlob.

nepet · 2024-02-07T14:32:10Z

A commit I added on top of this PR that changed the version numbers from 0.1.x to 0.2.0 resulted in a CI failure withcargo dist plan so I removed it again.

While we could also add this later, it would still be nice to have a version update commit in here that we can point the backend to.

cdecker · 2024-02-23T14:10:21Z

libs/gl-client-py/glclient/__init__.py

@@ -88,13 +89,13 @@ def export_node(self) -> schedpb.ExportNodeResponse:
        res = schedpb.ExportNodeResponse
        return res.FromString(bytes(self.inner.export_node()))

-    def node(self) -> "Node":
+    def node(self, creds: Credentials) -> "Node":


We probably want to have Scheduler have a copy of the Credentials, since we will eventually enforce that only an authenticated client can schedule. That would mean that the schedule() call also needs the Credentials, and we could just inherit from Scheduler to Node when creating the Node here.

Let's talk about this during our meeting.

nepet · 2024-02-23T16:30:58Z

Added credentials and upgradecreds command to the command line tool.

Adds a master rune and a credentials byte array to the proto messages for `register` and `response`. Sets dummy values for this values in the scheduler. This dummy values will be replaced by something meaningful in a future commit. Signed-off-by: Peter Neuroth <[email protected]>

Clippy was complaning about: - an unnecessary `return` keyword - a self conversion. Signed-off-by: Peter Neuroth <[email protected]>

This streamlines the rust and the python api. The python api uses method called `node` to schedule and return a node from the `Scheduler` class. BREAKING CHANGES: The `schedule` method (rs) does not return a node anymore but does insted return the schedule response. A new method `node` is introduced that returns a node instead. Signed-off-by: Peter Neuroth <[email protected]>

Adds `Credentials` that store the necessary information for authentication and authorization. There are two types of credentials: unauthenticated (also known as 'nobody') and device-specific. The device-specific credentials can be encoded to be stored on the device. The encoding allows for future extensions. Credentials offer flexible ways to be created and restored. BREAKING CHANGES: - Credentials replace the TlsConfig on the `Node`, - `Scheduler`(rs and py) method `node` got a `Credentials` parameter. Signed-off-by: Peter Neuroth <[email protected]>

Signed-off-by: Peter Neuroth <[email protected]>

We need to pass a rune down to the signer for propper authorization in our e2e security schema. Signed-off-by: Peter Neuroth <[email protected]>

Introduces runes to the greenlight client. Adds a `create_rune` method to the signer and adds the rune to the registration and recovery responses. Signed-off-by: Peter Neuroth <[email protected]>

Adds the rune to the credentials. This way all the node client can extract the rune from the credentials for future use. Signed-off-by: Peter Neuroth <[email protected]>

Add the rune to the request context. The signer extracts the rune from the PendingRequest and checks the validity as well as the restrictions. Signed-off-by: Peter Neuroth <[email protected]>

Signed-off-by: Peter Neuroth <[email protected]>

cdecker

Excellent changes, I just bikeshedded the Scheduler and TlsConfig builder API a bit, but will merge this now, and we can iterate or leave things are as they are.

cdecker · 2024-03-06T16:44:09Z

libs/gl-client-py/tests/test_creds.py

+from glclient import Scheduler, Credentials, TlsConfig
+
+CRED_RUNE = bytes(
+    '"\xec\x01q3gAOP3JVkuen3qOh2G3LMU9TbHpXQS2VXfecJmlZY89MC1nbDAmcHVia2V5PTA0OGI0ZWZhNDZkNTZmMmUxM2RmOTdjOGFmNzJiZjYzZWEwNDgzODFlMTdkMTRhOGVkMThlNDVhMzFkNDIzMmNlMzE3OWE4NjE2ZTU2ODUxOTc5MjcxOTZlMTI2YjU0YjhhMmU5NzAwNWJiNzY2YTYzM2M1ODc0M2RjMGU3ZDZhZGY=',


I got a bit sidetracked by those 2 leading hex-escaped bytes. Why not use base64-encoding here as well?

cdecker · 2024-03-06T16:55:37Z

docs/src/reference/creds.md

+    // Builds the default nobody identity.
+	let creds = Builder::as_nobody()
+		.with_default()
+		.expect("Failed to create default Nobody credentials")


We can likely determine at compile-time if this call can fail or not (whether or not the nobody credentials were compiled in), so we should make with_default() infallible.

cdecker · 2024-03-06T16:56:39Z

docs/src/reference/creds.md

+
+    // Access the tls config.
+    let tls_config = creds.tls_config()
+		.expect("Failed to create TlsConfig");


Can we have a Credentials instance that does not have valid TLS certs? And shouldn't that be check during .build()? We could make this infallible here too.

cdecker · 2024-03-06T16:57:23Z

docs/src/reference/creds.md

+	from glclient import Credentials, TlsConfig
+
+	# Builds the default nobody identity.
+	creds = Credentials.as_nobody().with_default().build();


Why doesn't .as_nobody() load the default TLS certs? It sounds like that ought to be the default behavior.

Unless Credentials.as_nobody() returns a usable Credentials instance on its own, in which case what is the with_default() for?

Ah I see, it fails on .build() if we call just as_nobody(), gotcha.

nepet force-pushed the main-0.2 branch 3 times, most recently from 489969d to 173c6b3 Compare September 10, 2023 16:24

cdecker added the state::needs rebase label Sep 13, 2023

nepet force-pushed the main-0.2 branch from 809d5e7 to ecf1ddb Compare September 14, 2023 11:03

nepet removed the state::needs rebase label Sep 14, 2023

nepet force-pushed the main-0.2 branch from ecf1ddb to 4a72abc Compare September 30, 2023 11:11

nepet marked this pull request as ready for review September 30, 2023 11:12

nepet force-pushed the main-0.2 branch from 80df5db to faf934c Compare September 30, 2023 18:09

nepet force-pushed the main-0.2 branch 2 times, most recently from 92251ee to 981db7e Compare October 9, 2023 15:55

nepet force-pushed the main-0.2 branch 2 times, most recently from 8b5a797 to 40c5809 Compare November 5, 2023 19:52

nepet mentioned this pull request Nov 8, 2023

Erik/doc improvements #302

Merged

nepet force-pushed the main-0.2 branch from 40c5809 to a90ecb4 Compare November 10, 2023 16:02

nepet force-pushed the main-0.2 branch from a90ecb4 to 2b4130a Compare November 21, 2023 10:28

nepet force-pushed the main-0.2 branch from ad9d0b4 to 180bb26 Compare November 26, 2023 13:24

cdecker requested a review from nepet December 5, 2023 11:05

cdecker self-assigned this Dec 5, 2023

cdecker force-pushed the main-0.2 branch from c728bd7 to 06f8b10 Compare December 12, 2023 11:02

cdecker force-pushed the main-0.2 branch from 06f8b10 to b6517b2 Compare January 8, 2024 10:52

nepet force-pushed the main-0.2 branch 3 times, most recently from 64fd6e1 to 6d16a7d Compare January 11, 2024 16:08

nepet force-pushed the main-0.2 branch from 3ccea07 to d5d4aa3 Compare January 30, 2024 17:59

nepet force-pushed the main-0.2 branch 4 times, most recently from 5bc51d0 to 561574c Compare February 9, 2024 08:06

cdecker force-pushed the main-0.2 branch from 4788de7 to 3b40cc5 Compare February 15, 2024 12:24

nepet force-pushed the main-0.2 branch from 3b40cc5 to 0d2b689 Compare February 23, 2024 10:54

cdecker commented Feb 23, 2024

View reviewed changes

nepet force-pushed the main-0.2 branch from f42ebc3 to a4af453 Compare February 27, 2024 10:01

cdecker force-pushed the main-0.2 branch 3 times, most recently from 6f05c18 to 737acd9 Compare March 1, 2024 17:42

nepet added 13 commits March 6, 2024 17:33

refactor(scheduler): Silence clippy

e006e05

Clippy was complaning about: - an unnecessary `return` keyword - a self conversion. Signed-off-by: Peter Neuroth <[email protected]>

scheduler: Add a builder for the scheduler

f49a6e1

Signed-off-by: Peter Neuroth <[email protected]>

proto: Add rune to the PendingRequest msg

e143795

We need to pass a rune down to the signer for propper authorization in our e2e security schema. Signed-off-by: Peter Neuroth <[email protected]>

client: Add runes to the signer

7478c9e

Introduces runes to the greenlight client. Adds a `create_rune` method to the signer and adds the rune to the registration and recovery responses. Signed-off-by: Peter Neuroth <[email protected]>

client: Add rune to credentials

4cfada3

Adds the rune to the credentials. This way all the node client can extract the rune from the credentials for future use. Signed-off-by: Peter Neuroth <[email protected]>

client: Add rune to e2e verification

d0d616f

Add the rune to the request context. The signer extracts the rune from the PendingRequest and checks the validity as well as the restrictions. Signed-off-by: Peter Neuroth <[email protected]>

py: Move fixtures to own module

f8d284e

Signed-off-by: Peter Neuroth <[email protected]>

test: Add test for a credential upgrade

d3164f2

Signed-off-by: Peter Neuroth <[email protected]>

ci: Change Install built wheel to use creds

9425e8b

Signed-off-by: Peter Neuroth <[email protected]>

docs: Add credentials to the docs

5a5618a

Signed-off-by: Peter Neuroth <[email protected]>

cdecker force-pushed the main-0.2 branch from 737acd9 to 5a5618a Compare March 6, 2024 16:33

cdecker commented Mar 6, 2024

View reviewed changes

cdecker merged commit a148699 into main Mar 6, 2024
18 checks passed

cdecker deleted the main-0.2 branch March 6, 2024 17:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Version 0.2 #232

Version 0.2 #232

cdecker commented Aug 15, 2023

nepet commented Sep 14, 2023

nepet commented Sep 30, 2023

cdecker commented Nov 23, 2023

nepet commented Nov 26, 2023

cdecker commented Jan 8, 2024

nepet commented Feb 7, 2024

cdecker Feb 23, 2024

cdecker Feb 23, 2024

nepet commented Feb 23, 2024

cdecker left a comment

cdecker Mar 6, 2024

cdecker Mar 6, 2024

cdecker Mar 6, 2024

cdecker Mar 6, 2024

cdecker Mar 6, 2024

cdecker Mar 6, 2024

Version 0.2 #232

Version 0.2 #232

Conversation

cdecker commented Aug 15, 2023

nepet commented Sep 14, 2023

nepet commented Sep 30, 2023

cdecker commented Nov 23, 2023

nepet commented Nov 26, 2023

cdecker commented Jan 8, 2024

nepet commented Feb 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nepet commented Feb 23, 2024

cdecker 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