netwerk/base/public/nsISecretDecoderRing.idl@b8a032363ba2 (annotated)
netwerk/base/public/nsISecretDecoderRing.idl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | /** |
| michael@0 | 9 | * Buffer type - for storing 8-bit octet values. |
| michael@0 | 10 | */ |
| michael@0 | 11 | [ptr] native buffer(unsigned char); |
| michael@0 | 12 | |
| michael@0 | 13 | [scriptable, uuid(0EC80360-075C-11d4-9FD4-00C04F1B83D8)] |
| michael@0 | 14 | interface nsISecretDecoderRing: nsISupports { |
| michael@0 | 15 | |
| michael@0 | 16 | /** |
| michael@0 | 17 | * Encrypt a buffer - callable only from C++. |
| michael@0 | 18 | * |
| michael@0 | 19 | * @return The length of the data in the output buffer. |
| michael@0 | 20 | */ |
| michael@0 | 21 | [noscript] long encrypt(in buffer data, in long dataLen, out buffer result); |
| michael@0 | 22 | |
| michael@0 | 23 | /** |
| michael@0 | 24 | * Decrypt a buffer - callable only from C++. |
| michael@0 | 25 | * |
| michael@0 | 26 | * @return The length of the data in the output buffer. |
| michael@0 | 27 | */ |
| michael@0 | 28 | [noscript] long decrypt(in buffer data, in long dataLen, out buffer result); |
| michael@0 | 29 | |
| michael@0 | 30 | /** |
| michael@0 | 31 | * Encrypt nul-terminated string to BASE64 output. |
| michael@0 | 32 | */ |
| michael@0 | 33 | string encryptString(in string text); |
| michael@0 | 34 | |
| michael@0 | 35 | /** |
| michael@0 | 36 | * Decrypt BASE64 input to nul-terminated string output. There is |
| michael@0 | 37 | * no check for embedded nul values in the decrypted output. |
| michael@0 | 38 | */ |
| michael@0 | 39 | string decryptString(in string crypt); |
| michael@0 | 40 | |
| michael@0 | 41 | /** |
| michael@0 | 42 | * Prompt the user to change the password on the SDR key. |
| michael@0 | 43 | */ |
| michael@0 | 44 | void changePassword(); |
| michael@0 | 45 | |
| michael@0 | 46 | /** |
| michael@0 | 47 | * Logout of the security device that protects the SDR key. |
| michael@0 | 48 | */ |
| michael@0 | 49 | void logout(); |
| michael@0 | 50 | |
| michael@0 | 51 | /** |
| michael@0 | 52 | * Logout of the security device that protects the SDR key and tear |
| michael@0 | 53 | * down authenticated objects. |
| michael@0 | 54 | */ |
| michael@0 | 55 | void logoutAndTeardown(); |
| michael@0 | 56 | }; |
| michael@0 | 57 | |
| michael@0 | 58 | /** |
| michael@0 | 59 | * Configuration interface for the Secret Decoder Ring |
| michael@0 | 60 | * - this interface allows setting the window that will be |
| michael@0 | 61 | * used as parent for dialog windows (such as password prompts) |
| michael@0 | 62 | */ |
| michael@0 | 63 | [scriptable, uuid(01D8C0F0-0CCC-11d4-9FDD-000064657374)] |
| michael@0 | 64 | interface nsISecretDecoderRingConfig: nsISupports { |
| michael@0 | 65 | void setWindow(in nsISupports w); |
| michael@0 | 66 | }; |
