Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
The user management, an This article is part of the [[Advanced_Usage|advanced featureAdvanced User's Guide]] of the client/server architectureof BaseX, . The user management defines which permissions are required by a user to perform a specificdatabase command or XQuery expression. Permissions are mostly relevant in the client/server architecture, as the [[Standalone Mode]] and the [[CommandsGUI]] is run with admin permissions.There are a few exceptions such as the [[XQuery Module#xquery:eval|database commandxquery: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==
==User names must follow the [[Valid Names|valid names constraints]], and the database patterns must follow the [[Commands==#Glob_Syntax|Glob Syntax]].
Admin ==Operations== For all operations, admin permissions are needed to execute all of the following commandsrequired: =Commands= '''Creating Create user 'test' (password will be entered on command line). By default, the user will have no permissions ('none'):
As global permissions, you can set 'none', 'read', 'write', 'create' and 'admin':
'''Revoking all global permissions from user 'test': '''
'''Showing local permissions on database 'factbook':'''
'''Dropping of user 'test':'''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}}.
<code>> DROP USER test</code> =Changelog=
[[Category:Server]]Revised in Version 8.0.
→XQuery
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>WRITEwrite</code> permission assignedwill also be able to execute commands requiring <code>READread</code> permission.Next, local Local permissions can be assigned are applied to databases, which . They have a higher precedenceand override globaluser settingspermissions.
[[File:perms.png|none|thumb|200px403px|Permissions hierarchy]]
<code>> CREATE USER test</code>
'''Change password of user 'test' to '71x343sd#': <code>> GRANT none TO ALTER PASSWORD test71x343sd#</code> Valid local permissions are 'none', 'read' and 'write':
'''Granting Grant local write permission on database 'factbook' permissions to user 'test': '''
<code>> GRANT write ON factbook unit* TO test</code>
Note: Local permissions overwrite global permissions.
As a consequence, the 'test' user will only be allowed toaccess (i.e., read and write) database starting with the letters 'factbookunit' database.If no local permissions are set, the global rights areinherited.
'''Showing Show global permissions:'''
<code>> SHOW USERS</code>
==XQuery== The available user functions are listed in the [[User Module]]: '''Create user 'test' with no permissions:''' <code>> SHOW USERS ON factbookdb:create('test', 'top-secret')</code> '''Show detailed information about user 'test':''' <code>user:list-details()[@name = 'test']</code> '''Drop user 'test':''' <code>user:drop('test')</code> =Storage= 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.
