WildFly Full 26.1 Model Reference

  1. home
  2. subsystem=elytron
  3. key-manager

A key manager definition for creating the KeyManager as used to create an SSLContext.

Provided capabilities(1)

Name Dynamic Other provider points
org.wildfly.security.key-manager true

none

Attributes (7)

  • algorithm The name of the algorithm to use to create the underlying KeyManagerFactory.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • alias-filter A filter to apply to the aliases returned from the KeyStore, can either be a comma separated list of aliases to return or one of the following formats ALL:-alias1:-alias2, NONE:+alias1:+alias2
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • credential-reference The credential reference to decrypt KeyStore item. (Not a password of the KeyStore.)
    • Attribute Value
    Type OBJECT
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • generate-self-signed-certificate-host If the file that backs the KeyStore does not exist and this attribute is set, then a self-signed certificate will be generated for the specified host name. This is not intended for production use.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • key-store Reference to the KeyStore to use to initialise the underlying KeyManagerFactory.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • provider-name The name of the provider to use to create the underlying KeyManagerFactory.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • providers Reference to obtain the Provider[] to use when creating the underlying KeyManagerFactory.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (3)

  • add Add the new key manager definition.
    Request Parameter Type Required Expressions Allowed Default value Description
    algorithm STRING false true The name of the algorithm to use to create the underlying KeyManagerFactory.
    alias-filter STRING false true A filter to apply to the aliases returned from the KeyStore, can either be a comma separated list of aliases to return or one of the following formats ALL:-alias1:-alias2, NONE:+alias1:+alias2
    credential-reference OBJECT true false The credential reference to decrypt KeyStore item. (Not a password of the KeyStore.)
    generate-self-signed-certificate-host STRING false true If the file that backs the KeyStore does not exist and this attribute is set, then a self-signed certificate will be generated for the specified host name. This is not intended for production use.
    key-store STRING true false Reference to the KeyStore to use to initialise the underlying KeyManagerFactory.
    provider-name STRING false true The name of the provider to use to create the underlying KeyManagerFactory.
    providers STRING false false Reference to obtain the Provider[] to use when creating the underlying KeyManagerFactory.
  • init Reinitialize key manager.
  • remove Remove the key manager definition.