Difference between revisions of "User Management"

From BaseX Documentation
Jump to navigation Jump to search
(44 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==User Management==
+
This article is part of the [[Advanced User's Guide]]. The user management defines which permissions are required by a user to perform a database command or XQuery expression.
  
<p>Admin permissions are needed to execute one of the following processes.</p>
+
Permissions are mostly relevant in the client/server architecture, as the [[Standalone Mode]] and the [[GUI]] is run with admin permissions.
 +
There are a few exceptions such as the [[XQuery Module#xquery:eval|xquery:eval]] function: Its execution scope can also be limited by specifying a permission.
 +
 
 +
Please take care of usual security measures: ensure that your password will not end up in your bash history, avoid sending passwords via ordinary REST requests, etc.
 +
 
 +
==Rules==
 +
 
 +
In the permission hierarchy below, the existing permissions are illustrated.
 +
A higher permission includes all lower permissions.
 +
For example, all users who have the <code>write</code> permission assigned
 +
will also be able to execute commands requiring <code>read</code> permission.
 +
 
 +
Local permissions are applied to databases. They have a higher precedence
 +
and override global permissions.
 +
 
 +
[[File:perms.png|none|thumb|403px|Permissions hierarchy]]
 +
 
 +
User names must follow the [[Valid Names|valid names constraints]], and the database patterns must follow the [[Commands#Glob_Syntax|Glob Syntax]].
 +
 
 +
==Operations==
 +
 
 +
For all operations, admin permissions are required:
 +
 
 +
=Commands=
 +
 
 +
'''Create user 'test' (password will be entered on command line). By default, the user will have no permissions ('none'):
 +
 
 +
<code>&gt; CREATE USER test</code>
 +
 
 +
'''Change password of user 'test' to '71x343sd#':
 +
 
 +
<code>&gt; ALTER PASSWORD test 71x343sd#</code>  
 
   
 
   
===Creating user 'test' with password 'test'===
+
'''Grant local write permissions to user 'test': '''
<code>&gt; CREATE USER test test</code>
+
 
+
<code>&gt; GRANT write ON unit* TO test</code>  
<p>As global permissions, you can set 'none', 'read', 'write', 'create' and 'admin':</p>
+
 
 
===Revoking all global permissions from user 'test'===
 
<code>&gt; GRANT none TO test</code>
 
 
<p>Valid local permissions are 'none', 'read' and 'write':</p>
 
 
===Granting write permission on database 'factbook' to user 'test'===
 
<code>&gt; GRANT write ON factbook TO test</code>  
 
<p>
 
 
Note: Local permissions overwrite global permissions.
 
Note: Local permissions overwrite global permissions.
As a consequence, the 'test' user will only be allowed to
+
As a consequence, the 'test' user will only be allowed to access (i.e., read and write)
access (i.e., read and write) the 'factbook' database.
+
database starting with the letters 'unit'. If no local permissions are set,
If no local permissions are set, the global rights are
+
the global rights are inherited.
inherited.
 
</p>
 
 
   
 
   
===Showing global permissions===
+
'''Show global permissions:'''
 +
 
 
<code>&gt; SHOW USERS</code>  
 
<code>&gt; SHOW USERS</code>  
 
===Showing local permissions on database 'factbook'===
 
<code>&gt; SHOW USERS ON factbook</code>
 
  
===Dropping of user 'test'===
+
==XQuery==
<code>&gt; DROP USER test</code>  
+
 
 +
The available user functions are listed in the [[User Module]]:
 +
 
 +
'''Create user 'test' with no permissions:'''
 +
 
 +
<code>db:create('test', 'top-secret')</code>
 +
 
 +
'''Show detailed information about user 'test':'''
 +
 
 +
<code>user:list-details()[@name = 'test']</code>
  
==Permissions hierarchy==
+
'''Drop user 'test':'''
  
In the permission hierarchy the higher permission contains all underlying rights.
+
<code>user:drop('test')</code>
For example if you have the permission 'write' you also have the permission 'read'.
 
  
[[File:perms.png|none|thumb|200px|Permissions hierarchy]]
+
=Storage=
  
==Commands and Permissions table==
+
The permission file {{Code|users.xml}} is stored in the database directory. This file can be manually edited; it will be parsed once when BaseX is started.
  
In this table you can see an overview about the BaseX commands and the
+
Salted SHA256 hashes are used for authentication (the current timestamp will be used as salt). Additionally, digest hashes are used in the client/server architecture and the [[Clients|Language Bindings]], and in the [[Web Application|HTTP Context]] if the [[Options#AUTHMETHOD|AUTHMETHOD]] is set to {{Code|Digest}}.
permission you need to execute the command. Without the needed permission
 
an error is thrown and the command will not be executed.
 
  
{| border="1" cellpadding="5" cellspacing="0"
+
=Changelog=
!Command
 
!Description
 
!Needed Permission
 
|-
 
|close
 
|Closes currently opened database.
 
|None
 
|-
 
|exit
 
|Exits BaseX.
 
|None
 
|-
 
|get
 
|Returns a property value.
 
|None
 
|-
 
|help
 
|Shows the help texts.
 
|None
 
|-
 
|password
 
|Changes password of currently logged-in user.
 
|None
 
|-
 
|set
 
|Sets a property value.
 
|None
 
|-
 
|xquery
 
|Executes a xquery function without database access.
 
|None
 
|-
 
|info
 
|Shows information about the currently opened database.
 
|Read
 
|-
 
|list
 
|Shows all available databases.
 
|Read
 
|-
 
|open
 
|Opens a database.
 
|Read
 
|-
 
|xquery
 
|Executes a read-only xquery function with database access.
 
|Read
 
|-
 
|add
 
|Adds documents to the currently opened database.
 
|Write
 
|-
 
|create index
 
|Creates the specified index.
 
|Write
 
|-
 
|delete
 
|Deletes documents from the currently opened database.
 
|Write
 
|-
 
|drop index
 
|Drops the specified index.
 
|Write
 
|-
 
|optimize
 
|Optimizes the database structure and renews the indexes.
 
|Write
 
|-
 
|xquery
 
|Executes a xquery update function.
 
|Write
 
|-
 
|alter db
 
|Renames a database.
 
|Create
 
|-
 
|create db
 
|Creates a database.
 
|Create
 
|-
 
|drop db
 
|Drops a database.
 
|Create
 
|-
 
|export
 
|Exports the database content.
 
|Create
 
|-
 
|alter user
 
|Changes the password of an user.
 
|Admin
 
|-
 
|create users
 
|Creates a new user.
 
|Admin
 
|-
 
|drop user
 
|Drops an user.
 
|Admin
 
|-
 
|grant
 
|Assigns permissions to users.
 
|Admin
 
|-
 
|kill
 
|Kills an user session on the server.
 
|Admin
 
|-
 
|show
 
|Shows different server information.
 
|Admin
 
|}
 
  
[[Category:Server]]
+
Revised in Version 8.0.

Revision as of 17:39, 2 August 2016

This article is part of the Advanced User's Guide. The user management defines which permissions are required by a user to perform a database command or XQuery expression.

Permissions are mostly relevant in the client/server architecture, as the Standalone Mode and the GUI is run with admin permissions. There are a few exceptions such as the xquery:eval function: Its execution scope can also be limited by specifying a permission.

Please take care of usual security measures: ensure that your password will not end up in your bash history, avoid sending passwords via ordinary REST requests, etc.

Rules

In the permission hierarchy below, the existing permissions are illustrated. A higher permission includes all lower permissions. For example, all users who have the write permission assigned will also be able to execute commands requiring read permission.

Local permissions are applied to databases. They have a higher precedence and override global permissions.

Permissions hierarchy

User names must follow the valid names constraints, and the database patterns must follow the Glob Syntax.

Operations

For all operations, admin permissions are required:

Commands

Create user 'test' (password will be entered on command line). By default, the user will have no permissions ('none'):

> CREATE USER test

Change password of user 'test' to '71x343sd#':

> ALTER PASSWORD test 71x343sd#

Grant local write permissions to user 'test':

> GRANT write ON unit* TO test

Note: Local permissions overwrite global permissions. As a consequence, the 'test' user will only be allowed to access (i.e., read and write) database starting with the letters 'unit'. If no local permissions are set, the global rights are inherited.

Show global permissions:

> SHOW USERS

XQuery

The available user functions are listed in the User Module:

Create user 'test' with no permissions:

db:create('test', 'top-secret')

Show detailed information about user 'test':

user:list-details()[@name = 'test']

Drop user 'test':

user:drop('test')

Storage

The permission file users.xml is stored in the database directory. This file can be manually edited; it will be parsed once when BaseX is started.

Salted SHA256 hashes are used for authentication (the current timestamp will be used as salt). Additionally, digest hashes are used in the client/server architecture and the Language Bindings, and in the HTTP Context if the AUTHMETHOD is set to Digest.

Changelog

Revised in Version 8.0.