com.mulesoft.modules.cryptography.internal.util

Class CryptoUtils

java.lang.Object

com.mulesoft.modules.cryptography.internal.util.CryptoUtils

public class CryptoUtils
extends Object

A set of helpers to deal on FIPS environment

Since:

1.4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_CUSTOM_CIPHER_PROPERTY
static String	ALLOW_NON_STANDARD_KEY_SIZE_PROPERTY
static String	ALLOW_REGISTRATION_XMLDSIG_PROPERTY Deprecated.
static String	LEGACY_KDF_PROPERTY
static String	LEGACY_SUN_PROVIDER_PROPERTY
static String	XML_DSIG_PROVIDER_CLASS_NAME The fully qualified class name of the Apache Santuario XMLDSig provider.
static String	XMLDSIG_PROVIDER_NAME

Method Summary

Modifier and Type	Method and Description
static boolean	allowLegacyDecryptionKdf()
static boolean	allowLegacyDecryptionSunProvider()
static Optional<Provider>	getBcSecurityProviderIfApplicable()
static String	getSafeErrorMessage(Throwable e, String defaultMessage) Gets a safe error message from an exception, prioritizing the most specific message available.
static Optional<Provider>	getXMLDSigProvider() Gets the XMLDSig provider if one is already registered globally.
static boolean	isFipsEnabled() Checks if FIPS is enabled.
static boolean	isXMLDSigRegistrationAllowedInFips() Deprecated. This method is deprecated as of version 2.1.0 and will be removed in a future version. XMLDSig provider registration in FIPS mode should be handled through alternative mechanisms.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LEGACY_KDF_PROPERTY

public static final String LEGACY_KDF_PROPERTY

See Also:

Constant Field Values

LEGACY_SUN_PROVIDER_PROPERTY

public static final String LEGACY_SUN_PROVIDER_PROPERTY

See Also:

Constant Field Values

ALLOW_REGISTRATION_XMLDSIG_PROPERTY

@Deprecated
public static final String ALLOW_REGISTRATION_XMLDSIG_PROPERTY

Deprecated.

See Also:

Constant Field Values

ALLOW_CUSTOM_CIPHER_PROPERTY

public static final String ALLOW_CUSTOM_CIPHER_PROPERTY

See Also:

Constant Field Values

ALLOW_NON_STANDARD_KEY_SIZE_PROPERTY

public static final String ALLOW_NON_STANDARD_KEY_SIZE_PROPERTY

See Also:

Constant Field Values

XMLDSIG_PROVIDER_NAME

public static final String XMLDSIG_PROVIDER_NAME

See Also:

Constant Field Values

XML_DSIG_PROVIDER_CLASS_NAME

public static final String XML_DSIG_PROVIDER_CLASS_NAME

The fully qualified class name of the Apache Santuario XMLDSig provider.

Since:

2.1.0

See Also:

Constant Field Values

Method Detail

isFipsEnabled

public static boolean isFipsEnabled()

Checks if FIPS is enabled.

Returns:

true if FIPS is enabled, false otherwise.

isXMLDSigRegistrationAllowedInFips

@Deprecated
public static boolean isXMLDSigRegistrationAllowedInFips()

Deprecated. This method is deprecated as of version 2.1.0 and will be removed in a future version. XMLDSig provider registration in FIPS mode should be handled through alternative mechanisms.

Checks if XMLDSig provider registration is allowed in FIPS mode.

Returns:

true if the system property com.mulesoft.connectors.allow-registration-of-xmldsig-provider-in-fips is set to true

Since:

2.0.0

getXMLDSigProvider

public static Optional<Provider> getXMLDSigProvider()

Gets the XMLDSig provider if one is already registered globally.

This method only checks for existing globally registered providers. It does NOT load or register providers. Provider loading and registration is handled by XmlKeyImpl which loads the provider in the current classloader to avoid classloader issues in MUnit tests.

Returns:

Optional containing the XMLDSig provider if already registered globally, empty otherwise

Since:

2.0

getBcSecurityProviderIfApplicable

public static Optional<Provider> getBcSecurityProviderIfApplicable()

allowLegacyDecryptionKdf

public static boolean allowLegacyDecryptionKdf()

allowLegacyDecryptionSunProvider

public static boolean allowLegacyDecryptionSunProvider()

getSafeErrorMessage

public static String getSafeErrorMessage(Throwable e,
                                         String defaultMessage)

Gets a safe error message from an exception, prioritizing the most specific message available.

Parameters:

e - The exception to get the message from

defaultMessage - The default message to use if no specific message is found

Returns:

A safe error message