1
2Android DirectBoot Sample
3===================================
4
5Sample demonstrating how to store data in a device protected storage which
6is always available while the device is booted both before and after any
7user credentials(PIN/Pattern/Password) are entered.
8
9Introduction
10------------
11
12This sample demonstrates how to store and access data in a device protected
13storage which is always available while the device is booted.
14Starting from Android N, the system provides two storage locations for user data:
15
16- Credential protected:
17    - The default storage location for all apps, available only after the user has entered their pattern/password
18
19- Device protected:
20    - A new storage location which is always available while the device is booted, both before and after any user credentials are entered
21
22Apps can mark individual components as being direct boot aware which indicates to the system that they can safely run when
23Credential protected storage is unavailable (an direct boot aware component primarily relies on data stored in the new Device protected storage area,
24but they may access Credential protected data when unlocked) by adding `directBootAware="true"` in the manifest.
25```
26<activity|provider|receiver|service ...
27android:directBootAware=”true”>
28```
29
30Components marked as directBoot aware are normal components that will continue to be available after the
31Credential protected storage becomes available. The storage APIs on the Context supplied to these components will always point to Credential protected storage by default.
32To access Device protected storage, you can create a secondary Context using this API
33```
34Context.createDeviceProtectedStorageContext()
35```
36All of the storage APIs on this returned Context will be redirected to point at Device protected storage.
37
38You need to be careful what data is stored/moved to a device protected storage
39because the storage isn't protected by the user's credential (PIN/Pattern/Password)
40You shouldn't store sensitive data (such as user's emails, auth tokens) in a
41device protected storage.
42
43Pre-requisites
44--------------
45
46- Android SDK 25
47- Android Build Tools v27.0.2
48- Android Support Repository
49
50Screenshots
51-------------
52
53<img src="screenshots/1.png" height="400" alt="Screenshot"/> <img src="screenshots/2.png" height="400" alt="Screenshot"/> <img src="screenshots/3.png" height="400" alt="Screenshot"/> <img src="screenshots/4.png" height="400" alt="Screenshot"/>
54
55Getting Started
56---------------
57
58This sample uses the Gradle build system. To build this project, use the
59"gradlew build" command or use "Import Project" in Android Studio.
60
61Support
62-------
63
64- Google+ Community: https://plus.google.com/communities/105153134372062985968
65- Stack Overflow: http://stackoverflow.com/questions/tagged/android
66
67If you've found an error in this sample, please file an issue:
68https://github.com/googlesamples/android-DirectBoot
69
70Patches are encouraged, and may be submitted by forking this project and
71submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
72
73License
74-------
75
76Copyright 2017 The Android Open Source Project, Inc.
77
78Licensed to the Apache Software Foundation (ASF) under one or more contributor
79license agreements.  See the NOTICE file distributed with this work for
80additional information regarding copyright ownership.  The ASF licenses this
81file to you under the Apache License, Version 2.0 (the "License"); you may not
82use this file except in compliance with the License.  You may obtain a copy of
83the License at
84
85http://www.apache.org/licenses/LICENSE-2.0
86
87Unless required by applicable law or agreed to in writing, software
88distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
89WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
90License for the specific language governing permissions and limitations under
91the License.
92