Management API Reference for client-ssl-context

An SSLContext for use on the client side of a connection.

Children (1)

ssl-session

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.ssl-context	true	/subsystem=elytron/server-ssl-context=* /subsystem=elytron/server-ssl-sni-context=* /subsystem=elytron/dynamic-client-ssl-context=*

Attributes (8)

active-session-count - The count of current active sessions.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The count of current active sessions.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

cipher-suite-filter - The filter to apply to specify the enabled cipher suites for TLSv1.2 and below.

Type	STRING
Default Value	DEFAULT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The filter to apply to specify the enabled cipher suites for TLSv1.2 and below.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "DEFAULT", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

cipher-suite-names - The filter to apply to specify the enabled cipher suites for TLSv1.3.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The filter to apply to specify the enabled cipher suites for TLSv1.3.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

key-manager - Reference to the key manager to use within the SSLContext.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reference to the key manager to use within the SSLContext.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.key-manager", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

protocols - The enabled protocols.

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	SSLv2 SSLv3 TLSv1 TLSv1.3 TLSv1.2 SSLv2Hello TLSv1.1
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The enabled protocols.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "SSLv2", "SSLv2Hello", "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3" ], "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

provider-name - The name of the provider to use. If not specified, all providers from providers will be passed to the SSLContext.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the provider to use. If not specified, all providers from providers will be passed to the SSLContext.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

providers - The name of the providers to obtain the Provider[] to use to load the SSLContext.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the providers to obtain the Provider[] to use to load the SSLContext.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.providers", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

trust-manager - Reference to the trust manager to use within the SSLContext.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reference to the trust manager to use within the SSLContext.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.trust-manager", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (2)

add - Add the SSLContext definition.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
cipher-suite-filter	STRING	false	true	DEFAULT	The filter to apply to specify the enabled cipher suites for TLSv1.2 and below.
cipher-suite-names	STRING	false	true		The filter to apply to specify the enabled cipher suites for TLSv1.3.
key-manager	STRING	false	false		Reference to the key manager to use within the SSLContext.
protocols	LIST	false	true		The enabled protocols.
provider-name	STRING	false	true		The name of the provider to use. If not specified, all providers from providers will be passed to the SSLContext.
providers	STRING	false	false		The name of the providers to obtain the Provider[] to use to load the SSLContext.
trust-manager	STRING	false	false		Reference to the trust manager to use within the SSLContext.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add the SSLContext definition.",
    "request-properties" : {
        "cipher-suite-filter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The filter to apply to specify the enabled cipher suites for TLSv1.2 and below.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "DEFAULT",
            "stability" : "default"
        },
        "cipher-suite-names" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The filter to apply to specify the enabled cipher suites for TLSv1.3.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "key-manager" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the key manager to use within the SSLContext.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.key-manager",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "protocols" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The enabled protocols.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "allowed" : [
                "SSLv2",
                "SSLv2Hello",
                "SSLv3",
                "TLSv1",
                "TLSv1.1",
                "TLSv1.2",
                "TLSv1.3"
            ],
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "provider-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the provider to use. If not specified, all providers from providers will be passed to the SSLContext.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "providers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the providers to obtain the Provider[] to use to load the SSLContext.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.providers",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "trust-manager" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the trust manager to use within the SSLContext.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.trust-manager",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - Remove the SSLContext definition.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the SSLContext definition.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.elytron.client-ssl-context

        
<feature spec="subsystem.elytron.client-ssl-context">
  <param name="client-ssl-context" value="{resource name}"/>
  <param name="cipher-suite-filter" value="{value}"/>
  <param name="cipher-suite-names" value="{value}"/>
  <param name="key-manager" value="{value}"/>
  <param name="protocols" value="{value}"/>
  <param name="provider-name" value="{value}"/>
  <param name="providers" value="{value}"/>
  <param name="trust-manager" value="{value}"/>
<feature/>