interfaces: new helpers to get and compare system key, for use with seeding debug api (1/N) #9028
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…p debug seeding`.
stolowski
added
Needs Samuele review
stolowski
commented
Jul 17, 2020
| // TODO: write custom struct compare | ||
| return !reflect.DeepEqual(mySystemKey, &diskSystemKey), nil | ||
| return reflect.DeepEqual(systemKey1, systemKey2), nil |
There was a problem hiding this comment.
Note: this might look very confusing with unified diff, but see line 255 above.
stolowski
changed the title
pedronis
reviewed
Jul 17, 2020
interfaces/system_key.go
Outdated
| raw, err := ioutil.ReadFile(dirs.SnapSystemKeyFile) | ||
| if err != nil { | ||
| if os.IsNotExist(err) { | ||
| return false, ErrSystemKeyMissing |
interfaces/system_key.go
Outdated
|
|
||
| var diskSystemKey systemKey | ||
| if err := json.Unmarshal(raw, &diskSystemKey); err != nil { | ||
| return false, err |
interfaces/system_key.go
Outdated
| _, ok1 := systemKey1.(*systemKey) | ||
| _, ok2 := systemKey2.(*systemKey) | ||
| if !(ok1 && ok2) { | ||
| return false, fmt.Errorf("internal error: cannot compare system keys") |
There was a problem hiding this comment.
"MatchSystemKeys: arguments are not system keys" ?
mvo5
reviewed
Jul 17, 2020
|
|
||
| ok, err := interfaces.MatchSystemKeys(key1, key2) | ||
| c.Assert(err, IsNil) | ||
| c.Check(ok, Equals, false) |
There was a problem hiding this comment.
Should we add a test that checks if two systems keys are equal? AFAICT we don't test this right now?
There was a problem hiding this comment.
Right, thanks for catching, forgot about this one!
|
|
||
| // RecordedSystemKey returns opaque system key read from the disk. | ||
| func RecordedSystemKey() (interface{}, error) { | ||
| raw, err := ioutil.ReadFile(dirs.SnapSystemKeyFile) |
There was a problem hiding this comment.
(nitpick) we could share the read logic between RecordedSystemKey and SystemKeyMismatch with something like:
diff --git a/interfaces/system_key.go b/interfaces/system_key.go
index 2988db52f3..2b9989ccf2 100644
--- a/interfaces/system_key.go
+++ b/interfaces/system_key.go
@@ -214,17 +214,10 @@ func SystemKeyMismatch() (bool, error) {
return false, err
}
- raw, err := ioutil.ReadFile(dirs.SnapSystemKeyFile)
- if err != nil && os.IsNotExist(err) {
- return false, ErrSystemKeyMissing
- }
+ diskSystemKey, err := readSystemKey()
if err != nil {
return false, err
}
- var diskSystemKey systemKey
- if err := json.Unmarshal(raw, &diskSystemKey); err != nil {
- return false, err
- }
// deal with the race that "snap run" may start, then snapd
// is upgraded and generates a new system-key with different
// inputs than the "snap run" in memory. In this case we
@@ -252,28 +245,34 @@ func SystemKeyMismatch() (bool, error) {
diskSystemKey.AppArmorParserFeatures = nil
mySystemKey.AppArmorParserFeatures = nil
- ok, err := MatchSystemKeys(mySystemKey, &diskSystemKey)
+ ok, err := MatchSystemKeys(mySystemKey, diskSystemKey)
return !ok, err
}
-// RecordedSystemKey returns opaque system key read from the disk.
-func RecordedSystemKey() (interface{}, error) {
+func readSystemKey() (*systemKey, error) {
raw, err := ioutil.ReadFile(dirs.SnapSystemKeyFile)
+ if err != nil && os.IsNotExist(err) {
+ return nil, ErrSystemKeyMissing
+ }
if err != nil {
- if os.IsNotExist(err) {
- return nil, ErrSystemKeyMissing
- }
return nil, err
}
-
var diskSystemKey systemKey
if err := json.Unmarshal(raw, &diskSystemKey); err != nil {
return nil, err
}
-
return &diskSystemKey, nil
}
+// RecordedSystemKey returns opaque system key read from the disk.
+func RecordedSystemKey() (interface{}, error) {
+ diskSystemKey, err := readSystemKey()
+ if err != nil {
+ return nil, err
+ }
+ return diskSystemKey, nil
+}
+
// CurrentSystemKey calculates and returns opaque system key.
func CurrentSystemKey() (interface{}, error) {
currentSystemKey, err := generateSystemKey()
zyga
approved these changes
Jul 17, 2020
interfaces/system_key.go
Outdated
| } | ||
|
|
||
| // MatchSystemKeys compares opaque system keys | ||
| func MatchSystemKeys(systemKey1, systemKey2 interface{}) (bool, error) { |
There was a problem hiding this comment.
Nitpick on the name, since this compares system keys for equality, how about just SystemKeysEqual
pedronis
approved these changes
Jul 20, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New helpers to get and compare opaque system keys, for use in debug api for seeding and preseeding.