1 /*
2  * Copyright (C) 2013 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 #include <media/stagefright/foundation/ABase.h>
18 #include <media/drm/DrmAPI.h>
19 #include <mediadrm/IDrmClient.h>
20 #include <mediadrm/IDrmMetricsConsumer.h>
21 
22 #ifndef ANDROID_IDRM_H_
23 
24 #define ANDROID_IDRM_H_
25 
26 namespace android {
27 namespace hardware {
28 namespace drm {
29 namespace V1_4 {
30 struct LogMessage;
31 }  // namespace V1_4
32 }  // namespace drm
33 }  // namespace hardware
34 
35 namespace drm = ::android::hardware::drm;
36 
37 struct AString;
38 
39 struct IDrm : public virtual RefBase {
40 
~IDrmIDrm41     virtual ~IDrm() {}
42 
43     virtual status_t initCheck() const = 0;
44 
45     virtual status_t isCryptoSchemeSupported(const uint8_t uuid[16],
46                                              const String8 &mimeType,
47                                              DrmPlugin::SecurityLevel securityLevel,
48                                              bool *result) = 0;
49 
50     virtual status_t createPlugin(const uint8_t uuid[16],
51                                   const String8 &appPackageName) = 0;
52 
53     virtual status_t destroyPlugin() = 0;
54 
55     virtual status_t openSession(DrmPlugin::SecurityLevel securityLevel,
56             Vector<uint8_t> &sessionId) = 0;
57 
58     virtual status_t closeSession(Vector<uint8_t> const &sessionId) = 0;
59 
60     virtual status_t
61         getKeyRequest(Vector<uint8_t> const &sessionId,
62                       Vector<uint8_t> const &initData,
63                       String8 const &mimeType, DrmPlugin::KeyType keyType,
64                       KeyedVector<String8, String8> const &optionalParameters,
65                       Vector<uint8_t> &request, String8 &defaultUrl,
66                       DrmPlugin::KeyRequestType *keyRequestType) = 0;
67 
68     virtual status_t provideKeyResponse(Vector<uint8_t> const &sessionId,
69                                         Vector<uint8_t> const &response,
70                                         Vector<uint8_t> &keySetId) = 0;
71 
72     virtual status_t removeKeys(Vector<uint8_t> const &keySetId) = 0;
73 
74     virtual status_t restoreKeys(Vector<uint8_t> const &sessionId,
75                                  Vector<uint8_t> const &keySetId) = 0;
76 
77     virtual status_t queryKeyStatus(Vector<uint8_t> const &sessionId,
78                                     KeyedVector<String8, String8> &infoMap) const = 0;
79 
80     virtual status_t getProvisionRequest(String8 const &certType,
81                                          String8 const &certAuthority,
82                                          Vector<uint8_t> &request,
83                                          String8 &defaulUrl) = 0;
84 
85     virtual status_t provideProvisionResponse(Vector<uint8_t> const &response,
86                                               Vector<uint8_t> &certificate,
87                                               Vector<uint8_t> &wrappedKey) = 0;
88 
89     virtual status_t getSecureStops(List<Vector<uint8_t>> &secureStops) = 0;
90     virtual status_t getSecureStopIds(List<Vector<uint8_t>> &secureStopIds) = 0;
91     virtual status_t getSecureStop(Vector<uint8_t> const &ssid, Vector<uint8_t> &secureStop) = 0;
92 
93     virtual status_t releaseSecureStops(Vector<uint8_t> const &ssRelease) = 0;
94     virtual status_t removeSecureStop(Vector<uint8_t> const &ssid) = 0;
95     virtual status_t removeAllSecureStops() = 0;
96 
97     virtual status_t getHdcpLevels(DrmPlugin::HdcpLevel *connectedLevel,
98             DrmPlugin::HdcpLevel *maxLevel)
99             const = 0;
100     virtual status_t getNumberOfSessions(uint32_t *currentSessions,
101             uint32_t *maxSessions) const = 0;
102     virtual status_t getSecurityLevel(Vector<uint8_t> const &sessionId,
103             DrmPlugin::SecurityLevel *level) const = 0;
104 
105     virtual status_t getOfflineLicenseKeySetIds(List<Vector<uint8_t>> &keySetIds) const = 0;
106     virtual status_t removeOfflineLicense(Vector<uint8_t> const &keySetId) = 0;
107     virtual status_t getOfflineLicenseState(Vector<uint8_t> const &keySetId,
108             DrmPlugin::OfflineLicenseState *licenseState) const = 0;
109 
110     virtual status_t getPropertyString(String8 const &name, String8 &value) const = 0;
111     virtual status_t getPropertyByteArray(String8 const &name,
112                                           Vector<uint8_t> &value) const = 0;
113     virtual status_t setPropertyString(String8 const &name,
114                                        String8 const &value ) const = 0;
115     virtual status_t setPropertyByteArray(String8 const &name,
116                                           Vector<uint8_t> const &value) const = 0;
117 
118     virtual status_t getMetrics(const sp<IDrmMetricsConsumer> &consumer) = 0;
119 
120     virtual status_t setCipherAlgorithm(Vector<uint8_t> const &sessionId,
121                                         String8 const &algorithm) = 0;
122 
123     virtual status_t setMacAlgorithm(Vector<uint8_t> const &sessionId,
124                                      String8 const &algorithm) = 0;
125 
126     virtual status_t encrypt(Vector<uint8_t> const &sessionId,
127                              Vector<uint8_t> const &keyId,
128                              Vector<uint8_t> const &input,
129                              Vector<uint8_t> const &iv,
130                              Vector<uint8_t> &output) = 0;
131 
132     virtual status_t decrypt(Vector<uint8_t> const &sessionId,
133                              Vector<uint8_t> const &keyId,
134                              Vector<uint8_t> const &input,
135                              Vector<uint8_t> const &iv,
136                              Vector<uint8_t> &output) = 0;
137 
138     virtual status_t sign(Vector<uint8_t> const &sessionId,
139                           Vector<uint8_t> const &keyId,
140                           Vector<uint8_t> const &message,
141                           Vector<uint8_t> &signature) = 0;
142 
143     virtual status_t verify(Vector<uint8_t> const &sessionId,
144                             Vector<uint8_t> const &keyId,
145                             Vector<uint8_t> const &message,
146                             Vector<uint8_t> const &signature,
147                             bool &match) = 0;
148 
149     virtual status_t signRSA(Vector<uint8_t> const &sessionId,
150                              String8 const &algorithm,
151                              Vector<uint8_t> const &message,
152                              Vector<uint8_t> const &wrappedKey,
153                              Vector<uint8_t> &signature) = 0;
154 
155     virtual status_t setListener(const sp<IDrmClient>& listener) = 0;
156 
157     virtual status_t requiresSecureDecoder(const char *mime, bool *required) const = 0;
158 
159     virtual status_t requiresSecureDecoder(const char *mime, DrmPlugin::SecurityLevel securityLevel,
160                                            bool *required) const = 0;
161 
162     virtual status_t setPlaybackId(
163             Vector<uint8_t> const &sessionId,
164             const char *playbackId) = 0;
165 
166     virtual status_t getLogMessages(Vector<drm::V1_4::LogMessage> &logs) const = 0;
167 
168 protected:
IDrmIDrm169     IDrm() {}
170 
171 private:
172     DISALLOW_EVIL_CONSTRUCTORS(IDrm);
173 };
174 
175 }  // namespace android
176 
177 #endif // ANDROID_IDRM_H_
178