Difference between revisions of "User Management"

From BaseX Documentation
Jump to navigation Jump to search
Line 10: Line 10:
 
With {{Version|8.0}}, the user management has been reworked:
 
With {{Version|8.0}}, the user management has been reworked:
  
* Permissions can be manually edited, as they are now stored as XML.
+
* Permissions can now be manually edited, as they are stored as XML.
 
* The permission file has been moved from the home directory to the database directory. It was renamed from {{Code|.basexperm}} to {{Code|users.xml}}.
 
* The permission file has been moved from the home directory to the database directory. It was renamed from {{Code|.basexperm}} to {{Code|users.xml}}.
* Local permissions are now defined for database glob patterns. Both local and global permissions are stored in the same file.
+
* Local permissions are now defined for database glob patterns instead of single databases. Both local and global permissions are stored in the same file.
* A new [[User Module]] was introduced to allow user management via XQuery.
+
* A new [[User Module]] is available, which allows user management via XQuery.
  
 
==Rules==
 
==Rules==

Revision as of 00:09, 11 December 2014

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.

With Version 8.0, the user management has been reworked:

  • Permissions can now be manually edited, as they are stored as XML.
  • The permission file has been moved from the home directory to the database directory. It was renamed from .basexperm to users.xml.
  • Local permissions are now defined for database glob patterns instead of single databases. Both local and global permissions are stored in the same file.
  • A new User Module is available, which allows user management via XQuery.

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.

Commands

Admin permissions are required to execute all of the following 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

Show detailed information about user 'test' via XQuery:

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

Drop of user 'test' via XQuery:

> XQUERY user:drop('test')

Changelog

Revised in Version 8.0.