Skip to content

Add discussion of pcrim use of payload file hash for the config file page #35

@iadgovuser26

Description

@iadgovuser26

Problem: The RIM Tool configuration file help page does not discuss the use of the File Hash within the payload element. The test config files included all have the hash attribute populated (for illustration purposes) but are specific to the test Support RIM files. When a user copies the config file and mods the obvious fields (e.g. platformManufacturerStr, platformModel, etc.) the need to update the hash field is typically overlooked.

Proposed solution:

  1. Add a note to the create page under the Examples section under before starting section configuration file help page that "The examples provided under the data folder are for illustrative purposes only and need to be updated by the user to match the intended use".
  2. Add a note for specifically pcrim types:
    TCG PC Client RIMs use a payloadType referred to as "Indirect" that implies they use a Support RIM file . The Payload element element in examples will have a File hash attribute within the Payload element (see this example) that are specific to the test Support RIM being references (e.g. "TpmLog.bin").

When using one of the proved example config files to generate a test Base RIM it is important the the hash be updated to match the intended support RIM. There are 2 options for modifying this hash:
a. Manually edit the file hash value in the json file with a sha256 hash calculated for the support RIM you wish to use before generating the Base RIM. AS an example:

"Payload": {
		"Directory": {
                	"supportRIMFormat": "TCG_EventLog_Assertion",
			"name": "TestRim",
			"File": [
				{
					"name": "TpmLog.bin",
					"hash": "4479ca722623f8c47b703996ced3cbd981b06b1ae8a897db70137e0b7c546848"
				}
			]
		}
	}

The hash should be updates with the sha256 hash of the new Support RIM being used.
b. If you remove the hash line in the json file the tool will populate the hash based upon the file provisioned via the -l parameter. In this case the example above would be:

"Payload": {
		"Directory": {
                	"supportRIMFormat": "TCG_EventLog_Assertion",
			"name": "TestRim",
			"File": [
				{
					"name": "TpmLog.bin",
				}
			]
		}
	}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions