Apply auto TOC to all of docs under docs/security/

AhyoungRyu · AhyoungRyu · commit 587d4baea064 · 2016-06-25T12:45:57.000-07:00
diff --git a/docs/security/authentication.md b/docs/security/authentication.md
@@ -19,11 +19,12 @@ limitations under the License.
 -->
 # Authentication for NGINX
 
-Authentication is company-specific.
+<div id="toc"></div>
 
-One option is to use [Basic Access Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)
+Authentication is company-specific.
+One option is to use [Basic Access Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).
 
-### HTTP Basic Authentication using NGINX
+## HTTP Basic Authentication using NGINX
 
 > **Quote from Wikipedia:** NGINX is a web server. It can act as a reverse proxy server for HTTP, HTTPS, SMTP, POP3, and IMAP protocols, as well as a load balancer and an HTTP cache.
 
@@ -39,7 +40,7 @@ This instruction based on Ubuntu 14.04 LTS but may work with other OS with few c
     ```
     $ apt-get install nginx
     ```
-    *Important: On pre 1.3.13 version of NGINX, Proxy for Websocket may not fully works. Please use latest version of NGINX. See: [NGINX documentation](https://www.nginx.com/blog/websocket-nginx/)*
+    > **NOTE :** On pre 1.3.13 version of NGINX, Proxy for Websocket may not fully works. Please use latest version of NGINX. See: [NGINX documentation](https://www.nginx.com/blog/websocket-nginx/).
 
 1. Setup init script in NGINX
 
@@ -119,12 +120,12 @@ This instruction based on Ubuntu 14.04 LTS but may work with other OS with few c
 1. More security consideration
 
 * Using HTTPS connection with Basic Authentication is highly recommended since basic auth without encryption may expose your important credential information over the network.
-* Using [Shiro Security feature built-into Zeppelin](https://github.com/apache/zeppelin/blob/master/SECURITY-README.md) is recommended if you prefer all-in-one solution for authentication but NGINX may provides ad-hoc solution for re-use authentication served by your system's NGINX server or in case of you need to separate authentication from zeppelin server.
+* Using [Shiro Security feature built-into Zeppelin](./shiroauthentication.html) is recommended if you prefer all-in-one solution for authentication but NGINX may provides ad-hoc solution for re-use authentication served by your system's NGINX server or in case of you need to separate authentication from zeppelin server.
 * It is recommended to isolate direct connection to Zeppelin server from public internet or external services to secure your zeppelin instance from unexpected attack or problems caused by public zone.
 
-### Another option
+## Another option
 
 Another option is to have an authentication server that can verify user credentials in an LDAP server.
 If an incoming request to the Zeppelin server does not have a cookie with user information encrypted with the authentication server public key, the user
 is redirected to the authentication server. Once the user is verified, the authentication server redirects the browser to a specific URL in the Zeppelin server which sets the authentication cookie in the browser.
-The end result is that all requests to the Zeppelin web server have the authentication cookie which contains user and groups information.
+The end result is that all requests to the Zeppelin web server have the authentication cookie which contains user and groups information.
diff --git a/docs/security/interpreter_authorization.md b/docs/security/interpreter_authorization.md
@@ -19,6 +19,8 @@ limitations under the License.
 -->
 # Interpreter and Data Source Authorization
 
+<div id="toc"></div>
+
 ## Interpreter Authorization
 
 Interpreter authorization involves permissions like creating an interpreter and execution queries using it.
diff --git a/docs/security/notebook_authorization.md b/docs/security/notebook_authorization.md
@@ -19,6 +19,9 @@ limitations under the License.
 -->
 # Zeppelin Notebook Authorization
 
+<div id="toc"></div>
+
+## Overview
 We assume that there is an **Shiro Authentication** component that associates a user string and a set of group strings with every NotebookSocket. 
 If you don't set the authentication components yet, please check [Shiro authentication for Apache Zeppelin](./shiroauthentication.html) first.
 
@@ -44,12 +47,12 @@ If someone who doesn't have **read** permission is trying to access the notebook
 ## How it works
 In this section, we will explain the detail about how the notebook authorization works in backend side.
 
-#### NotebookServer
+### NotebookServer
 The [NotebookServer](https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/main/java/org/apache/zeppelin/socket/NotebookServer.java) classifies every notebook operations into three categories: **Read**, **Write**, **Manage**.
 Before executing a notebook operation, it checks if the user and the groups associated with the `NotebookSocket` have permissions. 
 For example, before executing a **Read** operation, it checks if the user and the groups have at least one entity that belongs to the **Reader** entities.
 
-#### Notebook REST API call
+### Notebook REST API call
 Zeppelin executes a [REST API call](https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/main/java/org/apache/zeppelin/rest/NotebookRestApi.java) for the notebook permission information.
 In the backend side, Zeppelin gets the user information for the connection and allows the operation if the users and groups
 associated with the current user have at least one entity that belongs to owner entities for the notebook.
diff --git a/docs/security/shiroauthentication.md b/docs/security/shiroauthentication.md
@@ -20,43 +20,47 @@ limitations under the License.
 {% include JB/setup %}
 
 # Shiro authentication for Apache Zeppelin
+
+<div id="toc"></div>
+
+## Overview
 [Apache Shiro](http://shiro.apache.org/) is a powerful and easy-to-use Java security framework that performs authentication, authorization, cryptography, and session management. In this documentation, we will explain step by step how Shiro works for Zeppelin notebook authentication.
 
 When you connect to Apache Zeppelin, you will be asked to enter your credentials. Once you logged in, then you have access to all notes including other user's notes.
 
 ## Security Setup
 You can setup **Zeppelin notebook authentication** in some simple steps.
 
-####1. Secure the HTTP channel
-To secure the HTTP channel, you have to change both **anon** and **authcBasic** settings in `conf/shiro.ini`. In here, **anon** means "the access is anonymous" and **authcBasic** means "basic auth security".
+### 1. Secure the HTTP channel
+To secure the HTTP channel, you have to change both **anon** and **authc** settings in `conf/shiro.ini`. In here, **anon** means "the access is anonymous" and **authc** means "formed auth security".
 
 The default status of them is
 
 ```
 /** = anon
-#/** = authcBasic
+#/** = authc
 ```
-Deactivate the line "/** = anon" and activate the line "/** = authcBasic" in `conf/shiro.ini` file.
+Deactivate the line "/** = anon" and activate the line "/** = authc" in `conf/shiro.ini` file.
 
 ```
 #/** = anon
-/** = authcBasic
+/** = authc
 ```
 
 For the further information about  `shiro.ini` file format, please refer to [Shiro Configuration](http://shiro.apache.org/configuration.html#Configuration-INISections).
 
-####2. Secure the Websocket channel
+### 2. Secure the Websocket channel
 Set to property **zeppelin.anonymous.allowed** to **false** in `conf/zeppelin-site.xml`. If you don't have this file yet, just copy `conf/zeppelin-site.xml.template` to `conf/zeppelin-site.xml`.
 
-####3. Start Zeppelin
+### 3. Start Zeppelin
 
 ```
 bin/zeppelin-daemon.sh start (or restart)
 ```
 
 Then you can browse Zeppelin at [http://localhost:8080](http://localhost:8080).
 
-####4. Login
+### 4. Login
 Finally, you can login using one of the below **username/password** combinations.
 
 <center><img src="../assets/themes/zeppelin/img/docs-img/zeppelin-login.png"></center>
@@ -67,10 +71,8 @@ user1 = password2
 user2 = password3
 ```
 
-Those combinations are defined in the `conf/shiro.ini` file.
-
-####5. Groups and permissions (optional)
-In case you want to leverage user groups and permissions, use one of the following configuration for LDAP or AD under `[main]` segment of shiro.ini
+### 5. Groups and permissions (optional)
+In case you want to leverage user groups and permissions, use one of the following configuration for LDAP or AD under `[main]` segment in `shiro.ini`
 
 ```
 activeDirectoryRealm = org.apache.zeppelin.server.ActiveDirectoryGroupRealm
