| /* ***** 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" |
| |
| /** |
| * A object that hold authentication information. The caller of |
| * nsIAuthPrompt2::promptUsernameAndPassword or |
| * nsIAuthPrompt2::promptPasswordAsync provides an object implementing this |
| * interface; the prompt implementation can then read the values here to prefill |
| * the dialog. After the user entered the authentication information, it should |
| * set the attributes of this object to indicate to the caller what was entered |
| * by the user. |
| */ |
| [scriptable, uuid(0d73639c-2a92-4518-9f92-28f71fea5f20)] |
| interface nsIAuthInformation : nsISupports |
| { |
| /** @name Flags */ |
| /* @{ */ |
| /** |
| * This dialog belongs to a network host. |
| */ |
| const PRUint32 AUTH_HOST = 1; |
| |
| /** |
| * This dialog belongs to a proxy. |
| */ |
| const PRUint32 AUTH_PROXY = 2; |
| |
| /** |
| * This dialog needs domain information. The user interface should show a |
| * domain field, prefilled with the domain attribute's value. |
| */ |
| const PRUint32 NEED_DOMAIN = 4; |
| |
| /** |
| * This dialog only asks for password information. Authentication prompts |
| * SHOULD NOT show a username field. Attempts to change the username field |
| * will have no effect. nsIAuthPrompt2 implementations should, however, show |
| * its initial value to the user in some form. For example, a paragraph in |
| * the dialog might say "Please enter your password for user jsmith at |
| * server intranet". |
| * |
| * This flag is mutually exclusive with #NEED_DOMAIN. |
| */ |
| const PRUint32 ONLY_PASSWORD = 8; |
| /* @} */ |
| |
| /** |
| * Flags describing this dialog. A bitwise OR of the flag values |
| * above. |
| * |
| * It is possible that neither #AUTH_HOST nor #AUTH_PROXY are set. |
| * |
| * Auth prompts should ignore flags they don't understand; especially, they |
| * should not throw an exception because of an unsupported flag. |
| */ |
| readonly attribute unsigned long flags; |
| |
| /** |
| * The server-supplied realm of the authentication as defined in RFC 2617. |
| * Can be the empty string if the protocol does not support realms. |
| * Otherwise, this is a human-readable string like "Secret files". |
| */ |
| readonly attribute AString realm; |
| |
| /** |
| * The authentication scheme used for this request, if applicable. If the |
| * protocol for this authentication does not support schemes, this will be |
| * the empty string. Otherwise, this will be a string such as "basic" or |
| * "digest". This string will always be in lowercase. |
| */ |
| readonly attribute AUTF8String authenticationScheme; |
| |
| /** |
| * The initial value should be used to prefill the dialog or be shown |
| * in some other way to the user. |
| * On return, this parameter should contain the username entered by |
| * the user. |
| * This field can only be changed if the #ONLY_PASSWORD flag is not set. |
| */ |
| attribute AString username; |
| |
| /** |
| * The initial value should be used to prefill the dialog or be shown |
| * in some other way to the user. |
| * The password should not be shown in clear. |
| * On return, this parameter should contain the password entered by |
| * the user. |
| */ |
| attribute AString password; |
| |
| /** |
| * The initial value should be used to prefill the dialog or be shown |
| * in some other way to the user. |
| * On return, this parameter should contain the domain entered by |
| * the user. |
| * This attribute is only used if flags include #NEED_DOMAIN. |
| */ |
| attribute AString domain; |
| }; |
| |