/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * The contents of this file are subject to the Netscape Public
 * License Version 1.1 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of
 * the License at http://www.mozilla.org/NPL/
 *
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation. All
 * Rights Reserved.
 *
 * Contributor(s):
 *  thayes@netscape.com
 *
 */

#include "nsISupports.idl"

/* Buffer type - for storing 8-bit octet values */
[ptr] native buffer(unsigned char);

[scriptable, uuid(0EC80360-075C-11d4-9FD4-00C04F1B83D8)]
interface nsISecretDecoderRing: nsISupports {

  /* Encrypt a buffer - callable only from C++ */
  [noscript] long encrypt(in buffer data, in long dataLen, out buffer result);

  /* Decrypt a buffer - callable only from C++ */
  [noscript] long decrypt(in buffer data, in long dataLen, out buffer result);

  /* Encrypt nul-terminated string to BASE64 output */
  string encryptString(in string text);

  /* Decrypt BASE64 input to nul-terminated string output */
  /* There is no check for embedded nul values in the decrypted output */
  string decryptString(in string crypt);

  /* Prompt the user to change the password on the SDR key */
  void changePassword();

  /* Logout of the security device that protects the SDR key */
  void logout();
};

/*
 * Configuration interface for the Secret Decoder Ring
 *  - this interface allows setting the window that will be
 *    used as parent for dialog windows (such as password prompts)
 */
[scriptable, uuid(01D8C0F0-0CCC-11d4-9FDD-000064657374)]
interface nsISecretDecoderRingConfig: nsISupports {
  void setWindow(in nsISupports w);
};


