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