zervo/seb-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed some things in Certificates page.

Browse source
This commit is contained in:
Luca Bösch 2023-01-06 11:32:09 +01:00
parent 2383835942
commit 360f77c018
1 changed files with 66 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

132
docs/certificates.rst
View file

@ -1,66 +1,66 @@
.. _certificates-label: .. _certificates-label:
Certificates Certificates
==================== ====================
Overview Overview
-------- --------
Import and store X.509 certificates within SEB Server is a new feature since SEB Server version 1.2. This allows an institutional administrator Import and store X.509 certificates within SEB Server is a new feature since SEB Server version 1.2. This allows an institutional administrator
or an exam administrator to upload and store certificates for further use within SEB Server. or an exam administrator to upload and store certificates for further use within SEB Server.
.. note:: .. note::
Certificates uploaded to SEB Server are stored in a secured certificate-store that is stored within the data base rather then a Certificates uploaded to SEB Server are stored in a secured certificate-store that is stored within the data base rather than a
usual file. The certificated store is password secured and only the binary data of the certificate store is places into the usual file. The certificated store is password secured and only the binary data of the certificate store is placed into the
databease for securty reasons. database for security reasons.
Once a certificate has been uploaded to SEB Server it can be used for various other features of SEB Server where a certificate is needed. Once a certificate has been uploaded to SEB Server it can be used for various other features of SEB Server where a certificate is needed.
One feature that also comes with the SEB Server version 1.2 is the ability to encrypt a connection configuration with a certificate One feature that also comes with the SEB Server version 1.2 is the ability to encrypt a connection configuration with a certificate
that has the right purpose (Identity) to do so. If you need this feature already, please have a look at: :ref:`connection-configuration-label` that has the right purpose (Identity) to do so. If you need this feature already, please have a look at: :ref:`connection-configuration-label`.
Other planed features are the import of certificate encrypted exam configurations as well as to embed certificates within a exam configuration Other planed features are the import of certificate encrypted exam configurations as well as to embed certificates within an exam configuration
to allow certificate pinning between SEB and LMS. to allow certificate pinning between SEB and LMS.
There is currently certificate upload support for two version of certificates: There is currently certificate upload support for two version of certificates:
**PEM** **PEM**
This are usually non password protected certificates in different file-formats. SEB Server currently supports the following PEM file-formats: This are usually non password protected certificates in different file-formats. SEB Server currently supports the following PEM file-formats:
- .pem - .pem
- .crt - .crt
- .cer - .cer
**PKCS12** **PKCS12**
This are usually password protected certificates in different file-formats. SEB Server currently supports the following PKCS12 file-formats: This are usually password protected certificates in different file-formats. SEB Server currently supports the following PKCS12 file-formats:
- .p12 - .p12
- .pfx - .pfx
.. image:: images/certificates/cert_list.png .. image:: images/certificates/cert_list.png
:align: center :align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/certificates/cert_list.png :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/certificates/cert_list.png
Use Cases Use Cases
--------- ---------
**Upload a certificate** **Upload a certificate**
- To upload and store a certificate of supported file type, please open the "SEB Configuration" section and select the "Certificates" page - To upload and store a certificate of supported file type, please open the "SEB Configuration" section and select the "Certificates" page
- You will see the list of known certificates from the SEB Server like in the picture above. - You will see the list of known certificates from the SEB Server like in the picture above.
- Choose "Import Certificate" from the right action pane and the upload dialog will open. - Choose "Import Certificate" from the right action pane and the upload dialog will open.
- Within the upload dialog, select the certificate file on your local machine that you want to upload. - Within the upload dialog, select the certificate file on your local machine that you want to upload.
- If the certificate is password protected, you will need to give the password to upload the certificate. - If the certificate is password protected, you will need to give the password to upload the certificate.
- Chlick on "OK" to start the import. - Click on "OK" to start the import.
- If the import is successful the imported certificate will show up in the list. Otherwise SEB Server will display an error message with the reason of failure. - If the import is successful, the imported certificate will show up in the list. Otherwise, SEB Server will display an error message with the reason of failure.
**Remove / delete a certificate** **Remove / delete a certificate**
- To permanently delete a stored certificate on SEB Server, please open the "SEB Configuration" section and select the "Certificates" page - To permanently delete a stored certificate on SEB Server, please open the "SEB Configuration" section and select the "Certificates" page
- You will see the list of known certificates from the SEB Server like in the picture above. - You will see the list of known certificates from the SEB Server like in the picture above.
- Please select the certificate you want to remove. - Please select the certificate you want to remove.
- Choose "Remove Selected Certificates" from the right action pane and a configuration dialog will appear. - Choose "Remove Selected Certificates" from the right action pane and a configuration dialog will appear.
- If you are sure to delete the selected certificate(s), click on "OK" to delete. - If you are sure to delete the selected certificate(s), click on "OK" to delete.
- The deleted certificates disappear form the certificates list. - The deleted certificates disappear form the certificates list.