Rev 581 | Rev 928 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 217 | daniel-mar | 1 | <!DOCTYPE html> |
| 2 | |||
| 3 | <html lang="en"> |
||
| 4 | |||
| 5 | <head> |
||
| 6 | <title>Procedural documentation related to privacy</title> |
||
| 371 | daniel-mar | 7 | <style> |
| 8 | h2 { |
||
| 9 | font-size:large !important; |
||
| 434 | daniel-mar | 10 | text-decoration: underline !important; |
| 11 | font-weight: bold !important; |
||
| 371 | daniel-mar | 12 | } |
| 13 | h3 { |
||
| 14 | font-size:medium !important; |
||
| 434 | daniel-mar | 15 | text-decoration: underline !important; |
| 16 | font-style: italic !important; |
||
| 371 | daniel-mar | 17 | } |
| 386 | daniel-mar | 18 | .underline { |
| 19 | text-decoration: underline; |
||
| 20 | } |
||
| 217 | daniel-mar | 21 | </style> |
| 386 | daniel-mar | 22 | </head> |
| 23 | |||
| 24 | <body> |
||
| 217 | daniel-mar | 25 | <h1>Procedural documentation related to privacy</h1> |
| 581 | daniel-mar | 26 | <p><em>Revision: 17 May 2021</em></p> |
| 344 | daniel-mar | 27 | <p><strong><em>Important</em></strong><em>: This document is written by ViaThinkSoft (the developer of the software “OIDplus”) and gives general information on how OIDplus works regarding privacy-related topics. Since OIDplus is a web-software that can be downloaded, installed, and operated by anyone on their server systems, this document DOES NOT describe how the owners/administrators of this particular installation of OIDplus are handling your data. Therefore, the owner of this system should provide an additional/individual privacy statement.</em></p> |
| 434 | daniel-mar | 28 | <a id="terminology"></a><h2>Parties / Terminology</h2> |
| 219 | daniel-mar | 29 | <p><strong>ViaThinkSoft</strong> is the developer of the software solution “OIDplus”.</p> |
| 30 | <p><strong>OIDplus</strong> is a software solution to organize, manage and publish information about <strong>Object Identifiers</strong> (hereinafter referred to as OIDs) and their owners |
||
| 31 | (hereinafter referred to as <strong>Registration Authority</strong> or <strong>RA</strong>). |
||
| 239 | daniel-mar | 32 | It can be downloaded and installed on any server. A particular installation of OIDplus is called <strong>OIDplus instance</strong> or <strong>OIDplus system</strong>. |
| 344 | daniel-mar | 33 | Operators of OIDplus instances are usually software developers, workgroups, companies, or other organizations, hereinafter referred to as <strong>system owner</strong>. |
| 34 | A <strong>system administrator</strong> is a person who manages and maintains the OIDplus software and is usually also the same person who manages the server’s hardware and software.</p> |
||
| 217 | daniel-mar | 35 | <p><strong>Object Identifiers</strong> are organized in a hierarchical structure where RAs are delegating OIDs underneath the OIDs they are managing, to other RAs. In the context of a specific RA and OID, the “<strong>Superior RA</strong>” is the RA that has delegated the root OID of a specific RA. However, the statements about “Superior RAs” in this document do only apply if the Superior RA is using OIDplus to delegate the OID.</p> |
| 434 | daniel-mar | 36 | <a id="server_client_side"></a><h2>Definition of server-side and client-side</h2> |
| 344 | daniel-mar | 37 | <p>OIDplus is a web application written in the programming languages PHP (running on server-side) and HTML/JavaScript (running on the client-side).</p> |
| 434 | daniel-mar | 38 | <h3>Server-side</h3> |
| 369 | daniel-mar | 39 | <p>The PHP scripts of OIDplus are processed through a PHP script interpreter running on top of a web server software (“HTTP web server”), for example, “Apache” or “Nginx”. The actual data of OIDplus (OIDs, RAs, …) is stored in a DBMS (Database Management |
| 40 | System) e.g. “MySQL”, “MariaDB” or “PostgreSQL”. The DBMS is usually installed on the same server machine where PHP/Apache is installed, but it can be installed on any machine by the server administrator.</p> |
||
| 434 | daniel-mar | 41 | <h3>Client-side</h3> |
| 375 | daniel-mar | 42 | <p>While the user browses OIDplus, the server-side serves HTML and JavaScript contents to the client computer. Using a web browser software (like “Chrome” or “Firefox”), these contents are processed and displayed on the screen. Various JavaScript scripts are either required to run OIDplus or are improving the user experience, e.g. by reloading OID descriptions without reloading the whole page while the user browses OIDplus. There might be a few external JavaScripts included (currently only ReCaptcha), which are described at the end of the document.</p> |
| 434 | daniel-mar | 43 | <a id="scope"></a><h2>Scope of this document</h2> |
| 344 | daniel-mar | 44 | <p>This document contains information about the OIDplus software only. It is independent of the behavior of the client-side software (web browser, Operating system, firewalls, …), independent from the behavior of hardware (network routers or firewalls, …), independent from the behavior of the server-side software (Apache, PHP, MySQL/MariaDB/PostgreSQL/..., Operating system, etc.) and the practices how the system administrator is operating the server software, stores log files, manages firewalls, etc.</p> |
| 434 | daniel-mar | 45 | <a id="oid_information"></a><h2>OID information</h2> |
| 344 | daniel-mar | 46 | <p>The main purpose of OIDplus is to show and manage information on OID information.</p> |
| 219 | daniel-mar | 47 | <p>Some attributes of Object Identifiers (like ASN.1 identifiers) can only be changed by the Superior RA and not by the RA of that OID. On the other hand, some other information (like the title and description) can only be changed by the RA owning the OID and not by the Superior RA. The system administrator can edit all information.</p> |
| 434 | daniel-mar | 48 | <h3>Hidden OID information</h3> |
| 217 | daniel-mar | 49 | <p>A superior RA can set the “hidden” flag to an OID they delegate. This means the OID and all its subsequent OIDs are invisible to the public. However, the public can see the existence of hidden OIDs by a notice “<em>XX OIDs are hidden. Log in to see them</em>”.</p> |
| 219 | daniel-mar | 50 | <p>The system administrator can see all OIDs, even if they are hidden.</p> |
| 344 | daniel-mar | 51 | <p>An owner of an OID can see all OIDs which are directing to his root OID, even if some of them are hidden.</p> |
| 219 | daniel-mar | 52 | <p>If you are an <strong>owner of an OID</strong> and want to make your OID hidden from the public, please contact your <strong>superior RA</strong> (preferential) or the <strong>system administrator</strong> and ask them to mark your OID as hidden. Please note that this will also hide all OIDs that you delegate to yourself or other RAs.</p> |
| 434 | daniel-mar | 53 | <h3>Overview: Managed information about OIDs:</h3> |
| 217 | daniel-mar | 54 | <table border="1"> |
| 55 | <tr> |
||
| 581 | daniel-mar | 56 | <td width="111"><strong>Attribute:</strong></td> |
| 57 | <td width="196"><strong>Can only be changed by:</strong></td> |
||
| 58 | <td width="154"><strong>If not marked “hidden“, visible to:</strong></td> |
||
| 59 | <td width="154"><strong>If marked “hidden“, visible to:</strong></td> |
||
| 217 | daniel-mar | 60 | </tr> |
| 61 | <tr> |
||
| 581 | daniel-mar | 62 | <td width="111">Numeric Identifier</td> |
| 63 | <td width="196">Superior RA<br> System administrator<br> (can only be defined during creation and never be updated!)</td> |
||
| 64 | <td width="154">Public<br> RA<br> Superior RA<br> System administrator</td> |
||
| 65 | <td width="154">Superior RA<br> System administrator</td> |
||
| 217 | daniel-mar | 66 | </tr> |
| 67 | <tr> |
||
| 581 | daniel-mar | 68 | <td width="111">Alphanumeric identifier (for ASN.1 notation)</td> |
| 69 | <td width="196">Superior RA<br> System administrator</td> |
||
| 70 | <td width="154">Public<br> RA<br> Superior RA<br> System administrator</td> |
||
| 71 | <td width="154">Superior RA<br> System administrator</td> |
||
| 217 | daniel-mar | 72 | </tr> |
| 73 | <tr> |
||
| 581 | daniel-mar | 74 | <td width="111">Unicode label<br>(for IRI notation)</td> |
| 75 | <td width="196">Superior RA<br> System administrator</td> |
||
| 76 | <td width="154">Public<br> RA<br> Superior RA<br> System administrator</td> |
||
| 77 | <td width="154">Superior RA<br> System administrator</td> |
||
| 217 | daniel-mar | 78 | </tr> |
| 79 | <tr> |
||
| 581 | daniel-mar | 80 | <td width="111">RA</td> |
| 81 | <td width="196">Superior RA<br> System administrator</td> |
||
| 82 | <td width="154">Public<br> RA<br> Superior RA<br> System administrator</td> |
||
| 83 | <td width="154">Superior RA<br> System administrator</td> |
||
| 217 | daniel-mar | 84 | </tr> |
| 85 | <tr> |
||
| 581 | daniel-mar | 86 | <td width="111">Comment</td> |
| 87 | <td width="196">Superior RA<br> System administrator</td> |
||
| 88 | <td width="154">Public<br> RA<br> Superior RA<br> System administrator</td> |
||
| 89 | <td width="154">Superior RA<br> System administrator</td> |
||
| 217 | daniel-mar | 90 | </tr> |
| 91 | <tr> |
||
| 581 | daniel-mar | 92 | <td width="111">“Hidden” flag</td> |
| 93 | <td width="196">Superior RA<br> System administrator</td> |
||
| 94 | <td width="154">Public<br> RA<br> Superior RA<br> System administrator</td> |
||
| 95 | <td width="154">Superior RA<br> System administrator</td> |
||
| 217 | daniel-mar | 96 | </tr> |
| 97 | <tr> |
||
| 581 | daniel-mar | 98 | <td width="111">Title</td> |
| 99 | <td width="196">RA<br> System administrator</td> |
||
| 100 | <td width="154">Public<br> RA<br> Superior RA<br> System administrator</td> |
||
| 101 | <td width="154">Superior RA<br> System administrator</td> |
||
| 217 | daniel-mar | 102 | </tr> |
| 103 | <tr> |
||
| 581 | daniel-mar | 104 | <td width="111">Description</td> |
| 105 | <td width="196">RA<br> System administrator</td> |
||
| 106 | <td width="154">Public<br> RA<br> Superior RA<br> System administrator</td> |
||
| 107 | <td width="154">Superior RA<br> System administrator</td> |
||
| 217 | daniel-mar | 108 | </tr> |
| 109 | </table> |
||
| 434 | daniel-mar | 110 | <a id="ra_information"></a><h2>RA information</h2> |
| 344 | daniel-mar | 111 | <p>The information about RAs owning OIDs can be seen publicly. A RA can manage their contact data in the OIDplus system (login-area) and mark their information as “private” to limit the information visible to the public.</p> |
| 112 | <p>Following RA information is always displayed (even if marked “private”):</p> |
||
| 434 | daniel-mar | 113 | <h3>Overview: Managed information about RAs:</h3> |
| 217 | daniel-mar | 114 | <table border="1"> |
| 115 | <tr> |
||
| 581 | daniel-mar | 116 | <td width="111"><strong>Attribute:</strong></td> |
| 117 | <td width="196"><strong>Can only be changed by:</strong></td> |
||
| 118 | <td width="154"><strong>If not marked “private“, visible to:</strong></td> |
||
| 119 | <td width="154"><strong>If marked “private“, visible to:</strong></td> |
||
| 217 | daniel-mar | 120 | </tr> |
| 121 | <tr> |
||
| 581 | daniel-mar | 122 | <td width="111">Email-Address</td> |
| 123 | <td width="196">RA</td> |
||
| 124 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 125 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 217 | daniel-mar | 126 | </tr> |
| 127 | <tr> |
||
| 581 | daniel-mar | 128 | <td width="111">Name</td> |
| 129 | <td width="196">RA</td> |
||
| 130 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 131 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 217 | daniel-mar | 132 | </tr> |
| 133 | <tr> |
||
| 581 | daniel-mar | 134 | <td width="111">Organization</td> |
| 135 | <td width="196">RA</td> |
||
| 136 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 137 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 217 | daniel-mar | 138 | </tr> |
| 139 | <tr> |
||
| 581 | daniel-mar | 140 | <td width="111">Office</td> |
| 141 | <td width="196">RA</td> |
||
| 142 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 143 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 217 | daniel-mar | 144 | </tr> |
| 145 | <tr> |
||
| 581 | daniel-mar | 146 | <td width="111">Personal name</td> |
| 147 | <td width="196">RA</td> |
||
| 148 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 149 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 217 | daniel-mar | 150 | </tr> |
| 151 | <tr> |
||
| 581 | daniel-mar | 152 | <td width="111">Privacy flag</td> |
| 153 | <td width="196">RA</td> |
||
| 154 | <td width="154">RA<br>System administrator</td> |
||
| 155 | <td width="154">RA<br>System administrator</td> |
||
| 217 | daniel-mar | 156 | </tr> |
| 157 | <tr> |
||
| 581 | daniel-mar | 158 | <td width="111">Street</td> |
| 159 | <td width="196">RA</td> |
||
| 160 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 161 | <td width="154">RA<br>System administrator</td> |
||
| 217 | daniel-mar | 162 | </tr> |
| 163 | <tr> |
||
| 581 | daniel-mar | 164 | <td width="111">ZIP/Town</td> |
| 165 | <td width="196">RA</td> |
||
| 166 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 167 | <td width="154">RA<br>System administrator</td> |
||
| 217 | daniel-mar | 168 | </tr> |
| 169 | <tr> |
||
| 581 | daniel-mar | 170 | <td width="111">Country</td> |
| 171 | <td width="196">RA</td> |
||
| 172 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 173 | <td width="154">RA<br>System administrator</td> |
||
| 217 | daniel-mar | 174 | </tr> |
| 175 | <tr> |
||
| 581 | daniel-mar | 176 | <td width="111">Phone</td> |
| 177 | <td width="196">RA</td> |
||
| 178 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 179 | <td width="154">RA<br>System administrator</td> |
||
| 217 | daniel-mar | 180 | </tr> |
| 181 | <tr> |
||
| 581 | daniel-mar | 182 | <td width="111">Mobile</td> |
| 183 | <td width="196">RA</td> |
||
| 184 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 185 | <td width="154">RA<br>System administrator</td> |
||
| 217 | daniel-mar | 186 | </tr> |
| 187 | <tr> |
||
| 581 | daniel-mar | 188 | <td width="111">Fax</td> |
| 189 | <td width="196">RA</td> |
||
| 190 | <td width="154">Public<br> Superior RA<br> RA<br> System administrator</td> |
||
| 191 | <td width="154">RA<br>System administrator</td> |
||
| 217 | daniel-mar | 192 | </tr> |
| 193 | </table> |
||
| 434 | daniel-mar | 194 | <a id="ra_invitation"></a><h2>Invitation of RAs</h2> |
| 219 | daniel-mar | 195 | <p>When an OID is created by a RA or by the system administrator, the owner of the OID will be defined by an email address (which will be shown publicly). Therefore, it is possible to own an OID, even if you are not registered in the OIDplus system.</p> |
| 369 | daniel-mar | 196 | <p>When the OID is created and the RA with such an email address does not exist in the OIDplus system, the creator will be asked if they want to send an invitation. If they agree, an email will be sent to this email address, allowing them to click a link to register to the OIDplus system, so that they can add more contact data as well as be able to delegate and edit OID information.</p> |
| 434 | daniel-mar | 197 | <p>Currently, a RA cannot register themselves using the regular login method. (They can register themselves if they are using some alternative login methods as described below). Using the regular login method, they need an invitation by the system administrator or their superior RA to be able to register to the OIDplus system. (Note: To resend an invitation, the system administrator or superior RA needs to click “Update” at the OID delegation table, so that they are asked again to send the invitation).</p> |
| 217 | daniel-mar | 198 | <p>In addition to the invitation system, the system administrator can create RA accounts without email address verification.</p> |
| 434 | daniel-mar | 199 | <a id="oidinfo_publishing"></a><h2>Publishing RAs/OIDs to oid-info.com</h2> |
| 344 | daniel-mar | 200 | <p>oid-info.com is a web page that collects and displays information about OIDs, like a Wiki. OIDplus contains features to submit data of its database to oid-info.com</p> |
| 217 | daniel-mar | 201 | <p>There are two possibilities:</p> |
| 202 | <ol> |
||
| 219 | daniel-mar | 203 | <li>Manual transfer: The system administrator can create an XML file that contains OID and RA information (only the parts which can be seen by the public anyway) and can upload this XML file to oid-info.com</li> |
| 369 | daniel-mar | 204 | <li>If the OIDplus system is registered to ViaThinkSoft and the OID-info.com transfer is enabled (see below), |
| 205 | the OIDplus system will transmit XML data containing RA/OID information through an encrypted interface to ViaThinkSoft, |
||
| 206 | and ViaThinkSoft after regular manual check submits the data to the oid-info.com administrator.</li> |
||
| 217 | daniel-mar | 207 | </ol> |
| 434 | daniel-mar | 208 | <a id="systemid"></a><h2>Unique system ID</h2> |
| 362 | daniel-mar | 209 | <p>During the initial setup, a public/private-key-pair will be created which can be used for various purposes, e.g. to encrypt data between OIDplus and ViaThinkSoft if the “system registration” service is used (see below) or to sign OID-WHOIS responses.</p> |
| 217 | daniel-mar | 210 | <p>From this public key, a unique system ID will be derivated. The unique system ID and the public key can be seen in the setup screen.</p> |
| 434 | daniel-mar | 211 | <a id="system_registration"></a><h2>System registration and automatic publishing to oid-info.com</h2> |
| 344 | daniel-mar | 212 | <p>During initial setup, the system administrator can choose between the following options:</p> |
| 581 | daniel-mar | 213 | <p>0 Register to directory service and automatically publish RA/OID data at oid-info.com<br> 1 Only register to directory service<br> 2 Hide system</p> |
| 344 | daniel-mar | 214 | <p>This setting can always be changed in the administrator login/control panel.</p> |
| 434 | daniel-mar | 215 | <h3>Registering the system to the directory service (option 0 and 1)</h3> |
| 635 | daniel-mar | 216 | <p>The registration of the OIDplus system has various advantages:</p><!-- please keep in sync with plugins/viathinksoft/adminPages/120_registration/info.html document --> |
| 217 | daniel-mar | 217 | <ul> |
| 362 | daniel-mar | 218 | <li>The public key of the OIDplus instance will be published to the ViaThinkSoft web directory, so that users can check the integrity of the data (e.g. signed OID-WHOIS requests).</li> |
| 219 | <li>Since the 31-bit System ID can have hash conflicts, ViaThinkSoft will make sure that the System ID is only used by this OIDplus instance (it will force other OIDplus systems with the same system ID to change their IDs).</li> |
||
| 220 | <li>ViaThinkSoft can acknowledge the system name, administrator email address, and OID root arcs. Therefore, the OIDplus instance can be found using referral WHOIS.</li> |
||
| 221 | <li>The administrator can optionally enable the automatic publishing of the public OID information to the repository oid-info.com.</li> |
||
| 222 | <li>If the root OID(s) are approved by ViaThinkSoft (it will be manually verified that the root OIDs belong to the system owner), a feature will be unlocked which can be used to compare and import OIDs from oid-info.com into this OIDplus instance.</li> |
||
| 223 | <li>The OIDplus version will be reported to ViaThinkSoft. If a severe bug or security vulnerability is affecting this OIDplus instance, ViaThinkSoft can warn the administrator via email.</li> |
||
| 224 | <li>The directory service will automatically create an X.509 security certificate for this OIDplus instance (NOT an SSL certificate!) which can be used for various verifications.</li> |
||
| 217 | daniel-mar | 225 | </ul> |
| 344 | daniel-mar | 226 | <p>If privacy level option 0 or 1 was chosen, the OIDplus system will regularly contact the ViaThinkSoft server through a secure connection and send the following information:</p> |
| 217 | daniel-mar | 227 | <ul> |
| 219 | daniel-mar | 228 | <li>Privacy level (0, 1 or 2)</li> |
| 229 | <li>System ID</li> |
||
| 230 | <li>Public Key</li> |
||
| 231 | <li>Current URL</li> |
||
| 232 | <li>Administrator email address</li> |
||
| 233 | <li>System title</li> |
||
| 234 | <li>List of OID roots that this system is sending</li> |
||
| 362 | daniel-mar | 235 | <li>The version of the system (SVN revision)</li> |
| 219 | daniel-mar | 236 | <li>Installation type (ZIPed SVN snapshot or SVN working copy)</li> |
| 217 | daniel-mar | 237 | </ul> |
| 371 | daniel-mar | 238 | <p>ViaThinkSoft will store this data internally and publish parts into the public directory service located at <a href="https://oidplus.viathinksoft.com/directory/">https://oidplus.viathinksoft.com/directory/</a> :</p> |
| 217 | daniel-mar | 239 | <p>The public record contains:</p> |
| 240 | <ul> |
||
| 219 | daniel-mar | 241 | <li>System ID</li> |
| 242 | <li>Public key</li> |
||
| 243 | <li>Current URL</li> |
||
| 217 | daniel-mar | 244 | </ul> |
| 245 | <p>The other information will stay on the ViaThinkSoft internal database and will not be shared with other parties.</p> |
||
| 344 | daniel-mar | 246 | <p>If the system administrator enabled this option and want to revoke the permission, the system administrator has to change the privacy level in the administrator login/control panel. The system will automatically contact the ViaThinkSoft server again and performs the deletion of all data.</p> |
| 219 | daniel-mar | 247 | <p>Please note that the deletion of the record in the directory service does not delete OID/RA information which is already submitted at oid-info.com (if option 0 was chosen). To delete this data, the system administrator needs to contact the OID Repository Webmaster at <a href="mailto:admin@oid-info.com">admin@oid-info.com</a></p> |
| 434 | daniel-mar | 248 | <h3>Publish RA/OID data at oid-info.com (option 0)</h3> |
| 217 | daniel-mar | 249 | <p>If privacy level option 0 is chosen, the system regularly contacts the ViaThinkSoft server through a secure connection and sends the public RA/OID data. ViaThinkSoft will store this data and redirect it to the OID Repository Webmaster who will review the data and eventually submit it to the public repository www.oid-info.com</p> |
| 344 | daniel-mar | 250 | <p>If the system administrator enabled this option and want to revoke the permission, the system administrator has to change the privacy level in the administrator login/control panel to option 1 or 2 (to avoid that data is sent again). To remove already submitted OIDs, the system administrator needs to contact the OID Repository Webmaster at <a href="mailto:admin@oid-info.com">admin@oid-info.com</a></p> |
| 434 | daniel-mar | 251 | <h3>Hide system (option 2)</h3> |
| 217 | daniel-mar | 252 | <p>If privacy level option 2 was chosen, the system will neither contact ViaThinkSoft, nor oid-info.com.</p> |
| 434 | daniel-mar | 253 | <a id="logfiles"></a><h2>Log files</h2> |
| 254 | <h3>Logs by OIDplus</h3> |
||
| 217 | daniel-mar | 255 | <p>OIDplus manages log entries for specific events like logins, OID/RA modifications, creating and deletion of OIDs, etc.</p> |
| 256 | <p>These log messages are stored in the DBMS only.</p> |
||
| 219 | daniel-mar | 257 | <p>All log events are visible to the system administrator.</p> |
| 217 | daniel-mar | 258 | <p>Some events are visible to the RA and/or the Superior RA.</p> |
| 259 | <p>Log events may show the IP addresses of the computer that was connected to the OIDplus system and the email address if the RA was logged in using their credentials.</p> |
||
| 260 | <p>OIDplus does not provide a function to delete log events. A deletion must be done in the database directly, e.g. using a database client like phpMyAdmin.</p> |
||
| 434 | daniel-mar | 261 | <h3>Logs by host software, firewalls, etc.</h3> |
| 344 | daniel-mar | 262 | <p>Besides logs created by OIDplus, other client-side or server-side software involved in processing the web requests (like the HTTP web server, the PHP script interpreter, the database server, the Operating System, the web browser, or various firewalls) might log traffic and queries in various ways. These logs are independent of OIDplus and need to be managed by the system administrator and/or network administrators.</p> |
| 217 | daniel-mar | 263 | <p>If you are concerned about the contents of the log files, please contact the system administrator.</p> |
| 434 | daniel-mar | 264 | <a id="cookies"></a><h2>Cookies</h2> |
| 369 | daniel-mar | 265 | <p>A cookie is a small text file that is sent to this |
| 266 | website every time you visit it, e.g. to identify you |
||
| 267 | as a logged in user.</p> |
||
| 217 | daniel-mar | 268 | <p>OIDplus does only use cookies for the following purposes:</p> |
| 269 | <table border="1"> |
||
| 270 | <tr> |
||
| 581 | daniel-mar | 271 | <td width="122"><strong>Cookie</strong></td> |
| 272 | <td width="114"><strong>Category</strong></td> |
||
| 273 | <td width="139"><strong>Usage</strong></td> |
||
| 274 | <td width="118"><strong>Will be created:</strong></td> |
||
| 275 | <td width="126"><strong>Will be deleted:</strong></td> |
||
| 217 | daniel-mar | 276 | </tr> |
| 277 | <tr> |
||
| 581 | daniel-mar | 278 | <td width="122">Login-Cookie<br>(Regular login)</td> |
| 279 | <td width="114">Essential</td> |
||
| 280 | <td width="139">Contains a session key that is used to determine the user’s log-in-state and the permissions.</td> |
||
| 281 | <td width="118">During the login of a user or administrator using their password, if the "remember me" option is NOT selected.</td> |
||
| 282 | <td width="126">When the user is logged out, or the browser session closed.</td> |
||
| 217 | daniel-mar | 283 | </tr> |
| 284 | <tr> |
||
| 581 | daniel-mar | 285 | <td width="122">Login-Cookie<br>("Remember me" option)</td> |
| 286 | <td width="114">Essential</td> |
||
| 287 | <td width="139">Contains a server-signed "JSON Web Token" that contains the username.</td> |
||
| 288 | <td width="118">During the login of a user or administrator using their password, if the "remember me" option is selected.</td> |
||
| 289 | <td width="126">When the user logs out.</td> |
||
| 217 | daniel-mar | 290 | </tr> |
| 355 | daniel-mar | 291 | <tr> |
| 581 | daniel-mar | 292 | <td width="122">SSL-Detect-Cookie</td> |
| 293 | <td width="114">Essential</td> |
||
| 294 | <td width="139">If the option “automatic SSL detection” is enabled by the system administrator, this cookie will check if the SSL port is open, to allow automatic redirection of HTTP to HTTPS.</td> |
||
| 295 | <td width="118">During the first page visit</td> |
||
| 296 | <td width="126">When the browser session is closed.</td> |
||
| 355 | daniel-mar | 297 | </tr> |
| 426 | daniel-mar | 298 | <tr> |
| 581 | daniel-mar | 299 | <td width="122">Language Cookie</td> |
| 300 | <td width="114">Essential</td> |
||
| 301 | <td width="139">The language cookie contains the desired language.</td> |
||
| 302 | <td width="118">As soon as a flag is clicked, or if an URL was opened that has a <code>lang=...</code> argument</td> |
||
| 303 | <td width="126">When the browser session is closed.</td> |
||
| 426 | daniel-mar | 304 | </tr> |
| 581 | daniel-mar | 305 | <tr> |
| 306 | <td width="122">CSRF token (2x)</td> |
||
| 307 | <td width="114">Essential</td> |
||
| 308 | <td width="139">Contains a random string that will be embedded into the page, as counter-measure against "Cross-site request forgery" attacks.</td> |
||
| 309 | <td width="118">As soon as the page is opened using a JavaScript compatible web browser.</td> |
||
| 310 | <td width="126">When the browser session is closed.</td> |
||
| 311 | </tr> |
||
| 217 | daniel-mar | 312 | </table> |
| 434 | daniel-mar | 313 | <a id="external_javascripts"></a><h2>External JavaScripts</h2> |
| 217 | daniel-mar | 314 | <p>During the loading of the web page, various JavaScripts are included to improve the user experience and add essential functionalities. The basic scripts are the JavaScript files of OIDplus itself, which are stored on the server of the particular OIDplus installation.</p> |
| 378 | daniel-mar | 315 | <p>Following JavaScripts are loaded from an external source/server:</p> |
| 434 | daniel-mar | 316 | <h3>ReCAPTCHA (only if “ReCAPTCHA” is enabled)</h3> |
| 344 | daniel-mar | 317 | <p>To protect sensitive functions of OIDplus (e.g. the login form) from hackers, the system administrator can enable “ReCAPTCHA” which is a service of Google. Before enabling ReCAPTCHA in the OIDplus setup/settings, the system administrator has to request an API key from Google. The usage of ReCAPTCHA will probably introduce additional cookies that are out of the control of OIDplus.</p> |
| 318 | <p>Please see <a href="https://policies.google.com/privacy">Google’s Privacy Policy</a> and <a href="https://policies.google.com/terms">Terms of service</a> for more information.</p> |
||
| 217 | daniel-mar | 319 | <p>If the system administrator has not enabled the ReCAPTCHA feature, no external script will be included at all.</p> |
| 344 | daniel-mar | 320 | <p>If the feature is enabled, blocking the ReCAPTCHA JavaScript on the client-side will result in various functionalities (like the login form) not working.</p> |
| 434 | daniel-mar | 321 | <a id="additional_security"></a><h2>Additional security / access controls</h2> |
| 344 | daniel-mar | 322 | <p>System administrators can choose other methods to disable access from the public, e.g. by using firewalls (so that clients cannot access the server at all) or by setting up password protection at the level of the HTTP web server software (e.g. “Basic Auth” on Apache, so that the clients cannot access the directory where OIDplus is installed in).</p> |
| 434 | daniel-mar | 323 | <a id="encrypted_connections"></a><h2>Encrypted network connections</h2> |
| 344 | daniel-mar | 324 | <p>The server administrator is responsible for securing the network connections using “HTTPS”. This is done at the HTTP web server level (i.e. an Apache module/setting) and independent from OIDplus.</p> |
| 434 | daniel-mar | 325 | |
| 326 | <a id="login_admin"></a><h2>Administrator login procedure</h2> |
||
| 327 | <p>The administrator login requires a password that is stored in a local configuration file. It is stored using a "salted hash" which is like a "one-way encryption" and therefore, the plain password cannot be seen by anyone who is reading the configuration file.</p> |
||
| 328 | <p>The configuration file is generated by a "setup" utility and can be manually edited by the system administrator.</p> |
||
| 329 | |||
| 330 | <a id="login_ra"></a><h2>RA Login procedures</h2> |
||
| 331 | <p>There are several ways to log in as a Registration Authority:</p> |
||
| 332 | <ul> |
||
| 333 | <li>Regular log in method</li> |
||
| 334 | <li>Log in using Google (optional plugin for OIDplus)</li> |
||
| 437 | daniel-mar | 335 | <li>Log in using Facebook (optional plugin for OIDplus)</li> |
| 434 | daniel-mar | 336 | <li>Log in using LDAP/ActiveDirectory (optional plugin for OIDplus)</li> |
| 337 | </ul> |
||
| 338 | |||
| 339 | <a id="login_ra_regular"></a><h3>Regular log in method</h3> |
||
| 340 | <p>With the login method, the RA logs in using a password they defined. The password is stored in the database using a "salted hash" which is like "one-way encryption". Therefore, the system administrator cannot see the password in the database table.</p> |
||
| 341 | |||
| 342 | <a id="login_ra_google"></a><h3>Login using Google</h3> |
||
| 343 | <p>This alternative login method is an optional plugin that can be enabled by the administrator.</p> |
||
| 440 | daniel-mar | 344 | <p>When the user clicks the "login using Google" link, they will be redirected to a Google "consent" screen where they can log in using their Google account credentials. (This procedure is called OAuth2) Note that this consent screen contains a Google-specific privacy policy and terms of service. Once you have logged in, Google will redirect the user back to OIDplus and sends a signed message which contains following information about the person who has logged in:</p> |
| 434 | daniel-mar | 345 | <ul> |
| 440 | daniel-mar | 346 | <li>Email address</li> |
| 347 | <li>Verification status of the E-Mail address (must be verified)</li> |
||
| 348 | <li>Personal name</li> |
||
| 349 | <li>Language/Region setting (this information will not be evaluated by OIDplus and will be discarded)</li> |
||
| 350 | <li>Link to profile picture (this information will not be evaluated by OIDplus and will be discarded)</li> |
||
| 351 | <li>OpenID (this information will not be evaluated by OIDplus and will be discarded)</li> |
||
| 434 | daniel-mar | 352 | </ul> |
| 353 | <p>The Google password is not transmitted to OIDplus.</p> |
||
| 354 | <p>If it is the first time the user has logged in, then OIDplus will then create a new RA account in the local database that contains this information. The account is yet password-less, therefore it can only be used for the OAuth authentication.</p> |
||
| 355 | <p>The user can optionally define a password in case they want to additionally use the regular login method.</p> |
||
| 356 | <p>If the RA has a password-less account, then they cannot change their email address, because the OIDplus implementation of OAuth2 uses the email address as identification instead of the "OpenID" as usual. If they want to change their email address, then they must create a password first and then use the regular login method using the new email address.</p> |
||
| 357 | |||
| 436 | daniel-mar | 358 | <a id="login_ra_facebook"></a><h3>Login using Facebook</h3> |
| 359 | <p>This alternative login method is an optional plugin that can be enabled by the administrator.</p> |
||
| 440 | daniel-mar | 360 | <p>When the user clicks the "login using Facebook" link, they will be redirected to a Facebook "consent" screen where they can log in using their Facebook account credentials. (This procedure is called OAuth2) Note that this consent screen contains a Facebook-specific privacy policy and terms of service. Once you have logged in, Facebook will redirect the user back to OIDplus and sends a signed message which contains following information about the person who has logged in:</p> |
| 436 | daniel-mar | 361 | <ul> |
| 440 | daniel-mar | 362 | <li>Email address</li> |
| 363 | <li>Personal name</li> |
||
| 364 | <li>User ID (this information will not be evaluated by OIDplus and will be discarded)</li> |
||
| 436 | daniel-mar | 365 | </ul> |
| 366 | <p>The Facebook password is not transmitted to OIDplus.</p> |
||
| 437 | daniel-mar | 367 | <p>Facebook preserves permission to hand over the e-mail address so that the consent screen is not displayed in later login attempts. These consents are managed in the "App" permissions in the Facebook account and can also be revoked there.</p> |
| 436 | daniel-mar | 368 | <p>If it is the first time the user has logged in, then OIDplus will then create a new RA account in the local database that contains this information. The account is yet password-less, therefore it can only be used for the OAuth authentication.</p> |
| 369 | <p>The user can optionally define a password in case they want to additionally use the regular login method.</p> |
||
| 437 | daniel-mar | 370 | <p>If the RA has a password-less account, then they cannot change their email address, because the OIDplus implementation of OAuth2 uses the email address as identification instead of the "user id" as usual. If they want to change their email address, then they must create a password first and then use the regular login method using the new email address.</p> |
| 436 | daniel-mar | 371 | <p><b>Attention:</b> Deleting the "App" in your Facebook settings will not remove the account in OIDplus. You need to remove your OIDplus account first, and then remove the "App" permission in your Facebook account.</p> |
| 372 | |||
| 434 | daniel-mar | 373 | <a id="login_ra_ldap"></a><h3>Login using LDAP / ActiveDirectory</h3> |
| 374 | <p>This alternative login method is an optional plugin that can be enabled by the administrator.</p> |
||
| 375 | <p>LDAP / ActiveDirectory is a technology where a server managed authentication for several services (like Windows computers, intranet, network shares, mail accounts) and is usually used in large company networks.</p> |
||
| 376 | <p>In comparison to the usual login where the user enters the username and password, OIDplus will ask for an email address and password.</p> |
||
| 377 | <p>The email address is an optional field in the LDAP / ActiveDirectory database, therefore the network administrator must set the email addresses of each user in the network, so they can log in to OIDplus.</p> |
||
| 378 | <p>Once the user has entered the username and password, OIDplus will connect to the LDAP server and search for a user that fits the entered email address. When a user is found, OIDplus will check if the password fits the LDAP user.</p> |
||
| 379 | <p>Once this procedure was successful, OIDplus will fetch the following information from the LDAP server (if available in the LDAP directory):</p> |
||
| 380 | <ul> |
||
| 381 | <li>"Common name" (CN)</li> |
||
| 382 | <li>"Display name"</li> |
||
| 383 | <li>Given name</li> |
||
| 384 | <li>Surname (SN)</li> |
||
| 385 | <li>Company</li> |
||
| 386 | <li>Physical delivery office name</li> |
||
| 387 | <li>Department</li> |
||
| 388 | <li>Street address</li> |
||
| 389 | <li>Postal code</li> |
||
| 390 | <li>Locality (L)</li> |
||
| 391 | <li>Country (CO)</li> |
||
| 392 | <li>Phone number(s)</li> |
||
| 393 | <li>Mobile phone number</li> |
||
| 394 | <li>Fax number</li> |
||
| 395 | </ul> |
||
| 396 | <p>If it is the first time the user has logged in, then OIDplus will then create a new RA account in the local database that contains this information. The account is yet password-less, therefore it can only be used for the LDAP authentication.</p> |
||
| 397 | <p>The user can optionally define a password in case they want to additionally use the regular login method.</p> |
||
| 398 | <p>If the RA has a password-less account, then they cannot change their email address, because the OIDplus implementation of LDAP / ActiveDirectory uses the email address as identification instead of the username as usual. If they want to change their email address, then they must create a password first and then use the regular login method using the new email address.</p> |
||
| 399 | |||
| 217 | daniel-mar | 400 | </body> |
| 401 | |||
| 371 | daniel-mar | 402 | </html> |