Management API Reference for filtering-key-store

A filtering KeyStore definition.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.key-store	true	/subsystem=elytron/ldap-key-store=* /subsystem=elytron/key-store=* /subsystem=security/elytron-key-store=* /subsystem=security/elytron-trust-store=*

Attributes (3)

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

Type	STRING
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" : "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", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

key-store - Name of filtered KeyStore.

Type	STRING
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" : "Name of filtered KeyStore.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.key-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

state - The state of the underlying service that represents this KeyStore at runtime, if it is anything other than UP runtime operations will not be available.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Allowed Values	DOWN STARTING START_FAILED UP STOPPING REMOVED
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The state of the underlying service that represents this KeyStore at runtime, if it is anything other than UP runtime operations will not be available.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "DOWN", "STARTING", "START_FAILED", "UP", "STOPPING", "REMOVED" ], "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

Operations (5)

add - Add a new KeyStore definition.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
alias-filter	STRING	true	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
key-store	STRING	true	false		Name of filtered KeyStore.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new KeyStore definition.",
    "request-properties" : {
        "alias-filter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "key-store" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of filtered KeyStore.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.security.key-store",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

read-alias - Read an alias from a KeyStore.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
alias	STRING	true	false		The alias of the KeyStore item to read.
verbose	BOOLEAN	false	false	true	Whether or not to include the public key and encoded form of a certificate in the output. The default value is true.

Raw DMR model


{
    "operation-name" : "read-alias",
    "description" : "Read an alias from a KeyStore.",
    "request-properties" : {
        "alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The alias of the KeyStore item to read.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "verbose" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether or not to include the public key and encoded form of a certificate in the output. The default value is true.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

read-aliases - Read aliases from a KeyStore.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
recursive	BOOLEAN	false	false	false	Include information about each alias in the KeyStore. The default value is false.
verbose	BOOLEAN	false	false	true	Whether or not to include the public key and encoded form of a certificate in the output. The default value is true.

Raw DMR model


{
    "operation-name" : "read-aliases",
    "description" : "Read aliases from a KeyStore.",
    "request-properties" : {
        "recursive" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Include information about each alias in the KeyStore. The default value is false.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "verbose" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether or not to include the public key and encoded form of a certificate in the output. The default value is true.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "requires" : ["recursive"],
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

remove - Remove the KeyStore definition.

Raw DMR model


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

remove-alias - Remove an alias from a KeyStore.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
alias	STRING	true	false		The alias of the KeyStore item to remove.

Raw DMR model


{
    "operation-name" : "remove-alias",
    "description" : "Remove an alias from a KeyStore.",
    "request-properties" : {"alias" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The alias of the KeyStore item to remove.",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

Galleon Features

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

subsystem.elytron.filtering-key-store

        
<feature spec="subsystem.elytron.filtering-key-store">
  <param name="filtering-key-store" value="{resource name}"/>
  <param name="alias-filter" value="{value}"/>
  <param name="key-store" value="{value}"/>
<feature/>