-
Notifications
You must be signed in to change notification settings - Fork 174
/
Copy pathInsecurePermissionProtectionLevel.md.html
172 lines (145 loc) · 6.41 KB
/
InsecurePermissionProtectionLevel.md.html
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
<meta charset="utf-8">
(#) Custom permission created with a normal `protectionLevel`
!!! WARNING: Custom permission created with a normal `protectionLevel`
This is a warning.
Id
: `InsecurePermissionProtectionLevel`
Summary
: Custom permission created with a normal `protectionLevel`
Severity
: Warning
Category
: Security
Platform
: Android
Vendor
: Google - Android 3P Vulnerability Research
Contact
: https://github.com/google/android-security-lints
Feedback
: https://github.com/google/android-security-lints/issues
Min
: Lint 4.1
Compiled
: Lint 8.0 and 8.1
Artifact
: [com.android.security.lint:lint](com_android_security_lint_lint.md.html)
Affects
: Manifest files
Editing
: This check runs on the fly in the IDE editor
See
: https://goo.gle/InsecurePermissionProtectionLevel
Implementation
: [Source Code](https://github.com/google/android-security-lints/tree/main/checks/src/main/java/com/example/lint/checks/PermissionDetector.kt)
Tests
: [Source Code](https://github.com/google/android-security-lints/tree/main/checks/src/test/java/com/example/lint/checks/PermissionDetectorTest.kt)
Copyright Year
: 2024
Custom permissions are designed for sharing resources and capabilities
with other apps. However, typos and insufficient protection levels can
negate the usage of these custom permissions altogether. In general, use
`signature` or higher protection levels whenever possible, as this
ensures only other apps signed with the same certificate can access
these protected features.
!!! Tip
This lint check has an associated quickfix available in the IDE.
(##) Example
Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
AndroidManifest.xml:2:Warning: Custom permissions should have signature
`protectionLevel`s or higher [InsecurePermissionProtectionLevel]
<permission android:name="com.android.example.permission.CUSTOM_PERMISSION" />
------------------------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here is the source file referenced above:
`AndroidManifest.xml`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
<manifest xmlns:android='http://schemas.android.com/apk/res/android' package='test.pkg'>
<permission android:name="com.android.example.permission.CUSTOM_PERMISSION" />
<application android:debuggable='false'>
<activity android:name='com.example.MainActivity'></activity>
</application>
</manifest>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can also visit the
[source code](https://github.com/google/android-security-lints/tree/main/checks/src/test/java/com/example/lint/checks/PermissionDetectorTest.kt)
for the unit tests for this check to see additional scenarios.
The above example was automatically extracted from the first unit test
found for this lint check, `PermissionDetector.testWhenCustomPermissionNoSpecifiedProtectionLevel_showsWarning`.
To report a problem with this extracted sample, visit
https://github.com/google/android-security-lints/issues.
(##) Including
!!!
This is not a built-in check. To include it, add the below dependency
to your project. This lint check is included in the lint documentation,
but the Android team may or may not agree with its recommendations.
```
// build.gradle.kts
lintChecks("com.android.security.lint:lint:1.0.2")
// build.gradle
lintChecks 'com.android.security.lint:lint:1.0.2'
// build.gradle.kts with version catalogs:
lintChecks(libs.com.android.security.lint.lint)
# libs.versions.toml
[versions]
com-android-security-lint-lint = "1.0.2"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
com-android-security-lint-lint = {
module = "com.android.security.lint:lint",
version.ref = "com-android-security-lint-lint"
}
```
1.0.2 is the version this documentation was generated from;
there may be newer versions available.
[Additional details about com.android.security.lint:lint](com_android_security_lint_lint.md.html).
(##) Suppressing
You can suppress false positives using one of the following mechanisms:
* Adding the suppression attribute
`tools:ignore="InsecurePermissionProtectionLevel"` on the
problematic XML element (or one of its enclosing elements). You may
also need to add the following namespace declaration on the root
element in the XML file if it's not already there:
`xmlns:tools="http://schemas.android.com/tools"`.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<manifest xmlns:tools="http://schemas.android.com/tools">
...
<permission tools:ignore="InsecurePermissionProtectionLevel" .../>
...
</manifest>
```
* Using a special `lint.xml` file in the source tree which turns off
the check in that folder and any sub folder. A simple file might look
like this:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<lint>
<issue id="InsecurePermissionProtectionLevel" severity="ignore" />
</lint>
```
Instead of `ignore` you can also change the severity here, for
example from `error` to `warning`. You can find additional
documentation on how to filter issues by path, regular expression and
so on
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).
* In Gradle projects, using the DSL syntax to configure lint. For
example, you can use something like
```gradle
lintOptions {
disable 'InsecurePermissionProtectionLevel'
}
```
In Android projects this should be nested inside an `android { }`
block.
* For manual invocations of `lint`, using the `--ignore` flag:
```
$ lint --ignore InsecurePermissionProtectionLevel ...`
```
* Last, but not least, using baselines, as discussed
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).
<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>