vishaltanwar96 / aadhaar-py

This library helps you extract the embedded information in Aadhaar Secure QR Code

aadhaar-py 🐍

This library helps you extract the embedded information 💾 in Aadhaar Secure QR Code

Inspired from 😇

I would like to thank the authors of pyaadhaar. It wouldn't be possible to move into the right direction without this library.

Demo ✔️

Secure Aadhaar QR Decoder

Enough talk, show me how it works! ✨

>>> from aadhaar.secure_qr import extract_data
>>> received_qr_code_data = 12345678
>>> extracted_data = extract_data(received_qr_code_data)

The extract_data function returns an instance of ExtractedSecureQRData which has the definition of:

@dataclass(frozen=True)
class ExtractedSecureQRData:
    text_data: ExtractedTextData
    image: Image.Image
    contact_info: ContactData

Text Data 📝:

>>> extracted_data.text_data
ExtractedTextData(reference_id=ReferenceId(last_four_aadhaar_digits='8908', timestamp=datetime.datetime(2019, 3, 5, 15, 1, 37, 123000)), name='Penumarthi Venkat', date_of_birth=datetime.date(1987, 5, 7), gender=<Gender.MALE: 'Male'>, address=Address(care_of='S/O: Pattabhi Rama Rao', district='East Godavari', landmark='Near Siva Temple', house='4-83', location='Sctor-2', pin_code='533016', post_office='Aratlakatta', state='Andhra Pradesh', street='Main Road', sub_district='Karapa', vtc='Aratlakatta'))

The Embedded Image 🌆:

>>> extracted_data.image
<PIL.JpegImagePlugin.JpegImageFile image mode=RGB size=60x60 at 0x1029CA460>

The Contact Information 📧:

>>> extracted_data.contact_info
ContactData(email=Email(hex_string=None, fourth_aadhaar_digit='8'), mobile=Mobile(hex_string='1f31f19afc2bacbd8afb84526ae4da184a2727e8c2b1b6b9a81e4dc6b74d692a', fourth_aadhaar_digit='8'))

But hey! 🙄 I want to send this data via a ReSTful API, don't you have something to serialize that ugly instance of ExtractedSecureQRData? 😩

to_dict method to the rescue 💪

>>> extracted_data.to_dict()
{
  "text_data": {
    "reference_id": {
      "last_four_aadhaar_digits": "8908",
      "timestamp": "2019-03-05T15:01:37.123000"
    },
    "name": "Penumarthi Venkat",
    "date_of_birth": "1987-05-07",
    "gender": "Male",
    "address": {
      "care_of": "S/O: Pattabhi Rama Rao",
      "district": "East Godavari",
      "landmark": "Near Siva Temple",
      "house": "4-83",
      "location": "Sctor-2",
      "pin_code": "533016",
      "post_office": "Aratlakatta",
      "state": "Andhra Pradesh",
      "street": "Main Road",
      "sub_district": "Karapa",
      "vtc": "Aratlakatta"
    }
  },
  "image": "data:image/jpeg;base64,/9j/4AAQSkZblahblah",
  "contact_info": {
    "email": {
      "hex_string": None
    },
    "mobile": {
      "hex_string": "1f31f19afc2bacbd8afb84526ae4da184a2727e8c2b1b6b9a81e4dc6b74d692a"
    }
  }
}

Run Tests 🧪

python -m unittest discover tests/ --verbose

aadhaar-py's Issues

Validate the extracted data with Aadhaar Certificate

Fix Typing in the to_dict methods

https://github.com/vishaltanwar96/aadhaar-py/blob/main/aadhaar/secure_qr/extractor.py#L95
https://github.com/vishaltanwar96/aadhaar-py/blob/main/aadhaar/secure_qr/extractor.py#L108
https://github.com/vishaltanwar96/aadhaar-py/blob/main/aadhaar/secure_qr/extractor.py#L126

Maybe a solution could be to use Type Aliasing https://docs.python.org/3/library/typing.html#type-aliases

Optimise Workflows

Add Tox for Testing Multiple Environments

Fix the Demo Application

Maybe an API based Approach and using a React based Frontend or Simply revamping the old code.

Build Artifacts and Upload to PyPI and GH Release

Inject Encoding instead of using the global variable through out the program

Demo application not working.

Hi,

Please check as demo application url is not working now.

https://aadhaar-secure-qr.herokuapp.com/

Thanks,
Bhagwan Sahane

Ask Pillow devs/maintainers about the issue faced after updating to version 9.0.0 from 8.4.0

Not able to equate images after loading from disk actual_image.tobytes() differ from expected_image.tobytes()
and the workaround with pickled image bytes needs to compare actual_image.tobytes() withexpected_image.tobytes() otherwise assertEqual fails

Add Typing Stubs