## Provided Capabilities (1)

Name | Dynamic | Other provider points
--- | --- | ---
org.wildfly.clustering.jgroups.auth-token | true | /subsystem=jgroups/stack=*/protocol=AUTH/token=cipher /subsystem=jgroups/stack=*/protocol=AUTH/token=plain /subsystem=jgroups/stack=*/protocol=AUTH/token=digest /subsystem=jgroups/channel=*/fork=*/protocol=AUTH/token=digest /subsystem=jgroups/channel=*/fork=*/protocol=AUTH/token=plain

## Attributes (5)

- algorithm - The algorithm with which to transform the shared secret

  Type | STRING
  Default Value | RSA
  Is the attribute nillable? | true
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | resource-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The algorithm with which to transform the shared secret",
          "expressions-allowed" : true,
          "required" : false,
          "nillable" : true,
          "default" : "RSA",
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "resource-services",
          "capability-reference" : null
      }

- key-alias - The alias of the encryption key from the specified key store

  Type | STRING
  Does the attribute allow expression? | true
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | resource-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "The alias of the encryption key from the specified key store",
          "expressions-allowed" : true,
          "required" : true,
          "nillable" : false,
          "min-length" : 1,
          "max-length" : 2147483647,
          "stability" : "default",
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "resource-services",
          "capability-reference" : null
      }

- key-credential-reference - The credentials required to obtain the encryption key from the key store.

  Type | OBJECT
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "OBJECT"
          },
          "description" : "The credentials required to obtain the encryption key from the key store.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-constraints" : {"sensitive" : {"credential" : {"type" : "core"}}},
          "value-type" : {
              "store" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The name of the credential store holding the alias to credential.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "capability-reference" : "org.wildfly.security.credential-store",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "alias" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The alias which denotes stored secret or credential in the store.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "requires" : ["store"],
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "type" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The type of credential this reference is denoting.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "clear-text" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The secret specified using clear text. Check credential store way of supplying credential/secrets to services.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              }
          },
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

- key-store - A reference to a key store containing the encryption key

  Type | STRING
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | resource-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "STRING"
          },
          "description" : "A reference to a key store containing the encryption key",
          "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" : "resource-services"
      }

- shared-secret-reference - The credentials required to obtain the shared secret from the key store.

  Type | OBJECT
  Where is the attribute stored? | configuration
  Access Type | read-write
  Is restarted required? | no-services
  Stability Level | default
  Raw DMR model |
      {
          "type" : {
              "TYPE_MODEL_VALUE" : "OBJECT"
          },
          "description" : "The credentials required to obtain the shared secret from the key store.",
          "expressions-allowed" : false,
          "required" : true,
          "nillable" : false,
          "stability" : "default",
          "access-constraints" : {"sensitive" : {"credential" : {"type" : "core"}}},
          "value-type" : {
              "store" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The name of the credential store holding the alias to credential.",
                  "expressions-allowed" : false,
                  "required" : false,
                  "nillable" : true,
                  "capability-reference" : "org.wildfly.security.credential-store",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "alias" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The alias which denotes stored secret or credential in the store.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "requires" : ["store"],
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "type" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The type of credential this reference is denoting.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "clear-text" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The secret specified using clear text. Check credential store way of supplying credential/secrets to services.",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              }
          },
          "access-type" : "read-write",
          "storage" : "configuration",
          "restart-required" : "no-services",
          "capability-reference" : null
      }

## Operations (2)

- add - Adds an authentication token

  Request Parameter | Type | Required | Expressions Allowed | Default value | Description
  --- | --- | --- | --- | --- | ---
  algorithm | STRING | false | true | RSA | The algorithm with which to transform the shared secret
  key-alias | STRING | true | true |  | The alias of the encryption key from the specified key store
  key-credential-reference | OBJECT | true | false |  | The credentials required to obtain the encryption key from the key store.
  key-store | STRING | true | false |  | A reference to a key store containing the encryption key
  shared-secret-reference | OBJECT | true | false |  | The credentials required to obtain the shared secret from the key store.

  Raw DMR model |
      {
          "operation-name" : "add",
          "description" : "Adds an authentication token",
          "request-properties" : {
              "algorithm" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The algorithm with which to transform the shared secret",
                  "expressions-allowed" : true,
                  "required" : false,
                  "nillable" : true,
                  "default" : "RSA",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "key-alias" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "The alias of the encryption key from the specified key store",
                  "expressions-allowed" : true,
                  "required" : true,
                  "nillable" : false,
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "key-credential-reference" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "OBJECT"
                  },
                  "description" : "The credentials required to obtain the encryption key from the key store.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "stability" : "default",
                  "value-type" : {
                      "store" : {
                          "type" : {
                              "TYPE_MODEL_VALUE" : "STRING"
                          },
                          "description" : "The name of the credential store holding the alias to credential.",
                          "expressions-allowed" : false,
                          "required" : false,
                          "nillable" : true,
                          "capability-reference" : "org.wildfly.security.credential-store",
                          "min-length" : 1,
                          "max-length" : 2147483647,
                          "stability" : "default"
                      },
                      "alias" : {
                          "type" : {
                              "TYPE_MODEL_VALUE" : "STRING"
                          },
                          "description" : "The alias which denotes stored secret or credential in the store.",
                          "expressions-allowed" : true,
                          "required" : false,
                          "nillable" : true,
                          "requires" : ["store"],
                          "min-length" : 1,
                          "max-length" : 2147483647,
                          "stability" : "default"
                      },
                      "type" : {
                          "type" : {
                              "TYPE_MODEL_VALUE" : "STRING"
                          },
                          "description" : "The type of credential this reference is denoting.",
                          "expressions-allowed" : true,
                          "required" : false,
                          "nillable" : true,
                          "min-length" : 1,
                          "max-length" : 2147483647,
                          "stability" : "default"
                      },
                      "clear-text" : {
                          "type" : {
                              "TYPE_MODEL_VALUE" : "STRING"
                          },
                          "description" : "The secret specified using clear text. Check credential store way of supplying credential/secrets to services.",
                          "expressions-allowed" : true,
                          "required" : false,
                          "nillable" : true,
                          "min-length" : 1,
                          "max-length" : 2147483647,
                          "stability" : "default"
                      }
                  }
              },
              "key-store" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "STRING"
                  },
                  "description" : "A reference to a key store containing the encryption key",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "capability-reference" : "org.wildfly.security.key-store",
                  "min-length" : 1,
                  "max-length" : 2147483647,
                  "stability" : "default"
              },
              "shared-secret-reference" : {
                  "type" : {
                      "TYPE_MODEL_VALUE" : "OBJECT"
                  },
                  "description" : "The credentials required to obtain the shared secret from the key store.",
                  "expressions-allowed" : false,
                  "required" : true,
                  "nillable" : false,
                  "stability" : "default",
                  "value-type" : {
                      "store" : {
                          "type" : {
                              "TYPE_MODEL_VALUE" : "STRING"
                          },
                          "description" : "The name of the credential store holding the alias to credential.",
                          "expressions-allowed" : false,
                          "required" : false,
                          "nillable" : true,
                          "capability-reference" : "org.wildfly.security.credential-store",
                          "min-length" : 1,
                          "max-length" : 2147483647,
                          "stability" : "default"
                      },
                      "alias" : {
                          "type" : {
                              "TYPE_MODEL_VALUE" : "STRING"
                          },
                          "description" : "The alias which denotes stored secret or credential in the store.",
                          "expressions-allowed" : true,
                          "required" : false,
                          "nillable" : true,
                          "requires" : ["store"],
                          "min-length" : 1,
                          "max-length" : 2147483647,
                          "stability" : "default"
                      },
                      "type" : {
                          "type" : {
                              "TYPE_MODEL_VALUE" : "STRING"
                          },
                          "description" : "The type of credential this reference is denoting.",
                          "expressions-allowed" : true,
                          "required" : false,
                          "nillable" : true,
                          "min-length" : 1,
                          "max-length" : 2147483647,
                          "stability" : "default"
                      },
                      "clear-text" : {
                          "type" : {
                              "TYPE_MODEL_VALUE" : "STRING"
                          },
                          "description" : "The secret specified using clear text. Check credential store way of supplying credential/secrets to services.",
                          "expressions-allowed" : true,
                          "required" : false,
                          "nillable" : true,
                          "min-length" : 1,
                          "max-length" : 2147483647,
                          "stability" : "default"
                      }
                  }
              }
          },
          "reply-properties" : {},
          "stability" : "default",
          "read-only" : false,
          "runtime-only" : false
      }

- remove - Removes an authentication token

  Raw DMR model |
      {
          "operation-name" : "remove",
          "description" : "Removes an authentication token",
          "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.jgroups.channel.fork.protocol.AUTH.token.cipher

      <feature spec="subsystem.jgroups.channel.fork.protocol.AUTH.token.cipher">
        <param name="channel" value="{resource name}"/>
        <param name="fork" value="{resource name}"/>
        <param name="algorithm" value="{value}"/>
        <param name="key-alias" value="{value}"/>
        <param name="key-credential-reference" value="{value}"/>
        <param name="key-store" value="{value}"/>
        <param name="shared-secret-reference" value="{value}"/>
      <feature/>