Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 1 | <?xml version="1.0" encoding="utf-8"?> |
| 2 | <!-- Copyright (C) 2019 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 | <!-- |
| 18 | This XML file declares which system packages should be initially installed for new users based on |
Bookatz | a8c2d2a | 2019-11-13 10:10:18 -0800 | [diff] [blame] | 19 | their user type. All system packages on the device should ideally have an entry in an xml file |
Yan Zhu | 31b01e4 | 2020-05-18 12:19:08 -0700 | [diff] [blame] | 20 | (keyed by its manifest name), except auto-generated rro packages. Auto-generated RRO packages |
| 21 | (package name ends with ".auto_generated_rro_product__" or ".auto_generated_rro_vendor__") |
| 22 | will be installed for new users according to corresponding overlay target packages. |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 23 | |
Bookatz | a8c2d2a | 2019-11-13 10:10:18 -0800 | [diff] [blame] | 24 | Base user-types (every user will be at least one of these types) are: |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 25 | SYSTEM (user 0) |
| 26 | FULL (any non-profile human user) |
| 27 | PROFILE (profile human user) |
Bookatz | a8c2d2a | 2019-11-13 10:10:18 -0800 | [diff] [blame] | 28 | the precise meaning of which is defined in |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 29 | frameworks/base/core/java/android/content/pm/UserInfo.java. |
Bookatz | a8c2d2a | 2019-11-13 10:10:18 -0800 | [diff] [blame] | 30 | TODO(b/143784345): When UserInfo flags are categorized, reference the "base type" category here. |
| 31 | |
| 32 | More granular control is also available by specifying individual user types (every user is exactly |
| 33 | one of these user types). |
| 34 | This includes AOSP user types defined in frameworks/base/core/java/android/os/UserManager.java, like |
| 35 | android.os.usertype.full.SYSTEM |
| 36 | android.os.usertype.full.SECONDARY |
| 37 | android.os.usertype.full.GUEST |
| 38 | android.os.usertype.full.DEMO |
| 39 | android.os.usertype.full.RESTRICTED |
| 40 | android.os.usertype.profile.MANAGED |
| 41 | android.os.usertype.system.HEADLESS |
| 42 | as well as any OEM custom user types defined using |
| 43 | frameworks/base/services/core/java/com/android/server/pm/UserTypeFactory.java. |
| 44 | Any specified user types must be valid user types on the device (i.e. created in UserTypeFactory). |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 45 | |
| 46 | The following three examples should cover most normal cases: |
| 47 | |
| 48 | 1. For a system package to be pre-installed only in user 0: |
| 49 | |
| 50 | <install-in-user-type package="com.android.example"> |
Bookatz | 52c7408 | 2019-12-03 09:31:05 -0800 | [diff] [blame] | 51 | <install-in user-type="SYSTEM" /> |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 52 | </install-in-user-type> |
| 53 | |
| 54 | |
| 55 | 2. For a system package to be pre-installed on all human users (e.g. a web browser), i.e. to be |
Yan Zhu | 31b01e4 | 2020-05-18 12:19:08 -0700 | [diff] [blame] | 56 | installed on any user of type FULL or PROFILE (since this covers all human users): |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 57 | |
| 58 | <install-in-user-type package="com.android.example"> |
Bookatz | 52c7408 | 2019-12-03 09:31:05 -0800 | [diff] [blame] | 59 | <install-in user-type="FULL" /> |
| 60 | <install-in user-type="PROFILE" /> |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 61 | </install-in-user-type> |
| 62 | |
| 63 | |
| 64 | 3. For a system package to be pre-installed on all human users except for profile users (e.g. a |
| 65 | wallpaper app, since profiles cannot display wallpaper): |
| 66 | |
| 67 | <install-in-user-type package="com.android.example"> |
Bookatz | 52c7408 | 2019-12-03 09:31:05 -0800 | [diff] [blame] | 68 | <install-in user-type="FULL" /> |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 69 | </install-in-user-type> |
| 70 | |
| 71 | |
| 72 | Some system packages truly are required to be on all users, regardless of type, in which case use: |
| 73 | <install-in-user-type package="com.android.example"> |
| 74 | <install-in user-type="SYSTEM"> |
Bookatz | 52c7408 | 2019-12-03 09:31:05 -0800 | [diff] [blame] | 75 | <install-in user-type="FULL" /> |
| 76 | <install-in user-type="PROFILE" /> |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 77 | </install-in-user-type> |
| 78 | |
Bookatz | a8c2d2a | 2019-11-13 10:10:18 -0800 | [diff] [blame] | 79 | More fine-grained options are also available by specifying individual user types. |
| 80 | E.g. |
| 81 | <install-in-user-type package="com.android.example"> |
Bookatz | 52c7408 | 2019-12-03 09:31:05 -0800 | [diff] [blame] | 82 | <install-in user-type="android.os.usertype.profile.MANAGED" /> |
| 83 | <install-in user-type="android.os.usertype.full.GUEST" /> |
Bookatz | a8c2d2a | 2019-11-13 10:10:18 -0800 | [diff] [blame] | 84 | <install-in user-type="SYSTEM"> |
| 85 | </install-in-user-type> |
| 86 | which installs this package on any user whose user type is a managed profile or a guest, or is of |
| 87 | a SYSTEM base type. |
| 88 | |
| 89 | Additionally, packages can blacklist user types. Blacklists override any whitelisting (in any file). |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 90 | E.g. |
| 91 | <install-in-user-type package="com.android.example"> |
| 92 | <install-in user-type="FULL" /> |
Bookatz | a8c2d2a | 2019-11-13 10:10:18 -0800 | [diff] [blame] | 93 | <do-not-install-in user-type="android.os.usertype.full.GUEST" /> |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 94 | </install-in-user-type> |
Bookatz | a8c2d2a | 2019-11-13 10:10:18 -0800 | [diff] [blame] | 95 | If a user is of type android.os.usertype.full.GUEST (which itself is a subtype of FULL), this |
| 96 | package will NOT be installed, because the 'do-not-install-in' takes precedence over 'install-in'. |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 97 | |
| 98 | The way that a device treats system packages that do not have any entry (for any user type) at all |
| 99 | is determined by the config resource value config_userTypePackageWhitelistMode. |
| 100 | See frameworks/base/core/res/res/values/config.xml#config_userTypePackageWhitelistMode. |
| 101 | |
Adam Bookatz | 1efd27cd | 2020-03-19 18:37:36 -0700 | [diff] [blame] | 102 | Changes to the whitelist during system updates can result in installing additional system packages |
| 103 | to pre-existing users, but cannot uninstall pre-existing system packages from pre-existing users. |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 104 | --> |
| 105 | <config> |
| 106 | <install-in-user-type package="com.android.providers.settings"> |
| 107 | <install-in user-type="SYSTEM" /> |
| 108 | <install-in user-type="FULL" /> |
| 109 | <install-in user-type="PROFILE" /> |
| 110 | </install-in-user-type> |
Bookatz | 6d31ac1 | 2019-12-10 12:50:22 -0800 | [diff] [blame] | 111 | <install-in-user-type package="com.android.wallpaperbackup"> |
| 112 | <install-in user-type="FULL" /> |
| 113 | </install-in-user-type> |
Bookatz | 04d7ae5 | 2019-08-05 14:07:12 -0700 | [diff] [blame] | 114 | </config> |