Add client as parent class for primary and secondary #192

tanishqjasoria · 2019-05-28T22:29:21Z

Purpose of the PR:

Refactor primary.py and secondary.py to pull out common elements
Address Issue #14

Summary of Changes:

Add a client class implementing the common methods used by both
Primary and Secondary
Primary and Secondary inherits from the client class.

Client class aim to implement the common methods used by by both the Primary and Secondary. They would inherit the Client class and would implement additional methods as per their requirements.

Add two duplicate functions - refresh_toplevel_metadata - get_validated_target_info

Method get_target_list_from_director gets the list of latest updates to be install in the vehicle

This method would be used to verify timeserver signature on the timeserver_attestation before we proced to update the time of the client.

This method would be used to update the time of the client after the timeserver signature is verified and the list of nounce is verified by the Primary or Secondary.

Two important changes were introduced 1. Primary inherited from the Client class and upate the constructor of the primary class 2. Earlier the key of Primary was refered to as primary_key, to improve consistency in Client, Primary and Secondary, change it to ecu_key

Remove 1. refresh_toplevel_metadata 2. get_validated_target_info

Modify update_time to use method verify_timeserver_signature and update_verified_time from Client to verify signature of the timeserver and to update the time after verification process respectively.

Done to accomodate for changes made in Primary. In Primary, we now refere private key of Primary as ecu_key insted of primary_key

There was a copy of previous implemented version of this method in Primary, which needed to be removed so that Primary can use Client class implemtation of the method, by default.

Now metadata distributed to the partial verification secondaries would be in the form of a archive with the structure almost similar to that of the distributed archive for full verification. Here only director repo would be present and it would only have the targets metadata. This is done so that the secondary could obtain, save and expand the metadata recieved from primary in a similar fashion as that of full verification. It would further help in simplifying the partial verification process

Now primary is sending archive for partial verification metadata as well.

Used various tuf low level functions to verify the targets metadata supplied by the director repository. It complies with the latest Uptane standard for design.

Earlier even if no target_info was provided the validated_targets_for_this_ecu would be emptied. Now if new target info is present, then the list validated_targets_for_this_ecu would be updated

Earlier the test data was stores in seperate lists like TEMP_CLIENT_DIRS, vins, ecu_serials and secondary_instances Now all the data corresponding to a particular secondary is stored in a dictionary and all the dictionaries are further stored in a list TEST_INSTANCES

Update the function get_partial_metadata_fname to get_partial_metadata_archive_fname

Earlier the partial metadata supplied by the primary was just director_targets file but now the primary provides a archive with the structure similar to that of full metadata

Modified metadata files to include a possible update for the newly included partial verifying secondary ECU.

…t the update This included fileinfo corresponds to the info of the update that the partial verifying ECU would donwnload as per the new metadata.

The tests for partial verification ECU are carried out in the similar fashion as that of the full verification ECU.

Due to some discrepency in json and der metadata the tests failed while working with der formats

1. Removed methods which are implemented in theclient class 2. Modify update_time and fully_validate_metadata methods to use function from the client class

Earlier the private key of the primary ECU was used by the name 'primary_key'. Now it has been changed to 'ecu_key'

Syntax for initialization of parent from child class is different in python2.

lukpueh

Thanks for the clean PR, @tanishqjasoria! Please address my comments below and this should be good to merge.

IMO you can further remove redundancy in the Primary/Secondary class docstrings. Instead of duplicating docstrings, point the reader to the docstrings of the common Client parent class.

And you can also remove check_match calls in Primary/Secondary constructors for arguments that are checked in the parent class as well.

uptane/clients/client.py

uptane/clients/primary.py

uptane/clients/client.py

uptane/clients/secondary.py

…anishqjasoria/uptane into add_client_class

lukpueh

Thanks for the changes, @tanishqjasoria!

Please address whitespace comment below and update class docstrings in Primary and Secondary to no longer list methods and fields that were moved to Client.

lukpueh · 2019-07-10T10:11:23Z

uptane/clients/client.py

+      raise uptane.Error('Unexpected behavior: did not receive target info from'
+          ' Director repository (' + repr(self.director_repo_name) + ') for '
+          'a target (' + repr(target_filepath) + '). Is pinned.json configured '
+          'to allow some targets to validate without Director approval, or is'


Please add a space after is.

On a side-note, it's a good idea to have the separating space between strings over multiple lines either all in the end or in the beginning (I am slightly in favor of the former, as you did in all but one lines here).

lukpueh · 2019-07-10T15:05:04Z

Btw. don't worry about the failing Travis build due to missing Python 3.4. I'll fix this in https://github.com/lukpueh/uptane/tree/fix-ci-cd

tanishqjasoria added 30 commits May 16, 2019 12:35

Refactor: Add Client as parent class for Primary and Secondary

adee06a

Client class aim to implement the common methods used by by both the Primary and Secondary. They would inherit the Client class and would implement additional methods as per their requirements.

Add duplicate functions from Primary and Secondary

d239b38

Add two duplicate functions - refresh_toplevel_metadata - get_validated_target_info

Add method to obtain the targets list from the director

b056121

Method get_target_list_from_director gets the list of latest updates to be install in the vehicle

Add method to verify the timeserver signature

ed10eb3

This method would be used to verify timeserver signature on the timeserver_attestation before we proced to update the time of the client.

Add function to update time after verification of timeserver_attestation

9877c44

This method would be used to update the time of the client after the timeserver signature is verified and the list of nounce is verified by the Primary or Secondary.

Add time variables to the constructor

8950ac2

Fix Client import error

3f4587a

Remove function implemented in Client

b762483

Remove 1. refresh_toplevel_metadata 2. get_validated_target_info

Update primary_update_cycle

f6e4d32

Update update_time method

0d26682

Modify update_time to use method verify_timeserver_signature and update_verified_time from Client to verify signature of the timeserver and to update the time after verification process respectively.

Fix verify_timeserver_signature to return time_attestation as dictionary

4c0dc3c

Change primary_key to ecu_key

c2f801e

Done to accomodate for changes made in Primary. In Primary, we now refere private key of Primary as ecu_key insted of primary_key

Remove get_targetlist_from_director from Primary

7a59f5c

There was a copy of previous implemented version of this method in Primary, which needed to be removed so that Primary can use Client class implemtation of the method, by default.

Fix update_time to use dictionary format of attestation

bac471f

Inherit secondary from Client

d257a22

Update to be compatible with partial verification

de463d8

Update to reciver the metadata for partial verification

20ce126

Now primary is sending archive for partial verification metadata as well.

Add function for Partial Verification of Secondary

3398f37

Used various tuf low level functions to verify the targets metadata supplied by the director repository. It complies with the latest Uptane standard for design.

Update to store last validated targets until new found

f0b4611

Earlier even if no target_info was provided the validated_targets_for_this_ecu would be emptied. Now if new target info is present, then the list validated_targets_for_this_ecu would be updated

Update the test verifying the parital_metadata generaton for secondary

95df574

Update the function get_partial_metadata_fname to get_partial_metadata_archive_fname

Update samples to accomodate the changes in partial metadata

8084fda

Earlier the partial metadata supplied by the primary was just director_targets file but now the primary provides a archive with the structure similar to that of full metadata

Update metadata files to include update for the partial verifying ECU

71e37fb

Modified metadata files to include a possible update for the newly included partial verifying secondary ECU.

Add two more TEST_INSTANCES for the partial verifying secondary ECUs

9053517

Add pv__expected_updated_fileinfo to make partial verifying ECU accep…

ce58801

…t the update This included fileinfo corresponds to the info of the update that the partial verifying ECU would donwnload as per the new metadata.

Modify to include the tests for partial verifying secondary ECU

b38d4de

The tests for partial verification ECU are carried out in the similar fashion as that of the full verification ECU.

FIX error in test_20_update_time due to wrong function call

dcb6995

Add new sample metadata files for tests to work with der format

229a2c7

Due to some discrepency in json and der metadata the tests failed while working with der formats

tanishqjasoria added 3 commits May 28, 2019 16:32

Modify test to validate partial verification Secondary firmware also

0dd0403

Modify Secondary client to use methods from parent class

ee54328

1. Removed methods which are implemented in theclient class 2. Modify update_time and fully_validate_metadata methods to use function from the client class

Modify tests to accomodate for change of name of primary ECU keys

cde525a

Earlier the private key of the primary ECU was used by the name 'primary_key'. Now it has been changed to 'ecu_key'

tanishqjasoria changed the title ~~Add client as parent class for primary and secondar~~ Add client as parent class for primary and secondary May 30, 2019

FIX to work with python2

78cb23b

Syntax for initialization of parent from child class is different in python2.

lukpueh suggested changes Jul 2, 2019

View reviewed changes

tanishqjasoria added 5 commits July 8, 2019 16:49

Remove unused imports

3c0fad1

Remove methods list in Client class

fee6c12

Add the TODO comment from Primary

45f9385

Fix formatting issues

16ab335

Merge branch 'partial_verification_secondary' of https://github.com/t…

933bd1c

…anishqjasoria/uptane into add_client_class

lukpueh suggested changes Jul 10, 2019

View reviewed changes

tanishqjasoria added 2 commits July 10, 2019 14:16

Fix whitespace issues

3f99b2e

Fix docstrings for the classes

cd022ea

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add client as parent class for primary and secondary #192

Add client as parent class for primary and secondary #192

tanishqjasoria commented May 28, 2019

lukpueh left a comment

lukpueh left a comment

lukpueh Jul 10, 2019

lukpueh Jul 10, 2019

lukpueh commented Jul 10, 2019

Add client as parent class for primary and secondary #192

Are you sure you want to change the base?

Add client as parent class for primary and secondary #192

Conversation

tanishqjasoria commented May 28, 2019

Purpose of the PR:

Summary of Changes:

lukpueh left a comment

Choose a reason for hiding this comment

lukpueh left a comment

Choose a reason for hiding this comment

lukpueh Jul 10, 2019

Choose a reason for hiding this comment

lukpueh Jul 10, 2019

Choose a reason for hiding this comment

lukpueh commented Jul 10, 2019