The adafruit_circuitpython_rsa from adafruit

pyasn1 not implement currently?

I want to test load/save pem, der format key, but the pyasn1 module looks like not work currently,

from pyasn1.type import univ, namedtype, tag

Traceback (most recent call last):
File "", line 1, in
File "univ.py", line 10, in
File "error.py", line 37, in
TypeError: multiple bases have instance lay-out conflict

May need update due to `adafruit_logging` 4.0.0

This library likely needs updates due to the adafruit_logging library upgrade. New use should be CPython compatible, and it may be worth allowing the CPython logging module to be imported if available.

Some common issues that are now present across libraries:

Locations of classes have changed, and some may have been removed.
PrintLogger no longer exists; instead, instance a Logger and add a StreamHandler instance with default arguments as the handler.

memory allocation failed.

Which series chip tested ?
I receive below when I import adafruit_rsa on STM32F405RGT6:
import adafruit_rsa

Traceback (most recent call last):
File "", line 1, in
File "/lib/adafruit_rsa/init.py", line 27, in
File "/lib/adafruit_rsa/pkcs1.py", line 31, in
File "/lib/adafruit_hashlib/init.py", line 45, in
MemoryError: memory allocation failed, allocating 2933 bytes

Missing requirement for adafruit_hashlib

After a clean install with pip install adafruit-circuitpython-rsa when you attempt to import the module it raises an exception due to missing hashlib:

>>> import adafruit_rsa
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/timc/.local/lib/python3.10/site-packages/adafruit_rsa/__init__.py", line 19, in <module>
    from adafruit_rsa.pkcs1 import (
  File "/home/timc/.local/lib/python3.10/site-packages/adafruit_rsa/pkcs1.py", line 25, in <module>
    import adafruit_hashlib as hashlib
ModuleNotFoundError: No module named 'adafruit_hashlib'

RTD build status unknown

Looks like the last RTD build failed. Should be resolved once #22 is merged.

`typing.Literal` only available in Python 3.8+

A nested try/except block is needed to restore Python 3.7 compatibility

Doesn't install correctly from pip

I think pip installations of this library do not work properly.

In a test environment I installed with:

❯ pip install adafruit-circuitpython-rsa
Collecting adafruit-circuitpython-rsa
  Downloading adafruit-circuitpython-rsa-1.2.6.tar.gz (49 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 49.7/49.7 KB 7.0 MB/s eta 0:00:00
  Preparing metadata (setup.py) ... done
Requirement already satisfied: Adafruit-Blinka in ./testing_venv/lib/python3.8/site-packages (from adafruit-circuitpython-rsa) (7.1.0)
Requirement already satisfied: Adafruit-PlatformDetect>=3.13.0 in ./testing_venv/lib/python3.8/site-packages (from Adafruit-Blinka->adafruit-circuitpython-rsa) (3.20.1)
Requirement already satisfied: Adafruit-PureIO>=1.1.7 in ./testing_venv/lib/python3.8/site-packages (from Adafruit-Blinka->adafruit-circuitpython-rsa) (1.1.9)
Requirement already satisfied: pyftdi>=0.40.0 in ./testing_venv/lib/python3.8/site-packages (from Adafruit-Blinka->adafruit-circuitpython-rsa) (0.53.3)
Requirement already satisfied: pyusb!=1.2.0,>=1.0.0 in ./testing_venv/lib/python3.8/site-packages (from pyftdi>=0.40.0->Adafruit-Blinka->adafruit-circuitpython-rsa) (1.2.1)
Requirement already satisfied: pyserial>=3.0 in ./testing_venv/lib/python3.8/site-packages (from pyftdi>=0.40.0->Adafruit-Blinka->adafruit-circuitpython-rsa) (3.5)
Using legacy 'setup.py install' for adafruit-circuitpython-rsa, since package 'wheel' is not installed.
Installing collected packages: adafruit-circuitpython-rsa
  Running setup.py install for adafruit-circuitpython-rsa ... done
Successfully installed adafruit-circuitpython-rsa-1.2.6

It completes successfully, but then if I try to use it:

>>> import adafruit_rsa
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ModuleNotFoundError: No module named 'adafruit_rsa'

At least one problem leading to this is py_modules instead of packages here in the setup.py file:

Adafruit_CircuitPython_RSA/setup.py

Line 54 in 56e5bad

py_modules=["adafruit_rsa"],

AssertionError: Number must be an unsigned integer, not a float

as discussed in #10, the simpletest for this library fails:

on 5.0

Auto-reload is on. Simply save files over USB to run them or enter REPL to disable.
code.py output:
Generating keypair...
Encrypting message...
Traceback (most recent call last):
  File "code.py", line 16, in <module>
  File "/lib/adafruit_rsa/pkcs1.py", line 173, in encrypt
  File "/lib/adafruit_rsa/transform.py", line 181, in int2bytes
AssertionError: Number must be an unsigned integer, not a float.

and on 4.1.2

Auto-reload is on. Simply save files over USB to run them or enter REPL to disable.
code.py output:
Generating keypair...
Encrypting message...
Traceback (most recent call last):
  File "code.py", line 16, in <module>
  File "/lib/adafruit_rsa/pkcs1.py", line 173, in encrypt
  File "/lib/adafruit_rsa/transform.py", line 177, in int2bytes
AssertionError: Number must be an unsigned integer, not a float.```

rsa-512 private key exhausts stack

https://gist.github.com/richardanaya/3ab380003bb6544046039aa689906a81

code.py output:
Traceback (most recent call last):
  File "code.py", line 9, in <module>
  File "/lib/adafruit_jwt.py", line 101, in generate
RuntimeError: pystack exhausted

Update RTD parameter documentation

This library is missing Sphinx docstring documentation for ReadTheDocs for the functions contained within! See other libraries for examples. Here's a basic example of what is needed in the docstring for each function:

...

def some_function(a: float, b: int) -> Tuple[str, str, str]:
    """This is an explanation of the function

    :param float a: An explanation of parameter a
    :param int b: An explanation of parameter b
    """

...

VerificationError: Verification failed

Here are the 3 that are failing because of a VerificationError I suspect test_sign_verify_fail is also failing. All of the following outputs are from rsa_tests.py:

Testing: <function test_sign_verify_sha256 at 0x20002de0>
7064.67: DEBUG - find_p_q(248): Finding p
7069.36: DEBUG - find_p_q(248): Finding q
Traceback (most recent call last):
  File "code.py", line 102, in <module>
  File "code.py", line 49, in test_sign_verify_sha256
  File "/lib/adafruit_rsa/pkcs1.py", line 329, in verify
VerificationError: Verification failed

Testing: <function test_sign_verify_sha384 at 0x20002e30>
6557.27: DEBUG - find_p_q(312): Finding p
6621.99: DEBUG - find_p_q(312): Finding q
Traceback (most recent call last):
  File "code.py", line 106, in <module>
  File "code.py", line 62, in test_sign_verify_sha384
  File "/lib/adafruit_rsa/pkcs1.py", line 329, in verify
VerificationError: Verification failed

Testing: <function test_sign_verify_sha512 at 0x20002e90>
6816.8: DEBUG - find_p_q(376): Finding p
6871.6: DEBUG - find_p_q(376): Finding q
Traceback (most recent call last):
  File "code.py", line 108, in <module>
  File "code.py", line 73, in test_sign_verify_sha512
  File "/lib/adafruit_rsa/pkcs1.py", line 329, in verify
VerificationError: Verification failed

Incorrect type for hash_value arg in sign_hash function

The hash_value arg of the sign_hash in pkcs1.py currently is typed out as optional, but hash_value is required, lest an error occur when we reach the line:

clear_text = asn1_code + hash_value

Missing Type Annotations

There are missing type annotations for some functions in this library.

The typing module does not exist on CircuitPython devices so the import needs to be wrapped in try/except to catch the error for missing import. There is an example of how that is done here:

try:
    from typing import List, Tuple
except ImportError:
    pass

Once imported the typing annotations for the argument type(s), and return type(s) can be added to the function signature. Here is an example of a function that has had this done already:

def wrap_text_to_pixels(
    string: str, max_width: int, font=None, indent0: str = "", indent1: str = ""
) -> List[str]:

If you are new to Git or Github we have a guide about contributing to our projects here: https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github

There is also a guide that covers our CI utilities and how to run them locally to ensure they will pass in Github Actions here: https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code In particular the pages: Sharing docs on ReadTheDocs and Check your code with pre-commit contain the tools to install and commands to run locally to run the checks.

If you are attempting to resolve this issue and need help, you can post a comment on this issue and tag both @FoamyGuy and @kattni or reach out to us on Discord: https://adafru.it/discord in the #circuitpython-dev channel.

The following locations are reported by mypy to be missing type annotations:

Why are range and zip assigned to themselves

Does anyone know why this is done? Pylint 2.x doesn't like it and although it appears like there were disables put in to ignore the issues caused by this, I wanted to check before adding another disable.

Adafruit_CircuitPython_RSA/adafruit_rsa/_compat.py

Lines 43 to 45 in 39330c6

 # pylint: disable=redefined-builtin, invalid-name 

 range = range 

 zip = zip

Referencing main issue: adafruit/Adafruit_CircuitPython_Bundle#232

Code fails duplicate-code check, consider refactor

https://github.com/adafruit/Adafruit_CircuitPython_RSA/runs/6993443865?check_suite_focus=true#step:11:33

	# pylint: disable=redefined-builtin, invalid-name
	range = range
	zip = zip

adafruit / adafruit_circuitpython_rsa Goto Github PK

adafruit_circuitpython_rsa's Introduction

Introduction

Dependencies

Installing from PyPI

Usage Example

Documentation

Contributing

adafruit_circuitpython_rsa's People

Contributors

Stargazers

Watchers

Forkers

adafruit_circuitpython_rsa's Issues

Recommend Projects

Recommend Topics

Recommend Org