3KeyPradeep / CZERTAINLY-Software-Cryptography-Provider

CZERTAINLY - implementation of software Cryptography Provider connector

CZERTAINLY Software Cryptography Provider

This repository is part of the commercial open-source project CZERTAINLY. You can find more information about the project at CZERTAINLY repository, including the contribution guide.

Software Cryptography Provider Connector is the implementation of the following Function Groups and Kinds:

Function Group	Kind
Cryptography Provider	SOFT

Software Cryptography Provider implements cryptographic key management function based on the software keystore managed data. Therefore, it is not recommended to use this provider for the production environment, where you require higher protection of the cryptographic keys. The Software Cryptography Provider is intended for the development and testing purposes.

It is compatible with the Cryptography Provider interface. This entity provider utilizes the SSH authorized connection with the servers and provider the location configuration of the keystore with access to generate and manipulate the content.

Software Cryptography Provider Connector allows you to perform the following operations:

• Manage Token instances
• Manage cryptographic Keys
• Request cryptographic operations like encryption, decryption, signing, verification

Database requirements

Software Cryptography Provider Connector requires the PostgreSQL database to store the data. (at lease version 12+)

Supported key algorithms

Software Cryptography Provider Connector supports the following asymmetric algorithms:

Algorithm	Type	Key Properties
RSA	Asymmetric	Key lengths 1024, 2048, 4096
ECDSA	Asymmetric	Named curves secp192r1, secp224r1, secp256r1, secp384r1, secp521r1
FALCON	Asymmetric	With 512 and 1024 degrees spec
CRYSTALS-Dilithium	Asymmetric	Levels 2, 3, 5 and AES-256 option for expansion function
SPHINCS+	Asymmetric	With all parameter sets and robust instantiation option

Note: Symmetric keys are not supported by this Connector.

Interfaces

Software Cryptography Provider implements Cryptography Provider interfaces. To learn more about the interfaces and end points, refer to the CZERTAINLY Interfaces.

For more information, please refer to the CZERTAINLY documentation.

Docker container

Software Cryptography Provider Connector is provided as a Docker container. Use the 3keycompany/czertainly-software-cryptography-provider:tagname to pull the required image from the repository. It can be configured using the following environment variables:

Variable	Description	Required	Default value
JDBC_URL	JDBC URL for database access		N/A
JDBC_USERNAME	Username to access the database		N/A
JDBC_PASSWORD	Password to access the database		N/A
DB_SCHEMA	Database schema to use		softcp
PORT	Port where the service is exposed		8080
TOKEN_DELETE_ON_REMOVE	If the token should be deleted or kept in the database when removed		false
JAVA_OPTS	Customize Java system properties for running application		N/A