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