Add an endorser command line tool #240

rbehjati · 2023-07-20T18:36:14Z

Have tested with the following commands:

Provenance-less endorsement:

go run cmd/endorser/main.go \
 --binary_digest=sha256:1234 \
 --binary_name=binary \
 --verification_options=testdata/skip_verification.textproto

Resulting endorsement:

{
    "_type": "https://in-toto.io/Statement/v0.1",
    "predicateType": "https://github.com/project-oak/transparent-release/claim/v1",
    "subject": [
        {
            "name": "binary",
            "digest": {
                "sha256": "1234"
            }
        }
    ],
    "predicate": {
        "claimType": "https://github.com/project-oak/transparent-release/endorsement/v2",
        "issuedOn": "2023-07-20T19:38:48.780747796+01:00",
        "validity": {
            "notBefore": "2023-07-21T00:00:00Z",
            "notAfter": "2023-10-18T00:00:00Z"
        }
    }
}

Normal endorsement with linked provenance:

go run cmd/endorser/main.go \
 --binary_digest=sha256:39051983bbb600bbfb91bd22ee4c976420f8f0c6a895fd083dcb0d153ddd5fd6 \
 --binary_name=oak_echo_raw_enclave_app \
 --provenance_uris=https://ent-server-62sa4xcfia-ew.a.run.app/raw/sha256:b28696a8341443e3ba433373c60fe1eba8d96f28c8aff6c5ee03d752dd3b399b \
 --verification_options=testdata/skip_verification.textproto

Resulting endorsement:

{
    "_type": "https://in-toto.io/Statement/v0.1",
    "predicateType": "https://github.com/project-oak/transparent-release/claim/v1",
    "subject": [
        {
            "name": "oak_echo_raw_enclave_app",
            "digest": {
                "sha256": "39051983bbb600bbfb91bd22ee4c976420f8f0c6a895fd083dcb0d153ddd5fd6"
            }
        }
    ],
    "predicate": {
        "claimType": "https://github.com/project-oak/transparent-release/endorsement/v2",
        "issuedOn": "2023-07-20T19:33:34.793557441+01:00",
        "validity": {
            "notBefore": "2023-07-21T00:00:00Z",
            "notAfter": "2023-10-18T00:00:00Z"
        },
        "evidence": [
            {
                "role": "Provenance",
                "uri": "https://ent-server-62sa4xcfia-ew.a.run.app/raw/sha256:b28696a8341443e3ba433373c60fe1eba8d96f28c8aff6c5ee03d752dd3b399b",
                "digest": {
                    "sha256": "b28696a8341443e3ba433373c60fe1eba8d96f28c8aff6c5ee03d752dd3b399b"
                }
            }
        ]
    }
}

tiziano88 · 2023-07-21T09:44:56Z

cmd/endorser/README.md

+generates an endorsement statement, with the given provenances listed in the endorsement statement's
+evidence field.
+
+Example execution with not provenances:


Suggested change

Example execution with not provenances:

Example execution without provenances:

tiziano88 · 2023-07-21T09:52:51Z

cmd/endorser/main.go

+)
+
+// layout represents the expected date format.
+const layout = "20060102"


What format is this? Why not use ISO 8601? If it cannot be changed, could you add a comment here explaining why?

It is ISO 8601. Both YYYY-MM-DD and YYYYMMDD are allowed (wikipedia). But, changed it to YYYY-MM-DD.

tiziano88 · 2023-07-21T09:54:41Z

cmd/endorser/main.go

+	binaryDigest := flag.String("binary_digest", "", "Digest of the binary to endorse, of the form alg:value. Accepted values for alg include sha256, and sha2-256")
+	binaryName := flag.String("binary_name", "", "Name of the binary to endorse. Should match the name in provenances, if provenance URIs are provided.")
+	verificationOptions := flag.String("verification_options", "", "Output path to a textproto file containing verification options.")
+	endorsementPath := flag.String("endorsement_path", "endorsement.json", "Output path to store the generated endorsement statement in.")
+	notBefore := flag.String("not_before", defaultNotBefore,
+		"Optional -  The date from which the endorsement is effective. The expected date format is YYYYMMDD. Defaults to 1 day after the issuance date.")
+	notAfter := flag.String("not_after", defaultNotAfter,
+		"Required - The expiry date of the endorsement. The expected date format is YYYYMMDD. Defaults to 90 day after the issuance date.")
+	flag.Var(&provenanceURIs, "provenance_uris", "URIs of the provenances.")


I think flags are normally in the top level scope, unless they need to be dynamically generated.

tiziano88 · 2023-07-21T09:56:07Z

cmd/endorser/main.go

+	binaryName := flag.String("binary_name", "", "Name of the binary to endorse. Should match the name in provenances, if provenance URIs are provided.")
+	verificationOptions := flag.String("verification_options", "", "Output path to a textproto file containing verification options.")
+	endorsementPath := flag.String("endorsement_path", "endorsement.json", "Output path to store the generated endorsement statement in.")
+	notBefore := flag.String("not_before", defaultNotBefore,


Setting the default to a dynamic value seems confusing; if someone runs the --help command, they will see the default change all the time I think? It seems more appropriate to leave that empty, and if so rely on some logic to deal with the default

Makes sense. Removed the defaults from the flag, but these defaults are used if no value is specified.

tiziano88 · 2023-07-21T09:58:59Z

cmd/endorser/main.go

+
+	bytes, err := json.MarshalIndent(endorsement, "", "    ")
+	if err != nil {
+		log.Fatalf("could not marshal the fuzzing claim: %v", err)


Which fuzzing claim?

Good catch. sloppy copy-paste. Fixed.

tiziano88 · 2023-07-21T09:59:22Z

cmd/endorser/main.go

+}
+
+func main() {
+	// Current time in UTC time zone since it is used by OSS-Fuzz.


What is the connection with OSS-Fuzz?

Oops! Copy-paste! Fixed.

rbehjati

Thanks for the review.

rbehjati · 2023-07-21T10:40:50Z

cmd/endorser/README.md

+generates an endorsement statement, with the given provenances listed in the endorsement statement's
+evidence field.
+
+Example execution with not provenances:


rbehjati · 2023-07-21T10:42:44Z

cmd/endorser/main.go

+)
+
+// layout represents the expected date format.
+const layout = "20060102"


It is ISO 8601. Both YYYY-MM-DD and YYYYMMDD are allowed (wikipedia). But, changed it to YYYY-MM-DD.

rbehjati · 2023-07-21T10:43:03Z

cmd/endorser/main.go

+}
+
+func main() {
+	// Current time in UTC time zone since it is used by OSS-Fuzz.


Oops! Copy-paste! Fixed.

rbehjati · 2023-07-21T10:44:00Z

cmd/endorser/main.go

+	binaryName := flag.String("binary_name", "", "Name of the binary to endorse. Should match the name in provenances, if provenance URIs are provided.")
+	verificationOptions := flag.String("verification_options", "", "Output path to a textproto file containing verification options.")
+	endorsementPath := flag.String("endorsement_path", "endorsement.json", "Output path to store the generated endorsement statement in.")
+	notBefore := flag.String("not_before", defaultNotBefore,


Makes sense. Removed the defaults from the flag, but these defaults are used if no value is specified.

rbehjati · 2023-07-21T10:44:08Z

cmd/endorser/main.go

+	binaryDigest := flag.String("binary_digest", "", "Digest of the binary to endorse, of the form alg:value. Accepted values for alg include sha256, and sha2-256")
+	binaryName := flag.String("binary_name", "", "Name of the binary to endorse. Should match the name in provenances, if provenance URIs are provided.")
+	verificationOptions := flag.String("verification_options", "", "Output path to a textproto file containing verification options.")
+	endorsementPath := flag.String("endorsement_path", "endorsement.json", "Output path to store the generated endorsement statement in.")
+	notBefore := flag.String("not_before", defaultNotBefore,
+		"Optional -  The date from which the endorsement is effective. The expected date format is YYYYMMDD. Defaults to 1 day after the issuance date.")
+	notAfter := flag.String("not_after", defaultNotAfter,
+		"Required - The expiry date of the endorsement. The expected date format is YYYYMMDD. Defaults to 90 day after the issuance date.")
+	flag.Var(&provenanceURIs, "provenance_uris", "URIs of the provenances.")


rbehjati · 2023-07-21T10:45:38Z

cmd/endorser/main.go

+
+	bytes, err := json.MarshalIndent(endorsement, "", "    ")
+	if err != nil {
+		log.Fatalf("could not marshal the fuzzing claim: %v", err)


Good catch. sloppy copy-paste. Fixed.

rbehjati force-pushed the cmd-endorser branch from 7267ac5 to b196a25 Compare July 20, 2023 18:41

Add an endorser command line tool

dd66eb3

rbehjati force-pushed the cmd-endorser branch from b196a25 to dd66eb3 Compare July 20, 2023 18:48

Disable depguard linting

f675dfb

rbehjati requested a review from tiziano88 July 20, 2023 18:52

tiziano88 approved these changes Jul 21, 2023

View reviewed changes

Fixes after review

b5bdac9

rbehjati commented Jul 21, 2023

View reviewed changes

rbehjati added 2 commits July 21, 2023 12:42

Refactor input options into an object

dcadab0

Add an e2e test for the endorser to the CI

df34658

rbehjati force-pushed the cmd-endorser branch 3 times, most recently from 83bf39e to a81d632 Compare July 21, 2023 14:04

Final tweaks

920fdf0

rbehjati force-pushed the cmd-endorser branch from a81d632 to 920fdf0 Compare July 21, 2023 14:19

rbehjati merged commit 9fb29cf into project-oak:main Jul 21, 2023
8 checks passed

rbehjati deleted the cmd-endorser branch July 21, 2023 14:22

rbehjati mentioned this pull request Sep 5, 2023

Add library for generating endorsements #141

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add an endorser command line tool #240

Add an endorser command line tool #240

rbehjati commented Jul 20, 2023 •

edited

Loading

tiziano88 Jul 21, 2023

rbehjati Jul 21, 2023

tiziano88 Jul 21, 2023

rbehjati Jul 21, 2023

tiziano88 Jul 21, 2023

rbehjati Jul 21, 2023

tiziano88 Jul 21, 2023

rbehjati Jul 21, 2023

tiziano88 Jul 21, 2023

rbehjati Jul 21, 2023

tiziano88 Jul 21, 2023

rbehjati Jul 21, 2023

rbehjati left a comment

rbehjati Jul 21, 2023

rbehjati Jul 21, 2023

rbehjati Jul 21, 2023

rbehjati Jul 21, 2023

rbehjati Jul 21, 2023

rbehjati Jul 21, 2023

	Example execution with not provenances:
	Example execution without provenances:

Add an endorser command line tool #240

Add an endorser command line tool #240

Conversation

rbehjati commented Jul 20, 2023 • edited Loading

Provenance-less endorsement:

Normal endorsement with linked provenance:

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

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

rbehjati 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

rbehjati commented Jul 20, 2023 •

edited

Loading