1 /*
2  * Copyright (C) 2012 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 
19 // clang-format off
20 
21 #define KEYMASTER_PORT "com.android.trusty.keymaster"
22 #define KEYMASTER_MAX_BUFFER_LENGTH 4096
23 
24 // Commands
25 enum keymaster_command : uint32_t {
26     KEYMASTER_RESP_BIT              = 1,
27     KEYMASTER_STOP_BIT              = 2,
28     KEYMASTER_REQ_SHIFT             = 2,
29 
30     KM_GENERATE_KEY                 = (0 << KEYMASTER_REQ_SHIFT),
31     KM_BEGIN_OPERATION              = (1 << KEYMASTER_REQ_SHIFT),
32     KM_UPDATE_OPERATION             = (2 << KEYMASTER_REQ_SHIFT),
33     KM_FINISH_OPERATION             = (3 << KEYMASTER_REQ_SHIFT),
34     KM_ABORT_OPERATION              = (4 << KEYMASTER_REQ_SHIFT),
35     KM_IMPORT_KEY                   = (5 << KEYMASTER_REQ_SHIFT),
36     KM_EXPORT_KEY                   = (6 << KEYMASTER_REQ_SHIFT),
37     KM_GET_VERSION                  = (7 << KEYMASTER_REQ_SHIFT),
38     KM_ADD_RNG_ENTROPY              = (8 << KEYMASTER_REQ_SHIFT),
39     KM_GET_SUPPORTED_ALGORITHMS     = (9 << KEYMASTER_REQ_SHIFT),
40     KM_GET_SUPPORTED_BLOCK_MODES    = (10 << KEYMASTER_REQ_SHIFT),
41     KM_GET_SUPPORTED_PADDING_MODES  = (11 << KEYMASTER_REQ_SHIFT),
42     KM_GET_SUPPORTED_DIGESTS        = (12 << KEYMASTER_REQ_SHIFT),
43     KM_GET_SUPPORTED_IMPORT_FORMATS = (13 << KEYMASTER_REQ_SHIFT),
44     KM_GET_SUPPORTED_EXPORT_FORMATS = (14 << KEYMASTER_REQ_SHIFT),
45     KM_GET_KEY_CHARACTERISTICS      = (15 << KEYMASTER_REQ_SHIFT),
46     KM_ATTEST_KEY                   = (16 << KEYMASTER_REQ_SHIFT),
47     KM_UPGRADE_KEY                  = (17 << KEYMASTER_REQ_SHIFT),
48     KM_CONFIGURE                    = (18 << KEYMASTER_REQ_SHIFT),
49     KM_GET_HMAC_SHARING_PARAMETERS  = (19 << KEYMASTER_REQ_SHIFT),
50     KM_COMPUTE_SHARED_HMAC          = (20 << KEYMASTER_REQ_SHIFT),
51     KM_VERIFY_AUTHORIZATION         = (21 << KEYMASTER_REQ_SHIFT),
52     KM_DELETE_KEY                   = (22 << KEYMASTER_REQ_SHIFT),
53     KM_DELETE_ALL_KEYS              = (23 << KEYMASTER_REQ_SHIFT),
54     KM_DESTROY_ATTESTATION_IDS      = (24 << KEYMASTER_REQ_SHIFT),
55     KM_IMPORT_WRAPPED_KEY           = (25 << KEYMASTER_REQ_SHIFT),
56     KM_GET_VERSION_2                = (28 << KEYMASTER_REQ_SHIFT),
57     KM_EARLY_BOOT_ENDED             = (29 << KEYMASTER_REQ_SHIFT),
58     KM_DEVICE_LOCKED                = (30 << KEYMASTER_REQ_SHIFT),
59     KM_GENERATE_RKP_KEY             = (31 << KEYMASTER_REQ_SHIFT),
60     KM_GENERATE_CSR                 = (32 << KEYMASTER_REQ_SHIFT),
61     KM_CONFIGURE_VENDOR_PATCHLEVEL  = (33 << KEYMASTER_REQ_SHIFT),
62 
63     // Bootloader/provisioning calls.
64     KM_SET_BOOT_PARAMS = (0x1000 << KEYMASTER_REQ_SHIFT),
65     KM_SET_ATTESTATION_KEY = (0x2000 << KEYMASTER_REQ_SHIFT),
66     KM_APPEND_ATTESTATION_CERT_CHAIN = (0x3000 << KEYMASTER_REQ_SHIFT),
67     KM_ATAP_GET_CA_REQUEST = (0x4000 << KEYMASTER_REQ_SHIFT),
68     KM_ATAP_SET_CA_RESPONSE_BEGIN = (0x5000 << KEYMASTER_REQ_SHIFT),
69     KM_ATAP_SET_CA_RESPONSE_UPDATE = (0x6000 << KEYMASTER_REQ_SHIFT),
70     KM_ATAP_SET_CA_RESPONSE_FINISH = (0x7000 << KEYMASTER_REQ_SHIFT),
71     KM_ATAP_READ_UUID = (0x8000 << KEYMASTER_REQ_SHIFT),
72     KM_SET_PRODUCT_ID = (0x9000 << KEYMASTER_REQ_SHIFT),
73     KM_CLEAR_ATTESTATION_CERT_CHAIN = (0xa000 << KEYMASTER_REQ_SHIFT),
74     KM_SET_WRAPPED_ATTESTATION_KEY = (0xb000 << KEYMASTER_REQ_SHIFT),
75     KM_SET_ATTESTATION_IDS = (0xc000 << KEYMASTER_REQ_SHIFT),
76     KM_CONFIGURE_BOOT_PATCHLEVEL = (0xd000 << KEYMASTER_REQ_SHIFT),
77 };
78 
79 #ifdef __ANDROID__
80 
81 /**
82  * keymaster_message - Serial header for communicating with KM server
83  * @cmd: the command, one of keymaster_command.
84  * @payload: start of the serialized command specific payload
85  */
86 struct keymaster_message {
87     uint32_t cmd;
88     uint8_t payload[0];
89 };
90 
91 #endif
92