xref: /aosp_15_r20/hardware/interfaces/drm/1.0/default/DrmPlugin.h (revision 4d7e907c777eeecc4c5bd7cf640a754fac206ff7)
1*4d7e907cSAndroid Build Coastguard Worker /*
2*4d7e907cSAndroid Build Coastguard Worker  * Copyright (C) 2016 The Android Open Source Project
3*4d7e907cSAndroid Build Coastguard Worker  *
4*4d7e907cSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*4d7e907cSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*4d7e907cSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*4d7e907cSAndroid Build Coastguard Worker  *
8*4d7e907cSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*4d7e907cSAndroid Build Coastguard Worker  *
10*4d7e907cSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*4d7e907cSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*4d7e907cSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*4d7e907cSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*4d7e907cSAndroid Build Coastguard Worker  * limitations under the License.
15*4d7e907cSAndroid Build Coastguard Worker  */
16*4d7e907cSAndroid Build Coastguard Worker 
17*4d7e907cSAndroid Build Coastguard Worker #ifndef ANDROID_HARDWARE_DRM_V1_0__DRMPLUGIN_H
18*4d7e907cSAndroid Build Coastguard Worker #define ANDROID_HARDWARE_DRM_V1_0__DRMPLUGIN_H
19*4d7e907cSAndroid Build Coastguard Worker 
20*4d7e907cSAndroid Build Coastguard Worker #include <android/hardware/drm/1.0/IDrmPlugin.h>
21*4d7e907cSAndroid Build Coastguard Worker #include <android/hardware/drm/1.0/IDrmPluginListener.h>
22*4d7e907cSAndroid Build Coastguard Worker #include <hidl/Status.h>
23*4d7e907cSAndroid Build Coastguard Worker #include <media/drm/DrmAPI.h>
24*4d7e907cSAndroid Build Coastguard Worker 
25*4d7e907cSAndroid Build Coastguard Worker namespace android {
26*4d7e907cSAndroid Build Coastguard Worker namespace hardware {
27*4d7e907cSAndroid Build Coastguard Worker namespace drm {
28*4d7e907cSAndroid Build Coastguard Worker namespace V1_0 {
29*4d7e907cSAndroid Build Coastguard Worker namespace implementation {
30*4d7e907cSAndroid Build Coastguard Worker 
31*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::drm::V1_0::EventType;
32*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::drm::V1_0::IDrmPlugin;
33*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::drm::V1_0::IDrmPluginListener;
34*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::drm::V1_0::KeyRequestType;
35*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::drm::V1_0::KeyStatus;
36*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::drm::V1_0::KeyType;
37*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::drm::V1_0::KeyValue;
38*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::drm::V1_0::SecureStop;
39*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_array;
40*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_string;
41*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::hidl_vec;
42*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::Return;
43*4d7e907cSAndroid Build Coastguard Worker using ::android::hardware::Void;
44*4d7e907cSAndroid Build Coastguard Worker using ::android::sp;
45*4d7e907cSAndroid Build Coastguard Worker 
46*4d7e907cSAndroid Build Coastguard Worker struct DrmPlugin : public IDrmPlugin, android::DrmPluginListener {
47*4d7e907cSAndroid Build Coastguard Worker 
DrmPluginDrmPlugin48*4d7e907cSAndroid Build Coastguard Worker     DrmPlugin(android::DrmPlugin *plugin) : mLegacyPlugin(plugin) {}
~DrmPluginDrmPlugin49*4d7e907cSAndroid Build Coastguard Worker     ~DrmPlugin() {delete mLegacyPlugin;}
50*4d7e907cSAndroid Build Coastguard Worker 
51*4d7e907cSAndroid Build Coastguard Worker     // Methods from ::android::hardware::drm::V1_0::IDrmPlugin follow.
52*4d7e907cSAndroid Build Coastguard Worker 
53*4d7e907cSAndroid Build Coastguard Worker     Return<void> openSession(openSession_cb _hidl_cb) override;
54*4d7e907cSAndroid Build Coastguard Worker 
55*4d7e907cSAndroid Build Coastguard Worker     Return<Status> closeSession(const hidl_vec<uint8_t>& sessionId) override;
56*4d7e907cSAndroid Build Coastguard Worker 
57*4d7e907cSAndroid Build Coastguard Worker     Return<void> getKeyRequest(const hidl_vec<uint8_t>& scope,
58*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& initData, const hidl_string& mimeType,
59*4d7e907cSAndroid Build Coastguard Worker             KeyType keyType, const hidl_vec<KeyValue>& optionalParameters,
60*4d7e907cSAndroid Build Coastguard Worker             getKeyRequest_cb _hidl_cb) override;
61*4d7e907cSAndroid Build Coastguard Worker 
62*4d7e907cSAndroid Build Coastguard Worker     Return<void> provideKeyResponse(const hidl_vec<uint8_t>& scope,
63*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& response, provideKeyResponse_cb _hidl_cb)
64*4d7e907cSAndroid Build Coastguard Worker             override;
65*4d7e907cSAndroid Build Coastguard Worker 
66*4d7e907cSAndroid Build Coastguard Worker     Return<Status> removeKeys(const hidl_vec<uint8_t>& sessionId) override;
67*4d7e907cSAndroid Build Coastguard Worker 
68*4d7e907cSAndroid Build Coastguard Worker     Return<Status> restoreKeys(const hidl_vec<uint8_t>& sessionId,
69*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& keySetId) override;
70*4d7e907cSAndroid Build Coastguard Worker 
71*4d7e907cSAndroid Build Coastguard Worker     Return<void> queryKeyStatus(const hidl_vec<uint8_t>& sessionId,
72*4d7e907cSAndroid Build Coastguard Worker             queryKeyStatus_cb _hidl_cb) override;
73*4d7e907cSAndroid Build Coastguard Worker 
74*4d7e907cSAndroid Build Coastguard Worker     Return<void> getProvisionRequest(const hidl_string& certificateType,
75*4d7e907cSAndroid Build Coastguard Worker             const hidl_string& certificateAuthority,
76*4d7e907cSAndroid Build Coastguard Worker             getProvisionRequest_cb _hidl_cb) override;
77*4d7e907cSAndroid Build Coastguard Worker 
78*4d7e907cSAndroid Build Coastguard Worker     Return<void> provideProvisionResponse(const hidl_vec<uint8_t>& response,
79*4d7e907cSAndroid Build Coastguard Worker             provideProvisionResponse_cb _hidl_cb) override;
80*4d7e907cSAndroid Build Coastguard Worker 
81*4d7e907cSAndroid Build Coastguard Worker     Return<void> getSecureStops(getSecureStops_cb _hidl_cb) override;
82*4d7e907cSAndroid Build Coastguard Worker 
83*4d7e907cSAndroid Build Coastguard Worker     Return<void> getSecureStop(const hidl_vec<uint8_t>& secureStopId,
84*4d7e907cSAndroid Build Coastguard Worker             getSecureStop_cb _hidl_cb) override;
85*4d7e907cSAndroid Build Coastguard Worker 
86*4d7e907cSAndroid Build Coastguard Worker     Return<Status> releaseAllSecureStops() override;
87*4d7e907cSAndroid Build Coastguard Worker 
88*4d7e907cSAndroid Build Coastguard Worker     Return<Status> releaseSecureStop(const hidl_vec<uint8_t>& secureStopId)
89*4d7e907cSAndroid Build Coastguard Worker             override;
90*4d7e907cSAndroid Build Coastguard Worker 
91*4d7e907cSAndroid Build Coastguard Worker     Return<void> getPropertyString(const hidl_string& propertyName,
92*4d7e907cSAndroid Build Coastguard Worker             getPropertyString_cb _hidl_cb) override;
93*4d7e907cSAndroid Build Coastguard Worker 
94*4d7e907cSAndroid Build Coastguard Worker     Return<void> getPropertyByteArray(const hidl_string& propertyName,
95*4d7e907cSAndroid Build Coastguard Worker             getPropertyByteArray_cb _hidl_cb) override;
96*4d7e907cSAndroid Build Coastguard Worker 
97*4d7e907cSAndroid Build Coastguard Worker     Return<Status> setPropertyString(const hidl_string& propertyName,
98*4d7e907cSAndroid Build Coastguard Worker             const hidl_string& value) override;
99*4d7e907cSAndroid Build Coastguard Worker 
100*4d7e907cSAndroid Build Coastguard Worker     Return<Status> setPropertyByteArray(const hidl_string& propertyName,
101*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& value) override;
102*4d7e907cSAndroid Build Coastguard Worker 
103*4d7e907cSAndroid Build Coastguard Worker     Return<Status> setCipherAlgorithm(const hidl_vec<uint8_t>& sessionId,
104*4d7e907cSAndroid Build Coastguard Worker             const hidl_string& algorithm) override;
105*4d7e907cSAndroid Build Coastguard Worker 
106*4d7e907cSAndroid Build Coastguard Worker     Return<Status> setMacAlgorithm(const hidl_vec<uint8_t>& sessionId,
107*4d7e907cSAndroid Build Coastguard Worker             const hidl_string& algorithm) override;
108*4d7e907cSAndroid Build Coastguard Worker 
109*4d7e907cSAndroid Build Coastguard Worker     Return<void> encrypt(const hidl_vec<uint8_t>& sessionId,
110*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& keyId, const hidl_vec<uint8_t>& input,
111*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& iv, encrypt_cb _hidl_cb) override;
112*4d7e907cSAndroid Build Coastguard Worker 
113*4d7e907cSAndroid Build Coastguard Worker     Return<void> decrypt(const hidl_vec<uint8_t>& sessionId,
114*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& keyId, const hidl_vec<uint8_t>& input,
115*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& iv, decrypt_cb _hidl_cb) override;
116*4d7e907cSAndroid Build Coastguard Worker 
117*4d7e907cSAndroid Build Coastguard Worker     Return<void> sign(const hidl_vec<uint8_t>& sessionId,
118*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& keyId, const hidl_vec<uint8_t>& message,
119*4d7e907cSAndroid Build Coastguard Worker             sign_cb _hidl_cb) override;
120*4d7e907cSAndroid Build Coastguard Worker 
121*4d7e907cSAndroid Build Coastguard Worker     Return<void> verify(const hidl_vec<uint8_t>& sessionId,
122*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& keyId, const hidl_vec<uint8_t>& message,
123*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& signature, verify_cb _hidl_cb) override;
124*4d7e907cSAndroid Build Coastguard Worker 
125*4d7e907cSAndroid Build Coastguard Worker     Return<void> signRSA(const hidl_vec<uint8_t>& sessionId,
126*4d7e907cSAndroid Build Coastguard Worker             const hidl_string& algorithm, const hidl_vec<uint8_t>& message,
127*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& wrappedkey, signRSA_cb _hidl_cb) override;
128*4d7e907cSAndroid Build Coastguard Worker 
129*4d7e907cSAndroid Build Coastguard Worker     Return<void> setListener(const sp<IDrmPluginListener>& listener) override;
130*4d7e907cSAndroid Build Coastguard Worker 
131*4d7e907cSAndroid Build Coastguard Worker     Return<void> sendEvent(EventType eventType,
132*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<uint8_t>& sessionId, const hidl_vec<uint8_t>& data)
133*4d7e907cSAndroid Build Coastguard Worker             override;
134*4d7e907cSAndroid Build Coastguard Worker 
135*4d7e907cSAndroid Build Coastguard Worker     Return<void> sendExpirationUpdate(const hidl_vec<uint8_t>& sessionId,
136*4d7e907cSAndroid Build Coastguard Worker             int64_t expiryTimeInMS) override;
137*4d7e907cSAndroid Build Coastguard Worker 
138*4d7e907cSAndroid Build Coastguard Worker     Return<void> sendKeysChange(const hidl_vec<uint8_t>& sessionId,
139*4d7e907cSAndroid Build Coastguard Worker             const hidl_vec<KeyStatus>& keyStatusList, bool hasNewUsableKey)
140*4d7e907cSAndroid Build Coastguard Worker             override;
141*4d7e907cSAndroid Build Coastguard Worker 
142*4d7e907cSAndroid Build Coastguard Worker     // Methods from android::DrmPluginListener follow
143*4d7e907cSAndroid Build Coastguard Worker 
144*4d7e907cSAndroid Build Coastguard Worker     virtual void sendEvent(android::DrmPlugin::EventType eventType, int extra,
145*4d7e907cSAndroid Build Coastguard Worker             Vector<uint8_t> const *sessionId, Vector<uint8_t> const *data);
146*4d7e907cSAndroid Build Coastguard Worker 
147*4d7e907cSAndroid Build Coastguard Worker     virtual void sendExpirationUpdate(Vector<uint8_t> const *sessionId,
148*4d7e907cSAndroid Build Coastguard Worker             int64_t expiryTimeInMS);
149*4d7e907cSAndroid Build Coastguard Worker 
150*4d7e907cSAndroid Build Coastguard Worker     virtual void sendKeysChange(Vector<uint8_t> const *sessionId,
151*4d7e907cSAndroid Build Coastguard Worker             Vector<android::DrmPlugin::KeyStatus> const *keyStatusList,
152*4d7e907cSAndroid Build Coastguard Worker             bool hasNewUsableKey);
153*4d7e907cSAndroid Build Coastguard Worker 
154*4d7e907cSAndroid Build Coastguard Worker private:
155*4d7e907cSAndroid Build Coastguard Worker     android::DrmPlugin *mLegacyPlugin;
156*4d7e907cSAndroid Build Coastguard Worker     sp<IDrmPluginListener> mListener;
157*4d7e907cSAndroid Build Coastguard Worker 
158*4d7e907cSAndroid Build Coastguard Worker     DrmPlugin() = delete;
159*4d7e907cSAndroid Build Coastguard Worker     DrmPlugin(const DrmPlugin &) = delete;
160*4d7e907cSAndroid Build Coastguard Worker     void operator=(const DrmPlugin &) = delete;
161*4d7e907cSAndroid Build Coastguard Worker };
162*4d7e907cSAndroid Build Coastguard Worker 
163*4d7e907cSAndroid Build Coastguard Worker }  // namespace implementation
164*4d7e907cSAndroid Build Coastguard Worker }  // namespace V1_0
165*4d7e907cSAndroid Build Coastguard Worker }  // namespace drm
166*4d7e907cSAndroid Build Coastguard Worker }  // namespace hardware
167*4d7e907cSAndroid Build Coastguard Worker }  // namespace android
168*4d7e907cSAndroid Build Coastguard Worker 
169*4d7e907cSAndroid Build Coastguard Worker #endif  // ANDROID_HARDWARE_DRM_V1_0__DRMPLUGIN_H
170