aadhaarguard 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- aadhaarguard-0.2.0/LICENSE +202 -0
- aadhaarguard-0.2.0/PKG-INFO +217 -0
- aadhaarguard-0.2.0/README.md +193 -0
- aadhaarguard-0.2.0/pyproject.toml +45 -0
- aadhaarguard-0.2.0/setup.cfg +4 -0
- aadhaarguard-0.2.0/src/aadhaarguard/__init__.py +21 -0
- aadhaarguard-0.2.0/src/aadhaarguard/__main__.py +5 -0
- aadhaarguard-0.2.0/src/aadhaarguard/checksums.py +98 -0
- aadhaarguard-0.2.0/src/aadhaarguard/cli.py +160 -0
- aadhaarguard-0.2.0/src/aadhaarguard/detectors.py +355 -0
- aadhaarguard-0.2.0/src/aadhaarguard/fake.py +88 -0
- aadhaarguard-0.2.0/src/aadhaarguard/logfilter.py +46 -0
- aadhaarguard-0.2.0/src/aadhaarguard/py.typed +0 -0
- aadhaarguard-0.2.0/src/aadhaarguard/scanner.py +204 -0
- aadhaarguard-0.2.0/src/aadhaarguard.egg-info/PKG-INFO +217 -0
- aadhaarguard-0.2.0/src/aadhaarguard.egg-info/SOURCES.txt +22 -0
- aadhaarguard-0.2.0/src/aadhaarguard.egg-info/dependency_links.txt +1 -0
- aadhaarguard-0.2.0/src/aadhaarguard.egg-info/entry_points.txt +2 -0
- aadhaarguard-0.2.0/src/aadhaarguard.egg-info/requires.txt +3 -0
- aadhaarguard-0.2.0/src/aadhaarguard.egg-info/top_level.txt +1 -0
- aadhaarguard-0.2.0/tests/test_checksums.py +54 -0
- aadhaarguard-0.2.0/tests/test_cli.py +88 -0
- aadhaarguard-0.2.0/tests/test_detect.py +295 -0
- aadhaarguard-0.2.0/tests/test_redact.py +83 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: aadhaarguard
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: Find and redact Indian personal data (Aadhaar, PAN, GSTIN, UPI, phone, vehicle numbers and more; 15 kinds) with checksum validation. No dependencies.
|
|
5
|
+
Author: Pratix005
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/Pratix005/aadhaarguard
|
|
8
|
+
Project-URL: Issues, https://github.com/Pratix005/aadhaarguard/issues
|
|
9
|
+
Keywords: pii,india,aadhaar,pan,gstin,upi,redaction,dpdp,privacy,data-masking
|
|
10
|
+
Classifier: Development Status :: 4 - Beta
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
15
|
+
Classifier: Topic :: Security
|
|
16
|
+
Classifier: Topic :: Text Processing
|
|
17
|
+
Classifier: Typing :: Typed
|
|
18
|
+
Requires-Python: >=3.10
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
License-File: LICENSE
|
|
21
|
+
Provides-Extra: dev
|
|
22
|
+
Requires-Dist: pytest>=7; extra == "dev"
|
|
23
|
+
Dynamic: license-file
|
|
24
|
+
|
|
25
|
+
# aadhaarguard
|
|
26
|
+
|
|
27
|
+
Find and redact Indian personal data in text. Despite the name it covers 15
|
|
28
|
+
kinds, not just Aadhaar: PAN, GSTIN, UPI IDs, mobile numbers, bank accounts,
|
|
29
|
+
cards, vehicle registrations, driving licences and more (full list below).
|
|
30
|
+
Pure Python, no dependencies, Python 3.10+.
|
|
31
|
+
|
|
32
|
+
General-purpose PII tools handle emails and US-style numbers well, but they
|
|
33
|
+
mostly don't know Indian formats. A regex for "12 digits" flags every order ID
|
|
34
|
+
in your logs. aadhaarguard checks the check digits that Indian IDs carry
|
|
35
|
+
(Verhoeff for Aadhaar, mod-36 for GSTIN, Luhn for cards) and looks for
|
|
36
|
+
keywords like "aadhaar", "a/c" or "आधार" near a match before it reports
|
|
37
|
+
anything ambiguous.
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
pip install aadhaarguard
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Command line
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
$ aadhaarguard scan examples/customer.txt
|
|
47
|
+
examples/customer.txt:2:10: aadhaar XXXX XXXX 8697 (0.90)
|
|
48
|
+
examples/customer.txt:3:6: pan XXXXXX234F (0.99)
|
|
49
|
+
examples/customer.txt:4:8: gstin XXXXXXXXXXXT2ZM (0.99)
|
|
50
|
+
examples/customer.txt:5:9: phone +XX XXXXX X3210 (0.99)
|
|
51
|
+
examples/customer.txt:6:6: upi rXXXXXXXXX@okaxis (0.99)
|
|
52
|
+
examples/customer.txt:7:11: bank_account XXXXXXXXXX6789 (0.75)
|
|
53
|
+
examples/customer.txt:7:32: ifsc XXXXXXX1234 (0.85)
|
|
54
|
+
examples/customer.txt:8:10: vehicle XX XX XX 1234 (0.95)
|
|
55
|
+
|
|
56
|
+
8 finding(s) in 1 file(s)
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
`scan` exits with 1 when it finds something, so it works in CI and pre-commit.
|
|
60
|
+
Values are partially masked in the output so the scan itself doesn't leak data
|
|
61
|
+
into CI logs. Pass `--show` to see full values, or `--json` for machine output.
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
$ aadhaarguard redact examples/customer.txt --style partial
|
|
65
|
+
Customer: Ravi Kumar
|
|
66
|
+
Aadhaar: XXXX XXXX 8697
|
|
67
|
+
PAN: XXXXXX234F
|
|
68
|
+
...
|
|
69
|
+
Order 4521 shipped on 2026-11-21, total Rs 2,499.
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Other options: `-o out.txt`, `-i` (in place), `--kinds aadhaar,pan`,
|
|
73
|
+
`--min-confidence 0.8`, `-I` (also match lowercase IDs). `aadhaarguard kinds` lists
|
|
74
|
+
every detector.
|
|
75
|
+
|
|
76
|
+
## Python
|
|
77
|
+
|
|
78
|
+
```python
|
|
79
|
+
from aadhaarguard import scan, redact
|
|
80
|
+
|
|
81
|
+
text = "Aadhaar 3588 1399 8697, call +91 98765 43210"
|
|
82
|
+
|
|
83
|
+
for m in scan(text):
|
|
84
|
+
print(m.kind, m.value, m.start, m.end, m.confidence)
|
|
85
|
+
# aadhaar 3588 1399 8697 8 22 0.9
|
|
86
|
+
# phone +91 98765 43210 29 44 0.99
|
|
87
|
+
|
|
88
|
+
redact(text) # 'Aadhaar [AADHAAR], call [PHONE]'
|
|
89
|
+
redact(text, style="partial") # 'Aadhaar XXXX XXXX 8697, call +XX XXXXX X3210'
|
|
90
|
+
redact(text, style="mask") # 'Aadhaar XXXX XXXX XXXX, call +XX XXXXX XXXXX'
|
|
91
|
+
redact(text, style="hash") # 'Aadhaar [AADHAAR:e786c1b9d1], call [PHONE:1a6f46a8fa]' (keyed, see below)
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Use `Scanner` to keep settings:
|
|
95
|
+
|
|
96
|
+
```python
|
|
97
|
+
from aadhaarguard import Scanner
|
|
98
|
+
|
|
99
|
+
s = Scanner(kinds=["aadhaar", "pan", "phone"], min_confidence=0.8, ignore_case=True)
|
|
100
|
+
s.contains_pii(user_message)
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Redacting logs
|
|
104
|
+
|
|
105
|
+
```python
|
|
106
|
+
import logging
|
|
107
|
+
from aadhaarguard import RedactingFilter
|
|
108
|
+
|
|
109
|
+
handler = logging.StreamHandler()
|
|
110
|
+
handler.addFilter(RedactingFilter(style="partial"))
|
|
111
|
+
logging.basicConfig(level=logging.INFO, handlers=[handler])
|
|
112
|
+
|
|
113
|
+
logging.info("payment from %s", "9876543210@ybl")
|
|
114
|
+
# payment from 9XXXXXXXXX@ybl
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
The filter redacts the formatted message and any exception traceback.
|
|
118
|
+
|
|
119
|
+
### Test data
|
|
120
|
+
|
|
121
|
+
`aadhaarguard.fake` generates checksum-valid values for fixtures:
|
|
122
|
+
|
|
123
|
+
```python
|
|
124
|
+
from aadhaarguard.fake import Faker
|
|
125
|
+
|
|
126
|
+
f = Faker(seed=42)
|
|
127
|
+
f.aadhaar(), f.pan(), f.gstin(state="27"), f.phone(), f.upi(), f.card(), f.vehicle()
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
A random valid-looking Aadhaar or phone number can still belong to a real
|
|
131
|
+
person. Use these as test fixtures only.
|
|
132
|
+
|
|
133
|
+
## What it detects
|
|
134
|
+
|
|
135
|
+
| kind | format | validation |
|
|
136
|
+
|---|---|---|
|
|
137
|
+
| `aadhaar` | 12 digits, groups of 4 optional | first digit 2-9, Verhoeff checksum |
|
|
138
|
+
| `aadhaar_vid` | 16 digits | Verhoeff; needs keyword "VID" |
|
|
139
|
+
| `pan` | `AAAAA9999A` | 4th letter must be a valid holder type |
|
|
140
|
+
| `gstin` | 15 chars | state code 01-38/97/99, embedded PAN, check character |
|
|
141
|
+
| `ifsc` | `AAAA0XXXXXX` | 5th char is 0 |
|
|
142
|
+
| `upi` | `name@handle` | known handles (okaxis, ybl, paytm...) score higher; emails excluded |
|
|
143
|
+
| `email` | standard | |
|
|
144
|
+
| `phone` | `9876543210`, `+91 98765 43210`, `098765 43210`, `987 654 3210` | starts 6-9 |
|
|
145
|
+
| `card` | 13-19 digits | Luhn |
|
|
146
|
+
| `vehicle` | `MH 12 AB 1234`, `22 BH 1234 AA` | real state codes; BH year ≥ 21 |
|
|
147
|
+
| `driving_licence` | `MH14 20110062821` | state code, issue year not in future |
|
|
148
|
+
| `passport` | `J8369854` | needs keyword |
|
|
149
|
+
| `voter_id` | `ABC1234567` | needs keyword |
|
|
150
|
+
| `bank_account` | 9-18 digits | needs keyword ("account", "a/c", "खाता") |
|
|
151
|
+
| `pincode` | `560001` | needs keyword |
|
|
152
|
+
|
|
153
|
+
## How matching works
|
|
154
|
+
|
|
155
|
+
1. Each detector's regex finds candidates.
|
|
156
|
+
2. A score function rejects candidates that fail validation (bad checksum,
|
|
157
|
+
wrong state code, repeated digits like `9999999999`) and gives the rest a
|
|
158
|
+
base confidence.
|
|
159
|
+
3. If a keyword for that kind appears within 40 characters before or 20 after
|
|
160
|
+
the match, confidence goes up by 0.15. Kinds marked "needs keyword" are
|
|
161
|
+
dropped without one.
|
|
162
|
+
4. Where matches overlap, the one with its own keyword nearby wins, then the
|
|
163
|
+
higher confidence, then the longer span. So a GSTIN wins over the PAN inside
|
|
164
|
+
it, and `a/c 50100123456789` counts as an account number even though it
|
|
165
|
+
happens to pass the card checksum.
|
|
166
|
+
|
|
167
|
+
The default threshold is 0.5. Use 0.8 or higher if false positives cost more
|
|
168
|
+
than misses.
|
|
169
|
+
|
|
170
|
+
## Limitations
|
|
171
|
+
|
|
172
|
+
- **Bare 12-digit numbers.** About 1 in 10 random 12-digit numbers starting
|
|
173
|
+
2-9 passes the Verhoeff check, so an order ID can be reported as an Aadhaar
|
|
174
|
+
(confidence 0.75 without a keyword). Raise `--min-confidence` to 0.8 to only
|
|
175
|
+
report Aadhaar numbers that have a keyword nearby.
|
|
176
|
+
- **No checksum** exists (or is public) for PAN, IFSC, passport, voter ID or
|
|
177
|
+
vehicle numbers, so these rely on format and keywords.
|
|
178
|
+
- **Names and addresses** are not detected. That needs NER (for example
|
|
179
|
+
Presidio or spaCy); aadhaarguard covers structured identifiers only.
|
|
180
|
+
- **Uppercase by default** for PAN, GSTIN, IFSC, passport, voter ID and DL,
|
|
181
|
+
because official formats are uppercase and it's about 4x faster. Use
|
|
182
|
+
`ignore_case=True` / `-I` for user-typed input. Vehicle plates are always
|
|
183
|
+
uppercase-only, so English phrases like "or 12 1234" aren't flagged.
|
|
184
|
+
- **Hash style** uses HMAC-SHA256 with a random key per `Scanner`. Aadhaar has
|
|
185
|
+
only about 10^11 possible values, so a plain unkeyed hash could be reversed by
|
|
186
|
+
brute force. Pass `key=` to get the same hashes across runs, and keep that
|
|
187
|
+
key secret.
|
|
188
|
+
- **Speed.** About 1.7 MB/s on log-like text and over 60 MB/s on text without
|
|
189
|
+
digits; about 130 µs to redact one log line (`python scripts/benchmark.py`,
|
|
190
|
+
laptop CPU). That's fine for logs, chat messages and CI scans. For
|
|
191
|
+
multi-gigabyte data dumps, run it in parallel.
|
|
192
|
+
|
|
193
|
+
## pre-commit
|
|
194
|
+
|
|
195
|
+
```yaml
|
|
196
|
+
repos:
|
|
197
|
+
- repo: https://github.com/Pratix005/aadhaarguard
|
|
198
|
+
rev: v0.2.0
|
|
199
|
+
hooks:
|
|
200
|
+
- id: aadhaarguard
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
## Development
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
git clone https://github.com/Pratix005/aadhaarguard
|
|
207
|
+
cd aadhaarguard
|
|
208
|
+
python -m venv .venv && .venv/bin/pip install -e ".[dev]" # Windows: .venv\Scripts\pip
|
|
209
|
+
pytest
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
New detectors and more UPI handles are welcome; see
|
|
213
|
+
[CONTRIBUTING.md](CONTRIBUTING.md).
|
|
214
|
+
|
|
215
|
+
## License
|
|
216
|
+
|
|
217
|
+
Apache 2.0
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
# aadhaarguard
|
|
2
|
+
|
|
3
|
+
Find and redact Indian personal data in text. Despite the name it covers 15
|
|
4
|
+
kinds, not just Aadhaar: PAN, GSTIN, UPI IDs, mobile numbers, bank accounts,
|
|
5
|
+
cards, vehicle registrations, driving licences and more (full list below).
|
|
6
|
+
Pure Python, no dependencies, Python 3.10+.
|
|
7
|
+
|
|
8
|
+
General-purpose PII tools handle emails and US-style numbers well, but they
|
|
9
|
+
mostly don't know Indian formats. A regex for "12 digits" flags every order ID
|
|
10
|
+
in your logs. aadhaarguard checks the check digits that Indian IDs carry
|
|
11
|
+
(Verhoeff for Aadhaar, mod-36 for GSTIN, Luhn for cards) and looks for
|
|
12
|
+
keywords like "aadhaar", "a/c" or "आधार" near a match before it reports
|
|
13
|
+
anything ambiguous.
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
pip install aadhaarguard
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Command line
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
$ aadhaarguard scan examples/customer.txt
|
|
23
|
+
examples/customer.txt:2:10: aadhaar XXXX XXXX 8697 (0.90)
|
|
24
|
+
examples/customer.txt:3:6: pan XXXXXX234F (0.99)
|
|
25
|
+
examples/customer.txt:4:8: gstin XXXXXXXXXXXT2ZM (0.99)
|
|
26
|
+
examples/customer.txt:5:9: phone +XX XXXXX X3210 (0.99)
|
|
27
|
+
examples/customer.txt:6:6: upi rXXXXXXXXX@okaxis (0.99)
|
|
28
|
+
examples/customer.txt:7:11: bank_account XXXXXXXXXX6789 (0.75)
|
|
29
|
+
examples/customer.txt:7:32: ifsc XXXXXXX1234 (0.85)
|
|
30
|
+
examples/customer.txt:8:10: vehicle XX XX XX 1234 (0.95)
|
|
31
|
+
|
|
32
|
+
8 finding(s) in 1 file(s)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
`scan` exits with 1 when it finds something, so it works in CI and pre-commit.
|
|
36
|
+
Values are partially masked in the output so the scan itself doesn't leak data
|
|
37
|
+
into CI logs. Pass `--show` to see full values, or `--json` for machine output.
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
$ aadhaarguard redact examples/customer.txt --style partial
|
|
41
|
+
Customer: Ravi Kumar
|
|
42
|
+
Aadhaar: XXXX XXXX 8697
|
|
43
|
+
PAN: XXXXXX234F
|
|
44
|
+
...
|
|
45
|
+
Order 4521 shipped on 2026-11-21, total Rs 2,499.
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Other options: `-o out.txt`, `-i` (in place), `--kinds aadhaar,pan`,
|
|
49
|
+
`--min-confidence 0.8`, `-I` (also match lowercase IDs). `aadhaarguard kinds` lists
|
|
50
|
+
every detector.
|
|
51
|
+
|
|
52
|
+
## Python
|
|
53
|
+
|
|
54
|
+
```python
|
|
55
|
+
from aadhaarguard import scan, redact
|
|
56
|
+
|
|
57
|
+
text = "Aadhaar 3588 1399 8697, call +91 98765 43210"
|
|
58
|
+
|
|
59
|
+
for m in scan(text):
|
|
60
|
+
print(m.kind, m.value, m.start, m.end, m.confidence)
|
|
61
|
+
# aadhaar 3588 1399 8697 8 22 0.9
|
|
62
|
+
# phone +91 98765 43210 29 44 0.99
|
|
63
|
+
|
|
64
|
+
redact(text) # 'Aadhaar [AADHAAR], call [PHONE]'
|
|
65
|
+
redact(text, style="partial") # 'Aadhaar XXXX XXXX 8697, call +XX XXXXX X3210'
|
|
66
|
+
redact(text, style="mask") # 'Aadhaar XXXX XXXX XXXX, call +XX XXXXX XXXXX'
|
|
67
|
+
redact(text, style="hash") # 'Aadhaar [AADHAAR:e786c1b9d1], call [PHONE:1a6f46a8fa]' (keyed, see below)
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Use `Scanner` to keep settings:
|
|
71
|
+
|
|
72
|
+
```python
|
|
73
|
+
from aadhaarguard import Scanner
|
|
74
|
+
|
|
75
|
+
s = Scanner(kinds=["aadhaar", "pan", "phone"], min_confidence=0.8, ignore_case=True)
|
|
76
|
+
s.contains_pii(user_message)
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Redacting logs
|
|
80
|
+
|
|
81
|
+
```python
|
|
82
|
+
import logging
|
|
83
|
+
from aadhaarguard import RedactingFilter
|
|
84
|
+
|
|
85
|
+
handler = logging.StreamHandler()
|
|
86
|
+
handler.addFilter(RedactingFilter(style="partial"))
|
|
87
|
+
logging.basicConfig(level=logging.INFO, handlers=[handler])
|
|
88
|
+
|
|
89
|
+
logging.info("payment from %s", "9876543210@ybl")
|
|
90
|
+
# payment from 9XXXXXXXXX@ybl
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
The filter redacts the formatted message and any exception traceback.
|
|
94
|
+
|
|
95
|
+
### Test data
|
|
96
|
+
|
|
97
|
+
`aadhaarguard.fake` generates checksum-valid values for fixtures:
|
|
98
|
+
|
|
99
|
+
```python
|
|
100
|
+
from aadhaarguard.fake import Faker
|
|
101
|
+
|
|
102
|
+
f = Faker(seed=42)
|
|
103
|
+
f.aadhaar(), f.pan(), f.gstin(state="27"), f.phone(), f.upi(), f.card(), f.vehicle()
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
A random valid-looking Aadhaar or phone number can still belong to a real
|
|
107
|
+
person. Use these as test fixtures only.
|
|
108
|
+
|
|
109
|
+
## What it detects
|
|
110
|
+
|
|
111
|
+
| kind | format | validation |
|
|
112
|
+
|---|---|---|
|
|
113
|
+
| `aadhaar` | 12 digits, groups of 4 optional | first digit 2-9, Verhoeff checksum |
|
|
114
|
+
| `aadhaar_vid` | 16 digits | Verhoeff; needs keyword "VID" |
|
|
115
|
+
| `pan` | `AAAAA9999A` | 4th letter must be a valid holder type |
|
|
116
|
+
| `gstin` | 15 chars | state code 01-38/97/99, embedded PAN, check character |
|
|
117
|
+
| `ifsc` | `AAAA0XXXXXX` | 5th char is 0 |
|
|
118
|
+
| `upi` | `name@handle` | known handles (okaxis, ybl, paytm...) score higher; emails excluded |
|
|
119
|
+
| `email` | standard | |
|
|
120
|
+
| `phone` | `9876543210`, `+91 98765 43210`, `098765 43210`, `987 654 3210` | starts 6-9 |
|
|
121
|
+
| `card` | 13-19 digits | Luhn |
|
|
122
|
+
| `vehicle` | `MH 12 AB 1234`, `22 BH 1234 AA` | real state codes; BH year ≥ 21 |
|
|
123
|
+
| `driving_licence` | `MH14 20110062821` | state code, issue year not in future |
|
|
124
|
+
| `passport` | `J8369854` | needs keyword |
|
|
125
|
+
| `voter_id` | `ABC1234567` | needs keyword |
|
|
126
|
+
| `bank_account` | 9-18 digits | needs keyword ("account", "a/c", "खाता") |
|
|
127
|
+
| `pincode` | `560001` | needs keyword |
|
|
128
|
+
|
|
129
|
+
## How matching works
|
|
130
|
+
|
|
131
|
+
1. Each detector's regex finds candidates.
|
|
132
|
+
2. A score function rejects candidates that fail validation (bad checksum,
|
|
133
|
+
wrong state code, repeated digits like `9999999999`) and gives the rest a
|
|
134
|
+
base confidence.
|
|
135
|
+
3. If a keyword for that kind appears within 40 characters before or 20 after
|
|
136
|
+
the match, confidence goes up by 0.15. Kinds marked "needs keyword" are
|
|
137
|
+
dropped without one.
|
|
138
|
+
4. Where matches overlap, the one with its own keyword nearby wins, then the
|
|
139
|
+
higher confidence, then the longer span. So a GSTIN wins over the PAN inside
|
|
140
|
+
it, and `a/c 50100123456789` counts as an account number even though it
|
|
141
|
+
happens to pass the card checksum.
|
|
142
|
+
|
|
143
|
+
The default threshold is 0.5. Use 0.8 or higher if false positives cost more
|
|
144
|
+
than misses.
|
|
145
|
+
|
|
146
|
+
## Limitations
|
|
147
|
+
|
|
148
|
+
- **Bare 12-digit numbers.** About 1 in 10 random 12-digit numbers starting
|
|
149
|
+
2-9 passes the Verhoeff check, so an order ID can be reported as an Aadhaar
|
|
150
|
+
(confidence 0.75 without a keyword). Raise `--min-confidence` to 0.8 to only
|
|
151
|
+
report Aadhaar numbers that have a keyword nearby.
|
|
152
|
+
- **No checksum** exists (or is public) for PAN, IFSC, passport, voter ID or
|
|
153
|
+
vehicle numbers, so these rely on format and keywords.
|
|
154
|
+
- **Names and addresses** are not detected. That needs NER (for example
|
|
155
|
+
Presidio or spaCy); aadhaarguard covers structured identifiers only.
|
|
156
|
+
- **Uppercase by default** for PAN, GSTIN, IFSC, passport, voter ID and DL,
|
|
157
|
+
because official formats are uppercase and it's about 4x faster. Use
|
|
158
|
+
`ignore_case=True` / `-I` for user-typed input. Vehicle plates are always
|
|
159
|
+
uppercase-only, so English phrases like "or 12 1234" aren't flagged.
|
|
160
|
+
- **Hash style** uses HMAC-SHA256 with a random key per `Scanner`. Aadhaar has
|
|
161
|
+
only about 10^11 possible values, so a plain unkeyed hash could be reversed by
|
|
162
|
+
brute force. Pass `key=` to get the same hashes across runs, and keep that
|
|
163
|
+
key secret.
|
|
164
|
+
- **Speed.** About 1.7 MB/s on log-like text and over 60 MB/s on text without
|
|
165
|
+
digits; about 130 µs to redact one log line (`python scripts/benchmark.py`,
|
|
166
|
+
laptop CPU). That's fine for logs, chat messages and CI scans. For
|
|
167
|
+
multi-gigabyte data dumps, run it in parallel.
|
|
168
|
+
|
|
169
|
+
## pre-commit
|
|
170
|
+
|
|
171
|
+
```yaml
|
|
172
|
+
repos:
|
|
173
|
+
- repo: https://github.com/Pratix005/aadhaarguard
|
|
174
|
+
rev: v0.2.0
|
|
175
|
+
hooks:
|
|
176
|
+
- id: aadhaarguard
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
## Development
|
|
180
|
+
|
|
181
|
+
```
|
|
182
|
+
git clone https://github.com/Pratix005/aadhaarguard
|
|
183
|
+
cd aadhaarguard
|
|
184
|
+
python -m venv .venv && .venv/bin/pip install -e ".[dev]" # Windows: .venv\Scripts\pip
|
|
185
|
+
pytest
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
New detectors and more UPI handles are welcome; see
|
|
189
|
+
[CONTRIBUTING.md](CONTRIBUTING.md).
|
|
190
|
+
|
|
191
|
+
## License
|
|
192
|
+
|
|
193
|
+
Apache 2.0
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "aadhaarguard"
|
|
7
|
+
version = "0.2.0"
|
|
8
|
+
description = "Find and redact Indian personal data (Aadhaar, PAN, GSTIN, UPI, phone, vehicle numbers and more; 15 kinds) with checksum validation. No dependencies."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
license-files = ["LICENSE"]
|
|
12
|
+
requires-python = ">=3.10"
|
|
13
|
+
authors = [{ name = "Pratix005" }]
|
|
14
|
+
keywords = ["pii", "india", "aadhaar", "pan", "gstin", "upi", "redaction", "dpdp", "privacy", "data-masking"]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 4 - Beta",
|
|
17
|
+
"Intended Audience :: Developers",
|
|
18
|
+
"Operating System :: OS Independent",
|
|
19
|
+
"Programming Language :: Python :: 3",
|
|
20
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
21
|
+
"Topic :: Security",
|
|
22
|
+
"Topic :: Text Processing",
|
|
23
|
+
"Typing :: Typed",
|
|
24
|
+
]
|
|
25
|
+
dependencies = []
|
|
26
|
+
|
|
27
|
+
[project.optional-dependencies]
|
|
28
|
+
dev = ["pytest>=7"]
|
|
29
|
+
|
|
30
|
+
[project.urls]
|
|
31
|
+
Homepage = "https://github.com/Pratix005/aadhaarguard"
|
|
32
|
+
Issues = "https://github.com/Pratix005/aadhaarguard/issues"
|
|
33
|
+
|
|
34
|
+
[project.scripts]
|
|
35
|
+
aadhaarguard = "aadhaarguard.cli:main"
|
|
36
|
+
|
|
37
|
+
[tool.setuptools.packages.find]
|
|
38
|
+
where = ["src"]
|
|
39
|
+
|
|
40
|
+
[tool.setuptools.package-data]
|
|
41
|
+
aadhaarguard = ["py.typed"]
|
|
42
|
+
|
|
43
|
+
[tool.pytest.ini_options]
|
|
44
|
+
testpaths = ["tests", "src"]
|
|
45
|
+
addopts = "--doctest-modules"
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"""aadhaarguard: find and redact Indian personal data (Aadhaar, PAN, GSTIN, UPI and more)."""
|
|
2
|
+
|
|
3
|
+
from .detectors import DEFAULT_DETECTORS, KINDS, Detector
|
|
4
|
+
from .logfilter import RedactingFilter
|
|
5
|
+
from .scanner import STYLES, Match, Scanner, partial_mask, redact, scan
|
|
6
|
+
|
|
7
|
+
__version__ = "0.2.0"
|
|
8
|
+
|
|
9
|
+
__all__ = [
|
|
10
|
+
"DEFAULT_DETECTORS",
|
|
11
|
+
"KINDS",
|
|
12
|
+
"STYLES",
|
|
13
|
+
"Detector",
|
|
14
|
+
"Match",
|
|
15
|
+
"RedactingFilter",
|
|
16
|
+
"Scanner",
|
|
17
|
+
"partial_mask",
|
|
18
|
+
"redact",
|
|
19
|
+
"scan",
|
|
20
|
+
"__version__",
|
|
21
|
+
]
|