Skip to content

Commit 97e32f3

Browse files
committed
Initial commit.
0 parents  commit 97e32f3

File tree

247 files changed

+11865
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

247 files changed

+11865
-0
lines changed

.gitignore

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
*.iml
2+
.gradle
3+
/local.properties
4+
/.idea
5+
.DS_Store
6+
/build
7+
/captures
8+
.externalNativeBuild
9+
.cxx
10+
local.properties
11+
12+
# Do not upload libs to Github
13+
/private-libs

LICENSE.md

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
This project contains code written by The PixelExperience Project developers, AOSP, and finally Andy Bao.
2+
3+
- Code from The PixelExperience Project is under their copyright and licensed under the Apache License, Version 2.0.
4+
- Code from the AOSP (Android Open Source Project) is under their copyright and licensed under the Apache License, Version 2.0.
5+
- Code from Andy Bao is under their copyright and licensed under the Apache License, Version 2.0.
6+
7+
The Apache License, Version 2.0 is as follows:
8+
9+
```
10+
11+
Apache License
12+
Version 2.0, January 2004
13+
http://www.apache.org/licenses/
14+
15+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
16+
17+
1. Definitions.
18+
19+
"License" shall mean the terms and conditions for use, reproduction,
20+
and distribution as defined by Sections 1 through 9 of this document.
21+
22+
"Licensor" shall mean the copyright owner or entity authorized by
23+
the copyright owner that is granting the License.
24+
25+
"Legal Entity" shall mean the union of the acting entity and all
26+
other entities that control, are controlled by, or are under common
27+
control with that entity. For the purposes of this definition,
28+
"control" means (i) the power, direct or indirect, to cause the
29+
direction or management of such entity, whether by contract or
30+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
31+
outstanding shares, or (iii) beneficial ownership of such entity.
32+
33+
"You" (or "Your") shall mean an individual or Legal Entity
34+
exercising permissions granted by this License.
35+
36+
"Source" form shall mean the preferred form for making modifications,
37+
including but not limited to software source code, documentation
38+
source, and configuration files.
39+
40+
"Object" form shall mean any form resulting from mechanical
41+
transformation or translation of a Source form, including but
42+
not limited to compiled object code, generated documentation,
43+
and conversions to other media types.
44+
45+
"Work" shall mean the work of authorship, whether in Source or
46+
Object form, made available under the License, as indicated by a
47+
copyright notice that is included in or attached to the work
48+
(an example is provided in the Appendix below).
49+
50+
"Derivative Works" shall mean any work, whether in Source or Object
51+
form, that is based on (or derived from) the Work and for which the
52+
editorial revisions, annotations, elaborations, or other modifications
53+
represent, as a whole, an original work of authorship. For the purposes
54+
of this License, Derivative Works shall not include works that remain
55+
separable from, or merely link (or bind by name) to the interfaces of,
56+
the Work and Derivative Works thereof.
57+
58+
"Contribution" shall mean any work of authorship, including
59+
the original version of the Work and any modifications or additions
60+
to that Work or Derivative Works thereof, that is intentionally
61+
submitted to Licensor for inclusion in the Work by the copyright owner
62+
or by an individual or Legal Entity authorized to submit on behalf of
63+
the copyright owner. For the purposes of this definition, "submitted"
64+
means any form of electronic, verbal, or written communication sent
65+
to the Licensor or its representatives, including but not limited to
66+
communication on electronic mailing lists, source code control systems,
67+
and issue tracking systems that are managed by, or on behalf of, the
68+
Licensor for the purpose of discussing and improving the Work, but
69+
excluding communication that is conspicuously marked or otherwise
70+
designated in writing by the copyright owner as "Not a Contribution."
71+
72+
"Contributor" shall mean Licensor and any individual or Legal Entity
73+
on behalf of whom a Contribution has been received by Licensor and
74+
subsequently incorporated within the Work.
75+
76+
2. Grant of Copyright License. Subject to the terms and conditions of
77+
this License, each Contributor hereby grants to You a perpetual,
78+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
79+
copyright license to reproduce, prepare Derivative Works of,
80+
publicly display, publicly perform, sublicense, and distribute the
81+
Work and such Derivative Works in Source or Object form.
82+
83+
3. Grant of Patent License. Subject to the terms and conditions of
84+
this License, each Contributor hereby grants to You a perpetual,
85+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
86+
(except as stated in this section) patent license to make, have made,
87+
use, offer to sell, sell, import, and otherwise transfer the Work,
88+
where such license applies only to those patent claims licensable
89+
by such Contributor that are necessarily infringed by their
90+
Contribution(s) alone or by combination of their Contribution(s)
91+
with the Work to which such Contribution(s) was submitted. If You
92+
institute patent litigation against any entity (including a
93+
cross-claim or counterclaim in a lawsuit) alleging that the Work
94+
or a Contribution incorporated within the Work constitutes direct
95+
or contributory patent infringement, then any patent licenses
96+
granted to You under this License for that Work shall terminate
97+
as of the date such litigation is filed.
98+
99+
4. Redistribution. You may reproduce and distribute copies of the
100+
Work or Derivative Works thereof in any medium, with or without
101+
modifications, and in Source or Object form, provided that You
102+
meet the following conditions:
103+
104+
(a) You must give any other recipients of the Work or
105+
Derivative Works a copy of this License; and
106+
107+
(b) You must cause any modified files to carry prominent notices
108+
stating that You changed the files; and
109+
110+
(c) You must retain, in the Source form of any Derivative Works
111+
that You distribute, all copyright, patent, trademark, and
112+
attribution notices from the Source form of the Work,
113+
excluding those notices that do not pertain to any part of
114+
the Derivative Works; and
115+
116+
(d) If the Work includes a "NOTICE" text file as part of its
117+
distribution, then any Derivative Works that You distribute must
118+
include a readable copy of the attribution notices contained
119+
within such NOTICE file, excluding those notices that do not
120+
pertain to any part of the Derivative Works, in at least one
121+
of the following places: within a NOTICE text file distributed
122+
as part of the Derivative Works; within the Source form or
123+
documentation, if provided along with the Derivative Works; or,
124+
within a display generated by the Derivative Works, if and
125+
wherever such third-party notices normally appear. The contents
126+
of the NOTICE file are for informational purposes only and
127+
do not modify the License. You may add Your own attribution
128+
notices within Derivative Works that You distribute, alongside
129+
or as an addendum to the NOTICE text from the Work, provided
130+
that such additional attribution notices cannot be construed
131+
as modifying the License.
132+
133+
You may add Your own copyright statement to Your modifications and
134+
may provide additional or different license terms and conditions
135+
for use, reproduction, or distribution of Your modifications, or
136+
for any such Derivative Works as a whole, provided Your use,
137+
reproduction, and distribution of the Work otherwise complies with
138+
the conditions stated in this License.
139+
140+
5. Submission of Contributions. Unless You explicitly state otherwise,
141+
any Contribution intentionally submitted for inclusion in the Work
142+
by You to the Licensor shall be under the terms and conditions of
143+
this License, without any additional terms or conditions.
144+
Notwithstanding the above, nothing herein shall supersede or modify
145+
the terms of any separate license agreement you may have executed
146+
with Licensor regarding such Contributions.
147+
148+
6. Trademarks. This License does not grant permission to use the trade
149+
names, trademarks, service marks, or product names of the Licensor,
150+
except as required for reasonable and customary use in describing the
151+
origin of the Work and reproducing the content of the NOTICE file.
152+
153+
7. Disclaimer of Warranty. Unless required by applicable law or
154+
agreed to in writing, Licensor provides the Work (and each
155+
Contributor provides its Contributions) on an "AS IS" BASIS,
156+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
157+
implied, including, without limitation, any warranties or conditions
158+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
159+
PARTICULAR PURPOSE. You are solely responsible for determining the
160+
appropriateness of using or redistributing the Work and assume any
161+
risks associated with Your exercise of permissions under this License.
162+
163+
8. Limitation of Liability. In no event and under no legal theory,
164+
whether in tort (including negligence), contract, or otherwise,
165+
unless required by applicable law (such as deliberate and grossly
166+
negligent acts) or agreed to in writing, shall any Contributor be
167+
liable to You for damages, including any direct, indirect, special,
168+
incidental, or consequential damages of any character arising as a
169+
result of this License or out of the use or inability to use the
170+
Work (including but not limited to damages for loss of goodwill,
171+
work stoppage, computer failure or malfunction, or any and all
172+
other commercial damages or losses), even if such Contributor
173+
has been advised of the possibility of such damages.
174+
175+
9. Accepting Warranty or Additional Liability. While redistributing
176+
the Work or Derivative Works thereof, You may choose to offer,
177+
and charge a fee for, acceptance of support, warranty, indemnity,
178+
or other liability obligations and/or rights consistent with this
179+
License. However, in accepting such obligations, You may act only
180+
on Your own behalf and on Your sole responsibility, not on behalf
181+
of any other Contributor, and only if You agree to indemnify,
182+
defend, and hold each Contributor harmless for any liability
183+
incurred by, or claims asserted against, such Contributor by reason
184+
of your accepting any such warranty or additional liability.
185+
186+
END OF TERMS AND CONDITIONS
187+
```

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# UniversalAuth
2+
This project aims to bring a variety of custom authentication options to various Android ROMs.
3+
4+
**Your phone needs to have Xposed (or EdXposed/Lsposed).**
5+
6+
**This project has only been tested on Android 11. It may work in Android 10 and 12 though.** Support for more Android versions is a goal and I welcome contributions!
7+
8+
**You currently cannot use this project to authenticate in apps. It can only unlock your lockscreen.** Support for using this project to authenticate in apps is under development/investigation.
9+
## Authentication modules
10+
Currently available authentication modules:
11+
12+
- [Face unlock](#face-unlock)
13+
14+
### Face unlock
15+
Face unlock allows you to unlock your phone with your face.
16+
17+
#### WARNING
18+
The face unlock module depends on closed source, proprietary libraries developed by Megvii.
19+
I do not have a license to distribute these libraries and **Megvii has filed
20+
DMCA takedown notices to take down repositories containing these modules in
21+
the past**.
22+
23+
Therefore, to use the face unlock module, you will need to obtain these library files yourself.
24+
The module will ask you to provide these files during setup.
25+
26+
Here are the `SHA1` hashes of the library files:
27+
28+
```
29+
For arm64 phones (most phones):
30+
Filename: libFaceDetectCA.so SHA1: 0e9e08c7cc976e86a8b2c80732b0f3cef3ed09be Size (bytes): 256088
31+
Filename: libmegface.so SHA1: 9b598b767a124076d87bb7cc0097d968df620a1d Size (bytes): 7213272
32+
Filename: libMegviiUnlock-jni-1.2.so SHA1: cd3747023c62b3f489da6d104ce3ab51dd3d8bb7 Size (bytes): 260176
33+
Filename: libMegviiUnlock.so SHA1: 25f86732d5bf05679b69e4fa41957efb5491ebc6 Size (bytes): 1066008
34+
35+
For 32-bit ARM phones (very very old phones):
36+
Filename: libFaceDetectCA.so SHA1: cc5acf3fdc29d85a59fb7b1970fc41c7120e7fa2 Size (bytes): 136888
37+
Filename: libmegface.so SHA1: 6fe6848ab6ff0a29afb398dc6782f0d30031875a Size (bytes): 5266192
38+
Filename: libMegviiUnlock-jni-1.2.so SHA1: 44e77a1b87690d3571209a40a228e30fe185332c Size (bytes): 136888
39+
Filename: libMegviiUnlock.so SHA1: 448eca6eabd5f9cbc16b960813cb9996f15fe01c Size (bytes): 655788
40+
41+
x86_64 phones are not supported, but they are pretty rare.
42+
```
43+
44+
#### Installation
45+
1. Install and enable the UniversalAuth Xposed module. You can download it from [the releases page](https://github.com/null-dev/UniversalAuth/releases).
46+
2. Reboot to make sure the Xposed module is enabled.
47+
3. Install the face unlock auth module APK. You can download it from [the releases page](https://github.com/null-dev/UniversalAuth/releases).
48+
4. A new app called "Face unlock" should now appear, open it.
49+
5. Add the [library files](#warning) when asked.
50+
6. Grant the app permission to unlock your phone when asked.
51+
7. Enable the accessibility service when asked.
52+
8. Press the "START SETUP" button to enroll your face. The app will ask you to grant it camera permissions, make sure to select "allow while using the app" if that option is available.
53+
9. Lock your phone and test that you are able to use face unlock!
54+
55+
# Credits
56+
Thanks to:
57+
58+
- the PixelExperience devs for writing the core UI and face unlock logic code.
59+
- The LsPosed/EdXposed devs and rovo89 for Xposed.
60+
- topjohnwu for Magisk.
61+
- Google for AOSP.

branding/face-unlock.gif

6.87 MB
Loading

build.gradle

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
// Top-level build file where you can add configuration options common to all sub-projects/modules.
2+
plugins {
3+
id 'com.android.application' version '7.1.2' apply false
4+
id 'com.android.library' version '7.1.2' apply false
5+
id 'org.jetbrains.kotlin.android' version '1.6.10' apply false
6+
}
7+
8+
task clean(type: Delete) {
9+
delete rootProject.buildDir
10+
}

faceunlock-backend/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/build

faceunlock-backend/build.gradle

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
plugins {
2+
id 'com.android.library'
3+
id 'org.jetbrains.kotlin.android'
4+
}
5+
6+
android {
7+
compileSdk 32
8+
9+
defaultConfig {
10+
minSdk 29
11+
targetSdk 32
12+
13+
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
14+
consumerProguardFiles "consumer-rules.pro"
15+
}
16+
17+
buildTypes {
18+
release {
19+
minifyEnabled false
20+
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
21+
}
22+
}
23+
compileOptions {
24+
sourceCompatibility JavaVersion.VERSION_1_8
25+
targetCompatibility JavaVersion.VERSION_1_8
26+
}
27+
kotlinOptions {
28+
jvmTarget = '1.8'
29+
}
30+
}
31+
32+
dependencies {
33+
34+
implementation 'androidx.core:core-ktx:1.7.0'
35+
implementation 'androidx.appcompat:appcompat:1.4.1'
36+
implementation 'com.google.android.material:material:1.5.0'
37+
testImplementation 'junit:junit:4.13.2'
38+
androidTestImplementation 'androidx.test.ext:junit:1.1.3'
39+
androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
40+
}

faceunlock-backend/consumer-rules.pro

Whitespace-only changes.

faceunlock-backend/proguard-rules.pro

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Add project specific ProGuard rules here.
2+
# You can control the set of applied configuration files using the
3+
# proguardFiles setting in build.gradle.
4+
#
5+
# For more details, see
6+
# http://developer.android.com/guide/developing/tools/proguard.html
7+
8+
# If your project uses WebView with JS, uncomment the following
9+
# and specify the fully qualified class name to the JavaScript interface
10+
# class:
11+
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12+
# public *;
13+
#}
14+
15+
# Uncomment this to preserve the line number information for
16+
# debugging stack traces.
17+
#-keepattributes SourceFile,LineNumberTable
18+
19+
# If you keep the line number information, uncomment this to
20+
# hide the original source file name.
21+
#-renamesourcefileattribute SourceFile
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
package ax.nd.faceunlock_backend
2+
3+
import androidx.test.platform.app.InstrumentationRegistry
4+
import androidx.test.ext.junit.runners.AndroidJUnit4
5+
6+
import org.junit.Test
7+
import org.junit.runner.RunWith
8+
9+
import org.junit.Assert.*
10+
11+
/**
12+
* Instrumented test, which will execute on an Android device.
13+
*
14+
* See [testing documentation](http://d.android.com/tools/testing).
15+
*/
16+
@RunWith(AndroidJUnit4::class)
17+
class ExampleInstrumentedTest {
18+
@Test
19+
fun useAppContext() {
20+
// Context of the app under test.
21+
val appContext = InstrumentationRegistry.getInstrumentation().targetContext
22+
assertEquals("ax.nd.faceunlock_backend.test", appContext.packageName)
23+
}
24+
}

0 commit comments

Comments
 (0)