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