stdx.crypto.keys

Functionality Overview

The keys package provides asymmetric encryption and signature algorithms, including RSA and SM2 asymmetric encryption algorithms, as well as the ECDSA signature algorithm.

Using this package requires external dependencies on OpenSSL 3's crypto dynamic library files. Therefore, relevant tools must be installed before use.

• For Linux operating systems, refer to the following methods:

  • If the system's package manager supports installing the OpenSSL 3 development toolkit, you can install it this way. Ensure the system installation directory contains the dynamic library files libcrypto.so and libcrypto.so.3. For example, on Ubuntu 22.04, you can use the command sudo apt install libssl-dev to install the libssl-dev toolkit.
  • If installation via the above method is not possible, download the OpenSSL 3.x.x source code and compile/install the package manually. Ensure the installation directory contains libcrypto.so and libcrypto.so.3. Then, choose one of the following methods to ensure the system linker can locate these files:
    • If OpenSSL is not installed on the system, select direct installation to the system path during installation.
    • For custom directory installations, add the directory containing these files to the environment variables LD_LIBRARY_PATH and LIBRARY_PATH.

• For Windows operating systems, follow these steps:

  • Download the OpenSSL 3.x.x source code and compile/install the x64 architecture package, or download and install a third-party precompiled OpenSSL 3.x.x package for developers.
  • Ensure the installation directory contains the library files libcrypto.dll.a (or libcrypto.lib) and libcrypto-3-x64.dll.
  • Add the directory path containing libcrypto.dll.a (or libcrypto.lib) to the LIBRARY_PATH environment variable, and add the directory path containing libcrypto-3-x64.dll to the PATH environment variable.

• For macOS operating systems, refer to the following methods:

  • Use brew install openssl@3 to install, and ensure the system installation directory contains the dynamic library files libcrypto.dylib and libcrypto.3.dylib.
  • If installation via the above method is not possible, download the OpenSSL 3.x.x source code and compile/install the package manually. Ensure the installation directory contains libcrypto.dylib and libcrypto.3.dylib. Then, choose one of the following methods to ensure the system linker can locate these files:
    • If OpenSSL is not installed on the system, select direct installation to the system path during installation.
    • For custom directory installations, add the directory containing these files to the environment variables DYLD_LIBRARY_PATH and LIBRARY_PATH.

• For Android operating systems:

  • Since Android ships with a stripped-down version of OpenSSL by default, some interfaces may throw exceptions due to missing symbols. Therefore, users need to compile and install a complete OpenSSL 3.x.x version themselves.
  • Download the OpenSSL 3.x.x source code and use Android NDK to cross-compile dynamic library files for the target architectures (currently only arm64-v8a is supported). Ensure the build artifacts include libcrypto.so and libcrypto.so.3.
  • Add the directory containing these files to the environment variables LD_LIBRARY_PATH.

• For HarmonyOS operating systems:

  • Due to system restrictions in HarmonyOS 6.0 and above, stdx cannot directly access the system's built-in OpenSSL, users need to compile OpenSSL dynamic libraries for HarmonyOS and package them into the application.
  • For compiling OpenSSL for HarmonyOS, refer to OHOS Cangjie SDK Build Guide.
  • Package the compiled dynamic library files libcrypto_openssl.z.so and libssl_openssl.z.so into the application and ensure they can be correctly loaded at runtime.

Note:

If the OpenSSL 3 package is not installed or a lower version is installed, the program may fail to function and throw the related exception CryptoException: Can not load openssl library or function xxx.

API List

Classes

Class Name	Functionality
ECDSAPrivateKey	ECDSA private key class.
ECDSAPublicKey	ECDSA public key class.
GeneralPrivateKey	Implementation of generic private key parameter encryption/decryption functionality.
GeneralPublicKey	Implementation of generic public key parameter encryption/decryption functionality.
RSAPrivateKey	RSA private key class.
RSAPublicKey	RSA public key class.
SM2PrivateKey	SM2 private key class.
SM2PublicKey	SM2 public key class.

Enums

Enum Name	Functionality
Curve	The enum Curve is used to select the elliptic curve type for generating ECDSA keys.
PadOption	Used to set the padding mode for RSA.

Structs

Struct Name	Functionality
OAEPOption	Optimal Asymmetric Encryption Padding.
PSSOption	Probabilistic Signature Scheme.