GEODE-2809 Geode docs: Clarify SSL setup for client This closes #473
Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/1999a8f1 Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/1999a8f1 Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/1999a8f1 Branch: refs/heads/feature/GEM-1299 Commit: 1999a8f11d48b8ad0bf4761fc137a921362869d8 Parents: 0540d61 Author: Dave Barnes <dbar...@pivotal.io> Authored: Fri Apr 21 11:54:33 2017 -0700 Committer: zhouxh <gz...@pivotal.io> Committed: Wed Apr 26 23:28:49 2017 -0700 ---------------------------------------------------------------------- .../managing/security/implementing_ssl.html.md.erb | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/1999a8f1/geode-docs/managing/security/implementing_ssl.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/security/implementing_ssl.html.md.erb b/geode-docs/managing/security/implementing_ssl.html.md.erb index c19b6d9..4894de7 100644 --- a/geode-docs/managing/security/implementing_ssl.html.md.erb +++ b/geode-docs/managing/security/implementing_ssl.html.md.erb @@ -66,13 +66,13 @@ You can use Geode configuration properties to enable or disable SSL, to identify protocols, and to provide the location and credentials for key and trust stores. <dt>**ssl-enabled-components**</dt> -<dd>list of components for which to enable SSL. "all" or comma-separated list of components</dd> +<dd>List of components for which to enable SSL. Component list can be "all" or a comma-separated list of components.</dd> <dt>**ssl-require-authentication**</dt> -<dd>Requires two-way authentication, applies to all components except web. boolean - if true (the default), two-way authentication is required.</dd> +<dd>Requires two-way authentication, applies to all components except web. Boolean - if true (the default), two-way authentication is required.</dd> <dt>**ssl-web-require-authentication**</dt> -<dd>Requires two-way authentication for web component. boolean - if true, two-way authentication is required. Default is false (one-way authentication only).</dd> +<dd>Requires two-way authentication for web component. Boolean - if true, two-way authentication is required. Default is false (one-way authentication only).</dd> <dt>**ssl-default-alias**</dt> <dd>A server uses one key store to hold its SSL certificates. All components on that server can share a @@ -151,9 +151,13 @@ ssl-default-alias=Locator-Cert **Client properties** -The client's trust store must trust both locator and server certificates. +On the client, the list of enabled components reflects the server's configuration so the client +knows how it is expected to communicate with (for example) servers and locators. Paths to keystore +and truststore are local to the client. -Since the client did not specify a certificate alias, SSL will use the default certificate in its key store. +In this example, the client's trust store must trust both locator and server certificates. Since +the client does not specify a certificate alias, SSL will use the default certificate in its key +store. ``` pre ssl-enabled-components=server,locator