Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.WebAuth.Fido2ManagementDialog.html
src/eric7/Documentation/Source/eric7.WebBrowser.WebAuth.Fido2ManagementDialog.html
- branch
- eric7
- changeset 10860
- 46d5db6cd55d
equal
deleted
inserted
replaced
| 10859:399d19fc7eb5 | 10860:46d5db6cd55d |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.WebAuth.Fido2ManagementDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.WebBrowser.WebAuth.Fido2ManagementDialog</h1> | |
| 10 <p> | |
| 11 Module implementing a dialog to manage FIDO2 security keys. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#Fido2ManagementDialog">Fido2ManagementDialog</a></td> | |
| 23 <td>Class implementing a dialog to manage FIDO2 security keys.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 | |
| 27 <h3>Functions</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 | |
| 32 <hr /> | |
| 33 <hr /> | |
| 34 <a NAME="Fido2ManagementDialog" ID="Fido2ManagementDialog"></a> | |
| 35 <h2>Fido2ManagementDialog</h2> | |
| 36 <p> | |
| 37 Class implementing a dialog to manage FIDO2 security keys. | |
| 38 </p> | |
| 39 | |
| 40 <h3>Derived from</h3> | |
| 41 QDialog, Ui_Fido2ManagementDialog | |
| 42 <h3>Class Attributes</h3> | |
| 43 <table> | |
| 44 <tr><td>CredentialIdColumn</td></tr> | |
| 45 <tr><td>CredentialIdRole</td></tr> | |
| 46 <tr><td>DisplayNameColumn</td></tr> | |
| 47 <tr><td>RelyingPartyColumn</td></tr> | |
| 48 <tr><td>UserIdRole</td></tr> | |
| 49 <tr><td>UserNameColumn</td></tr> | |
| 50 </table> | |
| 51 | |
| 52 <h3>Class Methods</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#Fido2ManagementDialog.__init__">Fido2ManagementDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr> | |
| 63 <tr> | |
| 64 <td><a href="#Fido2ManagementDialog.__aboutToShowManagementMenu">__aboutToShowManagementMenu</a></td> | |
| 65 <td>Private slot to prepare the security key management menu before it is shown.</td> | |
| 66 </tr> | |
| 67 <tr> | |
| 68 <td><a href="#Fido2ManagementDialog.__changePin">__changePin</a></td> | |
| 69 <td>Private slot to change the PIN of the selected security key.</td> | |
| 70 </tr> | |
| 71 <tr> | |
| 72 <td><a href="#Fido2ManagementDialog.__checkPinStatus">__checkPinStatus</a></td> | |
| 73 <td>Private method to check the PIN status of the connected security key.</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#Fido2ManagementDialog.__deviceConnected">__deviceConnected</a></td> | |
| 77 <td>Private slot handling the device connected signal.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#Fido2ManagementDialog.__deviceDisconnected">__deviceDisconnected</a></td> | |
| 81 <td>Private slot handling the device disconnected signal.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#Fido2ManagementDialog.__forcePinChange">__forcePinChange</a></td> | |
| 85 <td>Private slot to force a PIN change before the next use.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#Fido2ManagementDialog.__getRequiredPin">__getRequiredPin</a></td> | |
| 89 <td>Private method to check, if a pin has been set for the selected device, and ask the user to enter it.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#Fido2ManagementDialog.__handleError">__handleError</a></td> | |
| 93 <td>Private method to handle an error reported by the manager.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#Fido2ManagementDialog.__initManagementMenu">__initManagementMenu</a></td> | |
| 97 <td>Private method to initialize the security key management menu with actions not needed so much.</td> | |
| 98 </tr> | |
| 99 <tr> | |
| 100 <td><a href="#Fido2ManagementDialog.__populateDeviceSelector">__populateDeviceSelector</a></td> | |
| 101 <td>Private slot to populate the device selector combo box.</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#Fido2ManagementDialog.__populatePasskeysList">__populatePasskeysList</a></td> | |
| 105 <td>Private slot to populate the list of store passkeys of the selected security key.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#Fido2ManagementDialog.__resetSecurityKey">__resetSecurityKey</a></td> | |
| 109 <td>Private slot to reset the selected security key.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#Fido2ManagementDialog.__setMinimumPinLength">__setMinimumPinLength</a></td> | |
| 113 <td>Private slot to set the minimum PIN length.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#Fido2ManagementDialog.__setPin">__setPin</a></td> | |
| 117 <td>Private slot to set a PIN for the selected security key.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#Fido2ManagementDialog.__showSecurityKeyInfo">__showSecurityKeyInfo</a></td> | |
| 121 <td>Private slot to show some info about the selected security key.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#Fido2ManagementDialog.__toggleAlwaysUv">__toggleAlwaysUv</a></td> | |
| 125 <td>Private slot to toggle the state of the 'Always Require User Verification' flag.</td> | |
| 126 </tr> | |
| 127 <tr> | |
| 128 <td><a href="#Fido2ManagementDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> | |
| 129 <td>Private slot to delete the selected passkey.</td> | |
| 130 </tr> | |
| 131 <tr> | |
| 132 <td><a href="#Fido2ManagementDialog.on_editButton_clicked">on_editButton_clicked</a></td> | |
| 133 <td>Private slot to edit the selected passkey.</td> | |
| 134 </tr> | |
| 135 <tr> | |
| 136 <td><a href="#Fido2ManagementDialog.on_loadPasskeysButton_clicked">on_loadPasskeysButton_clicked</a></td> | |
| 137 <td>Private slot to (re-)populate the passkeys list.</td> | |
| 138 </tr> | |
| 139 <tr> | |
| 140 <td><a href="#Fido2ManagementDialog.on_lockButton_toggled">on_lockButton_toggled</a></td> | |
| 141 <td>Private slot to handle the toggling of the device locked status.</td> | |
| 142 </tr> | |
| 143 <tr> | |
| 144 <td><a href="#Fido2ManagementDialog.on_passkeysList_itemSelectionChanged">on_passkeysList_itemSelectionChanged</a></td> | |
| 145 <td>Private slot handling the selection of a passkey.</td> | |
| 146 </tr> | |
| 147 <tr> | |
| 148 <td><a href="#Fido2ManagementDialog.on_pinButton_clicked">on_pinButton_clicked</a></td> | |
| 149 <td>Private slot to set or change the PIN for the selected security key.</td> | |
| 150 </tr> | |
| 151 <tr> | |
| 152 <td><a href="#Fido2ManagementDialog.on_securityKeysComboBox_currentIndexChanged">on_securityKeysComboBox_currentIndexChanged</a></td> | |
| 153 <td>Private slot handling the selection of security key.</td> | |
| 154 </tr> | |
| 155 </table> | |
| 156 | |
| 157 <h3>Static Methods</h3> | |
| 158 <table> | |
| 159 <tr><td>None</td></tr> | |
| 160 </table> | |
| 161 | |
| 162 | |
| 163 <a NAME="Fido2ManagementDialog.__init__" ID="Fido2ManagementDialog.__init__"></a> | |
| 164 <h4>Fido2ManagementDialog (Constructor)</h4> | |
| 165 <b>Fido2ManagementDialog</b>(<i>standalone=False, parent=None</i>) | |
| 166 <p> | |
| 167 Constructor | |
| 168 </p> | |
| 169 | |
| 170 <dl> | |
| 171 | |
| 172 <dt><i>standalone</i> (bool (optional))</dt> | |
| 173 <dd> | |
| 174 flag indicating the standalone management application | |
| 175 (defaults to False) | |
| 176 </dd> | |
| 177 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 178 <dd> | |
| 179 reference to the parent widget (defaults to None) | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <a NAME="Fido2ManagementDialog.__aboutToShowManagementMenu" ID="Fido2ManagementDialog.__aboutToShowManagementMenu"></a> | |
| 183 <h4>Fido2ManagementDialog.__aboutToShowManagementMenu</h4> | |
| 184 <b>__aboutToShowManagementMenu</b>(<i></i>) | |
| 185 <p> | |
| 186 Private slot to prepare the security key management menu before it is shown. | |
| 187 </p> | |
| 188 | |
| 189 <a NAME="Fido2ManagementDialog.__changePin" ID="Fido2ManagementDialog.__changePin"></a> | |
| 190 <h4>Fido2ManagementDialog.__changePin</h4> | |
| 191 <b>__changePin</b>(<i></i>) | |
| 192 <p> | |
| 193 Private slot to change the PIN of the selected security key. | |
| 194 </p> | |
| 195 | |
| 196 <a NAME="Fido2ManagementDialog.__checkPinStatus" ID="Fido2ManagementDialog.__checkPinStatus"></a> | |
| 197 <h4>Fido2ManagementDialog.__checkPinStatus</h4> | |
| 198 <b>__checkPinStatus</b>(<i>feature</i>) | |
| 199 <p> | |
| 200 Private method to check the PIN status of the connected security key. | |
| 201 </p> | |
| 202 | |
| 203 <dl> | |
| 204 | |
| 205 <dt><i>feature</i> (str (optional))</dt> | |
| 206 <dd> | |
| 207 name of the feature requesting the PIN (defaults to None) | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <dl> | |
| 211 <dt>Return:</dt> | |
| 212 <dd> | |
| 213 flag indicating a positive status | |
| 214 </dd> | |
| 215 </dl> | |
| 216 <dl> | |
| 217 <dt>Return Type:</dt> | |
| 218 <dd> | |
| 219 bool | |
| 220 </dd> | |
| 221 </dl> | |
| 222 <a NAME="Fido2ManagementDialog.__deviceConnected" ID="Fido2ManagementDialog.__deviceConnected"></a> | |
| 223 <h4>Fido2ManagementDialog.__deviceConnected</h4> | |
| 224 <b>__deviceConnected</b>(<i></i>) | |
| 225 <p> | |
| 226 Private slot handling the device connected signal. | |
| 227 </p> | |
| 228 | |
| 229 <a NAME="Fido2ManagementDialog.__deviceDisconnected" ID="Fido2ManagementDialog.__deviceDisconnected"></a> | |
| 230 <h4>Fido2ManagementDialog.__deviceDisconnected</h4> | |
| 231 <b>__deviceDisconnected</b>(<i></i>) | |
| 232 <p> | |
| 233 Private slot handling the device disconnected signal. | |
| 234 </p> | |
| 235 | |
| 236 <a NAME="Fido2ManagementDialog.__forcePinChange" ID="Fido2ManagementDialog.__forcePinChange"></a> | |
| 237 <h4>Fido2ManagementDialog.__forcePinChange</h4> | |
| 238 <b>__forcePinChange</b>(<i></i>) | |
| 239 <p> | |
| 240 Private slot to force a PIN change before the next use. | |
| 241 </p> | |
| 242 | |
| 243 <a NAME="Fido2ManagementDialog.__getRequiredPin" ID="Fido2ManagementDialog.__getRequiredPin"></a> | |
| 244 <h4>Fido2ManagementDialog.__getRequiredPin</h4> | |
| 245 <b>__getRequiredPin</b>(<i>feature=None</i>) | |
| 246 <p> | |
| 247 Private method to check, if a pin has been set for the selected device, and | |
| 248 ask the user to enter it. | |
| 249 </p> | |
| 250 | |
| 251 <dl> | |
| 252 | |
| 253 <dt><i>feature</i> (str (optional))</dt> | |
| 254 <dd> | |
| 255 name of the feature requesting the PIN (defaults to None) | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <dl> | |
| 259 <dt>Return:</dt> | |
| 260 <dd> | |
| 261 PIN of the selected security key or None in case of an issue | |
| 262 </dd> | |
| 263 </dl> | |
| 264 <dl> | |
| 265 <dt>Return Type:</dt> | |
| 266 <dd> | |
| 267 str or None | |
| 268 </dd> | |
| 269 </dl> | |
| 270 <a NAME="Fido2ManagementDialog.__handleError" ID="Fido2ManagementDialog.__handleError"></a> | |
| 271 <h4>Fido2ManagementDialog.__handleError</h4> | |
| 272 <b>__handleError</b>(<i>error, title, message</i>) | |
| 273 <p> | |
| 274 Private method to handle an error reported by the manager. | |
| 275 </p> | |
| 276 | |
| 277 <dl> | |
| 278 | |
| 279 <dt><i>error</i> (Exception)</dt> | |
| 280 <dd> | |
| 281 reference to the exception object | |
| 282 </dd> | |
| 283 <dt><i>title</i> (str)</dt> | |
| 284 <dd> | |
| 285 tirle of the message box | |
| 286 </dd> | |
| 287 <dt><i>message</i> (str)</dt> | |
| 288 <dd> | |
| 289 message to be shown | |
| 290 </dd> | |
| 291 </dl> | |
| 292 <a NAME="Fido2ManagementDialog.__initManagementMenu" ID="Fido2ManagementDialog.__initManagementMenu"></a> | |
| 293 <h4>Fido2ManagementDialog.__initManagementMenu</h4> | |
| 294 <b>__initManagementMenu</b>(<i></i>) | |
| 295 <p> | |
| 296 Private method to initialize the security key management menu with | |
| 297 actions not needed so much. | |
| 298 </p> | |
| 299 | |
| 300 <a NAME="Fido2ManagementDialog.__populateDeviceSelector" ID="Fido2ManagementDialog.__populateDeviceSelector"></a> | |
| 301 <h4>Fido2ManagementDialog.__populateDeviceSelector</h4> | |
| 302 <b>__populateDeviceSelector</b>(<i></i>) | |
| 303 <p> | |
| 304 Private slot to populate the device selector combo box. | |
| 305 </p> | |
| 306 | |
| 307 <a NAME="Fido2ManagementDialog.__populatePasskeysList" ID="Fido2ManagementDialog.__populatePasskeysList"></a> | |
| 308 <h4>Fido2ManagementDialog.__populatePasskeysList</h4> | |
| 309 <b>__populatePasskeysList</b>(<i></i>) | |
| 310 <p> | |
| 311 Private slot to populate the list of store passkeys of the selected security | |
| 312 key. | |
| 313 </p> | |
| 314 | |
| 315 <a NAME="Fido2ManagementDialog.__resetSecurityKey" ID="Fido2ManagementDialog.__resetSecurityKey"></a> | |
| 316 <h4>Fido2ManagementDialog.__resetSecurityKey</h4> | |
| 317 <b>__resetSecurityKey</b>(<i></i>) | |
| 318 <p> | |
| 319 Private slot to reset the selected security key. | |
| 320 </p> | |
| 321 | |
| 322 <a NAME="Fido2ManagementDialog.__setMinimumPinLength" ID="Fido2ManagementDialog.__setMinimumPinLength"></a> | |
| 323 <h4>Fido2ManagementDialog.__setMinimumPinLength</h4> | |
| 324 <b>__setMinimumPinLength</b>(<i></i>) | |
| 325 <p> | |
| 326 Private slot to set the minimum PIN length. | |
| 327 </p> | |
| 328 | |
| 329 <a NAME="Fido2ManagementDialog.__setPin" ID="Fido2ManagementDialog.__setPin"></a> | |
| 330 <h4>Fido2ManagementDialog.__setPin</h4> | |
| 331 <b>__setPin</b>(<i></i>) | |
| 332 <p> | |
| 333 Private slot to set a PIN for the selected security key. | |
| 334 </p> | |
| 335 | |
| 336 <a NAME="Fido2ManagementDialog.__showSecurityKeyInfo" ID="Fido2ManagementDialog.__showSecurityKeyInfo"></a> | |
| 337 <h4>Fido2ManagementDialog.__showSecurityKeyInfo</h4> | |
| 338 <b>__showSecurityKeyInfo</b>(<i></i>) | |
| 339 <p> | |
| 340 Private slot to show some info about the selected security key. | |
| 341 </p> | |
| 342 | |
| 343 <a NAME="Fido2ManagementDialog.__toggleAlwaysUv" ID="Fido2ManagementDialog.__toggleAlwaysUv"></a> | |
| 344 <h4>Fido2ManagementDialog.__toggleAlwaysUv</h4> | |
| 345 <b>__toggleAlwaysUv</b>(<i></i>) | |
| 346 <p> | |
| 347 Private slot to toggle the state of the 'Always Require User Verification' | |
| 348 flag. | |
| 349 </p> | |
| 350 | |
| 351 <a NAME="Fido2ManagementDialog.on_deleteButton_clicked" ID="Fido2ManagementDialog.on_deleteButton_clicked"></a> | |
| 352 <h4>Fido2ManagementDialog.on_deleteButton_clicked</h4> | |
| 353 <b>on_deleteButton_clicked</b>(<i></i>) | |
| 354 <p> | |
| 355 Private slot to delete the selected passkey. | |
| 356 </p> | |
| 357 | |
| 358 <a NAME="Fido2ManagementDialog.on_editButton_clicked" ID="Fido2ManagementDialog.on_editButton_clicked"></a> | |
| 359 <h4>Fido2ManagementDialog.on_editButton_clicked</h4> | |
| 360 <b>on_editButton_clicked</b>(<i></i>) | |
| 361 <p> | |
| 362 Private slot to edit the selected passkey. | |
| 363 </p> | |
| 364 | |
| 365 <a NAME="Fido2ManagementDialog.on_loadPasskeysButton_clicked" ID="Fido2ManagementDialog.on_loadPasskeysButton_clicked"></a> | |
| 366 <h4>Fido2ManagementDialog.on_loadPasskeysButton_clicked</h4> | |
| 367 <b>on_loadPasskeysButton_clicked</b>(<i></i>) | |
| 368 <p> | |
| 369 Private slot to (re-)populate the passkeys list. | |
| 370 </p> | |
| 371 | |
| 372 <a NAME="Fido2ManagementDialog.on_lockButton_toggled" ID="Fido2ManagementDialog.on_lockButton_toggled"></a> | |
| 373 <h4>Fido2ManagementDialog.on_lockButton_toggled</h4> | |
| 374 <b>on_lockButton_toggled</b>(<i>checked</i>) | |
| 375 <p> | |
| 376 Private slot to handle the toggling of the device locked status. | |
| 377 </p> | |
| 378 | |
| 379 <dl> | |
| 380 | |
| 381 <dt><i>checked</i> (bool)</dt> | |
| 382 <dd> | |
| 383 state of the lock/unlock button | |
| 384 </dd> | |
| 385 </dl> | |
| 386 <a NAME="Fido2ManagementDialog.on_passkeysList_itemSelectionChanged" ID="Fido2ManagementDialog.on_passkeysList_itemSelectionChanged"></a> | |
| 387 <h4>Fido2ManagementDialog.on_passkeysList_itemSelectionChanged</h4> | |
| 388 <b>on_passkeysList_itemSelectionChanged</b>(<i></i>) | |
| 389 <p> | |
| 390 Private slot handling the selection of a passkey. | |
| 391 </p> | |
| 392 | |
| 393 <a NAME="Fido2ManagementDialog.on_pinButton_clicked" ID="Fido2ManagementDialog.on_pinButton_clicked"></a> | |
| 394 <h4>Fido2ManagementDialog.on_pinButton_clicked</h4> | |
| 395 <b>on_pinButton_clicked</b>(<i></i>) | |
| 396 <p> | |
| 397 Private slot to set or change the PIN for the selected security key. | |
| 398 </p> | |
| 399 | |
| 400 <a NAME="Fido2ManagementDialog.on_securityKeysComboBox_currentIndexChanged" ID="Fido2ManagementDialog.on_securityKeysComboBox_currentIndexChanged"></a> | |
| 401 <h4>Fido2ManagementDialog.on_securityKeysComboBox_currentIndexChanged</h4> | |
| 402 <b>on_securityKeysComboBox_currentIndexChanged</b>(<i>index</i>) | |
| 403 <p> | |
| 404 Private slot handling the selection of security key. | |
| 405 </p> | |
| 406 | |
| 407 <dl> | |
| 408 | |
| 409 <dt><i>index</i> (int)</dt> | |
| 410 <dd> | |
| 411 index of the selected security key | |
| 412 </dd> | |
| 413 </dl> | |
| 414 <div align="right"><a href="#top">Up</a></div> | |
| 415 <hr /> | |
| 416 </body></html> |
