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

Commit 46f99f4e authored by David Drysdale's avatar David Drysdale Committed by Gerrit Code Review
Browse files

Merge "KeyMint HALs: clarifications"

parents 2f2db81f 8d925aee

security/keymint/aidl/android/hardware/security/keymint/IKeyMintDevice.aidl

+20 −9
Original line number Original line Diff line number Diff line
@@ -336,6 +336,17 @@ interface IKeyMintDevice { 
     * Only Tag::KEY_SIZE is required to generate an 3DES key, and its value must be 168.  If

     * Only Tag::KEY_SIZE is required to generate an 3DES key, and its value must be 168.  If

     * omitted, generateKey must return ErrorCode::UNSUPPORTED_KEY_SIZE.

     * omitted, generateKey must return ErrorCode::UNSUPPORTED_KEY_SIZE.

     *

     *

     * == HMAC Keys ==

     *

     * Tag::KEY_SIZE must be provided to generate an HMAC key, and its value must be >= 64 and a

     * multiple of 8.  All devices must support key sizes up to 512 bits, but StrongBox devices must

     * not support key sizes larger than 512 bits.  If omitted or invalid, generateKey() must return

     * ErrorCode::UNSUPPORTED_KEY_SIZE.

     *

     * Tag::MIN_MAC_LENGTH must be provided, and must be a multiple of 8 in the range 64 to 512

     * bits (inclusive). If omitted, generateKey must return ErrorCode::MISSING_MIN_MAC_LENGTH; if

     * invalid, generateKey must return ErrorCode::UNSUPPORTED_MIN_MAC_LENGTH.

     *

     * @param keyParams Key generation parameters are defined as KeyMintDevice tag/value pairs,

     * @param keyParams Key generation parameters are defined as KeyMintDevice tag/value pairs,

     *        provided in params.  See above for detailed specifications of which tags are required

     *        provided in params.  See above for detailed specifications of which tags are required

     *        for which types of keys.

     *        for which types of keys.
@@ -661,19 +672,19 @@ interface IKeyMintDevice { 
     *   structure, because it cannot add the DigestInfo structure.  Instead, the IKeyMintDevice

     *   structure, because it cannot add the DigestInfo structure.  Instead, the IKeyMintDevice

     *   must construct 0x00 || 0x01 || PS || 0x00 || M, where M is the provided message and PS is a

     *   must construct 0x00 || 0x01 || PS || 0x00 || M, where M is the provided message and PS is a

     *   random padding string at least eight bytes in length.  The size of the RSA key has to be at

     *   random padding string at least eight bytes in length.  The size of the RSA key has to be at

     *   least 11 bytes larger than the message, otherwise begin() must return

     *   least 11 bytes larger than the message, otherwise finish() must return

     *   ErrorCode::INVALID_INPUT_LENGTH.

     *   ErrorCode::INVALID_INPUT_LENGTH.

     *

     *

     * o PaddingMode::RSA_PKCS1_1_1_5_ENCRYPT padding does not require a digest.

     * o PaddingMode::RSA_PKCS1_1_1_5_ENCRYPT padding does not require a digest.

     *

     *

     * o PaddingMode::RSA_PSS padding requires a digest, which must match one of the padding values

     * o PaddingMode::RSA_PSS padding requires a digest, which must match one of the digest values

     *   in the key authorizations, and which may not be Digest::NONE.  begin() must return

     *   in the key authorizations, and which may not be Digest::NONE.  begin() must return

     *   ErrorCode::INCOMPATIBLE_DIGEST if this is not the case.  In addition, the size of the RSA

     *   ErrorCode::INCOMPATIBLE_DIGEST if this is not the case.  In addition, the size of the RSA

     *   key must be at least 2 + D bytes larger than the output size of the digest, where D is the

     *   key must be at least (D + S + 9) bits, where D is the size of the digest (in bits) and

     *   size of the digest, in bytes.  Otherwise begin() must return

     *   S is the size of the salt (in bits).  The salt size S must equal D, so the RSA key must

     *   ErrorCode::INCOMPATIBLE_DIGEST.  The salt size must be D.

     *   be at least (2*D + 9) bits. Otherwise begin() must return ErrorCode::INCOMPATIBLE_DIGEST.

     *

     *

     * o PaddingMode::RSA_OAEP padding requires a digest, which must match one of the padding values

     * o PaddingMode::RSA_OAEP padding requires a digest, which must match one of the digest values

     *   in the key authorizations, and which may not be Digest::NONE.  begin() must return

     *   in the key authorizations, and which may not be Digest::NONE.  begin() must return

     *   ErrorCode::INCOMPATIBLE_DIGEST if this is not the case.  RSA_OAEP padding also requires an

     *   ErrorCode::INCOMPATIBLE_DIGEST if this is not the case.  RSA_OAEP padding also requires an

     *   MGF1 digest, specified with Tag::RSA_OAEP_MGF_DIGEST, which must match one of the MGF1

     *   MGF1 digest, specified with Tag::RSA_OAEP_MGF_DIGEST, which must match one of the MGF1
@@ -683,9 +694,9 @@ interface IKeyMintDevice { 
     *

     *

     * -- EC Keys --

     * -- EC Keys --

     *

     *

     * Private key operations (KeyPurpose::SIGN) need authorization of digest and padding, which

     * Private key operations (KeyPurpose::SIGN) need authorization of digest, which means that the

     * means that the key authorizations must contain the specified values.  If not, begin() must

     * key authorizations must contain the specified values.  If not, begin() must return

     * return ErrorCode::INCOMPATIBLE_DIGEST.

     * ErrorCode::INCOMPATIBLE_DIGEST.

     *

     *

     * -- AES Keys --

     * -- AES Keys --

     *

     *

security/keymint/aidl/android/hardware/security/keymint/KeyPurpose.aidl

+2 −2
Original line number Original line Diff line number Diff line
@@ -23,7 +23,7 @@ package android.hardware.security.keymint; 
@VintfStability

@VintfStability

@Backing(type="int")

@Backing(type="int")

enum KeyPurpose {

enum KeyPurpose {

    /* Usable with RSA, 3DES and AES keys. */

    /* Usable with 3DES and AES keys. */

    ENCRYPT = 0,

    ENCRYPT = 0,





    /* Usable with RSA, 3DES and AES keys. */

    /* Usable with RSA, 3DES and AES keys. */
@@ -32,7 +32,7 @@ enum KeyPurpose { 
    /* Usable with RSA, EC and HMAC keys. */

    /* Usable with RSA, EC and HMAC keys. */

    SIGN = 2,

    SIGN = 2,





    /* Usable with RSA, EC and HMAC keys. */

    /* Usable with HMAC keys. */

    VERIFY = 3,

    VERIFY = 3,





    /* 4 is reserved */

    /* 4 is reserved */

security/keymint/aidl/android/hardware/security/keymint/PaddingMode.aidl

+1 −1
Original line number Original line Diff line number Diff line
@@ -26,7 +26,7 @@ package android.hardware.security.keymint; 
@VintfStability

@VintfStability

@Backing(type="int")

@Backing(type="int")

enum PaddingMode {

enum PaddingMode {

    NONE = 1, /* deprecated */

    NONE = 1,

    RSA_OAEP = 2,

    RSA_OAEP = 2,

    RSA_PSS = 3,

    RSA_PSS = 3,

    RSA_PKCS1_1_5_ENCRYPT = 4,

    RSA_PKCS1_1_5_ENCRYPT = 4,

security/keymint/aidl/android/hardware/security/keymint/Tag.aidl

+10 −4
Original line number Original line Diff line number Diff line
@@ -186,10 +186,16 @@ enum Tag { 
     * Tag::RSA_OAEP_MGF_DIGEST specifies the MGF1 digest algorithms that may be used with RSA

     * Tag::RSA_OAEP_MGF_DIGEST specifies the MGF1 digest algorithms that may be used with RSA

     * encryption/decryption with OAEP padding.  Possible values are defined by the Digest enum.

     * encryption/decryption with OAEP padding.  Possible values are defined by the Digest enum.

     *

     *

     * This tag is repeatable for key generation/import.  RSA cipher operations with OAEP padding

     * This tag is repeatable for key generation/import.

     * must specify an MGF1 digest in the params argument of begin(). If this tag is missing or the

     *

     * specified digest is not in the MGF1 digests associated with the key then begin operation must

     * If the caller specifies an MGF1 digest in the params argument of begin(), that digest must be

     * fail with ErrorCode::INCOMPATIBLE_MGF_DIGEST.

     * present as an RSA_OAEP_MGF_DIGEST value in the key characteristics (or the begin() operation

     * must fail with ErrorCode::INCOMPATIBLE_MGF_DIGEST).

     *

     * If the caller does not specify an MGF1 digest in the params argument of begin(), a default

     * MGF1 digest of SHA1 is used.  If the key characteristics have any explicitly specified values

     * for RSA_OAEP_MGF_DIGEST, then SHA1 must be included (or the begin() operation must fail with

     * ErrorCode::INCOMPATIBLE_MGF_DIGEST).

     *

     *

     * Must be hardware-enforced.

     * Must be hardware-enforced.

     */

     */

security/sharedsecret/aidl/android/hardware/security/sharedsecret/SharedSecretParameters.aidl

+3 −3
Original line number Original line Diff line number Diff line
@@ -33,9 +33,9 @@ parcelable SharedSecretParameters { 
    byte[] seed;

    byte[] seed;





    /**

    /**

     * A 32-byte value which is guaranteed to be different each time

     * A 32-byte value which is guaranteed to be different each time getSharedSecretParameters() is

     * getSharedSecretParameters() is called.  Probabilistic uniqueness (i.e. random) is acceptable,

     * called after a restart.  Probabilistic uniqueness (i.e. random) is acceptable, though a

     * though a stronger uniqueness guarantee (e.g. counter) is recommended where possible.

     * stronger uniqueness guarantee (e.g. counter) is recommended where possible.

     */

     */

    byte[] nonce;

    byte[] nonce;

}
 
}