-
Notifications
You must be signed in to change notification settings - Fork 11
/
BidHelperAndroid.java
500 lines (460 loc) · 18.7 KB
/
BidHelperAndroid.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
/* Copyright (c) 2011-2016 BlackBerry Limited.
*
* 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.
*/
package com.blackberry.bidhelper;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.database.Cursor;
import android.net.Uri;
import android.util.Base64;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.math.BigInteger;
import java.security.cert.CertificateException;
import java.security.cert.CertificateExpiredException;
import java.security.cert.CertificateFactory;
import java.security.cert.CertificateNotYetValidException;
import java.security.cert.X509Certificate;
import java.util.ArrayList;
import java.util.List;
import static com.blackberry.bidhelper.BidConstants.BIDE_CERTIFICATE_STRING;
import static com.blackberry.bidhelper.BidConstants.CERTIFICATE;
import static com.blackberry.bidhelper.BidConstants.CERTIFICATE_AVAILABLE;
import static com.blackberry.bidhelper.BidConstants.FAILURE_REPORT_STRING;
import static com.blackberry.bidhelper.BidConstants.ID_KEY;
import static com.blackberry.bidhelper.BidConstants.JBIDE_REPORT;
import static com.blackberry.bidhelper.BidConstants.KBIDE_REPORT;
import static com.blackberry.bidhelper.BidConstants.NONCE_KEY;
import static com.blackberry.bidhelper.BidConstants.NONCE_RADIX;
import static com.blackberry.bidhelper.BidConstants.REPORT_INSERTED;
import static com.blackberry.bidhelper.BidConstants.STATUS_REPORT_STRING;
import static com.blackberry.bidhelper.BidConstants.TZ_REPORT;
import static com.blackberry.bidhelper.BidConstants.TZ_SIGNATURE;
/**
* Android implementation of the <code>BidHelper</code> interface.
* <p/>
* This class provides convenience methods for obtaining status reports
* and failure reports from the BID content provider. After a request
* completes successfully, the caller is responsible for verifying the
* report object before attempting to access the contents of the report.
* An attempt to access the contents of an un-verified report will cause
* an exception to be thrown.
* <p/>
* This class can also register listeners for BID-related events such
* as the insertion of a report and the availability of a certificate.
* <p/>
* To facilitate porting to non-Android platforms, this class should be
* the only class in this package that depends on Android APIs.
* <p/>
* Using the helper API is a simple matter of constructing the helper, registering
* for events (optional), requesting a report, verifying the report, and destroying
* the helper when it is no longer needed:
* <p/>
* If you choose not to use the helper API and would rather query the content
* provider directly, please see <code>BidConstants</code> for all of the
* useful string constants that you will need. For example, to query all failure
* reports:
* <pre>
* Cursor cursor = getContentResolver().query(
* BidConstants.FAILURE_REPORT_STRING,
* null, null, null, null);
* </pre>
* Then access the rows and columns of the result using standard database methods:
* <pre>
* cursor.moveToFirst();
* int kbideReportIndex = cursor.getColumnIndexOrThrow(KBIDE_REPORT);
* String kbideReport = cursor.getString(kbideReportIndex);
* </pre>
* However when using this approach keep in mind that the reports are not validated,
* and you are responsible to validate the nonce, the hashes, and the signature
* prior to attempting to access the contents of the reports.
* <p/>
* If you choose not to use the helper API and would rather register manually for
* BID broadcasts, you will need to write your own subclass of BroadcastReceiver
* like this:
* <pre>
* public class MyBroadcastReceiver extends BroadcastReceiver {
*
* @Override
* public void onReceive(Context context, Intent intent) {
* if (intent.getAction().equals(BidConstants.CERTIFICATE_AVAILABLE)) {
* //...process the event
* } else if (intent.getAction().equals(BidConstants.REPORT_INSERTED)) {
* //...process the event
* }
* }
* </pre>
* Also, if you choose not to use the helper API, you will need to add a
* <receiver> tag like the following inside the <application> tag of
* your app's AndroidManifest.xml file:
* <pre>
* <receiver android:name=".MyBroadcastReceiver" android:enabled="true">
* <intent-filter>
* <action android:name="com.blackberry.bide.CERTIFICATE_AVAILABLE"/>
* <action android:name="com.blackberry.bide.REPORT_INSERTED"/>
* </intent-filter>
* </receiver>
* </pre>
*/
public final class BidHelperAndroid implements BidHelper {
/**
* Content URI for status reports.
*/
public static final Uri STATUS_REPORT_URI = Uri.parse(STATUS_REPORT_STRING);
/**
* Content URI for failure reports.
*/
public static final Uri BIDE_CERTIFICATE_URI = Uri.parse(BIDE_CERTIFICATE_STRING);
/**
* Content URI for failure reports.
*/
public static final Uri FAILURE_REPORT_URI = Uri.parse(FAILURE_REPORT_STRING);
/**
* Projection used for content provider queries.
*/
private static final String[] PROJECTION = {JBIDE_REPORT, KBIDE_REPORT, TZ_REPORT, TZ_SIGNATURE};
/**
* Bid Certificate
*/
private X509Certificate bidCert = null;
private Context context;
private List<BidListener> listeners;
private BidReceiver receiver;
/**
* Create a new BID helper for Android based on the specified application
* context.
*
* @param context the application context.
*/
public BidHelperAndroid(Context context) {
this.context = context;
listeners = new ArrayList<BidListener>();
receiver = new BidReceiver();
context.registerReceiver(receiver, receiver.getIntentFilter());
}
/**
* Creates an un-verified status report object populated with the specified
* values.
*
* @param cursor a pre-positioned cursor containing raw, un-verified values
* for creating the report.
* @return an un-verified status report object populated with the specified
* values.
*/
private static BidStatusReport createStatusReport(Cursor cursor) {
int jbideReportIndex = cursor.getColumnIndexOrThrow(JBIDE_REPORT);
int kbideReportIndex = cursor.getColumnIndexOrThrow(KBIDE_REPORT);
int tzReportIndex = cursor.getColumnIndexOrThrow(TZ_REPORT);
int tzSignatureIndex = cursor.getColumnIndexOrThrow(TZ_SIGNATURE);
return new BidStatusReport(cursor.getString(jbideReportIndex),
cursor.getString(kbideReportIndex),
cursor.getString(tzReportIndex),
cursor.getBlob(tzSignatureIndex),
getBase64Decoder());
}
/**
* Creates an un-verified failure report object populated with the specified
* values.
*
* @param cursor a pre-positioned cursor containing raw, un-verified values
* for creating the report.
* @return an un-verified failure report object populated with the specified
* values.
*/
private static BidFailureReport createFailureReport(Cursor cursor) {
int jbideReportIndex = cursor.getColumnIndexOrThrow(JBIDE_REPORT);
int kbideReportIndex = cursor.getColumnIndexOrThrow(KBIDE_REPORT);
int tzReportIndex = cursor.getColumnIndexOrThrow(TZ_REPORT);
int tzSignatureIndex = cursor.getColumnIndexOrThrow(TZ_SIGNATURE);
return new BidFailureReport(cursor.getString(jbideReportIndex),
cursor.getString(kbideReportIndex),
cursor.getString(tzReportIndex),
cursor.getBlob(tzSignatureIndex),
getBase64Decoder());
}
/**
* Creates an un-verified certificate.
*
* @param cursor a pre-positioned cursor containing raw, un-verified certificate.
* @return an un-verified certificate.
*/
private static byte[] getCertificate(Cursor cursor) {
int certificateIndex = cursor.getColumnIndexOrThrow(CERTIFICATE);
return cursor.getBlob(certificateIndex);
}
/**
* Returns a <code>Base64Decoder</code> implementation ready to use.
* (This is needed due to Java's lack of a cross-platform Base64 facility).
*
* @return a <code>Base64Decoder</code> implementation ready to use.
*/
private static Base64Decoder getBase64Decoder() {
//
// Unfortunately there is no common Base64 utility that exists
// in both Android and desktop Java, hence the need for the
// Base64Decoder interface here. Android has android.util.Base64.
// Desktop Java versions 6 and 7 have methods for Base64 encoding
// and decoding in javax.xml.bind.DatatypeConverter. Desktop Java
// version 8 introduced java.util.Base64 but alas too late for
// Android adoption.
//
return new Base64Decoder() {
@Override
public byte[] decode(String s) {
byte[] result = null;
try {
result = Base64.decode(s, Base64.DEFAULT);
} catch (IllegalArgumentException iae) {
// do nothing - result will be null
}
return result;
}
};
}
@Override
public void destroy() {
context.unregisterReceiver(receiver);
}
@Override
public void addBidListener(BidListener listener) {
if (listener != null) {
listeners.add(listener);
}
}
@Override
public void removeBidListener(BidListener listener) {
listeners.remove(listener);
}
@Override
public boolean isCertificateAvailable() {
if (bidCert == null) {
// We have not retrieved the certificate yet. Let's do that now
byte[] certificateBytes = null;
try {
certificateBytes = requestBidCertificate();
} catch (BidCertificateUnavailableException ex) {
// Certificate is not available
return false;
} catch (BidRequestException bre) {
return false;
}
// create an X509Certificate from the byte array
ByteArrayInputStream bis = new ByteArrayInputStream(certificateBytes);
try {
CertificateFactory cf = CertificateFactory.getInstance("X.509");
bidCert = (X509Certificate) cf.generateCertificate(bis);
} catch (CertificateException ce) {
return false;
}
}
if (bidCert != null) {
try {
bidCert.checkValidity();
} catch (CertificateExpiredException cee) {
bidCert = null;
return false;
} catch (CertificateNotYetValidException cnyve) {
return false;
}
return true;
} else {
return false;
}
}
@Override
public BidStatusReport requestStatusReport(BigInteger nonce)
throws BidRequestException {
try {
//
// Form the URI and query the content provider.
//
Uri.Builder builder = STATUS_REPORT_URI.buildUpon();
builder.appendQueryParameter(NONCE_KEY, nonce.toString(NONCE_RADIX));
Cursor cursor = context.getContentResolver().query(builder.build(), PROJECTION, null, null, null);
//
// Check for the unexpected.
//
if (cursor == null) {
throw new BidRequestException("null cursor for query " + STATUS_REPORT_STRING);
}
if (cursor.getCount() != 1) {
throw new BidRequestException("unexpected row count for query " + STATUS_REPORT_STRING);
}
if (!cursor.moveToFirst()) {
throw new BidRequestException("cursor failed for query " + STATUS_REPORT_STRING);
}
//
// Populate and return the report.
//
return createStatusReport(cursor);
} catch (Exception e) {
throw new BidRequestException(e);
}
}
@Override
public void verifyStatusReport(BidStatusReport report, BigInteger nonce, boolean certReqd)
throws BidCertificateUnavailableException,
IOException,
BidHashMismatchException,
BidSignatureVerificationException,
BidNonceMismatchException,
CertificateException {
if (certReqd && !isCertificateAvailable()) {
throw new BidCertificateUnavailableException("certificate not available");
}
// get certificate verifier - platform specific, pass in certificate
BidCertificateVerifier bcv = new BidCertificateVerifierAndroid();
bcv.setCertificate(bidCert);
bcv.verifyCertificateChain();
report.verify(bcv);
if (!nonce.equals(report.getNonce())) {
report.revokeVerification();
throw new BidNonceMismatchException("reported nonce does not match expected value");
}
}
@Override
public byte[] requestBidCertificate()
throws BidCertificateUnavailableException,
BidRequestException {
try {
//
// Form the URI and query the content provider.
//
Cursor cursor = context.getContentResolver().query(BIDE_CERTIFICATE_URI, PROJECTION, null, null, null);
//
// Check for the unexpected.
//
if (cursor == null) {
throw new BidCertificateUnavailableException("null cursor for query " + BIDE_CERTIFICATE_URI);
}
if (cursor.getCount() != 1) {
throw new BidRequestException("unexpected row count for query " + BIDE_CERTIFICATE_URI);
}
if (!cursor.moveToFirst()) {
throw new BidRequestException("cursor failed for query " + BIDE_CERTIFICATE_URI);
}
//
// Get the byte array representing the Bid certificate.
//
return getCertificate(cursor);
} catch (Exception e) {
throw new BidRequestException(e);
}
}
@Override
public BidFailureReport requestFailureReport(String reportId)
throws BidRequestException {
try {
//
// Form the URI and query the content provider.
//
Uri.Builder builder = FAILURE_REPORT_URI.buildUpon();
builder.appendQueryParameter(ID_KEY, reportId);
Cursor cursor = context.getContentResolver().query(builder.build(), PROJECTION, null, null, null);
//
// Check for the unexpected.
//
if (cursor == null) {
throw new BidRequestException("null cursor for query " + FAILURE_REPORT_STRING);
}
if (cursor.getCount() != 1) {
throw new BidRequestException("unexpected row count for query " + FAILURE_REPORT_STRING);
}
if (!cursor.moveToFirst()) {
throw new BidRequestException("cursor failed for query " + FAILURE_REPORT_STRING);
}
//
// Populate and return the report.
//
return createFailureReport(cursor);
} catch (Exception e) {
throw new BidRequestException(e);
}
}
@Override
public BidFailureReport[] requestAllFailureReports()
throws BidRequestException {
try {
//
// Query the content provider.
//
Cursor cursor = context.getContentResolver().query(FAILURE_REPORT_URI, PROJECTION, null, null, null);
//
// Check for the unexpected.
//
if (cursor == null) {
throw new BidRequestException("null cursor for query " + FAILURE_REPORT_STRING);
}
//
// Populate and return the reports.
//
int count = cursor.getCount();
BidFailureReport[] result = new BidFailureReport[count];
for (int i = 0; i < count; i++) {
cursor.moveToPosition(i);
result[i] = createFailureReport(cursor);
}
return result;
} catch (Exception e) {
throw new BidRequestException(e);
}
}
@Override
public void verifyFailureReport(BidFailureReport report, boolean certReqd)
throws BidCertificateUnavailableException,
IOException,
BidHashMismatchException,
BidSignatureVerificationException,
CertificateException {
if (certReqd && !isCertificateAvailable()) {
throw new BidCertificateUnavailableException("certificate not available");
}
// get certificate verifier - platform specific, pass in certificate
BidCertificateVerifier bcv = new BidCertificateVerifierAndroid();
bcv.setCertificate(bidCert);
bcv.verifyCertificateChain();
report.verify(bcv);
}
/**
* A BID broadcast receiver for firing <code>BidListener</code> events.
*/
private final class BidReceiver extends BroadcastReceiver {
@Override
public void onReceive(Context context, Intent intent) {
if (intent.getAction().equals(CERTIFICATE_AVAILABLE)) {
for (BidListener listener : listeners) {
listener.certificateAvailable();
}
} else if (intent.getAction().equals(REPORT_INSERTED)) {
for (BidListener listener : listeners) {
listener.reportInserted();
}
}
}
/**
* Returns an intent filter corresponding to BID broadcast events,
* used at registration to limit the scope of the receiver.
*
* @return an intent filter corresponding to BID broadcast events.
*/
public IntentFilter getIntentFilter() {
IntentFilter result = new IntentFilter();
result.addAction(CERTIFICATE_AVAILABLE);
result.addAction(REPORT_INSERTED);
return result;
}
}
}