gmalglib 0.5.2

Python package implementing GM algorithms in C.

gmalglib

Python extension library for GM (GuoMi) cryptographic algorithms, providing a set of fundamental cryptographic algorithms.

Implemented in C language, encapsulated based on the native CPython interface, without dependencies on any third-party libraries.

Installation

Windows

For python3.8 and higher versions, you can directly install using pip.

pip install gmalglib

Alternatively, refer to the source code installation for other platforms.

Other Platforms

Visit the PyPI project file list Download files page to download the source distribution package gmalglib-x.y.z.tar.gz, then proceed with the source code installation.

pip install gmalglib-x.y.z.tar.gz

Core Algorithms Implemented

• SM2 Public Key Cryptograhpic Algorithm Based on Elliptic Curves
  • Sign/Verify
  • Encrypt/Decrypt
• SM3 Cryptogrpahic Hash Algorithm
• SM4 Block Cipher Algorithm
• ZUC Stream Cipher Algorithm

Usage

For submodules under gmalglib, different algorithm encapsulations are respectively exported, and can be utilized in an object-oriented manner.

from gmalglib.sm3 import SM3

obj = SM3()
obj.update(b"message")
obj.update(b"digest")
print(obj.digest().hex())

Under gmalglib.wrapped, member methods of all algorithm objects are encapsulated, providing a procedural call method. Furthermore, the gmalglib namespace is imported, enabling direct usage.

import gmalglib

print(gmalglib.sm3_digest(b"messagedigest").hex())

About Random Number Generators

For all sections involving random number generators, custom parameters for random number generation are provided, implemented in the form of callback functions. The function type is Callable[[int], bytes], meaning it generates a byte string of a specified length.

def rnd_fn(n: int) -> bytes: ...

If no random number generator is passed, the default system-related random number generator is used. On Windows, it utilizes BCryptGenRandom, while other systems use /dev/urandom for implementation, which is similar to the Python standard library function os.urandom.

For specific implementation details, refer to random.c under the OsRandomProc function.