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