blob: 73a9e1d0133866d19e93fa6ec91cb32bf00e2735 [file] [log] [blame]
/*
* 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.
*/
#ifndef DRM_HAL_HIDL_H_
#define DRM_HAL_HIDL_H_
#include <android/hardware/drm/1.2/IDrmFactory.h>
#include <android/hardware/drm/1.2/IDrmPlugin.h>
#include <android/hardware/drm/1.2/IDrmPluginListener.h>
#include <android/hardware/drm/1.4/IDrmPlugin.h>
#include <android/hardware/drm/1.4/types.h>
#include <media/drm/DrmAPI.h>
#include <mediadrm/DrmMetrics.h>
#include <mediadrm/DrmSessionManager.h>
#include <mediadrm/DrmStatus.h>
#include <mediadrm/IDrm.h>
#include <mediadrm/IDrmClient.h>
#include <mediadrm/IDrmMetricsConsumer.h>
#include <utils/threads.h>
namespace drm = ::android::hardware::drm;
using drm::V1_0::EventType;
using drm::V1_0::IDrmFactory;
using drm::V1_0::IDrmPlugin;
using drm::V1_0::IDrmPluginListener;
using drm::V1_1::SecurityLevel;
using drm::V1_2::KeyStatus;
using drm::V1_2::OfflineLicenseState;
using ::android::hardware::hidl_vec;
using ::android::hardware::Return;
using ::android::hardware::Void;
typedef drm::V1_2::IDrmPluginListener IDrmPluginListener_V1_2;
typedef drm::V1_0::KeyStatus KeyStatus_V1_0;
namespace android {
struct DrmSessionClientInterface;
inline bool operator==(const Vector<uint8_t> &l, const Vector<uint8_t> &r) {
if (l.size() != r.size()) return false;
return memcmp(l.array(), r.array(), l.size()) == 0;
}
struct DrmHalHidl : public IDrm,
public IDrmPluginListener_V1_2 {
struct DrmSessionClient;
DrmHalHidl();
virtual ~DrmHalHidl();
virtual DrmStatus initCheck() const;
virtual DrmStatus isCryptoSchemeSupported(const uint8_t uuid[16], const String8& mimeType,
DrmPlugin::SecurityLevel level, bool* isSupported);
virtual DrmStatus createPlugin(const uint8_t uuid[16],
const String8 &appPackageName);
virtual DrmStatus destroyPlugin();
virtual DrmStatus openSession(DrmPlugin::SecurityLevel level,
Vector<uint8_t> &sessionId);
virtual DrmStatus closeSession(Vector<uint8_t> const &sessionId);
virtual DrmStatus
getKeyRequest(Vector<uint8_t> const &sessionId,
Vector<uint8_t> const &initData,
String8 const &mimeType, DrmPlugin::KeyType keyType,
KeyedVector<String8, String8> const &optionalParameters,
Vector<uint8_t> &request, String8 &defaultUrl,
DrmPlugin::KeyRequestType *keyRequestType);
virtual DrmStatus provideKeyResponse(Vector<uint8_t> const &sessionId,
Vector<uint8_t> const &response,
Vector<uint8_t> &keySetId);
virtual DrmStatus removeKeys(Vector<uint8_t> const &keySetId);
virtual DrmStatus restoreKeys(Vector<uint8_t> const &sessionId,
Vector<uint8_t> const &keySetId);
virtual DrmStatus queryKeyStatus(Vector<uint8_t> const &sessionId,
KeyedVector<String8, String8> &infoMap) const;
virtual DrmStatus getProvisionRequest(String8 const &certType,
String8 const &certAuthority,
Vector<uint8_t> &request,
String8 &defaultUrl);
virtual DrmStatus provideProvisionResponse(Vector<uint8_t> const &response,
Vector<uint8_t> &certificate,
Vector<uint8_t> &wrappedKey);
virtual DrmStatus getSecureStops(List<Vector<uint8_t>> &secureStops);
virtual DrmStatus getSecureStopIds(List<Vector<uint8_t>> &secureStopIds);
virtual DrmStatus getSecureStop(Vector<uint8_t> const &ssid, Vector<uint8_t> &secureStop);
virtual DrmStatus releaseSecureStops(Vector<uint8_t> const &ssRelease);
virtual DrmStatus removeSecureStop(Vector<uint8_t> const &ssid);
virtual DrmStatus removeAllSecureStops();
virtual DrmStatus getHdcpLevels(DrmPlugin::HdcpLevel *connectedLevel,
DrmPlugin::HdcpLevel *maxLevel) const;
virtual DrmStatus getNumberOfSessions(uint32_t *currentSessions,
uint32_t *maxSessions) const;
virtual DrmStatus getSecurityLevel(Vector<uint8_t> const &sessionId,
DrmPlugin::SecurityLevel *level) const;
virtual DrmStatus getOfflineLicenseKeySetIds(List<Vector<uint8_t>> &keySetIds) const;
virtual DrmStatus removeOfflineLicense(Vector<uint8_t> const &keySetId);
virtual DrmStatus getOfflineLicenseState(Vector<uint8_t> const &keySetId,
DrmPlugin::OfflineLicenseState *licenseState) const;
virtual DrmStatus getPropertyString(String8 const &name, String8 &value ) const;
virtual DrmStatus getPropertyByteArray(String8 const &name,
Vector<uint8_t> &value ) const;
virtual DrmStatus setPropertyString(String8 const &name, String8 const &value ) const;
virtual DrmStatus setPropertyByteArray(String8 const &name,
Vector<uint8_t> const &value ) const;
virtual DrmStatus getMetrics(const sp<IDrmMetricsConsumer> &consumer);
virtual DrmStatus setCipherAlgorithm(Vector<uint8_t> const &sessionId,
String8 const &algorithm);
virtual DrmStatus setMacAlgorithm(Vector<uint8_t> const &sessionId,
String8 const &algorithm);
virtual DrmStatus encrypt(Vector<uint8_t> const &sessionId,
Vector<uint8_t> const &keyId,
Vector<uint8_t> const &input,
Vector<uint8_t> const &iv,
Vector<uint8_t> &output);
virtual DrmStatus decrypt(Vector<uint8_t> const &sessionId,
Vector<uint8_t> const &keyId,
Vector<uint8_t> const &input,
Vector<uint8_t> const &iv,
Vector<uint8_t> &output);
virtual DrmStatus sign(Vector<uint8_t> const &sessionId,
Vector<uint8_t> const &keyId,
Vector<uint8_t> const &message,
Vector<uint8_t> &signature);
virtual DrmStatus verify(Vector<uint8_t> const &sessionId,
Vector<uint8_t> const &keyId,
Vector<uint8_t> const &message,
Vector<uint8_t> const &signature,
bool &match);
virtual DrmStatus signRSA(Vector<uint8_t> const &sessionId,
String8 const &algorithm,
Vector<uint8_t> const &message,
Vector<uint8_t> const &wrappedKey,
Vector<uint8_t> &signature);
virtual DrmStatus setListener(const sp<IDrmClient>& listener);
virtual DrmStatus requiresSecureDecoder(const char *mime, bool *required) const;
virtual DrmStatus requiresSecureDecoder(const char *mime,
DrmPlugin::SecurityLevel securityLevel,
bool *required) const;
virtual DrmStatus setPlaybackId(
Vector<uint8_t> const &sessionId,
const char *playbackId);
virtual DrmStatus getLogMessages(Vector<drm::V1_4::LogMessage> &logs) const;
virtual DrmStatus getSupportedSchemes(std::vector<uint8_t> &schemes) const;
// Methods of IDrmPluginListener
Return<void> sendEvent(EventType eventType,
const hidl_vec<uint8_t>& sessionId, const hidl_vec<uint8_t>& data);
Return<void> sendExpirationUpdate(const hidl_vec<uint8_t>& sessionId,
int64_t expiryTimeInMS);
Return<void> sendKeysChange(const hidl_vec<uint8_t>& sessionId,
const hidl_vec<KeyStatus_V1_0>& keyStatusList, bool hasNewUsableKey);
Return<void> sendKeysChange_1_2(const hidl_vec<uint8_t>& sessionId,
const hidl_vec<KeyStatus>& keyStatusList, bool hasNewUsableKey);
Return<void> sendSessionLostState(const hidl_vec<uint8_t>& sessionId);
private:
static Mutex mLock;
sp<IDrmClient> mListener;
mutable Mutex mEventLock;
mutable Mutex mNotifyLock;
const std::vector<sp<IDrmFactory>> mFactories;
sp<IDrmPlugin> mPlugin;
sp<drm::V1_1::IDrmPlugin> mPluginV1_1;
sp<drm::V1_2::IDrmPlugin> mPluginV1_2;
sp<drm::V1_4::IDrmPlugin> mPluginV1_4;
String8 mAppPackageName;
// Mutable to allow modification within GetPropertyByteArray.
mutable MediaDrmMetrics mMetrics;
std::vector<std::shared_ptr<DrmSessionClient>> mOpenSessions;
void closeOpenSessions();
void cleanup();
/**
* mInitCheck is:
* NO_INIT if a plugin hasn't been created yet
* ERROR_UNSUPPORTED if a plugin can't be created for the uuid
* OK after a plugin has been created and mPlugin is valid
*/
status_t mInitCheck;
std::vector<sp<IDrmFactory>> makeDrmFactories();
sp<IDrmPlugin> makeDrmPlugin(const sp<IDrmFactory>& factory,
const uint8_t uuid[16], const String8& appPackageName);
void writeByteArray(Parcel &obj, const hidl_vec<uint8_t>& array);
std::string reportPluginMetrics() const;
std::string reportFrameworkMetrics(const std::string& pluginMetrics) const;
DrmStatus getPropertyStringInternal(String8 const &name, String8 &value) const;
DrmStatus getPropertyByteArrayInternal(String8 const &name,
Vector<uint8_t> &value) const;
DrmStatus matchMimeTypeAndSecurityLevel(const sp<IDrmFactory> &factory,
const uint8_t uuid[16],
const String8 &mimeType,
DrmPlugin::SecurityLevel level,
bool *isSupported);
DISALLOW_EVIL_CONSTRUCTORS(DrmHalHidl);
};
} // namespace android
#endif // DRM_HAL_HIDL_H_