tequilaOS/platform_hardware_interfaces
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Replacing manual CBOR description with CDDL.

Browse source 
Clarify the result documentation by using exact CDDL descriptions for
the formattedMessage CBOR object.

Test: N/A
Change-Id: I0077c7d53385470ef058b6ce965adb9f7b0bba55
This commit is contained in:
Max Bires 2024-05-22 06:06:36 +00:00
parent 740301ed52
commit 2caf529bdc
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
confirmationui/aidl/android/hardware/confirmationui/IConfirmationResultCallback.aidl
View file

@ -38,15 +38,15 @@ interface IConfirmationResultCallback {
* prevented the TUI from being shut down gracefully. * prevented the TUI from being shut down gracefully.
* *
* @param formattedMessage holds the prompt text and extra data. * @param formattedMessage holds the prompt text and extra data.
* The message is CBOR (RFC 7049) encoded and has the following format: * The message is CBOR (RFC 7049) encoded and has the exact format
* CBOR_MAP{ "prompt", <promptText>, "extra", <extraData> } * given by the following CDDL:
* The message is a CBOR encoded map (type 5) with the keys *
* "prompt" and "extra". The keys are encoded as CBOR text string * formattedMessage = {
* (type 3). The value <promptText> is encoded as CBOR text string * "prompt" : tstr,
* (type 3), and the value <extraData> is encoded as CBOR byte string * "extra" : bstr,
* (type 2). The map must have exactly one key value pair for each of * }
* the keys "prompt" and "extra". Other keys are not allowed. *
* The value of "prompt" is given by the proptText argument to * The value of "prompt" is given by the promptText argument to
* IConfirmationUI::promptUserConfirmation and must not be modified * IConfirmationUI::promptUserConfirmation and must not be modified
* by the implementation. * by the implementation.
* The value of "extra" is given by the extraData argument to * The value of "extra" is given by the extraData argument to
@ -59,8 +59,7 @@ interface IConfirmationResultCallback {
* the "", concatenated with the formatted message as returned in the * the "", concatenated with the formatted message as returned in the
* formattedMessage argument. The HMAC is keyed with a 256-bit secret * formattedMessage argument. The HMAC is keyed with a 256-bit secret
* which is shared with Keymaster. In test mode the test key MUST be * which is shared with Keymaster. In test mode the test key MUST be
* used (see TestModeCommands.aidl and * used (see TestModeCommands.aidl and IConfirmationUI::TEST_KEY_BYTE)
* IConfirmationUI::TEST_KEY_BYTE).
*/ */
void result(in int error, in byte[] formattedMessage, in byte[] confirmationToken); void result(in int error, in byte[] formattedMessage, in byte[] confirmationToken);
} }