mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
76 lines
2.7 KiB
Plaintext
76 lines
2.7 KiB
Plaintext
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set sw=2 ts=8 et tw=80 : */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsICancelable.idl"
|
|
|
|
interface nsIHttpChannel;
|
|
interface nsIHttpAuthenticableChannel;
|
|
|
|
/**
|
|
* nsIHttpChannelAuthProvider
|
|
*
|
|
* This interface is intended for providing authentication for http-style
|
|
* channels, like nsIHttpChannel and nsIWebSocket, which implement the
|
|
* nsIHttpAuthenticableChannel interface.
|
|
*
|
|
* When requesting pages AddAuthorizationHeaders MUST be called
|
|
* in order to get the http cached headers credentials. When the request is
|
|
* unsuccessful because of receiving either a 401 or 407 http response code
|
|
* ProcessAuthentication MUST be called and the page MUST be requested again
|
|
* with the new credentials that the user has provided. After a successful
|
|
* request, checkForSuperfluousAuth MAY be called, and disconnect MUST be
|
|
* called.
|
|
*/
|
|
|
|
[scriptable, uuid(c68f3def-c7c8-4ee8-861c-eef49a48b702)]
|
|
interface nsIHttpChannelAuthProvider : nsICancelable
|
|
{
|
|
/**
|
|
* Initializes the http authentication support for the channel.
|
|
* Implementations must hold a weak reference of the channel.
|
|
*/
|
|
void init(in nsIHttpAuthenticableChannel channel);
|
|
|
|
/**
|
|
* Upon receipt of a server challenge, this function is called to determine
|
|
* the credentials to send.
|
|
*
|
|
* @param httpStatus
|
|
* the http status received.
|
|
* @param sslConnectFailed
|
|
* if the last ssl tunnel connection attempt was or not successful.
|
|
* @param callback
|
|
* the callback to be called when it returns NS_ERROR_IN_PROGRESS.
|
|
* The implementation must hold a weak reference.
|
|
*
|
|
* @returns NS_OK if the credentials were got and set successfully.
|
|
* NS_ERROR_IN_PROGRESS if the credentials are going to be asked to
|
|
* the user. The channel reference must be
|
|
* alive until the feedback from
|
|
* nsIHttpAuthenticableChannel's methods or
|
|
* until disconnect be called.
|
|
*/
|
|
void processAuthentication(in unsigned long httpStatus,
|
|
in boolean sslConnectFailed);
|
|
|
|
/**
|
|
* Add credentials from the http auth cache.
|
|
*/
|
|
void addAuthorizationHeaders();
|
|
|
|
/**
|
|
* Check if an unnecessary(and maybe malicious) url authentication has been
|
|
* provided.
|
|
*/
|
|
void checkForSuperfluousAuth();
|
|
|
|
/**
|
|
* Cancel pending user auth prompts and release the callback and channel
|
|
* weak references.
|
|
*/
|
|
void disconnect(in nsresult status);
|
|
};
|