Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 49e8287a authored by Seth Moore's avatar Seth Moore
Browse files

Update README and CHANGELOG for RKP 

Now that the HAL build has been split, move the markdown.

Add some notes about the split in CHANGELOG

Bug: 254112961
Test: N/A
Change-Id: I5d24f47ce4ac1fcdeda28827bebe6d5f2ddfd249
parent ca73d57c

security/keymint/README.md

0 → 100644
+10 −0
Original line number Diff line number Diff line 
# KeyMint HAL



This directory contains the HAL definition for KeyMint. KeyMint provides

cryptographic services in a hardware-isolated environment.



Note that the `IRemotelyProvisionedComponent` HAL, and it's associated types,

used to also be defined in this directory. As of Android U, this HAL has been

moved to a different directory (../rkp). This move is ABI compatible, as the

interfaces have been maintained. The build is split so that the generated

code may be built with different options.

security/keymint/RKP_CHANGELOG.md→security/rkp/CHANGELOG.md

+6 −0
Original line number Diff line number Diff line
@@ -19,6 +19,12 @@ This document provides an exact description of which changes have occurred in th 
  * `uniqueId` String added as a field in order to differentiate IRPC instances on device.



## IRemotelyProvisionedComponent 2 -> 3

* The RKP HAL now builds separately from KeyMint.

  * The HAL remains under the `android.hardware.security.keymint` package for

    compatibility with previous releases. ABI compatibility requires this.

  * Dependencies on the RKP HAL must add a dependency on

    `"android.hardware.security.rkp"` generated code (instead of

    `"android.hardward.security.keymint"`).

* ProtectedData has been removed.

* DeviceInfo

  * `version` has moved to a top-level field within the CSR generated by the HAL

security/keymint/RKP_README.md→security/rkp/README.md

+8 −8
Original line number Diff line number Diff line
@@ -6,8 +6,8 @@ Design a HAL to support over-the-air provisioning of certificates for asymmetric 
keys. The HAL must interact effectively with Keystore (and other daemons) and

protect device privacy and security.



Note that this API is designed for KeyMint, but with the intention that it

should be usable for other HALs that require certificate provisioning.

Note that this API was originally designed for KeyMint, with the intention that

it should be usable for other HALs that require certificate provisioning.

Throughout this document we'll refer to the Keystore and KeyMint (formerly

called Keymaster) components, but only for concreteness and convenience; those

labels could be replaced with the names of any system and secure area
@@ -312,7 +312,7 @@ the range \[-70000, -70999\] (these are reserved for future additions here). 
```



Please see

[ProtectedData.aidl](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/keymint/aidl/android/hardware/security/keymint/ProtectedData.aidl)

[ProtectedData.aidl](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/rkp/aidl/android/hardware/security/keymint/ProtectedData.aidl)

for a full CDDL definition of the BCC.



### `CertificateRequest`
@@ -366,9 +366,9 @@ Please see the related HAL documentation directly in the source code at the 
following links:



*   [IRemotelyProvisionedComponent

    HAL](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/keymint/aidl/android/hardware/security/keymint/IRemotelyProvisionedComponent.aidl)

*   [ProtectedData](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/keymint/aidl/android/hardware/security/keymint/ProtectedData.aidl)

*   [MacedPublicKey](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/keymint/aidl/android/hardware/security/keymint/MacedPublicKey.aidl)

*   [RpcHardwareInfo](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/keymint/aidl/android/hardware/security/keymint/RpcHardwareInfo.aidl)

*   [DeviceInfo](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/keymint/aidl/android/hardware/security/keymint/DeviceInfo.aidl)

    HAL](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/rkp/aidl/android/hardware/security/keymint/IRemotelyProvisionedComponent.aidl)

*   [ProtectedData](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/rkp/aidl/android/hardware/security/keymint/ProtectedData.aidl)

*   [MacedPublicKey](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/rkp/aidl/android/hardware/security/keymint/MacedPublicKey.aidl)

*   [RpcHardwareInfo](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/rkp/aidl/android/hardware/security/keymint/RpcHardwareInfo.aidl)

*   [DeviceInfo](https://cs.android.com/android/platform/superproject/+/master:hardware/interfaces/security/rkp/aidl/android/hardware/security/keymint/DeviceInfo.aidl)