mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-08 20:47:44 +00:00
125 lines
4.7 KiB
Plaintext
125 lines
4.7 KiB
Plaintext
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla 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/MPL/
|
|
*
|
|
* 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 Necko code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Christian Biesinger <cbiesinger@web.de>.
|
|
* Portions created by the Initial Developer are Copyright (C) 2006
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Google Inc.
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIAuthPromptCallback;
|
|
interface nsIChannel;
|
|
interface nsICancelable;
|
|
interface nsIAuthInformation;
|
|
|
|
/**
|
|
* An interface allowing to prompt for a username and password. This interface
|
|
* is usually acquired using getInterface on notification callbacks or similar.
|
|
* It can be used to prompt users for authentication information, either
|
|
* synchronously or asynchronously.
|
|
*/
|
|
[scriptable, uuid(447fc780-1d28-412a-91a1-466d48129c65)]
|
|
interface nsIAuthPrompt2 : nsISupports
|
|
{
|
|
/** @name Security Levels */
|
|
/* @{ */
|
|
/**
|
|
* The password will be sent unencrypted. No security provided.
|
|
*/
|
|
const PRUint32 LEVEL_NONE = 0;
|
|
/**
|
|
* Password will be sent encrypted, but the connection is otherwise
|
|
* insecure.
|
|
*/
|
|
const PRUint32 LEVEL_PW_ENCRYPTED = 1;
|
|
/**
|
|
* The connection, both for password and data, is secure.
|
|
*/
|
|
const PRUint32 LEVEL_SECURE = 2;
|
|
/* @} */
|
|
|
|
/**
|
|
* Requests a username and a password. Implementations will commonly show a
|
|
* dialog with a username and password field, depending on flags also a
|
|
* domain field.
|
|
*
|
|
* @param aChannel
|
|
* The channel that requires authentication.
|
|
* @param level
|
|
* One of the level constants from above. See there for descriptions
|
|
* of the levels.
|
|
* @param authInfo
|
|
* Authentication information object. The implementation should fill in
|
|
* this object with the information entered by the user before
|
|
* returning.
|
|
*
|
|
* @retval true
|
|
* Authentication can proceed using the values in the authInfo
|
|
* object.
|
|
* @retval false
|
|
* Authentication should be cancelled, usually because the user did
|
|
* not provide username/password.
|
|
*
|
|
* @note Exceptions thrown from this function will be treated like a
|
|
* return value of false.
|
|
*/
|
|
boolean promptAuth(in nsIChannel aChannel,
|
|
in PRUint32 level,
|
|
in nsIAuthInformation authInfo);
|
|
|
|
/**
|
|
* Asynchronously prompt the user for a username and password.
|
|
* This has largely the same semantics as promptUsernameAndPassword(),
|
|
* but must return immediately after calling and return the entered
|
|
* data in a callback.
|
|
*
|
|
* If the user closes the dialog using a cancel button or similar,
|
|
* the callback's nsIAuthPromptCallback::onAuthCancelled method must be
|
|
* called.
|
|
* Calling nsICancelable::cancel on the returned object SHOULD close the
|
|
* dialog and MUST call nsIAuthPromptCallback::onAuthCancelled on the provided
|
|
* callback.
|
|
*
|
|
* @throw NS_ERROR_NOT_IMPLEMENTED
|
|
* Asynchronous authentication prompts are not supported;
|
|
* the caller should fall back to promptUsernameAndPassword().
|
|
*/
|
|
nsICancelable asyncPromptAuth(in nsIChannel aChannel,
|
|
in nsIAuthPromptCallback aCallback,
|
|
in nsISupports aContext,
|
|
in PRUint32 level,
|
|
in nsIAuthInformation authInfo);
|
|
};
|
|
|
|
|