1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/*
* Copyright (C) 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.security;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.os.RemoteException;
import android.os.ServiceManager;
import android.os.ServiceSpecificException;
import android.os.StrictMode;
import android.security.maintenance.IKeystoreMaintenance;
import android.system.keystore2.Domain;
import android.system.keystore2.KeyDescriptor;
import android.system.keystore2.ResponseCode;
import android.util.Log;
/**
* @hide This is the client side for IKeystoreUserManager AIDL.
* It shall only be used by the LockSettingsService.
*/
public class AndroidKeyStoreMaintenance {
private static final String TAG = "AndroidKeyStoreMaintenance";
public static final int SYSTEM_ERROR = ResponseCode.SYSTEM_ERROR;
public static final int INVALID_ARGUMENT = ResponseCode.INVALID_ARGUMENT;
public static final int PERMISSION_DENIED = ResponseCode.PERMISSION_DENIED;
public static final int KEY_NOT_FOUND = ResponseCode.KEY_NOT_FOUND;
private static IKeystoreMaintenance getService() {
return IKeystoreMaintenance.Stub.asInterface(
ServiceManager.checkService("android.security.maintenance"));
}
/**
* Informs Keystore 2.0 about adding a user
*
* @param userId - Android user id of the user being added
* @return 0 if successful or a {@code ResponseCode}
* @hide
*/
public static int onUserAdded(@NonNull int userId) {
try {
getService().onUserAdded(userId);
return 0;
} catch (ServiceSpecificException e) {
Log.e(TAG, "onUserAdded failed", e);
return e.errorCode;
} catch (Exception e) {
Log.e(TAG, "Can not connect to keystore", e);
return SYSTEM_ERROR;
}
}
/**
* Informs Keystore 2.0 about removing a usergit mer
*
* @param userId - Android user id of the user being removed
* @return 0 if successful or a {@code ResponseCode}
* @hide
*/
public static int onUserRemoved(int userId) {
try {
getService().onUserRemoved(userId);
return 0;
} catch (ServiceSpecificException e) {
Log.e(TAG, "onUserRemoved failed", e);
return e.errorCode;
} catch (Exception e) {
Log.e(TAG, "Can not connect to keystore", e);
return SYSTEM_ERROR;
}
}
/**
* Informs Keystore 2.0 about changing user's password
*
* @param userId - Android user id of the user
* @param password - a secret derived from the synthetic password provided by the
* LockSettingService
* @return 0 if successful or a {@code ResponseCode}
* @hide
*/
public static int onUserPasswordChanged(int userId, @Nullable byte[] password) {
try {
getService().onUserPasswordChanged(userId, password);
return 0;
} catch (ServiceSpecificException e) {
Log.e(TAG, "onUserPasswordChanged failed", e);
return e.errorCode;
} catch (Exception e) {
Log.e(TAG, "Can not connect to keystore", e);
return SYSTEM_ERROR;
}
}
/**
* Informs Keystore 2.0 that an app was uninstalled and the corresponding namspace is to
* be cleared.
*/
public static int clearNamespace(@Domain int domain, long namespace) {
try {
getService().clearNamespace(domain, namespace);
return 0;
} catch (ServiceSpecificException e) {
Log.e(TAG, "clearNamespace failed", e);
return e.errorCode;
} catch (Exception e) {
Log.e(TAG, "Can not connect to keystore", e);
return SYSTEM_ERROR;
}
}
/**
* Queries user state from Keystore 2.0.
*
* @param userId - Android user id of the user.
* @return UserState enum variant as integer if successful or an error
*/
public static int getState(int userId) {
try {
return getService().getState(userId);
} catch (ServiceSpecificException e) {
Log.e(TAG, "getState failed", e);
return e.errorCode;
} catch (Exception e) {
Log.e(TAG, "Can not connect to keystore", e);
return SYSTEM_ERROR;
}
}
/**
* Informs Keystore 2.0 that an off body event was detected.
*/
public static void onDeviceOffBody() {
try {
getService().onDeviceOffBody();
} catch (Exception e) {
// TODO This fails open. This is not a regression with respect to keystore1 but it
// should get fixed.
Log.e(TAG, "Error while reporting device off body event.", e);
}
}
/**
* Migrates a key given by the source descriptor to the location designated by the destination
* descriptor.
*
* @param source - The key to migrate may be specified by Domain.APP, Domain.SELINUX, or
* Domain.KEY_ID. The caller needs the permissions use, delete, and grant for the
* source namespace.
* @param destination - The new designation for the key may be specified by Domain.APP or
* Domain.SELINUX. The caller need the permission rebind for the destination
* namespace.
*
* @return * 0 on success
* * KEY_NOT_FOUND if the source did not exists.
* * PERMISSION_DENIED if any of the required permissions was missing.
* * INVALID_ARGUMENT if the destination was occupied or any domain value other than
* the allowed once were specified.
* * SYSTEM_ERROR if an unexpected error occurred.
*/
public static int migrateKeyNamespace(KeyDescriptor source, KeyDescriptor destination) {
try {
getService().migrateKeyNamespace(source, destination);
return 0;
} catch (ServiceSpecificException e) {
Log.e(TAG, "migrateKeyNamespace failed", e);
return e.errorCode;
} catch (Exception e) {
Log.e(TAG, "Can not connect to keystore", e);
return SYSTEM_ERROR;
}
}
/**
* Deletes all keys in all KeyMint devices.
* Called by RecoverySystem before rebooting to recovery in order to delete all KeyMint keys,
* including synthetic password protector keys (used by LockSettingsService), as well as keys
* protecting DE and metadata encryption keys (used by vold). This ensures that FBE-encrypted
* data is unrecoverable even if the data wipe in recovery is interrupted or skipped.
*/
public static void deleteAllKeys() throws KeyStoreException {
StrictMode.noteDiskWrite();
try {
getService().deleteAllKeys();
} catch (RemoteException | NullPointerException e) {
throw new KeyStoreException(SYSTEM_ERROR,
"Failure to connect to Keystore while trying to delete all keys.");
} catch (ServiceSpecificException e) {
throw new KeyStoreException(e.errorCode,
"Keystore error while trying to delete all keys.");
}
}
}
|
