You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/07/20 22:35:51 UTC
[28/29] incubator-tinkerpop git commit: Update docs around Gremlin
Server security.
Update docs around Gremlin Server security.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/6ff68b2b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/6ff68b2b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/6ff68b2b
Branch: refs/heads/master
Commit: 6ff68b2bdaba8325fce4b60dbeee1d73b1cd7ed9
Parents: d2cc86e
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Mon Jul 20 14:57:46 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Mon Jul 20 14:57:46 2015 -0400
----------------------------------------------------------------------
docs/src/gremlin-applications.asciidoc | 4 ++--
docs/static/images/gremlin-server-secure.png | Bin 0 -> 39103 bytes
2 files changed, 2 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/6ff68b2b/docs/src/gremlin-applications.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/gremlin-applications.asciidoc b/docs/src/gremlin-applications.asciidoc
index 79d67ab..cf9b4e3 100644
--- a/docs/src/gremlin-applications.asciidoc
+++ b/docs/src/gremlin-applications.asciidoc
@@ -530,7 +530,7 @@ NOTE: Configuration of link:http://ganglia.sourceforge.net/[Ganglia] requires an
Security
^^^^^^^^
-Gremlin Server provides for several features that aid in the security of the graphs that it exposes. It has built in SSL support and a pluggable authentication framework using link:https://en.wikipedia.org/wiki/Simple_Authentication_and_Security_Layer[SASL] (Simple Authentication and Security Layer). SSL options are described in the configuration settings table above, so this section will focus on authentication.
+image:gremlin-server-secure.png[width=175,float=right] Gremlin Server provides for several features that aid in the security of the graphs that it exposes. It has built in SSL support and a pluggable authentication framework using link:https://en.wikipedia.org/wiki/Simple_Authentication_and_Security_Layer[SASL] (Simple Authentication and Security Layer). SSL options are described in the configuration settings table above, so this section will focus on authentication.
By default, Gremlin Server is configured to allow all requests to be processed (i.e. no authentication). To enable authentication, Gremlin Server must be configured with an `Authenticator` implementation in its YAML file. Gremlin Server comes packaged with an implementation called `SimpleAuthenticator`. The `SimpleAuthenticator` implements the `PLAIN` SASL mechanism (i.e. plain text) to authenticate a request. It validates username/password pairs against a graph database, which must be provided to it as part of the configuration.
@@ -572,7 +572,7 @@ $ bin/gremlin-server.sh conf/gremlin-server-secure.yaml
[INFO] GremlinServer$1 - Channel started at port 8182.
----
-To connect to Gremlin Server with `gremlin-driver`, set the `credentials` and `enableSsl` when constructing the `Cluster`.
+In addition to configuring the authenticator, `gremlin-server-secure.yaml` also enables SSL with a self-signed certificate. As SSL is enabled on the server it must also be enabled on the client when connecting. To connect to Gremlin Server with `gremlin-driver`, set the `credentials` and `enableSsl` when constructing the `Cluster`.
[source,java]
Cluster cluster = Cluster.build().credentials("stephen", "password")
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/6ff68b2b/docs/static/images/gremlin-server-secure.png
----------------------------------------------------------------------
diff --git a/docs/static/images/gremlin-server-secure.png b/docs/static/images/gremlin-server-secure.png
new file mode 100644
index 0000000..0c0dc3d
Binary files /dev/null and b/docs/static/images/gremlin-server-secure.png differ