Porter implementation of `/exec_work_order` (associated with TMapConKFrags for `/reencrypt` endpoint) by derekpierre · Pull Request #2729 · nucypher/nucypher

derekpierre · 2021-06-25T14:34:58Z

Type of PR:

Bugfix
Feature
Documentation
Other

Required reviews:

1
2
3

What this does:
POC implementation of /exec_work_order for Bob. The actual mechanics of the reencrypt operation is modified by TMapConKFrags since kFrags would not be stored by Ursula.

Slight modification to original design of function - #2667 (comment) ('work_order' -> 'work_order_payload')

Request

{
    "ursula": <checksum_address>,
    "work_order_payload": <bytes encoded as base64>
}

Response

{
    "result": {
        "work_order_result": <bytes encoded as base64>
    }
}

Issues fixed/closed:
Related to #2704
Closes #2667

Notes for reviewers:
Based over #2733 .

RestMiddleware.send_work_order_payload_to_ursula() will be changed by TMapConKfrags to not require an associated arrangement id, so there is currently a stub for that function until TMapConKFrags gets merged. Therefore, actually trying to use the endpoint at the moment will not work properly.

KPrasch

General high-level question: What made you decide to go with exec_work_order instead of retrieve?

derekpierre · 2021-06-28T23:24:42Z

General high-level question: What made you decide to go with exec_work_order instead of retrieve?

Traditionally "retrieve" was defined by Bob.retrieve (at least in the Python API/CLI) and it involved a series of steps including:

Getting the treasure map (probably no more with TMapConKFrags)
Processing the treasure map to obtain ursulas, and construct work orders
Sending work orders to ursula(s) to obtain cfrags
Attaching the returned cfrags to the capsule
Decrypting the data to obtain the cleartext

I viewed this as a single step in that process and did not want to confuse it with being the entire "retrieve" process.

One additional thought I had with this endpoint was the ability for exec_work_order to possibly generalize to any functionality, although I'm uncertain of the feasibility since these may/may not be different characters:

This can potentially be extended for additional functionality under the guise of a generalized WorkOrder (perhaps?). It could be more of an Ursula do something you know how to do (DKG, TSS, etc.) with the relevant WorkOrder sub-type provided.

(See #2667 (comment))

wdyt?

derekpierre · 2021-07-12T19:19:13Z

Unsure why test_policy_simple_sinpa is failing - perhaps someone can point me in the right direction - perhaps I missed something with the original TMapConKFrag rebase. Same issue in porter branch - https://app.circleci.com/pipelines/github/nucypher/nucypher/8150/workflows/8130953c-39e3-4906-bca5-39d5ee05c720/jobs/138062.

…roup ursula schemas together.

… tests. Some code refactoring.

…eated and used for tests. exec_work_order tests now actually use /reencrypt ursulas endpoints.

…r /exec_work_order. Documentation cleanup: use version 6.0.0 in output, 401 error status code.

piotr-roslaniec

LGTM 👍

vepkenez · 2021-07-14T15:20:28Z

nucypher/utilities/porter/control/specifications/fields/workorder.py



-class WorkOrder(BaseField, fields.Field):
+class WorkOrder(Base64BytesRepresentation):


I love this

… about url encoding in docs. Add unit test for Base64BytesRepresentation field. Cleanup imports.

derekpierre · 2021-07-14T15:28:15Z

docs/source/application_development/porter.rst

-    If URL parameters are used for the ``/publish_treasure_map`` endpoint instead of JSON data, the request will fail because the URL becomes too long.
+.. code:: bash
+
+    curl -X POST "<PORTER URI>/publish_treasure_map?treasure_map=Qld7S8sbKFCv2B8KxfJo4oxiTOjZ4VPyqTK5K1xK6DND6TbLg2hvlGaMV69aiiC5QfadB82w%2F5q1Sw%2BSNFHN2e ...&bob_encrypting_key=026d1f4ce5b2474e0dae499d6737a8d987ed3c9ab1a55e00f57ad2d8e81fe9e9ac"


@piotr-roslaniec / @vepkenez - it turns out that I am able to execute /publish_treasure_map with URL parameters using the python requests library even though the URL is long (~3000 characters) - the problem was the treasure_map value not being URL encoded 🤦 . Made a note about URL encoding in the docs, and that it is tool dependent.

Porter implementation of `/exec_work_order` (associated with TMapConKFrags for `/reencrypt` endpoint)

derekpierre added Web Webpages Bob 👨‍💼 Effects the "Bob" development area labels Jun 25, 2021

derekpierre added this to the Porter v1 (MVP) milestone Jun 25, 2021

derekpierre requested a review from KPrasch June 25, 2021 14:34

derekpierre self-assigned this Jun 25, 2021

derekpierre added the API label Jun 25, 2021

derekpierre force-pushed the exec-work-order branch 2 times, most recently from d4f3a82 to 220bbba Compare June 25, 2021 17:05

KPrasch reviewed Jun 28, 2021

View reviewed changes

derekpierre force-pushed the exec-work-order branch 2 times, most recently from 0f1206e to f24b3e1 Compare July 2, 2021 18:26

derekpierre mentioned this pull request Jul 2, 2021

[EPIC] Porter MVP - "Infura for NuCypher" #2664

Merged

derekpierre force-pushed the exec-work-order branch from f24b3e1 to 5ace902 Compare July 5, 2021 18:28

derekpierre force-pushed the porter branch from 2755f9e to daeb398 Compare July 12, 2021 14:33

derekpierre force-pushed the exec-work-order branch 3 times, most recently from c09355f to 087c800 Compare July 12, 2021 18:34

derekpierre requested review from KPrasch, cygnusv, fjarri, jMyles, piotr-roslaniec and vepkenez July 12, 2021 18:55

derekpierre changed the title ~~[WIP] Porter implementation of /exec_work_order (affected by TMapConKFrags)~~ Porter implementation of /exec_work_order (affected by TMapConKFrags) Jul 12, 2021

derekpierre marked this pull request as ready for review July 12, 2021 18:56

derekpierre force-pushed the porter branch from daeb398 to 76e7b03 Compare July 12, 2021 23:20

derekpierre force-pushed the exec-work-order branch from 087c800 to 5d20446 Compare July 12, 2021 23:23

derekpierre changed the title ~~Porter implementation of /exec_work_order (affected by TMapConKFrags)~~ Porter implementation of /exec_work_order (associated with TMapConKFrags for /reencrypt endpoint) Jul 12, 2021

derekpierre changed the title ~~Porter implementation of /exec_work_order (associated with TMapConKFrags for /reencrypt endpoint)~~ Porter implementation of /exec_work_order (associated with TMapConKFrags for /reencrypt endpoint) Jul 12, 2021

derekpierre added 6 commits July 14, 2021 09:17

Remove unnecessarly CLI commands for Porter. Some schema cleanup to g…

35c1c90

…roup ursula schemas together.

Initial implementation of Porter '/exec_work_order' functionality and…

1df8710

… tests. Some code refactoring.

Initial documentation of Porter '/exec_work_order' endpoint.

7b86e0a

Clean up WebController handling of request data.

f43ecec

Fix issues after TMapConKFrag rebase including how work orders are cr…

16103be

…eated and used for tests. exec_work_order tests now actually use /reencrypt ursulas endpoints.

Clarify format of "work_order_result" returned as the result of Porte…

21151ec

…r /exec_work_order. Documentation cleanup: use version 6.0.0 in output, 401 error status code.

piotr-roslaniec approved these changes Jul 14, 2021

View reviewed changes

vepkenez reviewed Jul 14, 2021

View reviewed changes

Ensure that url query parameters in tests are url encoded. Added note…

f73e028

… about url encoding in docs. Add unit test for Base64BytesRepresentation field. Cleanup imports.

derekpierre force-pushed the exec-work-order branch from 6494ba1 to f73e028 Compare July 14, 2021 15:25

vepkenez approved these changes Jul 14, 2021

View reviewed changes

derekpierre commented Jul 14, 2021

View reviewed changes

derekpierre merged commit e68eefe into nucypher:porter Jul 14, 2021

derekpierre mentioned this pull request Jul 14, 2021

Implement Porter functionality for Bob #2704

Closed

derekpierre added a commit that referenced this pull request Jul 26, 2021

Merge pull request #2729 from derekpierre/exec-work-order

1f49599

Porter implementation of `/exec_work_order` (associated with TMapConKFrags for `/reencrypt` endpoint)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Porter implementation of `/exec_work_order` (associated with TMapConKFrags for `/reencrypt` endpoint)#2729

Porter implementation of `/exec_work_order` (associated with TMapConKFrags for `/reencrypt` endpoint)#2729
derekpierre merged 7 commits intonucypher:porterfrom
derekpierre:exec-work-order

derekpierre commented Jun 25, 2021 •

edited

Loading

Uh oh!

KPrasch left a comment

Uh oh!

derekpierre commented Jun 28, 2021 •

edited

Loading

Uh oh!

derekpierre commented Jul 12, 2021 •

edited

Loading

Uh oh!

piotr-roslaniec left a comment

Uh oh!

vepkenez Jul 14, 2021

Uh oh!

derekpierre Jul 14, 2021 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants



		class WorkOrder(BaseField, fields.Field):
		class WorkOrder(Base64BytesRepresentation):

Conversation

derekpierre commented Jun 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

KPrasch left a comment

Choose a reason for hiding this comment

Uh oh!

derekpierre commented Jun 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

derekpierre commented Jul 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

piotr-roslaniec left a comment

Choose a reason for hiding this comment

Uh oh!

vepkenez Jul 14, 2021

Choose a reason for hiding this comment

Uh oh!

derekpierre Jul 14, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

derekpierre commented Jun 25, 2021 •

edited

Loading

derekpierre commented Jun 28, 2021 •

edited

Loading

derekpierre commented Jul 12, 2021 •

edited

Loading

derekpierre Jul 14, 2021 •

edited

Loading