← Back to plugin index

HSM Keystore
Description
Configures a HSM keystore. If a normal Java keystore is required, use the 'Java Keystore' Plugin instead.
Type name
HsmKeystore
Class
com.airlock.iam.core.misc.util.crypto.keystore.HsmKeystoreConfig
May be used by
FIDO Attestation Certificate Trust Verifier Public/Private JWK Configuration CRL Distribution Point Extension CRL Checker CRL Certificate Status Checker Encrypted Password Hash
License-Tags
HSM
Properties
Security Provider Name (securityProviderName)
Description
The name of the configured security provider. If a PKCS #11 security provider is used with the Oracle JVM, the name should be set to SunPKCS11-<nameOfToken>, where <nameOfToken> is the token name of the configured provider. If this is set to a SunPKCS11 provider the keystore type has to be set to 'PKCS11'. See the documentation for further details on how to configure the HSM Keystore.
Attributes
String
Mandatory
Suggested values
SunPKCS11-Luna, SunPKCS11-SoftHSM, LunaProvider
Keystore Type (keystoreType)
Description
The type of keystore to use. If a PKCS #11 security provider is used, this property must be set to 'PKCS11'.
Attributes
String
Mandatory
Suggested values
PKCS11, Luna
Keystore File (keystoreFile)
Description
Path to a file-based keystore.
This property only has to be set if the keystore is file-based. In any other case it should be left empty.
Attributes
File/Path
Optional
Keystore Password (keystorePassword)
Description
The password used to read the keystore or HSM module. If the HSM is already authenticated in another way, then this can be empty.
Attributes
String
Optional
Sensitive
YAML Template (with default values) 

type: HsmKeystore
id: HsmKeystore-xxxxxx
displayName: 
comment: 
properties:
  keystoreFile:
  keystorePassword:
  keystoreType:
  securityProviderName: