Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-server
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
caosdb
Software
caosdb-server
Merge requests
!41
REL: update changelog, bump version of pom.xml, update DEPENDENCIES
Code
Review changes
Check out branch
Open in Workspace
Download
Patches
Plain diff
Expand sidebar
Merged
REL: update changelog, bump version of pom.xml, update DEPENDENCIES
release-v0.5.0
into
main
Overview
0
Commits
58
Pipelines
2
Changes
1
Merged
Timm Fitschen
requested to merge
release-v0.5.0
into
main
3 years ago
Overview
0
Commits
58
Pipelines
2
Changes
1
0
0
Merge request reports
Viewing commit
488197a9
Prev
Next
Show latest version
1 file
+
65
−
50
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
488197a9
FIX: Formatting of Authentication.rst
· 488197a9
florian
authored
3 years ago
src/doc/specification/Authentication.rst
+
65
−
50
View file @ 488197a9
Edit in single-file editor
Open in Web IDE
Show full file
Authentication
==============
Some features of CaosDB are available to registered users only. Making any changes
to the data stock via HTTP requires authentication by `username` _plus_ `password`.
They are to be send as a HTTP header, while the password is to be hashed by the sha512 algorithm:
Some features of CaosDB are available to registered users only. Making any
changes to the data stock via HTTP requires authentication by ``username`` **plus**
``password``. They are to be send as a HTTP header, while the password is to be
hashed by the sha512 algorithm:
===========
====================
username: password:
===========
====================
`$username`
`$SHA512ed_password`
===========
====================
===========
== ==
====================
username:
password:
===========
== ==
====================
`
`$username`
` `
`$SHA512ed_password`
`
===========
== ==
====================
Sessions
--------
@@ -20,77 +21,91 @@ Login
Request Challenge
^^^^^^^^^^^^^^^^^
``GET http://host:port/mpidsserver/login?username=$username``
``GET http://host:port/mpidsserver/login`` with `username` header
``
*
``GET http://host:port/mpidsserver/login?username=$username``
*
``GET http://host:port/mpidsserver/login`` with
`
`username`
`
header
*
n
o password required to be sent over http*
*
*N
o password
is
required to be sent over http
.*
*
The request returns an AuthToken with a login challenge as a cookie.
The request returns an AuthToken with a login challenge as a cookie.
The AuthToken is a dictionary of the following form:
{scope=$scope;
mode=LOGIN;
offerer=$offerer;
auth=$auth
expires=$expires;
date=$date;
hash=$hash;
session=$session;
}
$scope:: A uri pattern string. Example: ` {**/*} `
$mode:: `ONETIME`, `SESSION`, or `LOGIN`
$offerer:: A valid username
$auth:: A valid username
$expires:: A `YYYY-MM-DD HH:mm:ss[.nnnn]` date string
$date:: A `YYYY-MM-DD HH:mm:ss[.nnnn]` date string
$hash:: A string
$session:: A string
The challenge is solved by concatenating the `$hash` string and
the user's `$password` string and calculating the sha512 hash of both.
.. code-block::
{scope=$scope;
mode=LOGIN;
offerer=$offerer;
auth=$auth
expires=$expires;
date=$date;
hash=$hash;
session=$session;
}
where
* ``$scope`` :: A uri pattern string. Example: ``{ **/* }``
* ``$mode`` :: ``ONETIME``, ``SESSION``, or ``LOGIN``
* ``$offerer`` :: A valid username
* ``$auth`` :: A valid username
* ``$expires`` :: A ``YYYY-MM-DD HH:mm:ss[.nnnn]`` date string
* ``$date`` :: A ``YYYY-MM-DD HH:mm:ss[.nnnn]`` date string
* ``$hash`` :: A string
* ``$session`` :: A string
The challenge is solved by concatenating the ``$hash`` string and
the user's ``$password`` string and calculating the sha512 hash of both.
Pseudo code:
.. code-block::
$solution = sha512($hash + sha512($password))
$solution = sha512($hash + sha512($password))
Send Solution
^^^^^^^^^^^^^
The old $hash string in the cookie has to be replaces by $solution and
The old
``
$hash
``
string in the cookie has to be replaces by
``
$solution
``
and
the cookie is to be send with the next request:
``PUT http://host:port/mpidsserver/login``
The server will return the user's entity in the HTTP body, e.g.
<Response ...>
.. code-block::
<Response ...>
<User name="$username" ...>
...
</User>
</Response>
</User>
</Response>
and a new AuthToken with `$mode=SESSION` and a new expiration date and so on. This AuthToken cookie is to be send with every request.
and a new AuthToken with ``$mode=SESSION`` and a new expiration date and so
on. This AuthToken cookie is to be send with every request.
Logout
^^^^^^
Send
Send
``PUT http://host:port/mpidsserver/logout``
with a valid AuthToken cookie. No new AuthToken will be returned and no AuthToken with that `$session` will be accepted anymore.
with a valid AuthToken cookie. No new AuthToken will be returned and no
AuthToken with that ``$session`` will be accepted anymore.
Commandline solution with ``curl``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Commandline solution with `curl`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To use curl for talking with the server, first save your password into a
variable: ``PW=$(cat)``
T
o use curl for talking with the server, first save your password into a variable:
``PW=$(cat)``
T
he create a cookie in ``cookie.txt`` like this (note that this makes your
password visible for a short time to everyone on your system:
The create a cookie in `cookie.txt` like this (note that this makes your password visible for a short time to everyone on your system:
``curl -X POST -c cookie.txt -D head.txt -H "Content-Type: application/x-www-form-urlencoded" -d username=<USERNAME> -d
password="$PW" --insecure "https://<SERVER>/login
``
.. code-block:: sh
curl -X POST -c cookie.txt -D head.txt -H "Content-Type: application/x-www-form-urlencoded" -d username=<USERNAME> -d
password="$PW" --insecure "https://<SERVER>/login
To use the cookie, pass it on with later requests:
``curl -X GET -b cookie.txt --insecure "https://<SERVER>/Entity/12345"``
.. code-block:: sh
curl -X GET -b cookie.txt --insecure "https://<SERVER>/Entity/12345"
Loading