Gitiles
Code Review Sign In
gerrit.omnirom.org / android_frameworks_av / 6605add70e438b7392c10cd42bd2bad954b3df3e / . / drm / libmediadrm / include / mediadrm / DrmHalHidl.h
blob: 91dc700b8a427b2f86306539ccd62e7b6b3e8d67 [file] [log] [blame]
Kyle Zhang6605add2022-01-13 17:51:23 +0000[diff] [blame^]1/*
2 * Copyright (C) 2021 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#ifndef DRM_HAL_HIDL_H_
18#define DRM_HAL_HIDL_H_
19
20#include <android/hardware/drm/1.0/IDrmFactory.h>
21#include <android/hardware/drm/1.0/IDrmPlugin.h>
22#include <android/hardware/drm/1.1/IDrmFactory.h>
23#include <android/hardware/drm/1.1/IDrmPlugin.h>
24#include <android/hardware/drm/1.2/IDrmFactory.h>
25#include <android/hardware/drm/1.2/IDrmPlugin.h>
26#include <android/hardware/drm/1.2/IDrmPluginListener.h>
27#include <android/hardware/drm/1.4/IDrmPlugin.h>
28#include <android/hardware/drm/1.4/types.h>
29
30#include <media/drm/DrmAPI.h>
31#include <mediadrm/DrmMetrics.h>
32#include <mediadrm/DrmSessionManager.h>
33#include <mediadrm/IDrm.h>
34#include <mediadrm/IDrmClient.h>
35#include <mediadrm/IDrmMetricsConsumer.h>
36#include <utils/threads.h>
37
38namespace drm = ::android::hardware::drm;
39using drm::V1_0::EventType;
40using drm::V1_0::IDrmFactory;
41using drm::V1_0::IDrmPlugin;
42using drm::V1_0::IDrmPluginListener;
43using drm::V1_1::SecurityLevel;
44using drm::V1_2::KeyStatus;
45using drm::V1_2::OfflineLicenseState;
46using ::android::hardware::hidl_vec;
47using ::android::hardware::Return;
48using ::android::hardware::Void;
49
50typedef drm::V1_2::IDrmPluginListener IDrmPluginListener_V1_2;
51typedef drm::V1_0::KeyStatus KeyStatus_V1_0;
52
53namespace android {
54
55struct DrmSessionClientInterface;
56
57inline bool operator==(const Vector<uint8_t> &l, const Vector<uint8_t> &r) {
58 if (l.size() != r.size()) return false;
59 return memcmp(l.array(), r.array(), l.size()) == 0;
60}
61
62struct DrmHalHidl : public IDrm,
63 public IDrmPluginListener_V1_2 {
64
65 struct DrmSessionClient;
66
67 DrmHalHidl();
68 virtual ~DrmHalHidl();
69
70 virtual status_t initCheck() const;
71
72 virtual status_t isCryptoSchemeSupported(const uint8_t uuid[16],
73 const String8& mimeType,
74 DrmPlugin::SecurityLevel level,
75 bool *isSupported);
76
77 virtual status_t createPlugin(const uint8_t uuid[16],
78 const String8 &appPackageName);
79
80 virtual status_t destroyPlugin();
81
82 virtual status_t openSession(DrmPlugin::SecurityLevel level,
83 Vector<uint8_t> &sessionId);
84
85 virtual status_t closeSession(Vector<uint8_t> const &sessionId);
86
87 virtual status_t
88 getKeyRequest(Vector<uint8_t> const &sessionId,
89 Vector<uint8_t> const &initData,
90 String8 const &mimeType, DrmPlugin::KeyType keyType,
91 KeyedVector<String8, String8> const &optionalParameters,
92 Vector<uint8_t> &request, String8 &defaultUrl,
93 DrmPlugin::KeyRequestType *keyRequestType);
94
95 virtual status_t provideKeyResponse(Vector<uint8_t> const &sessionId,
96 Vector<uint8_t> const &response,
97 Vector<uint8_t> &keySetId);
98
99 virtual status_t removeKeys(Vector<uint8_t> const &keySetId);
100
101 virtual status_t restoreKeys(Vector<uint8_t> const &sessionId,
102 Vector<uint8_t> const &keySetId);
103
104 virtual status_t queryKeyStatus(Vector<uint8_t> const &sessionId,
105 KeyedVector<String8, String8> &infoMap) const;
106
107 virtual status_t getProvisionRequest(String8 const &certType,
108 String8 const &certAuthority,
109 Vector<uint8_t> &request,
110 String8 &defaultUrl);
111
112 virtual status_t provideProvisionResponse(Vector<uint8_t> const &response,
113 Vector<uint8_t> &certificate,
114 Vector<uint8_t> &wrappedKey);
115
116 virtual status_t getSecureStops(List<Vector<uint8_t>> &secureStops);
117 virtual status_t getSecureStopIds(List<Vector<uint8_t>> &secureStopIds);
118 virtual status_t getSecureStop(Vector<uint8_t> const &ssid, Vector<uint8_t> &secureStop);
119
120 virtual status_t releaseSecureStops(Vector<uint8_t> const &ssRelease);
121 virtual status_t removeSecureStop(Vector<uint8_t> const &ssid);
122 virtual status_t removeAllSecureStops();
123
124 virtual status_t getHdcpLevels(DrmPlugin::HdcpLevel *connectedLevel,
125 DrmPlugin::HdcpLevel *maxLevel) const;
126 virtual status_t getNumberOfSessions(uint32_t *currentSessions,
127 uint32_t *maxSessions) const;
128 virtual status_t getSecurityLevel(Vector<uint8_t> const &sessionId,
129 DrmPlugin::SecurityLevel *level) const;
130
131 virtual status_t getOfflineLicenseKeySetIds(List<Vector<uint8_t>> &keySetIds) const;
132 virtual status_t removeOfflineLicense(Vector<uint8_t> const &keySetId);
133 virtual status_t getOfflineLicenseState(Vector<uint8_t> const &keySetId,
134 DrmPlugin::OfflineLicenseState *licenseState) const;
135
136 virtual status_t getPropertyString(String8 const &name, String8 &value ) const;
137 virtual status_t getPropertyByteArray(String8 const &name,
138 Vector<uint8_t> &value ) const;
139 virtual status_t setPropertyString(String8 const &name, String8 const &value ) const;
140 virtual status_t setPropertyByteArray(String8 const &name,
141 Vector<uint8_t> const &value ) const;
142 virtual status_t getMetrics(const sp<IDrmMetricsConsumer> &consumer);
143
144 virtual status_t setCipherAlgorithm(Vector<uint8_t> const &sessionId,
145 String8 const &algorithm);
146
147 virtual status_t setMacAlgorithm(Vector<uint8_t> const &sessionId,
148 String8 const &algorithm);
149
150 virtual status_t encrypt(Vector<uint8_t> const &sessionId,
151 Vector<uint8_t> const &keyId,
152 Vector<uint8_t> const &input,
153 Vector<uint8_t> const &iv,
154 Vector<uint8_t> &output);
155
156 virtual status_t decrypt(Vector<uint8_t> const &sessionId,
157 Vector<uint8_t> const &keyId,
158 Vector<uint8_t> const &input,
159 Vector<uint8_t> const &iv,
160 Vector<uint8_t> &output);
161
162 virtual status_t sign(Vector<uint8_t> const &sessionId,
163 Vector<uint8_t> const &keyId,
164 Vector<uint8_t> const &message,
165 Vector<uint8_t> &signature);
166
167 virtual status_t verify(Vector<uint8_t> const &sessionId,
168 Vector<uint8_t> const &keyId,
169 Vector<uint8_t> const &message,
170 Vector<uint8_t> const &signature,
171 bool &match);
172
173 virtual status_t signRSA(Vector<uint8_t> const &sessionId,
174 String8 const &algorithm,
175 Vector<uint8_t> const &message,
176 Vector<uint8_t> const &wrappedKey,
177 Vector<uint8_t> &signature);
178
179 virtual status_t setListener(const sp<IDrmClient>& listener);
180
181 virtual status_t requiresSecureDecoder(const char *mime, bool *required) const;
182
183 virtual status_t requiresSecureDecoder(const char *mime, DrmPlugin::SecurityLevel securityLevel,
184 bool *required) const;
185
186 virtual status_t setPlaybackId(
187 Vector<uint8_t> const &sessionId,
188 const char *playbackId);
189
190 virtual status_t getLogMessages(Vector<drm::V1_4::LogMessage> &logs) const;
191
192 // Methods of IDrmPluginListener
193 Return<void> sendEvent(EventType eventType,
194 const hidl_vec<uint8_t>& sessionId, const hidl_vec<uint8_t>& data);
195
196 Return<void> sendExpirationUpdate(const hidl_vec<uint8_t>& sessionId,
197 int64_t expiryTimeInMS);
198
199 Return<void> sendKeysChange(const hidl_vec<uint8_t>& sessionId,
200 const hidl_vec<KeyStatus_V1_0>& keyStatusList, bool hasNewUsableKey);
201
202 Return<void> sendKeysChange_1_2(const hidl_vec<uint8_t>& sessionId,
203 const hidl_vec<KeyStatus>& keyStatusList, bool hasNewUsableKey);
204
205 Return<void> sendSessionLostState(const hidl_vec<uint8_t>& sessionId);
206
207private:
208 static Mutex mLock;
209
210 sp<IDrmClient> mListener;
211 mutable Mutex mEventLock;
212 mutable Mutex mNotifyLock;
213
214 const std::vector<sp<IDrmFactory>> mFactories;
215 sp<IDrmPlugin> mPlugin;
216 sp<drm::V1_1::IDrmPlugin> mPluginV1_1;
217 sp<drm::V1_2::IDrmPlugin> mPluginV1_2;
218 sp<drm::V1_4::IDrmPlugin> mPluginV1_4;
219 String8 mAppPackageName;
220
221 // Mutable to allow modification within GetPropertyByteArray.
222 mutable MediaDrmMetrics mMetrics;
223
224 std::vector<std::shared_ptr<DrmSessionClient>> mOpenSessions;
225 void closeOpenSessions();
226 void cleanup();
227
228 /**
229 * mInitCheck is:
230 * NO_INIT if a plugin hasn't been created yet
231 * ERROR_UNSUPPORTED if a plugin can't be created for the uuid
232 * OK after a plugin has been created and mPlugin is valid
233 */
234 status_t mInitCheck;
235
236 std::vector<sp<IDrmFactory>> makeDrmFactories();
237 sp<IDrmPlugin> makeDrmPlugin(const sp<IDrmFactory>& factory,
238 const uint8_t uuid[16], const String8& appPackageName);
239
240 void writeByteArray(Parcel &obj, const hidl_vec<uint8_t>& array);
241
242 std::string reportPluginMetrics() const;
243 std::string reportFrameworkMetrics(const std::string& pluginMetrics) const;
244 status_t getPropertyStringInternal(String8 const &name, String8 &value) const;
245 status_t getPropertyByteArrayInternal(String8 const &name,
246 Vector<uint8_t> &value) const;
247 status_t matchMimeTypeAndSecurityLevel(const sp<IDrmFactory> &factory,
248 const uint8_t uuid[16],
249 const String8 &mimeType,
250 DrmPlugin::SecurityLevel level,
251 bool *isSupported);
252
253 DISALLOW_EVIL_CONSTRUCTORS(DrmHalHidl);
254};
255
256} // namespace android
257
258#endif // DRM_HAL_H_