-
Notifications
You must be signed in to change notification settings - Fork 2.8k
[ZEPPELIN-939] Improve notebook authorization documentation #947
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,21 +17,39 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --> | ||
| # Notebook Authorization | ||
| # Zeppelin Notebook Authorization | ||
|
|
||
| We assume that there is an authentication component that associates a user string and a set of group strings with every NotebookSocket. | ||
| 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. | ||
|
|
||
| Each note has the following: | ||
| * set of owner entities (users or groups) | ||
| * set of reader entities (users or groups) | ||
| * set of writer entities (users or groups) | ||
| ## Authorization Setting | ||
| You can set Zeppelin notebook permissions in each notebooks. Of course only **notebook owners** can change this configuration. | ||
| Just click **Lock icon** and open the permission setting page in your notebook. | ||
|
|
||
| If a set is empty, it means that any user can perform that operation. | ||
| As you can see, each Zeppelin notebooks has 3 entities : | ||
|
|
||
| The NotebookServer classifies every Note operation into three categories: read, write, manage. | ||
| Before executing a Note operation, it checks if the user and the groups associated with the NotebookSocket have permissions. For example, before executing an read | ||
| operation, it checks if the user and the groups have at least one entity that belongs to the reader entities. | ||
| * Owners ( users or groups ) | ||
| * Readers ( users or groups ) | ||
| * Writers ( users or groups ) | ||
|
|
||
| To initialize and modify note permissions, we provide UI like "Interpreter binding". The user inputs comma separated entities for owners, readers and writers. | ||
| We execute a rest api call with this information. In the backend we get the user information for the connection and allow the operation if the user and groups | ||
| associated with the current user have at least one entity that belongs to owner entities for the note. | ||
| <center><img src="../assets/themes/zeppelin/img/docs-img/permission_setting.png"></center> | ||
|
|
||
| Fill out the each forms with comma seperated **users** and **groups** configured in `conf/shiro.ini` file. | ||
| If the form is empty (*), it means that any users can perform that operation. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is that empty or "*"?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @felixcheung The default value is set as |
||
|
|
||
| If someone who doesn't have **read** permission is trying to access the notebook or someone who doesn't have **write** permission is trying to edit the notebook, Zeppelin will ask to login or block the user. | ||
|
|
||
| <center><img src="../assets/themes/zeppelin/img/docs-img/insufficient_privileges.png"></center> | ||
|
|
||
| ## How it works | ||
| In this section, we will explain the detail about how the notebook authorization works in backend side. | ||
|
|
||
| #### NotebookServer | ||
| The [NotebookServer](https://github.com/apache/incubator-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 | ||
| Zeppelin executes a [REST API call](https://github.com/apache/incubator-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. | ||
This file was deleted.

There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree we should fine tune this description, but is it more confusing that it is absent?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@felixcheung Thanks for sharing your opinion. Yeah you're right. I also saw some informations is added in this docs at #860. So I'll revert this docs then.