Interface RpcCryptoSettingsService

All Superinterfaces:
RpcHandler, Serializable
public interface RpcCryptoSettingsService extends RpcHandler
Service interface for managing cryptographic settings related to key algorithms in the formcycle certificate module. This service provides methods to retrieve and update key algorithm specifications, which include supported key sizes, default key sizes, and signature algorithms for RSA, DSA, and ECDSA.
Since:
8.5.0

  • Method Details

    • getCryptoSpec

      @NotNull @NotNull CryptoSpec getCryptoSpec()
      Retrieves the specifications for cryptographic algorithms, etc. used in the formcycle certificate module.
      Returns:
      a CryptoSpec object containing the supported key sizes, default key sizes, and signature algorithms for RSA, DSA, and ECDSA.

    • getCryptoSettings

      CryptoSettings getCryptoSettings(CertificateManagementUser user) throws FcCertificateManagementException
      Retrieves the cryptographic settings for a specific user in the formcycle certificate module.
      Parameters:
      user - the user for whom to retrieve the cryptographic settings, which must not be null.
      Returns:
      a CryptoSettings object containing the cryptographic settings for the specified user.
      Throws:
      IllegalArgumentException - if the provided user is null.
      FcCertificateManagementException - if the user does not have permission to view the cryptographic settings.

    • updateCryptoSpec

      @NotNull void updateCryptoSpec(CryptoSettings settings, CertificateManagementUser user) throws FcCertificateManagementException
      Updates the cryptographic settings in the formcycle certificate module.
      Parameters:
      settings - the new cryptographic settings to apply, which must not be null.
      user - the user updating the key algorithm specifications.
      Throws:
      IllegalArgumentException - if the provided settings are invalid or null.
      FcCertificateManagementException - if the user does not have permission to update the key algorithm specifications.